Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/allenrobel/ndfc_doc_builder

Build NDFC Ansible documentation from NDFC templates.
https://github.com/allenrobel/ndfc_doc_builder

Last synced: 16 days ago
JSON representation

Build NDFC Ansible documentation from NDFC templates.

Host: GitHub
URL: https://github.com/allenrobel/ndfc_doc_builder
Owner: allenrobel
License: mpl-2.0
Created: 2024-09-30T21:58:48.000Z (3 months ago)
Default Branch: main
Last Pushed: 2024-12-10T18:50:55.000Z (24 days ago)
Last Synced: 2024-12-15T09:05:38.401Z (19 days ago)
Language: Python
Size: 44.9 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Usage

1. The DCNM Ansible Collection must be installed and in your ``PYTHONPATH``

## Example

```bash
export PYTHONPATH=$PYTHONPATH:$HOME/repos/ansible_dev/dcnm_fabric/ansible_collections/cisco/dcnm
```

2. Set the following environment variables appropriately for your NDFC installation

```bash
export ND_USERNAME=admin
export ND_PASSWORD=my_password
export ND_IP4=10.1.1.1
export ND_DOMAIN=local
```

3. Change directory into the top-level of wherever you cloned this repo

```bash
cd $HOME/repos/ndfc_doc_builder
```

4. Edit the following script and modify ``template_name`` to the name of the template you want to document.

```bash
vi ./util/build_ndfc_fabric_documentation.py
```

```python
template_name = "Easy_Fabric"
```

## Example template names

| Template Name | Associated Fabric Type | Notes |
| ---------------- | ------------------------ | -------------------------------------------- |
| Easy_Fabric_IPFM | IP Fabric for Media | NDFC must be in IPFM mode when script is run |
| Easy_Fabric | VXLAN/EVPN Fabric | |
| External_Fabric | ISN, others | |
| LAN_Classic | Classic LAN | |
| MSD_Fabric | Multi-Site Domain Fabric | |

5. Run the script

```bash
./util/build_ndfc_fabric_documentation.py
```

6. The documentation will be printed as YAML.

# Manual fixes required

- 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

- 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

- 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

- 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

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

```bash
cd $HOME/repos
git clone https://github.com/ansible-network/collection_prep.git
cd $HOME/repos/collection_prep
# requires python 3.8
source ${HOME}/py38/bin/activate
pip install . --force
collection_prep_add_docs -p $HOME/repos/ansible_dev/dcnm_fabric/ansible_collections/cisco/dcnm
```