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

1 files changed, 74 insertions, 0 deletions

diff --git a/roles/openshift_sanitize_inventory/vars/main.yml b/roles/openshift_sanitize_inventory/vars/main.yml
index 37e88758d..0fc2372d2 100644
--- a/roles/openshift_sanitize_inventory/vars/main.yml
+++ b/roles/openshift_sanitize_inventory/vars/main.yml
@@ -2,3 +2,77 @@
 # origin uses community packages named 'origin'
 # openshift-enterprise uses Red Hat packages named 'atomic-openshift'
 known_openshift_deployment_types: ['origin', 'openshift-enterprise']
+
+__deprecation_header: "[DEPRECATION WARNING]:"
+
+# this is a list of variables that we will be deprecating within the next minor release, this list should be expected to change from release to release
+__warn_deprecated_vars:
+  # logging
+  - 'openshift_hosted_logging_deploy'
+  - 'openshift_hosted_logging_hostname'
+  - 'openshift_hosted_logging_ops_hostname'
+  - 'openshift_hosted_logging_master_public_url'
+  - 'openshift_hosted_logging_elasticsearch_cluster_size'
+  - 'openshift_hosted_logging_elasticsearch_ops_cluster_size'
+  - 'openshift_hosted_logging_image_pull_secret'
+  - 'openshift_hosted_logging_enable_ops_cluster'
+  - 'openshift_hosted_logging_curator_nodeselector'
+  - 'openshift_hosted_logging_curator_ops_nodeselector'
+  - 'openshift_hosted_logging_kibana_nodeselector'
+  - 'openshift_hosted_logging_kibana_ops_nodeselector'
+  - 'openshift_hosted_logging_fluentd_nodeselector_label'
+  - 'openshift_hosted_logging_journal_source'
+  - 'openshift_hosted_logging_journal_read_from_head'
+  - 'openshift_hosted_logging_elasticsearch_instance_ram'
+  - 'openshift_hosted_logging_storage_labels'
+  - 'openshift_hosted_logging_elasticsearch_pvc_dynamic'
+  - 'openshift_hosted_logging_elasticsearch_pvc_size'
+  - 'openshift_hosted_logging_elasticsearch_pvc_prefix'
+  - 'openshift_hosted_logging_elasticsearch_storage_group'
+  - 'openshift_hosted_logging_elasticsearch_nodeselector'
+  - 'openshift_hosted_logging_elasticsearch_ops_instance_ram'
+  - 'openshift_hosted_loggingops_storage_labels'
+  - 'openshift_hosted_logging_elasticsearch_ops_pvc_dynamic'
+  - 'openshift_hosted_logging_elasticsearch_ops_pvc_size'
+  - 'openshift_hosted_logging_elasticsearch_ops_pvc_prefix'
+  - 'openshift_hosted_logging_elasticsearch_storage_group'
+  - 'openshift_hosted_logging_elasticsearch_ops_nodeselector'
+  - 'openshift_hosted_logging_storage_access_modes'
+  - 'openshift_hosted_logging_storage_kind'
+  - 'openshift_hosted_loggingops_storage_kind'
+  - 'openshift_hosted_logging_storage_host'
+  - 'openshift_hosted_loggingops_storage_host'
+  - 'openshift_hosted_logging_storage_nfs_directory'
+  - 'openshift_hosted_loggingops_storage_nfs_directory'
+  - 'openshift_hosted_logging_storage_volume_name'
+  - 'openshift_hosted_loggingops_storage_volume_name'
+  - 'openshift_hosted_logging_storage_volume_size'
+  - 'openshift_hosted_loggingops_storage_volume_size'
+  - 'openshift_hosted_logging_enable_ops_cluster'
+  - 'openshift_hosted_logging_image_pull_secret'
+  - 'openshift_hosted_logging_curator_nodeselector'
+  - 'openshift_hosted_logging_curator_ops_nodeselector'
+  - 'openshift_hosted_logging_kibana_nodeselector'
+  - 'openshift_hosted_logging_kibana_ops_nodeselector'
+  - 'openshift_hosted_logging_ops_hostname'
+  - 'openshift_hosted_logging_fluentd_nodeselector_label'
+  - 'openshift_hosted_logging_journal_source'
+  - 'openshift_hosted_logging_journal_read_from_head'
+  - 'openshift_hosted_logging_elasticsearch_instance_ram'
+  - 'openshift_hosted_logging_elasticsearch_nodeselector'
+  - 'openshift_hosted_logging_elasticsearch_ops_instance_ram'
+  - 'openshift_hosted_logging_elasticsearch_ops_nodeselector'
+  - 'openshift_hosted_logging_storage_access_modes'
+  - 'openshift_hosted_logging_deployer_prefix'
+  - 'openshift_hosted_logging_deployer_version'
+  # metrics
+  - 'openshift_hosted_metrics_deploy'
+  - 'openshift_hosted_metrics_storage_kind'
+  - 'openshift_hosted_metrics_storage_access_modes'
+  - 'openshift_hosted_metrics_storage_host'
+  - 'openshift_hosted_metrics_storage_nfs_directory'
+  - 'openshift_hosted_metrics_storage_volume_name'
+  - 'openshift_hosted_metrics_storage_volume_size'
+  - 'openshift_hosted_metrics_storage_labels'
+  - 'openshift_hosted_metrics_deployer_prefix'
+  - 'openshift_hosted_metrics_deployer_version'