Switch README from markdown to rst
Change-Id: I7a53d456dbc7a3b8e2b6c20332f7a544bf48b9f3
This commit is contained in:
parent
c90e324170
commit
4531f7958e
43
README.md
43
README.md
@ -1,43 +0,0 @@
|
|||||||
ansible-openstack-cloud-launcher
|
|
||||||
================================
|
|
||||||
|
|
||||||
Requirements
|
|
||||||
------------
|
|
||||||
|
|
||||||
shade library needs to be installed, as that is required by the
|
|
||||||
OpenStack Ansible modules.
|
|
||||||
|
|
||||||
Role Variables
|
|
||||||
--------------
|
|
||||||
|
|
||||||
The role expects variables fed by ansible-playbook
|
|
||||||
on the CLI, e.g. 'ansible-playbook -i inventory play.yml -e "@resources.yml"'.
|
|
||||||
Please check resources.yml.sample on this repository for a full-blown example.
|
|
||||||
|
|
||||||
|
|
||||||
Dependencies
|
|
||||||
------------
|
|
||||||
|
|
||||||
None
|
|
||||||
|
|
||||||
Example playbook
|
|
||||||
----------------
|
|
||||||
```
|
|
||||||
---
|
|
||||||
- hosts: localhost
|
|
||||||
connection: local
|
|
||||||
gather_facts: false
|
|
||||||
roles:
|
|
||||||
- { role: ansible-openstack-cloud-launcher }
|
|
||||||
```
|
|
||||||
|
|
||||||
License
|
|
||||||
-------
|
|
||||||
|
|
||||||
Apache
|
|
||||||
|
|
||||||
Author information
|
|
||||||
------------------
|
|
||||||
|
|
||||||
ansible-openstack-cloud-launcher is maintained by Ricardo Carrillo Cruz.
|
|
||||||
The best way to contact him is on #openstack-infra on freenode.
|
|
62
README.rst
Normal file
62
README.rst
Normal file
@ -0,0 +1,62 @@
|
|||||||
|
===========================
|
||||||
|
ansible-role-cloud-launcher
|
||||||
|
===========================
|
||||||
|
|
||||||
|
Ansible role to launch multiple OpenStack Clouds resources
|
||||||
|
|
||||||
|
* License: Apache License, Version 2.0
|
||||||
|
* Documentation: https://ansible-role-cloud-launcher.readthedocs.org
|
||||||
|
* Source: https://git.openstack.org/cgit/openstack/ansible-role-cloud-launcher
|
||||||
|
* Bugs: https://bugs.launchpad.net/ansible-role-cloud-launcher
|
||||||
|
|
||||||
|
Description
|
||||||
|
-----------
|
||||||
|
|
||||||
|
ansible-role-cloud-launcher is an Ansible role that allows to launch
|
||||||
|
multiple OpenStack clouds resources.
|
||||||
|
Resources can be defined in a cloud by cloud basis or defined in a profile,
|
||||||
|
which may be reused by more than one cloud.
|
||||||
|
|
||||||
|
Requirements
|
||||||
|
------------
|
||||||
|
|
||||||
|
shade library needs to be installed, as that is required by the
|
||||||
|
OpenStack Ansible modules.
|
||||||
|
|
||||||
|
Role Variables
|
||||||
|
--------------
|
||||||
|
|
||||||
|
The role expects variables fed by ansible-playbook
|
||||||
|
on the CLI, for example:
|
||||||
|
|
||||||
|
ansible-playbook -i inventory play.yml -e "@resources.yml"
|
||||||
|
|
||||||
|
The role expects the resources variables file to have two dict variables,
|
||||||
|
*profiles* and *clouds*.
|
||||||
|
|
||||||
|
*profiles* contains a list of OpenStack resources definitions
|
||||||
|
that are meant to be reused by one or more clouds.
|
||||||
|
|
||||||
|
*clouds* contains a list of clouds the role will launch resources on. Each
|
||||||
|
cloud definition will have the OSCC cloud name, a list of profiles the cloud
|
||||||
|
will reuse and a list of resources specific to that cloud.
|
||||||
|
|
||||||
|
Please check resources.yml.sample on this repository for a full-blown example.
|
||||||
|
|
||||||
|
|
||||||
|
Dependencies
|
||||||
|
------------
|
||||||
|
|
||||||
|
None
|
||||||
|
|
||||||
|
Example playbook
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
---
|
||||||
|
- hosts: localhost
|
||||||
|
connection: local
|
||||||
|
gather_facts: false
|
||||||
|
roles:
|
||||||
|
- { role: ansible-role-cloud-launcher }
|
Loading…
Reference in New Issue
Block a user