From 77f53bd5a5146794df532fafbc21b5dbc9b920ad Mon Sep 17 00:00:00 2001 From: Matt Tarkington Date: Tue, 12 Nov 2024 14:01:45 -0500 Subject: [PATCH] update various readme docs --- README.md | 16 +++++++++------- roles/dtc/connectivity_check/README.md | 7 +++---- roles/dtc/create/README.md | 3 ++- roles/dtc/deploy/README.md | 10 ++++++++++ roles/dtc/remove/README.md | 3 ++- 5 files changed, 26 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index ac984a6f..1bafdbd3 100644 --- a/README.md +++ b/README.md @@ -187,7 +187,7 @@ all: ndfc: hosts: nac-ndfc1: - ansible_host: 10.X.X.X + ansible_host: "{{ lookup('ansible.builtin.env', 'ND_HOST') }}" ``` This structure creates two things in Ansible, a group called `ndfc` and a host called `nac-ndfc1:`. These are tied back to the directory structure of the repository that contains two folders in the top directory: @@ -209,7 +209,7 @@ The collection is **pre-built** to utilize the `group_vars` and `host_vars` matc #### Step 1 - Update the Inventory File -In the provided `inventory.yaml` file on the root directory, update the `ansible_host` variable to point to your NDFC controller by replacing `10.X.X.X` with the IP address of the NDFC controller. +In the provided `inventory.yaml` file on the root directory, update the `ansible_host` variable to point to your NDFC controller by replacing `"{{ lookup('ansible.builtin.env', 'ND_HOST') }}"` with the IP address of the NDFC controller or setting the ```ND_HOST``` environment variable as described in Step 3. #### Step 2 - Configure Ansible Connection File @@ -246,12 +246,14 @@ The usage of [Ansible vault](https://docs.ansible.com/ansible/latest/vault_guide The environment variables are set in the shell that is going to execute the playbook. The environment variables are configured via the `export` command in the shell (bash). Using this template set the environment variables to the correct credentials for the NDFC controller and the devices in the inventory on your topology. ```bash -# These are the credentials for -export ansible_user=admin -export ansible_password=Admin_123 +# These are the credentials for ND/NDFC +export ND_HOST=10.15.0.11 +export ND_DOMAIN=local +export ND_USERNAME=admin +export ND_PASSWORD=Admin_123 # These are the credentials for the devices in the inventory -export ndfc_switch_username=admin -export ndfc_switch_password=Admin_123 +export NDFC_SW_USERNAME=admin +export NDFC_SW_PASSWORD=Admin_123 ``` The following quickstart repository is available to provide a step by step guide for using this collection diff --git a/roles/dtc/connectivity_check/README.md b/roles/dtc/connectivity_check/README.md index 4d3344ed..615c2ee2 100644 --- a/roles/dtc/connectivity_check/README.md +++ b/roles/dtc/connectivity_check/README.md @@ -2,7 +2,7 @@ Role Name: cisco.nac_dc_vxlan.dtc.connectivity_check ======================================== This role is used to check the connectivity and authentication to NDFCs. -Additionally, the role is used to obtain the NDFC version information. +Additionally, the role is used to obtain the Nexus Dashboard (ND) and Nexus Dashboard Fabric Controller (NDFC) version information. Requirements ------------ @@ -33,12 +33,11 @@ The following tags can be used to selectively execute stages within the `cisco.n `cc` stands for `connectivity_check` role -* cc_connectivity_check -* cc_version +* cc_verify ```bash # Selectively run stage to add VRFs and Networks and skip all other stages -ansible-playbook -i inventory.yml vxlan.yml --tags cc_connectivity_check +ansible-playbook -i inventory.yml vxlan.yml --tags cc_verify ``` License diff --git a/roles/dtc/create/README.md b/roles/dtc/create/README.md index a6d2ed13..92d53e30 100644 --- a/roles/dtc/create/README.md +++ b/roles/dtc/create/README.md @@ -28,7 +28,7 @@ Example Playbook ``` ------- -The following tags can be used to selectively execute stages within the `cisco.nac_dc_vxlan.create` role +The following tags can be used to selectively execute stages within the `cisco.nac_dc_vxlan.dtc.create` role `cr` stands for `create_role` @@ -37,6 +37,7 @@ The following tags can be used to selectively execute stages within the `cisco.n * cr_manage_vpc_peers * cr_manage_interfaces * cr_manage_vrfs_networks +* cr_manage_policy ```bash # Selectively run stage to add VRFs and Networks and skip all other stages diff --git a/roles/dtc/deploy/README.md b/roles/dtc/deploy/README.md index 56e4d00b..bfcb9f4c 100644 --- a/roles/dtc/deploy/README.md +++ b/roles/dtc/deploy/README.md @@ -27,6 +27,16 @@ Example Playbook - role: cisco.nac_dc_vxlan.dtc.deploy ``` +------- +The following tags can be used to selectively execute stages within the `cisco.nac_dc_vxlan.dtc.deploy` role + +* role_deploy + +```bash +# Selectively run stage to add VRFs and Networks and skip all other stages +ansible-playbook -i inventory.yml vxlan.yml --tags role_deploy +``` + License ------- diff --git a/roles/dtc/remove/README.md b/roles/dtc/remove/README.md index 5cde68b7..bfbd55c3 100644 --- a/roles/dtc/remove/README.md +++ b/roles/dtc/remove/README.md @@ -28,7 +28,7 @@ Example Playbook ``` ------- -The following tags can be used to selectively execute stages within the `cisco.nac_dc_vxlan.create` role +The following tags can be used to selectively execute stages within the `cisco.nac_dc_vxlan.dtc.remove` role `rr` stands for `remove_role` @@ -38,6 +38,7 @@ The following tags can be used to selectively execute stages within the `cisco.n * rr_manage_vpc_peers * rr_manage_links * rr_manage_switches +* rr_manage_policy ```bash # Selectively run stage to remove networks and vrfs and skip all other stages