/ndfc_doc_builder

Build documentation from NDFC templates

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

Usage

For now, run ./util/build_*.py scripts from the directory level above ./util.

cd $HOME/repos/ansible_dev/ndfc_doc_builder ./util/build_lan_classic_fabric_doc.py ./util/build_vxlan_evpn_fabric_doc.py ./util/build_vxlan_evpn_msd_fabric_doc.py

Manual fixes required

  1. type: str should be type: int due to default is int

                 MS_IFC_BGP_AUTH_KEY_TYPE:
                 choices:
                 - 3
                 - 7
                 default: 3
                 description:
                 - 'BGP Key Encryption Type: 3 - 3DES, 7 - Cisco'
                 required: false
                 type: str   (should be int)

             BGP_AUTH_KEY_TYPE:
                 choices:
                 - 3
                 - 7
                 default: 3
                 description:
                 - 'BGP Key Encryption Type: 3 - 3DES, 7 - Cisco'
                 required: false
                 type: str (should be int)

             BGW_ROUTING_TAG:
                 default: 54321
                 description:
                 - Routing tag associated with IP address of loopback and DCI interfaces
                 required: false
                 type: str

             RS_ROUTING_TAG:
                 default: 54321
                 description:
                 - Routing tag associated with Route Server IP for redistribute direct.
                     This is the IP used in eBGP EVPN peering.
                 required: false
                 type: int

             STP_BRIDGE_PRIORITY:
                 default: 0
                 description:
                 - Bridge priority for the spanning tree in increments of 4096
                 required: false
                 type: str

             VPC_PEER_LINK_PO:
                 default: 500
                 description:
                 - No description available
                 required: false
                 type: str

             VPC_PEER_LINK_VLAN:
                 default: 3600
                 description:
                 - 'VLAN range for vPC Peer Link SVI '
                 required: false
                 type: str

  2. Defines a comma-separated range, which should be str. default needs to have quotes "0"

                 MST_INSTANCE_RANGE:
                 default: 0
                 description:
                 - 'MST instance range, Example: 0-3,5,7-9, Default is 0'
                 required: false
                 type: str

  3. IPFM_FABRIC_PARAMETERS. default: 1 needs to be default: "1" LINK_STATE_ROUTING_TAG: default: "1" description: - Routing process tag for the fabric required: false type: str

  4. List type requires -> elements: str

                 NETFLOW_EXPORTER_LIST:
                 default: ''
                 description:
                 - One or Multiple Netflow Exporters
                 required: false
                 type: list

             NETFLOW_MONITOR_LIST:
                 default: ''
                 description:
                 - One or Multiple Netflow Monitors
                 required: false
                 type: list


             NETFLOW_RECORD_LIST:
                 default: ''
                 description:
                 - One or Multiple Netflow Records
                 required: false
                 type: list

             NETFLOW_SAMPLER_LIST:
                 default: ''
                 description:
                 - One or multiple netflow Samplers. Applicable to N7K only
                 required: false
                 type: list

 IPFM_FABRIC_PARAMETERS

             ASM_GROUP_RANGES:
                 default: ''
                 description:
                 - 'ASM group ranges with prefixes (len:4-32) example: 239.1.1.0/25,
                     max 20 ranges. Enabling SPT-Threshold Infinity to prevent switchover
                     to source-tree.'
                 required: false
                 type: list

Usage for .rst doc generator for DCNM Ansible Collection

https://github.com/ansible-network/collection_prep?tab=readme-ov-file#doc-generator

cd $HOME/repos git clone https://github.com/ansible-network/collection_prep.git cd /Users/arobel/repos/collection_prep

requires python 3.8

source ${HOME}/py38/bin/activate pip install . --force collection_prep_add_docs -p /Users/arobel/repos/ansible_dev/dcnm_image_policy/ansible_collections/cisco/dcnm

collection_prep_add_docs -p /Users/arobel/repos/ansible_dev/dcnm_fabric/ansible_collections/cisco/dcnm