Feat(eos_cli_config_gen): Add knob to define port in GNMI transport g…

…rpc (#3245) Co-authored-by: Guillaume Mulocher <[email protected]> Co-authored-by: Claus Holbech <[email protected]>
aristanetworks · Oct 19, 2023 · ae7c25e · ae7c25e
1 parent 232ca91
commit ae7c25e
Show file tree

Hide file tree

Showing 12 changed files with 45 additions and 11 deletions.
diff --git a/.../molecule/eos_cli_config_gen/documentation/devices/management-gnmi-new-flags.md b/.../molecule/eos_cli_config_gen/documentation/devices/management-gnmi-new-flags.md
@@ -38,10 +38,10 @@ interface Management1
 
 #### Management API gNMI Summary
 
-| Transport | SSL Profile | VRF | Notification Timestamp | ACL |
-| --------- | ----------- | --- | ---------------------- | --- |
-| MGMT | gnmi | MGMT | send-time | acl1 |
-| mytransport | - | - | send-time | acl1 |
+| Transport | SSL Profile | VRF | Notification Timestamp | ACL | Port |
+| --------- | ----------- | --- | ---------------------- | --- | ---- |
+| MGMT | gnmi | MGMT | send-time | acl1 | 6030 |
+| mytransport | - | - | send-time | acl1 | 6032 |
 
 Provider eos-native is configured.
 
@@ -56,6 +56,7 @@ management api gnmi
       ip access-group acl1
       notification timestamp send-time
    transport grpc mytransport
+      port 6032
       ip access-group acl1
       notification timestamp send-time
    provider eos-native

diff --git a/...arista/avd/molecule/eos_cli_config_gen/documentation/devices/management-gnmi.md b/...arista/avd/molecule/eos_cli_config_gen/documentation/devices/management-gnmi.md
@@ -38,10 +38,10 @@ interface Management1
 
 #### Management API gNMI Summary
 
-| Transport | SSL Profile | VRF | Notification Timestamp | ACL |
-| --------- | ----------- | --- | ---------------------- | --- |
-| MGMT | - | MGMT | last-change-time | ACL-GNMI |
-| MONITORING | - | MONITORING | last-change-time | - |
+| Transport | SSL Profile | VRF | Notification Timestamp | ACL | Port |
+| --------- | ----------- | --- | ---------------------- | --- | ---- |
+| MGMT | - | MGMT | last-change-time | ACL-GNMI | 6030 |
+| MONITORING | - | MONITORING | last-change-time | - | 6031 |
 
 Provider eos-native is configured.
 
@@ -54,6 +54,7 @@ management api gnmi
       vrf MGMT
       ip access-group ACL-GNMI
    transport grpc MONITORING
+      port 6031
       vrf MONITORING
    provider eos-native
 ```
diff --git a/...ons/arista/avd/molecule/eos_cli_config_gen/intended/configs/management-gnmi-new-flags.cfg b/...ons/arista/avd/molecule/eos_cli_config_gen/intended/configs/management-gnmi-new-flags.cfg
@@ -19,6 +19,7 @@ management api gnmi
       ip access-group acl1
       notification timestamp send-time
    transport grpc mytransport
+      port 6032
       ip access-group acl1
       notification timestamp send-time
    provider eos-native

diff --git a/...e_collections/arista/avd/molecule/eos_cli_config_gen/intended/configs/management-gnmi.cfg b/...e_collections/arista/avd/molecule/eos_cli_config_gen/intended/configs/management-gnmi.cfg
@@ -17,6 +17,7 @@ management api gnmi
       vrf MGMT
       ip access-group ACL-GNMI
    transport grpc MONITORING
+      port 6031
       vrf MONITORING
    provider eos-native
 !

diff --git a/.../arista/avd/molecule/eos_cli_config_gen/inventory/host_vars/management-gnmi-new-flags.yml b/.../arista/avd/molecule/eos_cli_config_gen/inventory/host_vars/management-gnmi-new-flags.yml
@@ -10,3 +10,4 @@ management_api_gnmi:
     - name: mytransport
       notification_timestamp: "send-time"
       ip_access_group: acl1
+      port: "6032"
diff --git a/...ollections/arista/avd/molecule/eos_cli_config_gen/inventory/host_vars/management-gnmi.yml b/...ollections/arista/avd/molecule/eos_cli_config_gen/inventory/host_vars/management-gnmi.yml
@@ -7,3 +7,4 @@ management_api_gnmi:
         ip_access_group: ACL-GNMI
       - name: MONITORING
         vrf: MONITORING
+        port: 6031
diff --git a/...lections/arista/avd/roles/eos_cli_config_gen/docs/tables/management-api-gnmi.md b/...lections/arista/avd/roles/eos_cli_config_gen/docs/tables/management-api-gnmi.md
@@ -16,6 +16,7 @@
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;vrf</samp>](## "management_api_gnmi.transport.grpc.[].vrf") | String |  |  |  | VRF name is optional |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;notification_timestamp</samp>](## "management_api_gnmi.transport.grpc.[].notification_timestamp") | String |  |  | Valid Values:<br>- send-time<br>- last-change-time | Per the gNMI specification, the default timestamp field of a notification message is set to be<br>the time at which the value of the underlying data source changes or when the reported event takes place.<br>In order to facilitate integration in legacy environments oriented around polling style operations,<br>an option to support overriding the timestamp field to the send-time is available from EOS 4.27.0F.<br> |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ip_access_group</samp>](## "management_api_gnmi.transport.grpc.[].ip_access_group") | String |  |  |  | ACL name |
+    | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;port</samp>](## "management_api_gnmi.transport.grpc.[].port") | Integer |  |  |  | GNMI port.<br>Make sure to update the control-plane ACL accordingly in order for the service to be reachable by external applications.<br> |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;grpc_tunnels</samp>](## "management_api_gnmi.transport.grpc_tunnels") | List, items: Dictionary |  |  |  |  |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;- name</samp>](## "management_api_gnmi.transport.grpc_tunnels.[].name") | String | Required, Unique |  |  | Transport name |
     | [<samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;shutdown</samp>](## "management_api_gnmi.transport.grpc_tunnels.[].shutdown") | Boolean |  |  |  | Operational status of the gRPC tunnel |
@@ -49,6 +50,7 @@
             vrf: <str>
             notification_timestamp: <str>
             ip_access_group: <str>
+            port: <int>
         grpc_tunnels:
           - name: <str>
             shutdown: <bool>

diff --git a/...ollections/arista/avd/roles/eos_cli_config_gen/schemas/eos_cli_config_gen.jsonschema.json b/...ollections/arista/avd/roles/eos_cli_config_gen/schemas/eos_cli_config_gen.jsonschema.json
@@ -7868,6 +7868,11 @@
                     "type": "string",
                     "description": "ACL name",
                     "title": "IP Access Group"
+                  },
+                  "port": {
+                    "type": "integer",
+                    "description": "GNMI port.\nMake sure to update the control-plane ACL accordingly in order for the service to be reachable by external applications.\n",
+                    "title": "Port"
                   }
                 },
                 "additionalProperties": false,

diff --git a/...ble_collections/arista/avd/roles/eos_cli_config_gen/schemas/eos_cli_config_gen.schema.yml b/...ble_collections/arista/avd/roles/eos_cli_config_gen/schemas/eos_cli_config_gen.schema.yml
@@ -4717,6 +4717,16 @@ keys:
                 ip_access_group:
                   type: str
                   description: ACL name
+                port:
+                  type: int
+                  description: 'GNMI port.
+
+                    Make sure to update the control-plane ACL accordingly in order
+                    for the service to be reachable by external applications.
+
+                    '
+                  convert_types:
+                  - str
           grpc_tunnels:
             type: list
             primary_key: name

diff --git a/...ista/avd/roles/eos_cli_config_gen/schemas/schema_fragments/management_api_gnmi.schema.yml b/...ista/avd/roles/eos_cli_config_gen/schemas/schema_fragments/management_api_gnmi.schema.yml
@@ -42,6 +42,13 @@ keys:
                 ip_access_group:
                   type: str
                   description: ACL name
+                port:
+                  type: int
+                  description: |
+                      GNMI port.
+                      Make sure to update the control-plane ACL accordingly in order for the service to be reachable by external applications.
+                  convert_types:
+                    - str
           grpc_tunnels:
             type: list
             primary_key: name

diff --git a/...ctions/arista/avd/roles/eos_cli_config_gen/templates/documentation/management-api-gnmi.j2 b/...ctions/arista/avd/roles/eos_cli_config_gen/templates/documentation/management-api-gnmi.j2
@@ -26,16 +26,17 @@
 {# new table view using the new flags #}
 {%     if management_api_gnmi.transport.grpc is arista.avd.defined %}
 
-| Transport | SSL Profile | VRF | Notification Timestamp | ACL |
-| --------- | ----------- | --- | ---------------------- | --- |
+| Transport | SSL Profile | VRF | Notification Timestamp | ACL | Port |
+| --------- | ----------- | --- | ---------------------- | --- | ---- |
 {%         for transport in management_api_gnmi.transport.grpc %}
 {%             if transport.name is arista.avd.defined %}
 {%                 set transport_name = transport.name %}
 {%                 set ssl_profile = transport.ssl_profile | arista.avd.default('-') %}
 {%                 set vrf = transport.vrf | arista.avd.default('-') %}
 {%                 set notif = transport.notification_timestamp | arista.avd.default('last-change-time') %}
 {%                 set acl = transport.ip_access_group | arista.avd.default('-') %}
-| {{ transport_name }} | {{ ssl_profile }} | {{ vrf }} | {{ notif }} | {{ acl }} |
+{%                 set port = transport.port | arista.avd.default('6030') %}
+| {{ transport_name }} | {{ ssl_profile }} | {{ vrf }} | {{ notif }} | {{ acl }} | {{ port }} |
 {%             endif %}
 {%         endfor %}
 {%     endif %}

diff --git a/ansible_collections/arista/avd/roles/eos_cli_config_gen/templates/eos/management-api-gnmi.j2 b/ansible_collections/arista/avd/roles/eos_cli_config_gen/templates/eos/management-api-gnmi.j2
@@ -29,6 +29,9 @@ management api gnmi
 {%                     if transport.ssl_profile is arista.avd.defined %}
       ssl profile {{ transport.ssl_profile }}
 {%                     endif %}
+{%                     if transport.port is arista.avd.defined %}
+      port {{ transport.port }}
+{%                     endif %}
 {%                     if transport.vrf is arista.avd.defined %}
       vrf {{ transport.vrf }}
 {%                     endif %}