Skip to content

Commit

Permalink
update various readme docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mtarking committed Nov 12, 2024
1 parent d833a5b commit 77f53bd
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 13 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
7 changes: 3 additions & 4 deletions roles/dtc/connectivity_check/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------
Expand Down Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion roles/dtc/create/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand All @@ -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
Expand Down
10 changes: 10 additions & 0 deletions roles/dtc/deploy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------

Expand Down
3 changes: 2 additions & 1 deletion roles/dtc/remove/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand All @@ -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
Expand Down

0 comments on commit 77f53bd

Please sign in to comment.