[DOCS] Add project links; fix indents; wording

Change-Id: Ie5225d641c2db96ca314ab54613588408eb77005
This commit is contained in:
Robb Romans 2016-08-16 09:15:15 -05:00
parent e9dd64afb9
commit 12176ece55
4 changed files with 56 additions and 40 deletions

View File

@ -2,6 +2,11 @@
OpenStack-Ansible glance OpenStack-Ansible glance
======================== ========================
This Ansible role installs and configures OpenStack glance and glance This Ansible role installs and configures OpenStack glance and the
registry. glance registry.
Documentation for the project can be found at:
http://docs.openstack.org/developer/openstack-ansible-os_glance/
The project home is at:
http://launchpad.net/openstack-ansible

View File

@ -16,10 +16,10 @@ file-based storage by default. Two additional stores, ``http`` and ``cinder``
(Block Storage), are also enabled by default. (Block Storage), are also enabled by default.
You can choose alternative default stores and alternative additional stores. You can choose alternative default stores and alternative additional stores.
For example, a deployer that uses Ceph may configure the following Ansible For example, a deployer that uses Ceph can configure the following Ansible
variables: variables:
.. code-block:: yaml .. code-block:: yaml
glance_default_store = rbd glance_default_store = rbd
glance_additional_stores: glance_additional_stores:
@ -39,7 +39,7 @@ account for the ``images`` pool.
In ``user_variables.yml``: In ``user_variables.yml``:
.. code-block:: yaml .. code-block:: yaml
glance_default_store: rbd glance_default_store: rbd
ceph_mons: ceph_mons:
@ -50,11 +50,11 @@ In ``user_variables.yml``:
You can use the following variables if you are not using the defaults: You can use the following variables if you are not using the defaults:
.. code-block:: yaml .. code-block:: yaml
glance_ceph_client: <glance-username> glance_ceph_client: <glance-username>
glance_rbd_store_pool: <glance-pool-name> glance_rbd_store_pool: <glance-pool-name>
glance_rbd_store_chunk_size: <chunk-size> glance_rbd_store_chunk_size: <chunk-size>
Storing images in Cloud Files Storing images in Cloud Files
@ -69,35 +69,35 @@ usage.
.. code-block:: yaml .. code-block:: yaml
glance_default_store: swift glance_default_store: swift
#. Set the appropriate authentication URL and version: #. Set the appropriate authentication URL and version:
.. code-block:: yaml .. code-block:: yaml
glance_swift_store_auth_version: 2 glance_swift_store_auth_version: 2
glance_swift_store_auth_address: https://127.0.0.1/v2.0 glance_swift_store_auth_address: https://127.0.0.1/v2.0
#. Set the swift account credentials: #. Set the swift account credentials:
.. code-block:: yaml .. code-block:: yaml
# Replace this capitalized variables with actual data. # Replace this capitalized variables with actual data.
glance_swift_store_user: GLANCE_SWIFT_TENANT:GLANCE_SWIFT_USER glance_swift_store_user: GLANCE_SWIFT_TENANT:GLANCE_SWIFT_USER
glance_swift_store_key: SWIFT_PASSWORD_OR_KEY glance_swift_store_key: SWIFT_PASSWORD_OR_KEY
#. Change the ``glance_swift_store_endpoint_type`` from the default #. Change the ``glance_swift_store_endpoint_type`` from the default
``internalURL`` settings to ``publicURL`` if needed. ``internalURL`` settings to ``publicURL`` if needed.
.. code-block:: yaml .. code-block:: yaml
glance_swift_store_endpoint_type: publicURL glance_swift_store_endpoint_type: publicURL
#. Define the store name: #. Define the store name:
.. code-block:: yaml .. code-block:: yaml
glance_swift_store_container: STORE_NAME glance_swift_store_container: STORE_NAME
Replace ``STORE_NAME`` with the container name in swift to be Replace ``STORE_NAME`` with the container name in swift to be
used for storing images. If the container does not exist, it is used for storing images. If the container does not exist, it is
@ -107,7 +107,7 @@ usage.
.. code-block:: yaml .. code-block:: yaml
glance_swift_store_region: STORE_REGION glance_swift_store_region: STORE_REGION
Replace ``STORE_REGION`` if needed. Replace ``STORE_REGION`` if needed.
@ -115,7 +115,7 @@ usage.
.. code-block:: yaml .. code-block:: yaml
glance_flavor: GLANCE_FLAVOR glance_flavor: GLANCE_FLAVOR
By default, glance uses caching and authenticates with the By default, glance uses caching and authenticates with the
Identity (keystone) service. The default maximum size of the image cache is 10GB. Identity (keystone) service. The default maximum size of the image cache is 10GB.
@ -127,14 +127,14 @@ usage.
.. code-block:: yaml .. code-block:: yaml
glance_flavor: keystone glance_flavor: keystone
Or, to disable both authentication and caching, set Or, to disable both authentication and caching, set
``GLANCE_FLAVOR`` to no value: ``GLANCE_FLAVOR`` to no value:
.. code-block:: yaml .. code-block:: yaml
glance_flavor: glance_flavor:
This option is set by default to use authentication and cache This option is set by default to use authentication and cache
management in the ``playbooks/roles/os_glance/defaults/main.yml`` management in the ``playbooks/roles/os_glance/defaults/main.yml``

View File

@ -1,19 +1,29 @@
================================= =============================
Glance role for OpenStack-Ansible OpenStack-Ansible glance role
================================= =============================
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
configure-glance.rst configure-glance.rst
:tags: openstack, glance, cloud, ansible This role installs the following Upstart services:
:category: \*nix
This role will install the following Upstart services:
* glance-api * glance-api
* glance-registry * glance-registry
Default variables
~~~~~~~~~~~~~~~~~
.. literalinclude:: ../../defaults/main.yml
:language: yaml
:start-after: under the License.
Required variables
~~~~~~~~~~~~~~~~~~
None
Example playbook Example playbook
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
@ -23,8 +33,9 @@ Example playbook
Tags Tags
~~~~ ~~~~
This role supports two tags: ``glance-install`` and ``glance-config`` This role supports two tags: ``glance-install`` and ``glance-config``.
The ``glance-install`` tag can be used to install and upgrade. The
``glance-config`` tag can be used to manage configuration.
The ``glance-install`` tag can be used to install and upgrade. :tags: openstack, glance, cloud, ansible
:category: \*nix
The ``glance-config`` tag can be used to manage configuration.

View File

@ -1,9 +1,9 @@
- name: Install glance server - name: Install glance server
hosts: glance_all hosts: glance_all
user: root user: root
roles: roles:
- { role: "os_glance", tags: [ "os-glance" ] } - { role: "os_glance", tags: [ "os-glance" ] }
vars: vars:
external_lb_vip_address: 172.16.24.1 external_lb_vip_address: 172.16.24.1
internal_lb_vip_address: 192.168.0.1 internal_lb_vip_address: 192.168.0.1
glance_galera_address: "{{ internal_lb_vip_address }}" glance_galera_address: "{{ internal_lb_vip_address }}"