Creating structure to warn for use of deprecated variables and set them in a single location before they are no longer honored

4 files changed, 90 insertions, 0 deletions

diff --git a/roles/openshift_sanitize_inventory/tasks/__deprecations_logging.yml b/roles/openshift_sanitize_inventory/tasks/__deprecations_logging.yml
new file mode 100644
index 000000000..e52ab5f6d
--- /dev/null
+++ b/roles/openshift_sanitize_inventory/tasks/__deprecations_logging.yml
@@ -0,0 +1,48 @@
+---
+# this is used to set the logging variables from deprecated values to the current variables names
+# this file should be deleted once variables are no longer honored
+
+- conditional_set_fact:
+    facts: "{{ hostvars[inventory_hostname] }}"
+    vars:
+      logging_hostname: openshift_hosted_logging_hostname
+      logging_ops_hostname: openshift_hosted_logging_ops_hostname
+      logging_elasticsearch_cluster_size: openshift_hosted_logging_elasticsearch_cluster_size
+      logging_elasticsearch_ops_cluster_size: openshift_hosted_logging_elasticsearch_ops_cluster_size
+      openshift_logging_storage_kind: openshift_hosted_logging_storage_kind
+      openshift_logging_storage_host: openshift_hosted_logging_storage_host
+      openshift_logging_storage_labels: openshift_hosted_logging_storage_labels
+      openshift_logging_storage_volume_size: openshift_hosted_logging_storage_volume_size
+      openshift_loggingops_storage_kind: openshift_hosted_loggingops_storage_kind
+      openshift_loggingops_storage_host: openshift_hosted_loggingops_storage_host
+      openshift_loggingops_storage_labels: openshift_hosted_loggingops_storage_labels
+      openshift_loggingops_storage_volume_size: openshift_hosted_loggingops_storage_volume_size
+      openshift_logging_use_ops: openshift_hosted_logging_enable_ops_cluster
+      openshift_logging_image_pull_secret: openshift_hosted_logging_image_pull_secret
+      openshift_logging_kibana_hostname: openshift_hosted_logging_hostname
+      openshift_logging_kibana_ops_hostname: openshift_hosted_logging_ops_hostname
+      openshift_logging_fluentd_journal_source: openshift_hosted_logging_journal_source
+      openshift_logging_fluentd_journal_read_from_head: openshift_hosted_logging_journal_read_from_head
+      openshift_logging_es_memory_limit: openshift_hosted_logging_elasticsearch_instance_ram
+      openshift_logging_es_nodeselector: openshift_hosted_logging_elasticsearch_nodeselector
+      openshift_logging_es_ops_memory_limit: openshift_hosted_logging_elasticsearch_ops_instance_ram
+      openshift_logging_storage_access_modes: openshift_hosted_logging_storage_access_modes
+      openshift_logging_master_public_url: openshift_hosted_logging_master_public_url
+      openshift_logging_image_prefix: openshift_hosted_logging_deployer_prefix
+      openshift_logging_image_version: openshift_hosted_logging_deployer_version
+      openshift_logging_install_logging: openshift_hosted_logging_deploy
+
+
+- set_fact:
+    openshift_logging_elasticsearch_pvc_dynamic: "{{ 'true' if openshift_logging_storage_kind | default(none) == 'dynamic' else '' }}"
+    openshift_logging_elasticsearch_pvc_size: "{{ openshift_logging_storage_volume_size if openshift_logging_storage_kind | default(none) in ['dynamic','nfs'] else ''  }}"
+    openshift_logging_elasticsearch_pvc_prefix: "{{ 'logging-es' if openshift_logging_storage_kind | default(none) == 'dynamic' else '' }}"
+    openshift_logging_elasticsearch_ops_pvc_dynamic: "{{ 'true' if openshift_loggingops_storage_kind | default(none) == 'dynamic' else '' }}"
+    openshift_logging_elasticsearch_ops_pvc_size: "{{ openshift_loggingops_storage_volume_size if openshift_loggingops_storage_kind | default(none) in ['dynamic','nfs'] else ''  }}"
+    openshift_logging_elasticsearch_ops_pvc_prefix: "{{ 'logging-es-ops' if openshift_loggingops_storage_kind | default(none) == 'dynamic' else '' }}"
+    openshift_logging_curator_nodeselector: "{{ openshift_hosted_logging_curator_nodeselector | default('') | map_from_pairs }}"
+    openshift_logging_curator_ops_nodeselector: "{{ openshift_hosted_logging_curator_ops_nodeselector | default('') | map_from_pairs }}"
+    openshift_logging_kibana_nodeselector: "{{ openshift_hosted_logging_kibana_nodeselector | default('') | map_from_pairs }}"
+    openshift_logging_kibana_ops_nodeselector: "{{ openshift_hosted_logging_kibana_ops_nodeselector | default('') | map_from_pairs }}"
+    openshift_logging_fluentd_nodeselector: "{{ openshift_hosted_logging_fluentd_nodeselector_label | default('logging-infra-fluentd=true') | map_from_pairs }}"
+    openshift_logging_es_ops_nodeselector: "{{ openshift_hosted_logging_elasticsearch_ops_nodeselector | default('') | map_from_pairs }}"
diff --git a/roles/openshift_sanitize_inventory/tasks/__deprecations_metrics.yml b/roles/openshift_sanitize_inventory/tasks/__deprecations_metrics.yml
new file mode 100644
index 000000000..279646981
--- /dev/null
+++ b/roles/openshift_sanitize_inventory/tasks/__deprecations_metrics.yml
@@ -0,0 +1,17 @@
+---
+# this is used to set the metrics variables from deprecated values to the current variables names
+# this file should be deleted once variables are no longer honored
+
+- conditional_set_fact:
+    facts: "{{ hostvars[inventory_hostname] }}"
+    vars:
+      openshift_metrics_storage_access_modes: openshift_hosted_metrics_storage_access_modes
+      openshift_metrics_storage_host: openshift_hosted_metrics_storage_host
+      openshift_metrics_storage_nfs_directory: openshift_hosted_metrics_storage_nfs_directory
+      openshift_metrics_storage_volume_name: openshift_hosted_metrics_storage_volume_name
+      openshift_metrics_storage_volume_size: openshift_hosted_metrics_storage_volume_size
+      openshift_metrics_storage_labels: openshift_hosted_metrics_storage_labels
+      openshift_metrics_image_prefix: openshift_hosted_metrics_deployer_prefix
+      openshift_metrics_image_version: openshift_hosted_metrics_deployer_version
+      openshift_metrics_install_metrics: openshift_hosted_metrics_deploy
+      openshift_metrics_storage_kind: openshift_hosted_metrics_storage_kind
diff --git a/roles/openshift_sanitize_inventory/tasks/deprecations.yml b/roles/openshift_sanitize_inventory/tasks/deprecations.yml
new file mode 100644
index 000000000..94d3acffc
--- /dev/null
+++ b/roles/openshift_sanitize_inventory/tasks/deprecations.yml
@@ -0,0 +1,21 @@
+---
+
+- name: Check for usage of deprecated variables
+  set_fact:
+    __deprecation_message: "{{ __deprecation_message | default([]) }} + ['{{ __deprecation_header }} {{ item }} is a deprecated variable and will be no longer be used in the next minor release. Please update your inventory accordingly.']"
+  when:
+  - hostvars[inventory_hostname][item] is defined
+  with_items: "{{ __warn_deprecated_vars }}"
+
+- block:
+  - debug: msg="{{__deprecation_message}}"
+  - pause:
+      seconds: "{{ 10 }}"
+  when:
+  - __deprecation_message | default ('') | length > 0
+
+# for with_fileglob Ansible resolves the path relative to the roles/<rolename>/files directory
+- name: Assign deprecated variables to correct counterparts
+  include: "{{ item }}"
+  with_fileglob:
+  - "../tasks/__deprecations_*.yml"
diff --git a/roles/openshift_sanitize_inventory/tasks/main.yml b/roles/openshift_sanitize_inventory/tasks/main.yml
index 47d7be05a..ca69c5b84 100644
--- a/roles/openshift_sanitize_inventory/tasks/main.yml
+++ b/roles/openshift_sanitize_inventory/tasks/main.yml
@@ -1,4 +1,8 @@
 ---
+# We should print out deprecations prior to any failures so that if a play does fail for other reasons
+# the user would also be aware of any deprecated variables they should note to adjust
+- include: deprecations.yml
+
 - name: Abort when conflicting deployment type variables are set
   when:
     - deployment_type is defined