defaults: add a comment about `igw_network`

This add a quick documentation in ceph-defaults about `igw_network`

Signed-off-by: Guillaume Abrioux <gabrioux@redhat.com>
(cherry picked from commit c5728bdc6351fe985e17b095cbd5871ef673dc29)

diff --git a/group_vars/all.yml.sample b/group_vars/all.yml.sample
index d4d28a079346d61636172071761e086342e1dc6d..9efefa0dc71cd2d22ec042972113031948b22d93 100644 (file)
--- a/group_vars/all.yml.sample
+++ b/group_vars/all.yml.sample
@@ -722,6 +722,14 @@ dummy:
 #alertmanager_cluster_port: 9094
 #alertmanager_conf_overrides: {}
 # igw
+#
+# `igw_network` variable is intended for allowing dashboard deployment with iSCSI node not residing in the same subnet than what is defined in `public_network`.
+# For example:
+# If the ceph public network is 2a00:8a60:1:c301::/64 and the iSCSI Gateway resides
+# at a dedicated gateway network (2a00:8a60:1:c300::/64) (With routing between those networks).
+# It means "{{ hostvars[item]['ansible_facts']['all_ipv4_addresses'] | ips_in_ranges(public_network.split(',')) | last | ipwrap }}" will be empty.
+# As a consequence, this prevent from deploying dashboard with iSCSI node when it reside in a subnet different than `public_network`.
+# Using `igw_network` make it possible, set it with the subnet used by your iSCSI node.
 #igw_network: "{{ public_network }}"
 
 

diff --git a/group_vars/rhcs.yml.sample b/group_vars/rhcs.yml.sample
index d395292403b909d05ee5f3f337fe839544cc614c..9419f6161b27abf12d5e2fdb1170c51136089bd3 100644 (file)
--- a/group_vars/rhcs.yml.sample
+++ b/group_vars/rhcs.yml.sample
@@ -722,6 +722,14 @@ alertmanager_container_image: registry.redhat.io/openshift4/ose-prometheus-alert
 #alertmanager_cluster_port: 9094
 #alertmanager_conf_overrides: {}
 # igw
+#
+# `igw_network` variable is intended for allowing dashboard deployment with iSCSI node not residing in the same subnet than what is defined in `public_network`.
+# For example:
+# If the ceph public network is 2a00:8a60:1:c301::/64 and the iSCSI Gateway resides
+# at a dedicated gateway network (2a00:8a60:1:c300::/64) (With routing between those networks).
+# It means "{{ hostvars[item]['ansible_facts']['all_ipv4_addresses'] | ips_in_ranges(public_network.split(',')) | last | ipwrap }}" will be empty.
+# As a consequence, this prevent from deploying dashboard with iSCSI node when it reside in a subnet different than `public_network`.
+# Using `igw_network` make it possible, set it with the subnet used by your iSCSI node.
 #igw_network: "{{ public_network }}"
 
 

diff --git a/roles/ceph-defaults/defaults/main.yml b/roles/ceph-defaults/defaults/main.yml
index 6c8a250544aaa40b69d2c37b5c4b2522d6c434ef..c4ec5f9ae4130b1e9241cc76a294c765812be3b3 100644 (file)
--- a/roles/ceph-defaults/defaults/main.yml
+++ b/roles/ceph-defaults/defaults/main.yml
@@ -714,6 +714,14 @@ alertmanager_port: 9093
 alertmanager_cluster_port: 9094
 alertmanager_conf_overrides: {}
 # igw
+#
+# `igw_network` variable is intended for allowing dashboard deployment with iSCSI node not residing in the same subnet than what is defined in `public_network`.
+# For example:
+# If the ceph public network is 2a00:8a60:1:c301::/64 and the iSCSI Gateway resides
+# at a dedicated gateway network (2a00:8a60:1:c300::/64) (With routing between those networks).
+# It means "{{ hostvars[item]['ansible_facts']['all_ipv4_addresses'] | ips_in_ranges(public_network.split(',')) | last | ipwrap }}" will be empty.
+# As a consequence, this prevent from deploying dashboard with iSCSI node when it reside in a subnet different than `public_network`.
+# Using `igw_network` make it possible, set it with the subnet used by your iSCSI node.
 igw_network: "{{ public_network }}"