Add reminder to remove custom blackbox endpoints

[technowhizz]

No description provided.

[Alex-Welsh]

This change is coming in Epoxy, not Caracal, and I don't think we need the warning anyway. prometheus_blackbox_exporter_endpoints has been removed from the master branch already, so when we merge stackhpc/2025.1 to do the upgrades, it'll get removed automatically

[jackhodgkiss]

This change is coming in Epoxy, not Caracal, and I don't think we need the warning anyway. prometheus_blackbox_exporter_endpoints has been removed from the master branch already, so when we merge stackhpc/2025.1 to do the upgrades, it'll get removed automatically

Though it won't be removed from a kolla/globals.yml inside an environment.

[Alex-Welsh]

@technowhizz can you update this to target stackhpc/master and mention kolla/globals.yml inside an environment specifically?

[Alex-Welsh]

Endpoints for the blackbox exporter are now templated in the kolla-ansible
group vars for the cloud.

Not all endpoints are templated e.g. backend endpoints. They're still done here in SKC.

Additional endpoints may be
added through the prometheus_blackbox_exporter_endpoints_kayobe variable.

That varies depending on what you want to template. This is all correct if you want it to be templated by kayobe, but you can also use stackhpc_prometheus_blackbox_exporter_endpoints_custom if you want it templated by Kolla Ansible

[technowhizz]

Do you have examples of these @Alex-Welsh ?

[Alex-Welsh]

Yeah, so these endpoints are the ones that aren't templated in Kolla-Ansible upstream yet: https://github.com/stackhpc/stackhpc-kayobe-config/blob/stackhpc/master/etc/kayobe/kolla/inventory/group_vars/prometheus-blackbox-exporter#L27-L66

And for the other one, there are two options if you want to add endpoints:
If you want kolla-ansible to template it then you add it to stackhpc_prometheus_blackbox_exporter_endpoints_custom
If you want kayobe to template it then you add it to prometheus_blackbox_exporter_endpoints_kayobe
The output can be different because they each access different variables.

[Alex-Welsh]

Suggested change

	Endpoints for the blackbox exporter are now templated in the kolla-ansible
	group vars for the cloud. This means that the
	``prometheus_blackbox_exporter_endpoints`` variable can be removed from the
	environment's ``kolla/globals.yml`` file (if applicable) and the endpoints will
	fallback to the ones templated in the group vars. Additional endpoints may be
	added through the ``prometheus_blackbox_exporter_endpoints_kayobe`` variable.
	For example:
	Many endpoints for the Blackbox exporter are now templated in the Kolla-Ansible
	group vars for the cloud. This means that the
	``prometheus_blackbox_exporter_endpoints`` variable can be removed from the
	environment's ``kolla/globals.yml`` file (if applicable) and the endpoints will
	fallback to the ones templated in the group vars. Backend endpoints such as
	`these <https://github.com/stackhpc/stackhpc-kayobe-config/blob/094c2e012a037309d103c08a71eb633fdeb214e7/etc/kayobe/kolla/inventory/group_vars/prometheus-blackbox-exporter#L27-L64>`__
	are not yet templated by Kolla-Ansible.
	Additional endpoints may still be added.
	For Kolla-Ansible templating, use ``stackhpc_prometheus_blackbox_exporter_endpoints_custom``.
	For example:
	.. code-block:: yaml
	:caption: ``etc/kayobe/kolla/inventory/group_vars/prometheus-blackbox-exporter``
	stackhpc_prometheus_blackbox_exporter_endpoints_custom:
	- 'custom_service:http_2xx:{{ public_protocol }}://{{ external_fqdn | put_address_in_context('url') }}:{{ custom_serivce_port }}'
	Alternatively, for Kayobe templating, use the ``prometheus_blackbox_exporter_endpoints_kayobe`` variable.
	For example:

[Alex-Welsh]

@technowhizz I'd like to get this wrapped up soon since the epoxy release isn't far away. Can you respond to the comments & resolve the merge conflict?

[Alex-Welsh]

@technowhizz I've added a suggestion, could you review please?