dashboard: allow disabling of unused features

Unconfigured dashboard features can lead to empty tabs in the dashboard
containing no meaningful content. Allow users to disable dashboard features
they know will not be used.

A list of features to be disabled allows the user to define a streamlined
dashboard as standard across deployments. Defaults to disabling no features,
ensuring that users are sure they do not need the dashboard feature before
disabling it.

Signed-off-by: Alex Lambert <lamberta@microsoft.com>
(cherry picked from commit a9680ab17f19cc37809ef016897244f975034666)

diff --git a/group_vars/all.yml.sample b/group_vars/all.yml.sample
index 9e154455af285e67188d187c4072d467a143b22b..f6f6f15c6203527823332feb2d16318b8b335f21 100644 (file)
--- a/group_vars/all.yml.sample
+++ b/group_vars/all.yml.sample
@@ -665,6 +665,7 @@ dummy:
 #dashboard_rgw_api_admin_resource: ''
 #dashboard_rgw_api_no_ssl_verify: False
 #dashboard_frontend_vip: ''
+#dashboard_disabled_features: []
 #prometheus_frontend_vip: ''
 #alertmanager_frontend_vip: ''
 #node_exporter_container_image: "docker.io/prom/node-exporter:v0.17.0"

diff --git a/group_vars/rhcs.yml.sample b/group_vars/rhcs.yml.sample
index 758dfac4cc1bfd611fd05604394155c382984e42..2bfa10dde56912b6b5df6bc22aba62c43a35f658 100644 (file)
--- a/group_vars/rhcs.yml.sample
+++ b/group_vars/rhcs.yml.sample
@@ -665,6 +665,7 @@ ceph_docker_registry_auth: true
 #dashboard_rgw_api_admin_resource: ''
 #dashboard_rgw_api_no_ssl_verify: False
 #dashboard_frontend_vip: ''
+#dashboard_disabled_features: []
 #prometheus_frontend_vip: ''
 #alertmanager_frontend_vip: ''
 node_exporter_container_image: registry.redhat.io/openshift4/ose-prometheus-node-exporter:v4.6

diff --git a/roles/ceph-dashboard/tasks/configure_dashboard.yml b/roles/ceph-dashboard/tasks/configure_dashboard.yml
index b75710fb4afb083c621f66024fd31397f3c3f61a..21f1f8f2c829314d871fe1e84c1a96902edd13ab 100644 (file)
--- a/roles/ceph-dashboard/tasks/configure_dashboard.yml
+++ b/roles/ceph-dashboard/tasks/configure_dashboard.yml
@@ -192,6 +192,13 @@
     CEPH_CONTAINER_IMAGE: "{{ ceph_docker_registry + '/' + ceph_docker_image + ':' + ceph_docker_image_tag if containerized_deployment | bool else None }}"
     CEPH_CONTAINER_BINARY: "{{ container_binary }}"
 
+- name: disable unused dashboard features
+  command: "{{ container_exec_cmd }} ceph --cluster {{ cluster }} dashboard feature disable {{ item }}"
+  delegate_to: "{{ groups[mon_group_name][0] }}"
+  run_once: true
+  changed_when: false
+  with_items: "{{ dashboard_disabled_features }}"
+
 - name: set grafana api user
   command: "{{ container_exec_cmd }} ceph --cluster {{ cluster }} dashboard set-grafana-api-username {{ grafana_admin_user }}"
   delegate_to: "{{ groups[mon_group_name][0] }}"

diff --git a/roles/ceph-defaults/defaults/main.yml b/roles/ceph-defaults/defaults/main.yml
index 7fc41abacb573cc24f38bca60fadb114bf8e3bb8..930bc0418c4da8110c136e511df9a98cc77e2e12 100644 (file)
--- a/roles/ceph-defaults/defaults/main.yml
+++ b/roles/ceph-defaults/defaults/main.yml
@@ -657,6 +657,7 @@ dashboard_rgw_api_user_id: ceph-dashboard
 dashboard_rgw_api_admin_resource: ''
 dashboard_rgw_api_no_ssl_verify: False
 dashboard_frontend_vip: ''
+dashboard_disabled_features: []
 prometheus_frontend_vip: ''
 alertmanager_frontend_vip: ''
 node_exporter_container_image: "docker.io/prom/node-exporter:v0.17.0"