1f4996bdd9
Deployers who use a dollar sign ($) in their swift backend passwords for glance will be unable to authenticate to the swift backend. This is due to how oslo.config formats strings. This patch adds documentation and comments to the user_variables.yml to ensure deployers know how to escape those strings. This patch also adds a commented variable for the auth version on swift backends so that deployers are reminded to use the correct version number. Closes-bug: 1514291 Change-Id: I717e9afb5af1160de67dc5d0f87985fde5ad393e
124 lines
3.5 KiB
ReStructuredText
124 lines
3.5 KiB
ReStructuredText
`Home <index.html>`_ OpenStack-Ansible Installation Guide
|
|
|
|
Configuring the Image service
|
|
-----------------------------
|
|
|
|
In an all-in-one deployment with a single infrastructure node, the Image
|
|
service uses the local file system on the target host to store images.
|
|
When deploying production clouds we recommend backing Glance with a
|
|
swift backend or some form or another of shared storage.
|
|
|
|
The following procedure describes how to modify the
|
|
``/etc/openstack_deploy/user_variables.yml`` file to enable Cloud Files
|
|
usage.
|
|
|
|
#. Change the default store to use Object Storage (swift), the
|
|
underlying architecture of Cloud Files:
|
|
|
|
.. code-block:: yaml
|
|
|
|
glance_default_store: swift
|
|
|
|
#. Set the appropriate authentication URL and version:
|
|
|
|
.. code-block:: yaml
|
|
|
|
glance_swift_store_auth_version: 2
|
|
glance_swift_store_auth_address: https://127.0.0.1/v2.0
|
|
|
|
#. Set the swift account credentials (see *Special Considerations* at the
|
|
bottom of this page):
|
|
|
|
.. code-block:: yaml
|
|
|
|
# Replace this capitalized variables with actual data.
|
|
glance_swift_store_user: GLANCE_SWIFT_TENANT:GLANCE_SWIFT_USER
|
|
glance_swift_store_key: SWIFT_PASSWORD_OR_KEY
|
|
|
|
#. Change the ``glance_swift_store_endpoint_type`` from the default
|
|
``internalURL`` settings to ``publicURL`` if needed.
|
|
|
|
.. code-block:: yaml
|
|
|
|
glance_swift_store_endpoint_type: publicURL
|
|
|
|
#. Define the store name:
|
|
|
|
.. code-block:: yaml
|
|
|
|
glance_swift_store_container: STORE_NAME
|
|
|
|
Replace ``STORE_NAME`` with the container name in swift to be
|
|
used for storing images. If the container doesn't exist, it will be
|
|
automatically created.
|
|
|
|
#. Define the store region:
|
|
|
|
.. code-block:: yaml
|
|
|
|
glance_swift_store_region: STORE_REGION
|
|
|
|
Replace ``STORE_REGION`` if needed.
|
|
|
|
#. (Optional) Set the paste deploy flavor:
|
|
|
|
.. code-block:: yaml
|
|
|
|
glance_flavor: GLANCE_FLAVOR
|
|
|
|
By default, the Image service uses caching and authenticates with the
|
|
Identity service. The default maximum size of the image cache is 10
|
|
GB. The default Image service container size is 12 GB. In some
|
|
configurations, the Image service might attempt to cache an image
|
|
which exceeds the available disk space. If necessary, you can disable
|
|
caching. For example, to use Identity without caching, replace
|
|
``GLANCE_FLAVOR`` with ``keystone``:
|
|
|
|
.. code-block:: yaml
|
|
|
|
glance_flavor: keystone
|
|
|
|
Or, to disable both authentication and caching, set
|
|
``GLANCE_FLAVOR`` to no value:
|
|
|
|
.. code-block:: yaml
|
|
|
|
glance_flavor:
|
|
|
|
This option is set by default to use authentication and cache
|
|
management in the ``playbooks/roles/os_glance/defaults/main.yml``
|
|
file. To override the default behavior, set ``glance_flavor`` to a
|
|
different value in ``/etc/openstack_deploy/user_variables.yml``.
|
|
|
|
The possible values for ``GLANCE_FLAVOR`` are:
|
|
|
|
- (Nothing)
|
|
|
|
- ``caching``
|
|
|
|
- ``cachemanagement``
|
|
|
|
- ``keystone``
|
|
|
|
- ``keystone+caching``
|
|
|
|
- ``keystone+cachemanagement`` (default)
|
|
|
|
- ``trusted-auth``
|
|
|
|
- ``trusted-auth+cachemanagement``
|
|
|
|
Special Considerations
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
If the swift password or key contains a dollar sign (``$``), it must
|
|
be escaped with an additional dollar sign (``$$``). For example, a password of
|
|
``super$ecure`` would need to be entered as ``super$$ecure``. This is needed
|
|
due to the way `oslo.config formats strings`_.
|
|
|
|
.. _oslo.config formats strings: https://bugs.launchpad.net/oslo-incubator/+bug/1259729
|
|
|
|
--------------
|
|
|
|
.. include:: navigation.txt
|