Feat(eos_cli_config_gen): Add support for grpc-tunnel

[adietrich-ussignal]

Change Summary

Add grpc-tunnel to the management api gnmi data model.

Related Issue(s)

Fixes #2665

Component(s) name

arista.avd.eos_cli_config_gen

Proposed changes

This change adds the grpc-tunnel configuration settings to the management api gnmi data model. Allows for the creation of multiple tunnels, and multiple target_ids per tunnel as is permitted by EOS. Multiple target_ids can be separated by a space.

This configuration is only valid as of EOS 4.27.0F.

Added the following to schema management_api_gnmi

management_api_gnmi:
[...]
          grpc_tunnels:
            type: list
            items:
              type: dict
              keys:
                name:
                  type: str
                  description: Transport name
                shutdown:
                  type: bool
                  description: Operational status of the gRPC tunnel
                tunnel_ssl_profile:
                  type: str
                  description: Tunnel SSL profile name
                gnmi_ssl_profile:
                  type: str
                  description: gNMI SSL profile name
                vrf:
                  type: str
                  description: VRF name is optional
                destination:
                  type: dict
                  keys:
                    address:
                      type: str
                      description: IP address or hostname
                    port:
                      type: int
                      min: 1
                      max: 65535
                      convert_types:
                      - str
                      description: TCP Port
                local_interface:
                  type: dict
                  keys:
                    interface:
                      type: str
                      description: Interface name
                    port:
                      type: int
                      min: 1
                      max: 65535
                      convert_types:
                      - str
                      description: TCP Port
                target:
                  type: dict
                  keys:
                    use_serial_number:
                      type: bool
                      description: Use serial number as the Target ID
                    target_id:
                      type: str
                      description: |
                        Target IDs as a string. More than one Target ID can be specified.
                        Examples:
                        - "id1 id2 id3"
                        - "id1"

How to test

Ran the pre-commit on changes to the schema and Jinja2 templates for both EOS and Documentation.
Added tests to the eos_cli_config_gen molecule using management-gnmi-grpc-tunnel.yml.

Checklist

User Checklist

• Pre-Commit Check
• eos_cli_config_gen Molecule test

Repository Checklist

• My code has been rebased from devel before I start
• I have read the CONTRIBUTING document.
• My change requires a change to the documentation and documentation have been updated accordingly.
• I have updated molecule CI testing accordingly. (check the box if not applicable)

[gmuloc]

Thanks a lot for this PR! Very complete implementation.

I have added a couple of comments mostly around adding constraints in the schema, that will make for simpler jinja templates and cleaning up a bit of extra lines in the documentation.

Do not hesitate to ask questions / precisions

For reference:

Leaf1(config-grpc-tunnel-transport-BLAH)#show cli commands
APPEND [ COMMENT ]
[no|default] comment
[no|default] destination HOST port PORT
do CMD
exit
[no|default] gnmi ssl profile PROFILE
[no|default] local interface INTF [ port PORT ]
show active
show active all [ detail ]
show comment
[no|default] shutdown
[no|default] target ( serial-number | TARGET_ID )
[no|default] tunnel ssl profile PROFILE
[no|default] vrf VRF

[adietrich-ussignal]

I appreciate the quick review!

I added changes in-line with what was requested. Took a bit to work out the whitespace details, but I think I got it this time.

[adietrich-ussignal]

You left quite a few comments so GitHub hid some of them. I think they are all covered now :)

[gmuloc]

Thanks for the fast update - a couple new comments regarding the remaining extra blank line and the useless check for name

[gmuloc]

Looks like this one still needs to be addressed!

[adietrich-ussignal]

I appreciate the patience and continual feedback! It appears, to my eye, that the spacing is fixed on the documentation.

[ClausHolbechArista]

Would this be better as a list that we then join on white space?

[carlbuchmann]

• +1, this should be a list and renamed to target_ids

[gmuloc]

@adietrich-ussignal - would you have some time to look at the latest review comments on this PR - we would love to include it in the next dev release or the one just after! Let us know if you need some help on addressing them!

[adietrich-ussignal]

I'll review the comments and push commits on this issue tomorrow.

[adietrich-ussignal]

Having some issues getting the proper commits amidst the other changes. I would greatly appreciate some guidance to resolve.

[gmuloc]

Having some issues getting the proper commits amidst the other changes. I would greatly appreciate some guidance to resolve.

Hi @adietrich-ussignal - fixed the things going on with schema.
I took the liberty to add the items key in the schema for target_ids and also to modify a bit the documentation template as it was failing if no destination was given or if no target was given.

[adietrich-ussignal]

Thanks @gmuloc! Learned a lot through this one and by reviewing your latest code revision.

[carlbuchmann]

LGTM, thanks for this great contribution @adietrich-ussignal