Conditional removal and docs update

Author: assumptionsandg

doc/source/configuration/monitoring.rst

@@ -145,38 +145,34 @@ in your cloud. StackHPC Kayobe Config includes a playbook for manual
 deployment, and it's necessary that some variables are set before
 running this playbook.
 
-To successfully deploy OpenStack Capacity, you are required to specify
-the OpenStack application credentials in ``kayobe/secrets.yml`` as:
+OpenStack Capacity is deployed automatically using a service deploy hook
+with the generated kolla-ansible admin credentials, you can override these
+by setting the authentication url, username, password, project name and
+project domain name in ``kayobe/stackhpc-monitoring.yml``:
 
 .. code-block:: yaml
 
-    secrets_os_capacity_credential_id: <some_credential_id>
-    secrets_os_capacity_credential_secret: <some_credential_secret>
+    stackhpc_os_capacity_auth_url: <keystone_auth_url>
+    stackhpc_os_capacity_username: <openstack_username>
+    stackhpc_os_capacity_password: <openstack_password_encrypted_with_vault>
+    stackhpc_os_capacity_project_name: <openstack_project_name>
+    stackhpc_os_capacity_domain_name: <openstack_project_domain_name>
 
-The Keystone authentication URL and OpenStack region can be changed
-from their defaults in ``stackhpc-monitoring.yml`` should you need to
-set a different OpenStack region for your cloud. The authentication
-URL is set to use ``kolla_internal_fqdn`` by default:
-
-.. code-block:: yaml
-
-    stackhpc_os_capacity_auth_url: <some_authentication_url>
-    stackhpc_os_capacity_openstack_region_name: <some_openstack_region>
-
-Additionally, you are required to enable a conditional flag to allow
-HAProxy and Prometheus configuration to be templated during deployment.
+Additionally, you should ensure these credentials have the correct permissions
+for the exporter. If you are deploying in a cloud with internal TLS, you may be required
+to disable certificate verification for the OpenStack Capacity exporter
+if your certificate is not signed by a trusted CA.
 
 .. code-block:: yaml
 
-    stackhpc_enable_os_capacity: true
+    stackhpc_os_capacity_openstack_verify: false
 
-If you are deploying in a cloud with internal TLS, you may be required
-to disable certificate verification for the OpenStack Capacity exporter
-if your certificate is not signed by a trusted CA.
+The OpenStack region can be changed from it's default in ``stackhpc-monitoring.yml`` 
+should you need to set a different OpenStack region for your cloud:
 
 .. code-block:: yaml
 
-    stackhpc_os_capacity_openstack_verify: false
+    stackhpc_os_capacity_openstack_region_name: <some_openstack_region>
 
 After defining your credentials, you may deploy OpenStack Capacity
 using the ``ansible/deploy-os-capacity-exporter.yml`` Ansible playbook

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

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

etc/kayobe/kolla/config/prometheus/prometheus.yml.d/70-oscapacity.yml

@@ -1,6 +1,5 @@
 # yamllint disable-file
 ---
-{% if stackhpc_enable_os_capacity | bool %}
 {% raw %}
 scrape_configs:
   - job_name: os-capacity
@@ -13,4 +12,3 @@ scrape_configs:
     scheme: https
 {% endif %}
 {% endraw %}
-{% endif %}

etc/kayobe/stackhpc-monitoring.yml

@@ -11,14 +11,6 @@ alertmanager_low_memory_threshold_gib: 5
 ###############################################################################
 # Exporter configuration
 
-# Whether the OpenStack Capacity exporter is enabled.
-# Enabling this flag will result in HAProxy configuration and Prometheus scrape
-# targets being templated during deployment.
-stackhpc_enable_os_capacity: false
-
-# Keystone authentication URL for OpenStack Capacity
-stackhpc_os_capacity_auth_url: "http{% if kolla_enable_tls_internal | bool %}s{% endif %}://{{ kolla_internal_fqdn }}:5000"
-
 # OpenStack region for OpenStack Capacity
 stackhpc_os_capacity_openstack_region_name: "{{ openstack_region_name | default(RegionOne) }}"
 

releasenotes/notes/os-capacity-deploy-hook-b52e87c0819df6fd.yaml

@@ -0,0 +1,19 @@
+---
+features:
+  - |
+    Automatic deployment for OpenStack Capacity via a Kayobe service
+    deploy hook using kolla admin credentials.
+issues:
+  - |
+    Will fail service deploy if correct authentication is not used for
+    os_capacity exporter and if kolla credentials are invalid or do not
+    have suitable permissions.
+upgrade:
+  - |
+    Remove application credentials used for OpenStack Capacity and replace
+    with OpenStack username/password authentication. Also required to include
+    OpenStack project name and project domain name.
+deprecations:
+  - |
+    Application credential support for OpenStack Capacity is deprecated.
+    `stackhpc_enable_os_capacity` condtional variable is deprecated.