Skip to content

Commit 390893e

Browse files
committed
Enhancement: CVP_GUIDE and Readme
1 parent 857d402 commit 390893e

2 files changed

Lines changed: 40 additions & 13 deletions

File tree

CVP_GUIDE.md

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Jumpstart your automation journey with sample input files that demonstrate prope
5959
### 🎨 Jinja-Based Templates
6060
Enhance scalability and flexibility with Jinja-based templates support. These templates empower you to dynamically generate input configurations, adapting to various deployments with ease.
6161

62-
### Infrastructure as Code
62+
### 🏗️ Infrastructure as Code
6363
Embrace infrastructure as code and manage your entire Catalyst Center configuration through Git. This provides:
6464
- **Complete version control**: Track every change and easily revert to previous states
6565
- **Increased collaboration**: Simplify teamwork with a centralized platform
@@ -68,7 +68,7 @@ Embrace infrastructure as code and manage your entire Catalyst Center configurat
6868

6969
---
7070

71-
## 📦 Installation
71+
## 📦 Installation
7272

7373
### Install Collection (Includes CVPs)
7474

@@ -113,7 +113,7 @@ Minimal inventory (`inventory/hosts.yml`):
113113
catalyst_center_hosts:
114114
hosts:
115115
catalyst_center220:
116-
ansible_host: "{{ lookup('env', 'HOSTIP') }}"
116+
ansible_connection: local
117117
catalystcenter_host: "{{ lookup('env', 'HOSTIP') }}"
118118
catalystcenter_username: "{{ lookup('env', 'CATALYST_CENTER_USERNAME') }}"
119119
catalystcenter_password: "{{ lookup('env', 'CATALYST_CENTER_PASSWORD') }}"
@@ -496,6 +496,7 @@ Establish foundational access control and integrate with external systems.
496496
|-----|-------------|--------|
497497
| **users_and_roles** | Role Based Access Control and Users Management | [📖 Guide](cvp/users_and_roles/README.md) |
498498
| **ise_radius_integration** | ISE and AAA Servers Integration | [📖 Guide](cvp/ise_radius_integration/README.md) |
499+
| **ansible_vault_update** | Update Ansible Vault encrypted credentials | [📖 Guide](cvp/ansible_vault_update/README.md) |
499500
500501
---
501502
@@ -517,6 +518,7 @@ Design your network hierarchy, configure settings, and discover devices.
517518
| **provision** | Device Provisioning and Re-Provisioning Management | [📖 Guide](cvp/provision/README.md) |
518519
| **device_templates** | Design and Deploy Device Templates | [📖 Guide](cvp/device_templates/README.md) |
519520
| **tags_manager** | Tags Management | [📖 Guide](cvp/tags_manager/README.md) |
521+
| **access_point_location** | Access Point location management on floor maps | [📖 Guide](cvp/access_point_location/README.md) |
520522
521523
---
522524
@@ -532,6 +534,7 @@ Configure underlay automation and SD-Access fabric.
532534
| **sda_virtual_networks_l2l3_gateways** | Virtual Networks and L3 Anycast Gateways and L2 VLANs Management | [📖 Guide](cvp/sda_virtual_networks_l2l3_gateways/README.md) |
533535
| **sda_fabric_device_roles** | SDA Fabric Device assignment to fabric sites and zones | [📖 Guide](cvp/sda_fabric_device_roles/README.md) |
534536
| **sda_hostonboarding** | SDA Fabric Devices and Host Onboarding | [📖 Guide](cvp/sda_hostonboarding/README.md) |
537+
| **sda_fabric_discover_and_onboard_fabric_devices** | Discover and onboard devices into the SDA fabric | [📖 Guide](cvp/sda_fabric_discover_and_onboard_fabric_devices/README.md) |
535538
| **sda_fabric_extranet_policy** | SDA Extranet Policies Management | [📖 Guide](cvp/sda_fabric_extranet_policy/README.md) |
536539
| **sda_fabric_multicast** | SDA Fabric Multicast Management | [📖 Guide](cvp/sda_fabric_multicast/README.md) |
537540
| **application_policy** | Application Policy Management | [📖 Guide](cvp/application_policy/README.md) |
@@ -629,19 +632,30 @@ git commit -m "Add customized CVPs"
629632
630633
### 2. Use Ansible Vault for Secrets
631634
635+
The inventory at [Prerequisite: Inventory File](#-prerequisite-inventory-file)
636+
reads credentials from environment variables. For long-term storage, keep the
637+
same variable names (`catalystcenter_host`, `catalystcenter_username`,
638+
`catalystcenter_password`) but source them from an Ansible Vault file in
639+
`group_vars/`, so they are picked up automatically by the
640+
`catalyst_center_hosts` group without `-e` overrides.
641+
632642
```bash
633-
# Create vault file
634-
ansible-vault create group_vars/all/vault.yml
643+
# 1. Create vault file for the catalyst_center_hosts group
644+
mkdir -p group_vars/catalyst_center_hosts
645+
ansible-vault create group_vars/catalyst_center_hosts/vault.yml
646+
```
635647
636-
# Add credentials
637-
vault_catalystcenter_host: "10.1.1.1"
638-
vault_catalystcenter_username: "admin"
639-
vault_catalystcenter_password: "secret"
648+
```yaml
649+
# group_vars/catalyst_center_hosts/vault.yml (encrypted)
650+
catalystcenter_host: "10.1.1.1"
651+
catalystcenter_username: "admin"
652+
catalystcenter_password: "secret"
653+
```
640654
641-
# Reference in playbook
655+
```bash
656+
# 2. Run the playbook — vault vars override the env-based defaults
642657
ansible-playbook -i inventory/hosts.yml \
643658
cvp/site_hierarchy/playbook/site_hierarchy_playbook.yml \
644-
-e catalystcenter_host="{{ vault_catalystcenter_host }}" \
645659
--ask-vault-pass
646660
```
647661

cvp/README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Minimal inventory (`inventory/hosts.yml`):
5252
catalyst_center_hosts:
5353
hosts:
5454
catalyst_center220:
55-
ansible_host: "{{ lookup('env', 'HOSTIP') }}"
55+
ansible_connection: local
5656
catalystcenter_host: "{{ lookup('env', 'HOSTIP') }}"
5757
catalystcenter_username: "{{ lookup('env', 'CATALYST_CENTER_USERNAME') }}"
5858
catalystcenter_password: "{{ lookup('env', 'CATALYST_CENTER_PASSWORD') }}"
@@ -160,7 +160,8 @@ ansible-playbook \
160160
| **sda_fabric_device_roles** | Assign fabric device roles (edge, border, control plane) | Role assignment |
161161
| **sda_fabric_transits** | Configure fabric transits and inter-site connectivity | SD-Access transits |
162162
| **sda_fabric_multicast** | Configure multicast settings in SDA fabric | Multicast enablement |
163-
| **sda_extranet_policies** | Manage extranet policies for inter-VN communication | Extranet configuration |
163+
| **sda_fabric_extranet_policy** | Manage extranet policies for inter-VN communication | Extranet configuration |
164+
| **sda_fabric_discover_and_onboard_fabric_devices** | Discover and onboard devices into the SDA fabric | Fabric onboarding |
164165
| **sda_device_removal_and_unprovision** | Remove devices from fabric | Cleanup workflows |
165166
| **sda_port_assignment_migration** | Migrate port assignments | Port migration |
166167

@@ -173,6 +174,13 @@ ansible-playbook \
173174
| **assurance_health_score_settings** | Configure health score thresholds | Custom thresholds |
174175
| **assurance_intelligent_capture** | Configure intelligent packet capture (iCAP) | Packet analysis |
175176

177+
### 📊 Inventory Information
178+
179+
| CVP | Description | Key Features |
180+
|-----|-------------|--------------|
181+
| **fabric_devices_info** | Retrieve SDA fabric devices information and inventory | Fabric inventory |
182+
| **network_devices_info** | Retrieve network devices information and inventory | Network inventory |
183+
176184
### 🔐 Security & Integration
177185

178186
| CVP | Description | Key Features |
@@ -200,13 +208,18 @@ ansible-playbook \
200208
| **users_and_roles** | Manage users and RBAC roles | User management |
201209
| **accesspoints_configuration_provisioning** | Configure and provision access points | AP management |
202210
| **access_point_location** | Manage AP locations on floor maps | Location services |
211+
| **ansible_vault_update** | Update Ansible Vault encrypted credentials | Secret rotation |
203212

204213
### 📋 Config Generators
205214

206215
Config generator CVPs extract current configurations for documentation or migration:
207216

208217
- `accesspoint_config_generator`
218+
- `accesspoint_location_config_generator`
209219
- `application_policy_config_generator`
220+
- `assurance_device_health_score_settings_config_generator`
221+
- `assurance_issue_config_generator`
222+
- `backup_and_restore_config_generator`
210223
- `device_credential_config_generator`
211224
- `discovery_config_generator`
212225
- `events_and_notifications_config_generator`

0 commit comments

Comments
 (0)