[DOCS] Cleanup the role docs for consistency and clarity
Change-Id: Iac7740b161162bcc1a70053273f8e4ffc60f610c
This commit is contained in:
Travis Truman
parent
7fb1c5dd06
commit
bbe2748658
|
|
@ -1,5 +1,5 @@
|
|||
plugins
|
||||
########
|
||||
OpenStack-Ansible Plugins
|
||||
#########################
|
||||
:tags: openstack, cloud, ansible
|
||||
:category: \*nix
|
||||
|
||||
|
|
@ -9,43 +9,53 @@ contributor guidelines
|
|||
Filing Bugs
|
||||
-----------
|
||||
|
||||
Bugs should be filed on Launchpad, not GitHub: "https://bugs.launchpad.net/openstack-ansible"
|
||||
Bugs should be filed on Launchpad, not GitHub: "https://bugs.launchpad.net
|
||||
/openstack-ansible"
|
||||
|
||||
|
||||
When submitting a bug, or working on a bug, please ensure the following criteria are met:
|
||||
* The description clearly states or describes the original problem or root cause of the problem.
|
||||
When submitting a bug, or working on a bug, please ensure the following
|
||||
criteria are met:
|
||||
* The description clearly states or describes the original problem or root
|
||||
cause of the problem.
|
||||
* Include historical information on how the problem was identified.
|
||||
* Any relevant logs are included.
|
||||
* The provided information should be totally self-contained. External access to web services/sites should not be needed.
|
||||
* The provided information should be totally self-contained. External
|
||||
access to web services/sites should not be needed.
|
||||
* Steps to reproduce the problem if possible.
|
||||
|
||||
|
||||
Submitting Code
|
||||
---------------
|
||||
|
||||
Changes to the project should be submitted for review via the Gerrit tool, following
|
||||
the workflow documented at: "http://docs.openstack.org/infra/manual/developers.html#development-workflow"
|
||||
Changes to the project should be submitted for review via the Gerrit tool,
|
||||
following the workflow documented at:
|
||||
"http://docs.openstack.org/infra/manual/developers.html#development-workflow"
|
||||
|
||||
Pull requests submitted through GitHub will be ignored and closed without regard.
|
||||
Pull requests submitted through GitHub will be ignored and closed without
|
||||
regard.
|
||||
|
||||
|
||||
Extra
|
||||
-----
|
||||
|
||||
Tags:
|
||||
If it's a bug that needs fixing in a branch in addition to Master, add a '\<release\>-backport-potential' tag (eg ``juno-backport-potential``). There are predefined tags that will autocomplete.
|
||||
Tags: If it's a bug that needs fixing in a branch in addition to Master, add a
|
||||
'\<release\>-backport-potential' tag (eg ``juno-backport-potential``).
|
||||
There are predefined tags that will autocomplete.
|
||||
|
||||
Status:
|
||||
Please leave this alone, it should be New till someone triages the issue.
|
||||
|
||||
Importance:
|
||||
Should only be touched if it is a Blocker/Gating issue. If it is, please set to High, and only use Critical if you have found a bug that can take down whole infrastructures.
|
||||
Should only be touched if it is a Blocker/Gating issue. If it is, please
|
||||
set to High, and only use Critical if you have found a bug that can take
|
||||
down whole infrastructures.
|
||||
|
||||
|
||||
Style guide
|
||||
-----------
|
||||
|
||||
When creating tasks and other roles for use in Ansible please create then using the YAML dictionary format.
|
||||
When creating tasks and other roles for use in Ansible please create then
|
||||
using the YAML dictionary format.
|
||||
|
||||
Example YAML dictionary format:
|
||||
.. code-block:: yaml
|
||||
|
|
@ -69,17 +79,22 @@ Example **NOT** in YAML dictionary format:
|
|||
- some-other-tag
|
||||
|
||||
|
||||
Usage of the ">" and "|" operators should be limited to Ansible conditionals and command modules such as the ansible ``shell`` module.
|
||||
Usage of the ">" and "|" operators should be limited to Ansible conditionals
|
||||
and command modules such as the ansible ``shell`` module.
|
||||
|
||||
|
||||
Issues
|
||||
------
|
||||
|
||||
When submitting an issue, or working on an issue please ensure the following criteria are met:
|
||||
* The description clearly states or describes the original problem or root cause of the problem.
|
||||
When submitting an issue, or working on an issue please ensure the following
|
||||
criteria are met:
|
||||
* The description clearly states or describes the original problem or root
|
||||
cause of the problem.
|
||||
* Include historical information on how the problem was identified.
|
||||
* Any relevant logs are included.
|
||||
* If the issue is a bug that needs fixing in a branch other than Master, add the ‘backport potential’ tag TO THE ISSUE (not the PR).
|
||||
* The provided information should be totally self-contained. External access to web services/sites should not be needed.
|
||||
* If the issue is a bug that needs fixing in a branch other than Master,
|
||||
add the ‘backport potential’ tag TO THE ISSUE (not the PR).
|
||||
* The provided information should be totally self-contained. External
|
||||
access to web services/sites should not be needed.
|
||||
* If the issue is needed for a hotfix release, add the 'expedite' label.
|
||||
* Steps to reproduce the problem if possible.
|
||||
|
|
|
|||
85
README.rst
85
README.rst
|
|
@ -1,6 +1,81 @@
|
|||
plugins collection
|
||||
##################
|
||||
:tags: openstack, cloud, ansible, plugins
|
||||
:category: \*nix
|
||||
OpenStack-Ansible Plugins
|
||||
=========================
|
||||
|
||||
Plugins used to power OpenStack-Ansible and our various roles.
|
||||
These are the plugins the OpenStack-Ansible deployment project relies on. The
|
||||
plugins can be added to any Ansible project by simply cloning this repository
|
||||
and setting up the ``ansible.cfg`` file to point at them as additional plugins
|
||||
for your project.
|
||||
|
||||
Actions
|
||||
-------
|
||||
|
||||
This project provides the Ansible modules:
|
||||
|
||||
* config_template
|
||||
* dist_sort
|
||||
* glance
|
||||
* keystone
|
||||
* memcached
|
||||
* name2int
|
||||
* neutron
|
||||
* provider_networks
|
||||
|
||||
Filters
|
||||
-------
|
||||
|
||||
This project provides the Ansible Jinja2 filters:
|
||||
|
||||
* bit_length_power_of_2
|
||||
* netloc
|
||||
* netloc_no_port
|
||||
* netorigin
|
||||
* string_2_int
|
||||
* pip_requirement_names
|
||||
* pip_constraint_update
|
||||
* splitlines
|
||||
* filtered_list
|
||||
* git_link_parse
|
||||
* git_link_parse_name
|
||||
* deprecated
|
||||
|
||||
Lookups
|
||||
-------
|
||||
|
||||
This project provides the lookup:
|
||||
|
||||
* with_py_pkgs
|
||||
|
||||
Callbacks
|
||||
---------
|
||||
|
||||
This project provides an Ansible callback that will report
|
||||
task profiling timings
|
||||
|
||||
|
||||
Example ansible.cfg file
|
||||
------------------------
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
[defaults]
|
||||
lookup_plugins = /etc/ansible/plugins/lookups
|
||||
filter_plugins = /etc/ansible/plugins/filters
|
||||
action_plugins = /etc/ansible/plugins/actions
|
||||
library = /etc/ansible/plugins/library
|
||||
|
||||
|
||||
Example role requirement overload for automatic plugin download
|
||||
---------------------------------------------------------------
|
||||
|
||||
The Ansible role requirement file can be used to overload the ``ansible-
|
||||
galaxy`` command to automatically fetch the plugins for you in a given
|
||||
project. To do this add the following lines to your ``ansible-role-
|
||||
requirements.yml`` file.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
- name: plugins
|
||||
src: https://github.com/openstack/openstack-ansible-plugins
|
||||
path: /etc/ansible
|
||||
scm: git
|
||||
version: master
|
||||
|
|
|
|||
|
|
@ -1,36 +1 @@
|
|||
plugins Docs
|
||||
============
|
||||
|
||||
These are the plugins the OpenStack-Ansible deployment project relies on.
|
||||
The plugins can be added to any openstack deployment by quite simply cloning
|
||||
this repository into your plugin and library source and setting up the
|
||||
``ansible.cfg`` file to point at them as additional plugins for your project.
|
||||
|
||||
|
||||
Example ansible.cfg file
|
||||
------------------------
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
[defaults]
|
||||
lookup_plugins = /etc/ansible/plugins/lookups
|
||||
filter_plugins = /etc/ansible/plugins/filters
|
||||
action_plugins = /etc/ansible/plugins/actions
|
||||
library = /etc/ansible/plugins/library
|
||||
|
||||
|
||||
Example role requirement overload for automatic plugin download
|
||||
---------------------------------------------------------------
|
||||
|
||||
The Ansible role requirement file can be used to overload the ``ansible-galaxy``
|
||||
command to automatically fetch the plugins for you in a given project. To do this
|
||||
add the following lines to your ``ansible-role-requirements.yml`` file.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
- name: plugins
|
||||
src: https://github.com/openstack/openstack-ansible-plugins
|
||||
path: /etc/ansible
|
||||
scm: git
|
||||
version: master
|
||||
|
||||
.. include:: ../../README.rst
|
||||
Loading…
Reference in New Issue