openstack/openstack-ansible-lxc_container_create
Code Issues Proposed changes

DOC - Adopting the common role documentation pattern

Browse Source 
As discussed during the Newton design summit, we
agreed to adopt the role documentation pattern laid
out in the os_keystone role

Change-Id: Ifbf6c90481a6b40781341dce2b1992a6baebe633
This commit is contained in:
Travis Truman 2016-06-07 10:44:42 -04:00
parent cf2d0f6507
commit 3d41e00e9a
2 changed files with 27 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

87
README.rst
View File

@ -1,12 +1,26 @@
OpenStack LXC container create
##############################
:tags: openstack, lxc, container, cloud, ansible
:category: \*nix
OpenStack-Ansible LXC container create
######################################
Role for creating LXC containers. This role has been setup for use in OpenStack. This role will
create several directories on the LXC host for use in bind mounted storage within the container.
Ansible role for creating LXC containers. This role will create several
directories on the LXC host for use in bind mounted storage within the
container.
Default Variables
=================
.. literalinclude:: ../../defaults/main.yml
:language: yaml
:start-after: under the License.
Required Variables
==================
None
Example Playbook
================
Example Play:
.. code-block:: yaml
- name: Create container(s)
@ -14,62 +28,5 @@ Example Play:
gather_facts: false
user: root
roles:
- { role: "lxc_container_create", tags: [ "lxc-container-create" ] }
- { role: "lxc_container_create" }
Example Inventory:
.. code-block:: json
{
"all_containers": {
"children": [
"group_of_containers"
],
"hosts": []
},
"lxc_hosts": {
"children": [],
"hosts": [
"infra1"
]
},
"group_of_containers": {
"children": [],
"hosts": [
"container1"
]
},
"_meta": {
"hostvars": {
"infra1": {
"ansible_ssh_host": "192.168.0.1",
"container_address": "192.168.0.1",
"container_name": "infra1",
"container_networks": {
"management_address": {
"bridge": "br-mgmt",
"interface": "eth1",
"netmask": "255.255.252.0",
"type": "veth"
}
}
},
"container1": {
"ansible_ssh_host": "10.0.0.1",
"container_address": "10.0.0.1",
"container_name": "container1",
"container_networks": {
"management_address": {
"address": "10.0.0.1",
"bridge": "br-mgmt",
"interface": "eth1",
"netmask": "255.255.252.0",
"type": "veth"
}
},
"physical_host": "infra1",
"physical_host_group": "lxc_hosts"
}
}
}
}

16
doc/source/index.rst
View File

@ -1,15 +1 @@
Example Index for role docs
============================
Role to create LXC containers. This role can be used to configure
multiple networks within a container and do specific container
tuning.
Basic Role Example
^^^^^^^^^^^^^^^^^^
.. code-block:: yaml
- role: "lxc_container_create"
lxc_container_backing_store: dir
.. include:: ../../README.rst