Service Telemetry Framework Release Notes 1.5

Red Hat OpenStack Platform 16.1

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. 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

01 Dec 2022

1.5

 

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

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/17.0/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/17.0/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.

22 Jun 2023

1.5.2

https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.1/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.