[bug_fix] Updated README to match RedHat's ansible collection template (DCNE-198) #692
Conversation
samiib
requested review from
lhercot,
shrsr,
akinross,
anvitha-jain,
sajagana and
gmicol
|
Should we add a link to the following page https://github.com/shrsr/ansible/blob/devel/docs/docsite/rst/dev_guide/developing_modules_general_aci.rst? |
@akinross I think this is a really great documentation, we should add to the wiki of this repo or as another markdown in this repo. |
Yes this is written by @shrsr a long time ago but should have been included in the repo. I now have had multiple occasions where people wanting to contribute were not aware so think we should be more vocal about this. #278 is actually sort of tracking it already I think |
README.md
Outdated
| ### Second Approach | ||
| ## Use Cases | ||
|
|
||
| Once the collection is installed, you can use it in a playbook by specifying the full namespace path to the module, plugin and/or role. | ||
|
|
||
| ### Adding a new EPG | ||
|
|
||
| Go to [ansible-aci Actions](https://github.com/CiscoDevNet/ansible-aci/actions) | ||
| ```yml | ||
| - hosts: aci | ||
| gather_facts: no | ||
|
|
||
| Select the latest CI build | ||
| tasks: | ||
| - name: Add a new EPG | ||
| cisco.aci.aci_epg: | ||
| hostname: apic | ||
| username: admin | ||
| password: SomeSecretPassword | ||
| tenant: production | ||
| ap: intranet | ||
| epg: web_epg | ||
| description: Web Intranet EPG | ||
| bd: prod_bd | ||
| delegate_to: localhost | ||
| ``` | ||
|
|
||
| Under Artifacts download collection and unzip it using Terminal or Console. | ||
| ## Optimizing Playbooks | ||
|
|
||
| *Note: The collection file is a zip file containing a tar.gz file. We recommend using CLI because some GUI-based unarchiver might unarchive both nested archives in one go.* | ||
| There are two main methods to optimize the execution of ACI modules in your playbooks. | ||
|
|
||
| Install the unarchived tar.gz file | ||
| 1. Using the ACI HTTPAPI plugin | ||
| 1. Using the `suppress_` options | ||
|
|
||
| ```sh | ||
| ansible-galaxy collection install cisco-aci-1.0.0.tar.gz —-force | ||
| ``` |
There was a problem hiding this comment.
Why removing this second approach?
There was a problem hiding this comment.
@akinross and I agreed, that since the builds aren't consistently green due to the integration tests that we wouldn't recommend doing it this way anymore.
#692 (comment)
The idea was to add a nightly dev build that gets published instead. Not sure if this is possible with Ansible Galaxy but thought I would add a backlog item for it.
There was a problem hiding this comment.
How would the nightly be different from the CI actions downloads and how is it different from building from source in regard to the integration tests?
How are we tracking this nightly suggestion?
Until we have the nightly available more easily I would keep that in.
|
|
||
| *Note: This collection is not compatible with versions of Ansible before v2.8.* |
There was a problem hiding this comment.
I think, we should still keep this note somewhere in readMe
There was a problem hiding this comment.
We already mention in the requirements section that the collection requires Ansible v2.15+
v2.8 has been EOL for almost 3 years now. I think its okay to remove.
Readme should match this template https://access.redhat.com/articles/7068606