Skip to content

Update: Enhance Readme#37

Open
Quy-1009 wants to merge 4 commits into
mainfrom
thomas_fix_readme
Open

Update: Enhance Readme#37
Quy-1009 wants to merge 4 commits into
mainfrom
thomas_fix_readme

Conversation

@Quy-1009

Copy link
Copy Markdown

Type of Change

  • Bug fix
  • Documentation update

Description

Documentation cleanup for workflows under cvp/:

  • Bug fix: Corrected YAML examples in cvp/network_settings/README.md to match the schema (parentNameparent_name, site_typetype, fixed types for timezone / dhcp_server / ntp_server).
  • Bug fix: Removed personal paths /Users/majlona/... from cvp/sda_fabric_device_roles/README.md.
  • Enhancement: Added a "Validate Input (Schema & Vars Validation)" section to 10 READMEs, instructing users how to run ./tools/schemavalidation.sh with the corresponding schema/vars pair.

Impact: Documentation only — no changes to playbooks, roles, schemas, or vars files.

Testing Done:

  • Manual: cross-checked YAML examples against the actual schema.
  • Manual: verified every schema_path / vars_path referenced in the new validate sections exists on disk and yamale passes.

Checklist

  • Code follows the project style guidelines
  • Self-review completed
  • Documentation updated
  • No new warnings
  • Sanity checks passed

Ansible Best Practices

  • Idempotent (no task changes)
  • Secrets handled securely
  • Playbooks remain modular and reusable

Documentation

  • All options and parameters documented
  • Examples provided and tested
  • Notes and limitations clearly stated

Notes to Reviewers

  • Pure documentation PR, no runtime impact.
  • Please focus on: (1) YAML keys in cvp/network_settings/README.md matching the schema, (2) schema/vars paths in the new validate sections.
  • Other READMEs still contain minor issues (broken bash blocks, ##X headings missing a space, hardcoded IPs) — out of scope, will be addressed in a follow-up PR.

@DNACENSolutions DNACENSolutions left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no Relative paths.

-vvvv
```

> `VARS_FILE_PATH` is resolved relative to the playbook directory, so you can also use the shorter form `--extra-vars "VARS_FILE_PATH=../vars/accesspoint_config_inputs.yml"`.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove this one. we should document only absolute path, as customer may have their playbook and cars file at different location.


```bash
ansible-playbook -i ./inventory/demo_lab/hosts.yaml \
./cvp/accesspoint_config_generator/playbook/accesspoint_config_generator.yml \

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you should not test fro with in the collection, but from your own test project and give an absolute path to the playbooks from your project.


```bash
(pyats) bash-4.4$ ./tools/schemavalidation.sh \
-s cvp/accesspoint_config_generator/schema/accesspoint_config_schema.yml \

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no relative paths.

@DNACENSolutions DNACENSolutions left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

address comments

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants