Service Telemetry Framework Release Notes 1.5

Red Hat OpenStack Platform 16.2

Release details for Service Telemetry Framework 1.5

OpenStack Documentation Team

Red Hat Customer Content Services

Abstract

This document outlines the major features, enhancements, and known issues in this release of Service Telemetry Framework.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see our CTO Chris Wright’s message.

Chapter 1. Introduction to Service Telemetry Framework release

This release of Service Telemetry Framework (STF) provides new features and resolved issues specific to STF.

STF uses components from other Red Hat products. For specific information pertaining to the support of these components, see https://access.redhat.com/site/support/policy/updates/openstack/platform/ and https://access.redhat.com/support/policy/updates/openshift/.

STF 1.5 is compatible with OpenShift Container Platform version 4.10 and 4.12 as the deployment platform.

1.1. Product support

The Red Hat Customer Portal offers resources to guide you through the installation and configuration of Service Telemetry Framework. The following types of documentation are available through the Customer Portal:

  • Product documentation
  • Knowledge base articles and solutions
  • Technical briefs

  • Support case management

    You can access the Customer Portal at https://access.redhat.com/.

Chapter 2. Service Telemetry Framework release information

Notes for updates released during the supported lifecycle of this Service Telemetry Framework (STF) release appear in the advisory text associated with each update.

2.1. Service Telemetry Framework 1.5.0

These release notes highlight enhancements and removed functionality to be taken into consideration when you install this release of Service Telemetry Framework (STF).

This release includes the following advisories:

RHEA-2022:8735-01
Release of components for Service Telemetry Framework 1.5.0 - Container Images

2.1.1. Release notes

This section outlines important details about the release, including recommended practices and notable changes to STF. You must take this information into account to ensure the best possible outcomes for your installation.

BZ#2121457
STF 1.5.0 supports OpenShift Container Platform 4.10. Previous releases of STF were limited to OpenShift Container Platform 4.8, which is nearing the end of extended support. OpenShift Container Platform 4.10 is an Extended Update Support (EUS) release with full support until November 2022, and maintenance support until September 2023. For more information, see Red Hat OpenShift Container Platform Life Cycle Policy.

2.1.2. Deprecated Functionality

The items in this section are either no longer supported, or will no longer be supported in a future release.

BZ#2153825
The sg-core application plugin elasticsearch is deprecated in STF 1.5.
BZ#2152901
The use of prometheus-webhook-snmp is deprecated in STF 1.5.

2.1.3. Removed Functionality

BZ#2150029
The section in the STF documentation describing how to use STF and Gnocchi together has been removed. The use of Gnocchi is limited to use for autoscaling.

2.2. Service Telemetry Framework 1.5.1

These release notes highlight enhancements and removed functionality to be taken into consideration when you install this release of Service Telemetry Framework (STF).

This release includes the following advisory:

RHSA-2023:1529-04
Release of components for Service Telemetry Framework 1.5.1 - Container Images

2.2.1. Release notes

This section outlines important details about the release, including recommended practices and notable changes to STF. You must take this information into account to ensure the best possible outcomes for your installation.

BZ#2176537
STF 1.5.1 supports OpenShift Container Platform 4.10 and 4.12. Previous releases of STF were limited to OpenShift Container Platform 4.8, which is nearing the end of extended support. OpenShift Container Platform 4.12 is an Extended Update Support (EUS) release currently in full support, and maintenance support until July 2024. For more information, see Red Hat OpenShift Container Platform Life Cycle Policy.
BZ#2173856
There is an issue where the events datasource in Grafana is unavailable when events storage is disabled. The default setting of events storage is disabled. The virtual machine dashboard presents warnings about a missing datasource because the datasource is using annotations and is unavailable by default. Workaround (if any): You can use the available switch on the virtual machine dashboard to disable the annotations and match the default deployment options in STF.

2.2.2. Enhancements

This release of STF features the following enhancements:

BZ#2092544
You can have more control over certificate renewal configuration with additional certificate expiration configuration for CA and endpoint certificates for QDR and Elasticsearch.
STF-559
You can now use the additional SNMP trap delivery controls in STF to configure the trap delivery target, port, community, default trap OID, default trap severity, and trap OID prefix.
BZ#2159464
This feature has been rebuilt on golang 1.18, to remain on a supported golang version, which benefits future maintenance activities.

2.3. Service Telemetry Framework 1.5.2

These release notes highlight enhancements and removed functionality to be taken into consideration when you install this release of Service Telemetry Framework (STF).

This release includes the following advisory:

RHEA-2023:3785
Release for Service Telemetry Framework 1.5.2

2.3.1. Bug fixes

These bugs were fixed in this release of STF:

BZ#2211897

Previously, you installed Prometheus Operator from OperatorHub.io Operators CatalogSource, which interfered with in-cluster monitoring in Red Hat OpenShift Container Platform.

To remedy this, you now use Prometheus Operator from the Community Operators CatalogSource during STF installation. For more information on how to migrate from OperatorHub.io Operators CatalogSource to Community Operators CatalogSource, see the Knowledge Base Article Migrating Service Telemetry Framework to Prometheus Operator from community-operators

2.3.2. Enhancements

This release of STF features the following enhancements:

BZ#2138179
You can now deploy Red Hat OpenStack Platform (RHOSP) with director Operator for monitoring RHOSP 16.2 with STF.

2.3.3. Removed functionality

The following functionality has been removed from this release of STF:

BZ#2189670
Documentation about ephemeral storage is removed. Ensure that you use persistent storage in production deployments.

2.4. Service Telemetry Framework 1.5.3

These release notes highlight enhancements and removed functionality to be taken into consideration when you install this release of Service Telemetry Framework (STF).

This release includes the following advisory:

RHEA-2023:123051-01
Release for Service Telemetry Framework 1.5.3

2.4.1. Enhancements

This release of STF features the following enhancements:

JIRA#STF-1525
In versions of STF before 1.5.3, STF used the Role-based access control (RBAC) profiles created by Red Hat OpenShift Container Platform (RHOCP) Cluster Monitoring Operator. STF now manages its own RBAC profiles as part of the deployment. STF no longer requires RHOCP Cluster Monitoring on the cluster, resulting in an independent RBAC control interface.
JIRA#STF-1512
To match the polling frequency of Ceilometer, the default polling frequency in STF of the scrape interval of the Smart Gateways and the polling frequency of collectd are now 30 seconds each.
JIRA#STF-1485

If you deploy STF 1.5 with Red Hat OpenShift Container Platform (RHOCP) version 4.12 or newer, the default channel of the Certificate Manager for RHOCP Operator is stable-v1.

Deployments of STF 1.5 with RHOCP 4.10 use a channel that is technical preview and the deployment procedure is different. Ensure that you migrate to the stable-v1 channel before you upgrade RHOCP to version 4.13 or newer.

For more information about migrating the Certificate Manager for RHOCP Operator from the tech-preview channel to the stable-v1 channel, see the Red Hat knowledgebase article Updating Service Telemetry Framework cert-manager dependency from tech-preview to stable-v1.

JIRA#STF-496
In this release of STF, STF metrics data store (Prometheus) is supported when you use Red Hat Cluster Observability Operator (COO). For more information about migrating from the community Prometheus Operator to Red Hat Cluster Observability Operator, see the Red Hat knowledgebase article, Migrating Service Telemetry Framework to fully supported operators.
JIRA#STF-1277
In this release of STF, you can forward events to a user-provided Elasticsearch instance.
JIRA#STF-1224
STF now supports Red Hat OpenShift Container Platform (RHOCP) versions from 4.12 to 4.14.
JIRA#STF-1387
In this release of STF, you can configure the backends.events.elasticsearch.forwarding parameter of the ServiceTelemetry object to forward storage events to an Elasticsearch instance. For more information about enabling Elasticsearch as a storage back end for events, see Primary parameters of the ServiceTelemetry object in the Service Telemetry Framework 1.5 Guide.

2.4.2. Removed functionality

The following functionality has been removed from this release of STF:

JIRA#STF-1526

STF 1.5 supports the latest Red Hat OpenShift Container Platform(RHOCP) Extended Update Support (EUS) releases, such as RHOCP 4.12 and RHOCP 4.14. Other versions of RHOCP are supported only for upgrading between EUS releases.

RHOCP 4.10 is end-of-life, so STF 1.5.3 is not included in the RHOCP 4.10 CatalogSource. For more information about the supported life cycle of RHOCP, see https://access.redhat.com/support/policy/updates/openshift

JIRA#STF-1504
In this release of STF, the interface in Service Telemetry Operator that you use to manage a logging storage backend is removed. Using Loki to store logs that were transported with amqp1 is not supported in production environments.
JIRA#STF-1498
In this release of STF, events are not managed by default. The events pipeline is disabled when you deploy Red Hat OpenStack Platform (RHOSP).

2.4.3. Deprecated functionality

The items in this section are either no longer supported, or will no longer be supported in a future release.

JIRA#STF-1507
STF high availability (HA) mode is deprecated.
JIRA#STF-1493
Elasticsearch management is deprecated when you deploy STF with the value of the observabilityStrategy parameter set to use_community. Elasticsearch management is removed if you set the value of the observabilityStrategy parameter to use_hybrid or use_redhat.

You can still use AMQ Interconnect to transmit events from RHOSP to STF with an external Elasticsearch that you configure with a URL and other parameters, to enable the events Smart Gateway to connect and store events.

For more information about how to provide a compatible connection with a user-provided instance of Elasticsearch, see the Red Hat knowledgebase article Using Service Telemetry Framework with Elasticsearch.

JIRA#STF-1531
The basic authorization login methods for the STF UI interfaces are deprecated and replaced by the OAuth UI login methods.
JIRA#STF-1097
In this version of STF, deploying with Elasticsearch is not supported. The Elasticsearch plugin in sg-core is deprecated and the limited use of events in dashboards for STF is removed. STF now uses a forwarding model to allow transport and storage of events to a user-provided Elasticsearch instance through the sg-core component.

2.5. Service Telemetry Framework 1.5.4

These release notes highlight enhancements and removed functionality to be taken into consideration when you install this release of Service Telemetry Framework (STF).

This release includes the following advisory:

RHSA-2024:127788-02
Release for Service Telemetry Framework 1.5.4

2.5.1. Enhancements

This release of STF features the following enhancements:

JIRA#OSPRH-800
In this release of STF, you can now deploy STF in a Red Hat OpenShift Container Platform(RHOCP) disconnected environment. For more information about deploying STF in a RHOCP disconnected environment, see link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/17.1/html/service_telemetry_framework_1.5/#deploying-stf-on-openshift-disconnected-environments_assembly-preparing-your-ocp-environment-for-stf [Deploying STF on Red Hat OpenShift Container Platform-disconnected environments] in the Service Telemetry Framework 1.5 guide.
JIRA#OSPRH-2577
In this release of STF, STF requests Grafana, GrafanaDashboard, and GrafanaDatasource objects from Grafana Operator v5 community operator, not Grafana Operator v4. Grafana Operator v5 is the recommended Grafana version for STF 1.5.4, but STF can request objects from Grafana Operator v4 if the Custom Resource Definitions (CRDs) for Grafana Operator v5 are not available. The default route for Grafana Operator v5 has changed from grafana-route to default-grafana-route. For more information about migrating Grafana Operator, see the Red Hat Knowledgebase solution Migrate from Grafana Operator v4 to v5.
JIRA#OSPRH-2140

Previously, STF used a static target version of Prometheus, namely version 2.43.0, when you migrated from the community Prometheus Operator to the supported Cluster Observability Operator.

In this release of STF, when you define the value of the observabilityStrategy parameter to use_redhat in the ServiceTelemetry object, which is the default, the Service Telemetry Operator does not request a specific version of Prometheus.

If you do not specify the version of Prometheus, STF uses the default version provided by Cluster Observability Operator.

JIRA#OSPRH-3492
In this release of STF, you cannot use basic authentication methods for the STF UI interfaces and must use the oauth-proxy interface for authentication.
JIRA#OSPRH-825
In this release of STF, if you install the Grafana Operator from the community CatalogSource and enable graphing, you can load dashboards automatically into Grafana using the graphing.dashboards.enabled parameter. You do not have to load dashboards from the github.com/infrawatch/dashboards repository.

2.5.2. Deprecated Functionality

The items in this section are either no longer supported, or will no longer be supported in a future release.

Deprecation of Service Telemetry Framework

After this release, STF is deprecated from full support and moves to maintenance support. At the end of the support lifecycle for Red Hat OpenStack Platform (RHOSP) 17.1, STF moves to Extended Lifecycle Support (ELS).

During the maintenance support lifecycle, Red Hat will not add new features to STF 1.5. Red Hat will continue to rebase and release STF onto Extended Update Support (EUS) versions of Red Hat OpenShift Container Platform as they become available during the lifecycle of RHOSP 17.1. Red Hat continues to address critical STF bugs and CVEs.

For more information on the product lifecycle for RHOSP and STF, see the Red Hat OpenStack Platform Support Life Cycle and Service Telemetry Framework Life Cycle pages on the customer portal.

2.6. Documentation Changes

This section details the major documentation updates delivered with Service Telemetry Framework (STF) 1.5, and the changes made to the documentation set that include adding new features, enhancements, and corrections. The section also details the addition of new titles and the removal of retired or replaced titles.

Table 2.1. Document changes

DateVersions impactedAffected contentDescription of change

Mar 2024

1.5.4

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html-single/service_telemetry_framework_1.5/index#deploying-stf-on-openshift-disconnected-environments_assembly-preparing-your-ocp-environment-for-stf

You can now deploy STF on RHOCP-disconnected environments.

Mar 2024

1.5.4

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html-single/service_telemetry_framework_1.5/index#setting-up-grafana-to-host-the-dashboard_assembly-advanced-features

Grafana Operator v4 development was discontinued upstream since December 2023. Ensure that you use Grafana Operator v5 instead.

Nov 2023

1.5.3

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html-single/service_telemetry_framework_1.5/index#creating-the-base-configuration-for-stf_assembly-completing-the-stf-configuration

Event storage now uses a forwarding model and event delivery is not enabled by default. The instructions for enabling event delivery are available in the Red Hat Knowledgebase solution https://access.redhat.com/articles/7032697

Nov 2023

1.5.3

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html-single/service_telemetry_framework_1.5/index#creating-openstack-environment-file-for-multiple-clouds_assembly-completing-the-stf-configurationhttps://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html-single/service_telemetry_framework_1.5/index#configuring-the-stf-connection-for-the-overcloud_assembly-completing-the-stf-configuration

In the stf-connectors.yaml template, you can now use the short hostname for the the qdr::router_id value instead of the default FQDN which might be too long in older versions of QDR. You do not need to update your current configuration if the default values are less than 61 characters long.

Nov 2023

1.5.3

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html-single/service_telemetry_framework_1.5/index#importing-dashboards_assembly-advanced-features

The procedure for importing the events dashboard was removed. Event delivery is no longer enabled by default.

Nov 2023

1.5.3

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html-single/service_telemetry_framework_1.5/index#creating-the-base-configuration-for-stf_assembly-completing-the-stf-configuration

In the enable-stf.yaml file, the default polling frequency for collectd is increased from 5 seconds to 30 seconds to match the polling frequency of Ceilometer. The relevant parameters are CollectdAmqpInterval and CollectdDefaultPollingInterval.

Nov 2023

1.5.3

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html-single/service_telemetry_framework_1.5/index#creating-the-base-configuration-for-stf_assembly-completing-the-stf-configuration

In the enable-stf.yaml file, the number of example default pollsters for Ceilometer is reduced to limit the number of unnecessary endpoints that are not used by the STF sample dashboards.

Nov 2023

1.5.3

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html-single/service_telemetry_framework_1.5/index#deploying-stf-to-the-openshift-environment_assembly-installing-the-core-components-of-stf

The oc wait command is added to verification procedures throughout the STF Guide to highlight that some commands take time to complete.

Nov 2023

1.5.3

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html-single/service_telemetry_framework_1.5/index#configuring-the-stf-connection-for-the-overcloud_assembly-completing-the-stf-configuration

In new deployments, the QDR connection uses basic password authentication by default. Configuration procedures are updated to add the password authentication step.

Nov 2023

1.5.3

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html-single/service_telemetry_framework_1.5/index#creating-an-alert-rule-in-prometheus_assembly-advanced-features

PrometheusRules custom resources have been updated to match the apiVersion used by the Cluster Observability Operator. The previous commands used monitoring.coreos.com instead of monitoring.rhobs.

22 Jun 2023

1.5.2

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html-single/service_telemetry_framework_1.5/index#configuring-the-stf-connection-for-the-overcloud_assembly-completing-the-stf-configuration

More information about AMQ Interconnect topic parameters and topic addresses for cloud configurations.

22 Jun 2023

1.5.2

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html/service_telemetry_framework_1.5/index

Section added about Red Hat OpenStack Platform (RHOSP) with director Operator for monitoring RHOSP 16.2 with STF.

30 Mar 2023

1.5.1

 

Removed section from STF documentation titled, "Deploying to non-standard network topologies". The recommendations were unnecessary and potentially inaccurate.

30 Mar 2023

1.5.1

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html-single/service_telemetry_framework_1.5/index#configuration-parameters-for-snmptraps_assembly-advanced-features

The additional configuration parameters available in STF 1.5.1 have been added to the “Sending Alerts as SNMP traps” section. There is more information and examples for configuring a ServiceTelemetry object for SNMP trap delivery from Prometheus Alerts.

30 Mar 2023

1.5.1

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html-single/service_telemetry_framework_1.5/index#proc-updating-the-amq-interconnect-ca-certificate_assembly-renewing-the-amq-interconnect-certificate

The tripleo-ansible-inventory.yaml path has been updated to match the correct path on RHOSP 13 and 16.2 deployments.

01 Dec 2022

1.5

 

Removed section from STF documentation about using Gnocchi with STF. You can only use Gnocchi for autoscaling.