Various os_capacity fixes

Author: assumptionsandg

doc/source/configuration/monitoring.rst

@@ -141,8 +141,9 @@ OpenStack Capacity
 ==================
 
 OpenStack Capacity allows you to see how much space you have avaliable
-in your cloud. StackHPC Kayobe Config includes this exporter by default
-and it's necessary that some variables are set to allow deployment.
+in your cloud. StackHPC Kayobe Config includes a playbook for manual 
+deployment, and it's necessary that some variables are set to before
+running this playbook.
 
 To successfully deploy OpenStack Capacity, you are required to specify
 the OpenStack application credentials in ``kayobe/secrets.yml`` as:
@@ -153,6 +154,13 @@ the OpenStack application credentials in ``kayobe/secrets.yml`` as:
     secrets_os_exporter_credential_id: <some_credential_id>
     secrets_os_exporter_credential_secret: <some_credential_secret>
 
+Additionally, you are required to enable a conditional flag to allow
+HAProxy configuration to be templated to controllers during deployment.
+
+.. code-block:: yaml
+
+    stackhpc_enable_os_capacity: true
+
 After defining your credentials, You may deploy OpenStack Capacity
 using the ``ansible/deploy-os-capacity-exporter.yml`` Ansible playbook
 via Kayobe.

etc/kayobe/ansible/templates/os_capacity-clouds.yml.j2

@@ -1,9 +1,9 @@
 clouds:
   openstack:
     auth:
-      auth_url: "{{ secrets_os_exporter_auth_url }}"
-      application_credential_id: "{{ secrets_os_exporter_credential_id }}"
-      application_credential_secret: "{{ secrets_os_exporter_credential_secret }}"
+      auth_url: "{{ secrets_os_capacity_auth_url }}"
+      application_credential_id: "{{ secrets_os_capacity_credential_id }}"
+      application_credential_secret: "{{ secrets_os_capacity_credential_secret }}"
     region_name: "RegionOne"
     interface: "internal"
     identity_api_version: 3

etc/kayobe/kolla/config/haproxy/services.d/os_exporter.cfg

@@ -1,3 +1,4 @@
+{% if stackhpc_enable_os_capacity | bool %}
 {% raw %}
 frontend os_capacity_frontend
     mode http
@@ -17,3 +18,4 @@ backend os_capacity_backend
     server {{ host_name }} {{ host_ip }}:9000 check inter 2000 rise 2 fall 5
 {% endfor %}
 {% endraw %}
+{% endif %}

etc/kayobe/stackhpc-monitoring.yml

@@ -9,3 +9,13 @@
 alertmanager_low_memory_threshold_gib: 5
 
 ###############################################################################
+
+###############################################################################
+# Exporter configuration
+
+# Whether the OpenStack Capacity exporter is enabled.
+# Enabling this flag will result in HAProxy configuration being templated during
+# deployment.
+stackhpc_enable_os_capacity: false
+
+###############################################################################

releasenotes/notes/os-capacity-94006f03f16583e4.yaml

@@ -9,7 +9,11 @@ upgrade:
   - |
     To deploy the OpenStack Capacity Grafana dashboard, you must
     define OpenStack application credential variables:
-    ``secrets_os_exporter_auth_url``,
-    ``secrets_os_exporter_credential_id`` and
-    ``secrets_os_exporter_credential_secret`` as laid out in the
+    ``secrets_os_capacity_auth_url``,
+    ``secrets_os_capacity_credential_id`` and
+    ``secrets_os_capacity_credential_secret`` as laid out in the
     'Monitoring' documentation.
+
+    You must also enable the ``stackhpc_enable_os_capacity``
+    flag for OpenStack Capacity HAProxy configuration to be
+    templated.