docker: osd, clarify variable usage for scenarii

Signed-off-by: Sébastien Han <seb@redhat.com>

diff --git a/group_vars/osds.yml.sample b/group_vars/osds.yml.sample
index 1d154f4a1fd1c2eb15852c42dc2c20e0dfc66d37..2fbae80066a07c6b43dad8ddf2bdfa18ddad2f01 100644 (file)
--- a/group_vars/osds.yml.sample
+++ b/group_vars/osds.yml.sample
@@ -181,17 +181,31 @@ dummy:
 #kv_type: etcd
 #kv_endpoint: 127.0.0.1
 #kv_port: 4001
+#ceph_docker_image: "ceph/daemon"
+#ceph_docker_image_tag: latest
+#ceph_config_keys: [] # DON'T TOUCH ME
+#ceph_docker_on_openstack: false
 
-# Add -e OSD_JOURNAL={{ raw_journal_devices }} to configure a journal device to ceph_osd_docker_prepare_env variable
-# make sure you only pass a single device, otherwise this will fail horribly.
+# PREPARE DEVICE
+# Make sure you only pass a single device to raw_journal_devices, otherwise this will fail horribly.
+# This is why we use [0] in the example.
 #
-# Add -e OSD_DMCRYPT=1 to use the collocated dmcrypt scenario to the ceph_osd_docker_prepare_env and ceph_osd_docker_extra_env variables
+# WARNING /!\ DMCRYPT scenario ONLY works with Docker version 1.12.5 and above
+#
+# Examples:
+# Journal collocated: ceph_osd_docker_prepare_env: -e CLUSTER={{ cluster }} -e OSD_JOURNAL_SIZE={{ journal_size }} -e OSD_FORCE_ZAP=1
+# Dedicated journal: ceph_osd_docker_prepare_env: -e CLUSTER={{ cluster }} -e OSD_JOURNAL_SIZE={{ journal_size }} -e OSD_FORCE_ZAP=1 -e OSD_JOURNAL={{ raw_journal_devices[0] }}
+# Encrypted OSD: ceph_osd_docker_prepare_env: -e CLUSTER={{ cluster }} -e OSD_JOURNAL_SIZE={{ journal_size }} -e OSD_FORCE_ZAP=1 -e OSD_DMCRYPT=1
+# Encrypted OSD with dedicated journal: ceph_osd_docker_prepare_env: -e CLUSTER={{ cluster }} -e OSD_JOURNAL_SIZE={{ journal_size }} -e OSD_FORCE_ZAP=1 -e OSD_DMCRYPT=1 -e OSD_JOURNAL={{ raw_journal_devices[0] }}
+#
+#ceph_osd_docker_devices: "{{ devices }}"
 #ceph_osd_docker_prepare_env: -e CLUSTER={{ cluster }} -e OSD_JOURNAL_SIZE={{ journal_size }} -e OSD_FORCE_ZAP=1
-#ceph_docker_image: "ceph/daemon"
-#ceph_docker_image_tag: latest
+
+# ACTIVATE DEVICE
+# Examples:
+# Journal collocated or Dedicated journal: ceph_osd_docker_extra_env: -e CLUSTER={{ cluster }} -e CEPH_DAEMON=OSD_CEPH_DISK_ACTIVATE -e OSD_JOURNAL_SIZE={{ journal_size }}
+# Encrypted OSD or Encrypted OSD with dedicated journal: ceph_osd_docker_extra_env: -e CLUSTER={{ cluster }} -e CEPH_DAEMON=OSD_CEPH_DISK_ACTIVATE -e OSD_JOURNAL_SIZE={{ journal_size }} -e OSD_DMCRYPT=1
+#
 #ceph_osd_docker_extra_env: -e CLUSTER={{ cluster }} -e CEPH_DAEMON=OSD_CEPH_DISK_ACTIVATE -e OSD_JOURNAL_SIZE={{ journal_size }}
-#ceph_osd_docker_devices: "{{ devices }}"
-#ceph_docker_on_openstack: false
-#ceph_config_keys: [] # DON'T TOUCH ME
-#ceph_osd_docker_run_script_path: "/usr/share"
+#ceph_osd_docker_run_script_path: "/usr/share" # script called by systemd to run the docker command
 

diff --git a/roles/ceph-osd/defaults/main.yml b/roles/ceph-osd/defaults/main.yml
index c2713274ada62236b1bfa09b4456bab23b42b518..d326251130045a2cec029e8c30d5d0c31b54eb17 100644 (file)
--- a/roles/ceph-osd/defaults/main.yml
+++ b/roles/ceph-osd/defaults/main.yml
@@ -173,16 +173,30 @@ osd_containerized_deployment_with_kv: false
 kv_type: etcd
 kv_endpoint: 127.0.0.1
 kv_port: 4001
+ceph_docker_image: "ceph/daemon"
+ceph_docker_image_tag: latest
+ceph_config_keys: [] # DON'T TOUCH ME
+ceph_docker_on_openstack: false
 
-# Add -e OSD_JOURNAL={{ raw_journal_devices }} to configure a journal device to ceph_osd_docker_prepare_env variable
-# make sure you only pass a single device, otherwise this will fail horribly.
+# PREPARE DEVICE
+# Make sure you only pass a single device to raw_journal_devices, otherwise this will fail horribly.
+# This is why we use [0] in the example.
 #
-# Add -e OSD_DMCRYPT=1 to use the collocated dmcrypt scenario to the ceph_osd_docker_prepare_env and ceph_osd_docker_extra_env variables
+# WARNING /!\ DMCRYPT scenario ONLY works with Docker version 1.12.5 and above
+#
+# Examples:
+# Journal collocated: ceph_osd_docker_prepare_env: -e CLUSTER={{ cluster }} -e OSD_JOURNAL_SIZE={{ journal_size }} -e OSD_FORCE_ZAP=1
+# Dedicated journal: ceph_osd_docker_prepare_env: -e CLUSTER={{ cluster }} -e OSD_JOURNAL_SIZE={{ journal_size }} -e OSD_FORCE_ZAP=1 -e OSD_JOURNAL={{ raw_journal_devices[0] }}
+# Encrypted OSD: ceph_osd_docker_prepare_env: -e CLUSTER={{ cluster }} -e OSD_JOURNAL_SIZE={{ journal_size }} -e OSD_FORCE_ZAP=1 -e OSD_DMCRYPT=1
+# Encrypted OSD with dedicated journal: ceph_osd_docker_prepare_env: -e CLUSTER={{ cluster }} -e OSD_JOURNAL_SIZE={{ journal_size }} -e OSD_FORCE_ZAP=1 -e OSD_DMCRYPT=1 -e OSD_JOURNAL={{ raw_journal_devices[0] }}
+#
+ceph_osd_docker_devices: "{{ devices }}"
 ceph_osd_docker_prepare_env: -e CLUSTER={{ cluster }} -e OSD_JOURNAL_SIZE={{ journal_size }} -e OSD_FORCE_ZAP=1
-ceph_docker_image: "ceph/daemon"
-ceph_docker_image_tag: latest
+
+# ACTIVATE DEVICE
+# Examples:
+# Journal collocated or Dedicated journal: ceph_osd_docker_extra_env: -e CLUSTER={{ cluster }} -e CEPH_DAEMON=OSD_CEPH_DISK_ACTIVATE -e OSD_JOURNAL_SIZE={{ journal_size }}
+# Encrypted OSD or Encrypted OSD with dedicated journal: ceph_osd_docker_extra_env: -e CLUSTER={{ cluster }} -e CEPH_DAEMON=OSD_CEPH_DISK_ACTIVATE -e OSD_JOURNAL_SIZE={{ journal_size }} -e OSD_DMCRYPT=1
+#
 ceph_osd_docker_extra_env: -e CLUSTER={{ cluster }} -e CEPH_DAEMON=OSD_CEPH_DISK_ACTIVATE -e OSD_JOURNAL_SIZE={{ journal_size }}
-ceph_osd_docker_devices: "{{ devices }}"
-ceph_docker_on_openstack: false
-ceph_config_keys: [] # DON'T TOUCH ME
-ceph_osd_docker_run_script_path: "/usr/share"
+ceph_osd_docker_run_script_path: "/usr/share" # script called by systemd to run the docker command