From 736d1707339cb99396578018a6bda7af9184fb02 Mon Sep 17 00:00:00 2001 From: Jean-Philippe Evrard Date: Thu, 7 Dec 2017 13:50:04 +0000 Subject: [PATCH] Clarify cinder integration documentation It's often expected that OpenStack-Ansible wire things up. While we decide if we need to wire Magnum up in group vars to a variable that's not defined on all the deployments [1], we should at least document how to configure os_magnum. [1]: We could reuse the cinder_default_volume_type, but this variable is not set in all the environments, or set only to the cinder nodes. It would risk being wrongly wired, and not work. This could lead to issues in the expectations. Closes-Bug: 1721878 Change-Id: I2eca155484e8d4440ec2ece91a7c4e3e3b610950 --- doc/source/index.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/doc/source/index.rst b/doc/source/index.rst index 21682b3..9db85ac 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -48,6 +48,30 @@ To use this role, define the following variables: This list is not exhaustive. See role internals for further details. +Wiring docker with cinder +~~~~~~~~~~~~~~~~~~~~~~~~~ + +If you need to use volumes, default_docker_volume_type should be set. +By default, Magnum doesn't need one. + +To deploy Magnum with cinder integration, please set the following +in your ``/etc/openstack_deploy/user_variables.yml``: + +.. code-block:: yaml + + magnum_config_overrides: + cinder: + default_docker_volume_type: lvm + +If you have defined cinder_default_volume_type for all your nodes, +by defining it in your user_variables, you can re-use it directly: + +.. code-block:: yaml + + magnum_config_overrides: + cinder: + default_docker_volume_type: "{{ cinder_default_volume_type }}" + Example playbook ~~~~~~~~~~~~~~~~