zware/awx
1
0
Fork 0
mirror of https://github.com/ZwareBear/awx.git synced 2026-03-20 07:43:35 -05:00
Code Issues Packages Projects Releases Wiki Activity

Documentation updates

Browse Source
This commit is contained in:
AlanCoding
2020-06-19 09:49:37 -04:00
parent a7fe5e1dd2
commit 0dbaf632dc
5 changed files with 17 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
awx_collection/tools/roles/template_galaxy/templates/README.md.j2
View File

@@ -4,12 +4,12 @@
[comment]: # (* *)
[comment]: # (* WARNING *)
[comment]: # (* *)
[comment]: # (* This file is manageed by Ansible and not to be *)
[comment]: # (* This file is templated and not to be *)
[comment]: # (* edited directly! Instead modify: *)
[comment]: # (* tools/roles/template_galaxy/templates/README.md.j2 *)
[comment]: # (* *)
[comment]: # (* Changed to the base README.md file are lost upon *)
[comment]: # (* the build of the collection *)
[comment]: # (* Changes to the base README.md file are refreshed *)
[comment]: # (* upon build of the collection *)
[comment]: # (*******************************************************)
This Ansible collection allows for easy interaction with an {% if collection_package | lower() == 'awx' %}AWX{% else %}Ansible Tower{% endif %} server via Ansible playbooks.
@@ -49,13 +49,13 @@ The OAuth2 token is the preferred method. You can obtain a token via the
AWX CLI [login](https://docs.ansible.com/ansible-tower/latest/html/towercli/reference.html#awx-login)
command.
These can be specified via:
These can be specified via (from highest to lowest precedence):
- environment variables (most useful when running against localhost)
- direct module parameters
- environment variables (most useful when running against localhost)
- a config file path specified by the `tower_config_file` parameter
- a config file at `/etc/tower/tower_cli.cfg`
- a config file at `~/.tower_cli.cfg`
- a config file at `/etc/tower/tower_cli.cfg`
Config file syntax looks like this:
@@ -73,6 +73,7 @@ Notable releases of the `{{ collection_namespace }}.{{ collection_package }}` co
{% if collection_package | lower() == "awx" %}
- 7.0.0 is intended to be identical to the content prior to the migration, aside from changes necessary to function as a collection.
- 11.0.0 has no non-deprecated modules that depend on the deprecated `tower-cli` [PyPI](https://pypi.org/project/ansible-tower-cli/).
- 0.0.1-devel is the version you should see if installing from source, which is intended for development and expected to be unstable.
{% else %}
- 3.7.0 initial release
{% endif %}

4
awx_collection/tools/roles/template_galaxy/templates/galaxy.yml.j2
View File

@@ -6,8 +6,8 @@
# (* edited directly! Instead modify: *)
# (* tools/roles/template_galaxy/templates/galaxy.yml.j2 *)
# (* *)
# (* Changed to the base README.md file are lost upon *)
# (* the build of the collection *)
# (* Changes to the base galaxy.yml file are refreshed *)
# (* upon build of the collection *)
# (********************************************************)
---
authors:

4
awx_collection/tools/template_galaxy.yml
View File

@@ -27,13 +27,13 @@
set_fact:
collection_version_override: 0.0.1-devel
- name: Template the galaxy.yml source file
- name: Template the galaxy.yml source file (should be commited with your changes)
template:
src: "{{ collection_source }}/tools/roles/template_galaxy/templates/galaxy.yml.j2"
dest: "{{ collection_source }}/galaxy.yml"
force: true
- name: Template the README.md source file
- name: Template the README.md source file (should be commited with your changes)
template:
src: "{{ collection_source }}/tools/roles/template_galaxy/templates/README.md.j2"
dest: "{{ collection_source }}/README.md"