From a5a82aaae590549afcc27983597022acb03086cb Mon Sep 17 00:00:00 2001 From: Chris Sibbitt Date: Wed, 4 Oct 2023 16:00:58 -0400 Subject: [PATCH 01/10] Eliminate duplicate line (#501) --- .../proc_configuring-the-stf-connection-for-the-overcloud.adoc | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-the-overcloud.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-the-overcloud.adoc index 60455cde..ca02c87b 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-the-overcloud.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-the-overcloud.adoc @@ -67,11 +67,10 @@ endif::[] * The `qdr::router_id` configuration is to override the default value which uses the fully-qualified domain name (FQDN) of the host. In some cases the FQDN can result in a router ID length of greater than 61 characters which results in failed QDR connections. For deployments with shorter FQDN values this is not necessary. * The `resource_registry` configuration directly loads the collectd service because you do not include the `collectd-write-qdr.yaml` environment file for multiple cloud deployments. -* Replace the `host` parameter with the value that you retrieved in xref:retrieving-the-qdr-route-address_assembly-completing-the-stf-configuration[]. +* Replace the `host` sub-parameter of `MetricsQdrConnectors` with the value that you retrieved in xref:retrieving-the-qdr-route-address_assembly-completing-the-stf-configuration[]. ifdef::include_when_13,include_when_17[] * Replace the `caCertFileContent` parameter with the contents retrieved in xref:getting-ca-certificate-from-stf-for-overcloud-configuration_assembly-completing-the-stf-configuration[]. endif::include_when_13,include_when_17[] -* Replace the `host` sub-parameter of `MetricsQdrConnectors` with the value that you retrieved in xref:retrieving-the-qdr-route-address_assembly-completing-the-stf-configuration[]. * Set `topic` value of `CeilometerQdrMetricsConfig.topic` to define the topic for Ceilometer metrics. The value is a unique topic identifier for the cloud such as `cloud1-metering`. * Set `CollectdAmqpInstances` sub-parameter to define the topic for collectd metrics. The section name is a unique topic identifier for the cloud such as `cloud1-telemetry`. ifndef::include_when_13[] From 3e400fc7127f22bf843730b809d116dadb6d94c5 Mon Sep 17 00:00:00 2001 From: Chris Sibbitt Date: Thu, 12 Oct 2023 15:53:54 -0400 Subject: [PATCH 02/10] Adding details for QDR password auth (#502) * Adding details for QDR password auth * Move note about disabling auth to main section * Update doc-Service-Telemetry-Framework/modules/proc_retrieving-the-qdr-password.adoc Co-authored-by: Leif Madsen * Update doc-Service-Telemetry-Framework/modules/proc_retrieving-the-qdr-password.adoc Co-authored-by: mickogeary --------- Co-authored-by: Leif Madsen Co-authored-by: mickogeary --- ...mbly_completing-the-stf-configuration.adoc | 1 + ...-openstack-platform-overcloud-for-stf.adoc | 1 + ...r-director-operator-for-the-overcloud.adoc | 2 ++ ...-the-stf-connection-for-the-overcloud.adoc | 4 +++ .../proc_retrieving-the-qdr-password.adoc | 25 +++++++++++++++++++ 5 files changed, 33 insertions(+) create mode 100644 doc-Service-Telemetry-Framework/modules/proc_retrieving-the-qdr-password.adoc diff --git a/doc-Service-Telemetry-Framework/assemblies/assembly_completing-the-stf-configuration.adoc b/doc-Service-Telemetry-Framework/assemblies/assembly_completing-the-stf-configuration.adoc index db479abe..fb6dd127 100644 --- a/doc-Service-Telemetry-Framework/assemblies/assembly_completing-the-stf-configuration.adoc +++ b/doc-Service-Telemetry-Framework/assemblies/assembly_completing-the-stf-configuration.adoc @@ -29,6 +29,7 @@ include::../modules/proc_configuring-red-hat-openstack-platform-overcloud-for-st ifdef::include_when_13,include_when_17[] include::../modules/proc_getting-ca-certificate-from-stf-for-overcloud-configuration.adoc[leveloffset=+2] endif::include_when_13,include_when_17[] +include::../modules/proc_retrieving-the-qdr-password.adoc[leveloffset=+2] include::../modules/proc_retrieving-the-qdr-route-address.adoc[leveloffset=+2] include::../modules/proc_creating-the-base-configuration-for-stf.adoc[leveloffset=+2] include::../modules/proc_configuring-the-stf-connection-for-the-overcloud.adoc[leveloffset=+2] diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf.adoc index ceba9322..c1c73f78 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf.adoc @@ -9,6 +9,7 @@ As part of the {OpenStack} ({OpenStackShort}) overcloud deployment using directo ifdef::include_when_13,include_when_17[] . xref:getting-ca-certificate-from-stf-for-overcloud-configuration_assembly-completing-the-stf-configuration[] endif::include_when_13,include_when_17[] +. xref:retrieving-the-qdr-password_assembly-completing-the-stf-configuration[Retrieving the {MessageBus} password] . xref:retrieving-the-qdr-route-address_assembly-completing-the-stf-configuration[Retrieving the {MessageBus} route address] . xref:creating-the-base-configuration-for-stf_assembly-completing-the-stf-configuration[Creating the base configuration for {ProjectShort}] . xref:configuring-the-stf-connection-for-the-overcloud_assembly-completing-the-stf-configuration[Configuring the {ProjectShort} connection for the overcloud] diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc index 892d1317..f5017fb1 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-director-operator-for-the-overcloud.adoc @@ -40,6 +40,8 @@ data: role: edge verifyHostname: false sslProfile: sslProfile + saslUsername: guest@default-interconnect + saslPassword: pass: MetricsQdrSSLProfiles: - name: sslProfile diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-the-overcloud.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-the-overcloud.adoc index ca02c87b..769fb11c 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-the-overcloud.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-the-overcloud.adoc @@ -9,6 +9,7 @@ To configure the {Project} ({ProjectShort}) connection, you must create a file t ifdef::include_when_13,include_when_17[] * Retrieve the CA certificate from the {MessageBus} deployed by {ProjectShort}. For more information, see xref:getting-ca-certificate-from-stf-for-overcloud-configuration_assembly-completing-the-stf-configuration[]. endif::include_when_13,include_when_17[] +* Retrieve the {MessageBus} password. For more information, see xref:retrieving-the-qdr-password_assembly-completing-the-stf-configuration[]. * Retrieve the {MessageBus} route address. For more information, see xref:retrieving-the-qdr-route-address_assembly-completing-the-stf-configuration[]. // The following configuration should match the contents in modules/proc_creating-openstack-environment-file-for-multiple-clouds.adoc. If you have changes to make, please make the same changes to both files. @@ -41,6 +42,8 @@ parameter_defaults: role: edge verifyHostname: false sslProfile: sslProfile + saslUsername: guest@default-interconnect + saslPassword: pass: MetricsQdrSSLProfiles: - name: sslProfile @@ -68,6 +71,7 @@ endif::[] * The `qdr::router_id` configuration is to override the default value which uses the fully-qualified domain name (FQDN) of the host. In some cases the FQDN can result in a router ID length of greater than 61 characters which results in failed QDR connections. For deployments with shorter FQDN values this is not necessary. * The `resource_registry` configuration directly loads the collectd service because you do not include the `collectd-write-qdr.yaml` environment file for multiple cloud deployments. * Replace the `host` sub-parameter of `MetricsQdrConnectors` with the value that you retrieved in xref:retrieving-the-qdr-route-address_assembly-completing-the-stf-configuration[]. +* Replace the `` portion of the `saslPassword` sub-parameter of `MetricsQdrConnectors` with the value you retrieved in xref:retrieving-the-qdr-password_assembly-completing-the-stf-configuration[]. ifdef::include_when_13,include_when_17[] * Replace the `caCertFileContent` parameter with the contents retrieved in xref:getting-ca-certificate-from-stf-for-overcloud-configuration_assembly-completing-the-stf-configuration[]. endif::include_when_13,include_when_17[] diff --git a/doc-Service-Telemetry-Framework/modules/proc_retrieving-the-qdr-password.adoc b/doc-Service-Telemetry-Framework/modules/proc_retrieving-the-qdr-password.adoc new file mode 100644 index 00000000..f9550217 --- /dev/null +++ b/doc-Service-Telemetry-Framework/modules/proc_retrieving-the-qdr-password.adoc @@ -0,0 +1,25 @@ +[id="retrieving-the-qdr-password_{context}"] += Retrieving the {MessageBus} password + +[role="_abstract"] +When you configure the {OpenStack} ({OpenStackShort}) overcloud for {Project} ({ProjectShort}), you must provide the {MessageBus} password in the {ProjectShort} connection file. + +You can disable basic authentication on the {MessageBus} connection by setting the value of the `transports.qdr.auth` parameter of the ServiceTelemetry spec to `none`. The `transports.qdr.auth` parameter is absent in versions of {ProjectShort} before 1.5.3, so the default behavior is that basic authentication is disabled. In a new install of {ProjectShort} 1.5.3 or later, the default value of `transports.qdr.auth` is `basic`, but if you upgraded to {ProjectShort} 1.5.3, the default value of `transports.qdr.auth` is `none`. + +.Procedure + +. Log in to your {OpenShift} environment where {ProjectShort} is hosted. + +. Change to the `service-telemetry` project: ++ +[source,bash] +---- +$ oc project service-telemetry +---- + +. Retrieve the {MessageBus} password: ++ +[source,bash,options="nowrap",subs="verbatim"] +---- +$ oc get secret default-interconnect-users -o json | jq -r .data.guest | base64 -d +---- From 13e7f216ad43fb6d6d08907e29954a2587030673 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Tue, 24 Oct 2023 08:58:06 -0400 Subject: [PATCH 03/10] Support OCP versions 4.12 through 4.14 (#503) * Support OCP versions 4.12 through 4.14 Update the stf-attributes to cover OCP 4.12 through 4.14 as our default, as OCP 4.10 is EOL. Update the Makefile for building to only cover RHOSP 17.1 and 16.2. * Need html-latest for upstream publish script --- common/global/stf-attributes.adoc | 10 +++++----- doc-Service-Telemetry-Framework/Makefile | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/common/global/stf-attributes.adoc b/common/global/stf-attributes.adoc index 18859528..f4a9091a 100644 --- a/common/global/stf-attributes.adoc +++ b/common/global/stf-attributes.adoc @@ -45,8 +45,8 @@ ifeval::["{build}" == "upstream"] :Project: Service{nbsp}Telemetry{nbsp}Framework :ProjectShort: STF :MessageBus: Apache{nbsp}Qpid{nbsp}Dispatch{nbsp}Router -:SupportedOpenShiftVersion: 4.10 -:NextSupportedOpenShiftVersion: 4.12 +:SupportedOpenShiftVersion: 4.12 +:NextSupportedOpenShiftVersion: 4.14 :CodeReadyContainersVersion: 2.6.0 endif::[] @@ -55,7 +55,7 @@ ifeval::["{build}" == "downstream"] :OpenShiftShort: OCP :OpenStack: Red{nbsp}Hat{nbsp}OpenStack{nbsp}Platform :OpenStackShort: RHOSP -:OpenStackVersion: 17.0 +:OpenStackVersion: 17.1 :OpenStackLong: {OpenStack}{nbsp}{OpenStackVersion} :OpenStackInstaller: director :OVirt: Red{nbsp}Hat{nbsp}Virtualization @@ -63,6 +63,6 @@ ifeval::["{build}" == "downstream"] :Project: Service{nbsp}Telemetry{nbsp}Framework :ProjectShort: STF :MessageBus: AMQ{nbsp}Interconnect -:SupportedOpenShiftVersion: 4.10 -:NextSupportedOpenShiftVersion: 4.12 +:SupportedOpenShiftVersion: 4.12 +:NextSupportedOpenShiftVersion: 4.14 endif::[] diff --git a/doc-Service-Telemetry-Framework/Makefile b/doc-Service-Telemetry-Framework/Makefile index 45501d12..e321f39f 100644 --- a/doc-Service-Telemetry-Framework/Makefile +++ b/doc-Service-Telemetry-Framework/Makefile @@ -24,7 +24,7 @@ endif all: html -html: html-latest html171 html170 html162 html13 +html: html-latest html171 html162 html-latest: prepare $(IMAGES_TS) $(DEST_HTML) From 3802f4a8795c1ded35dfaf73ad98037fedc0225f Mon Sep 17 00:00:00 2001 From: Roger Heslop Date: Tue, 24 Oct 2023 09:24:20 -0500 Subject: [PATCH 04/10] Summary: Replace incorrect stf-connectors.yaml filename with enable-stf.yaml (#504) Tracker: https://bugzilla.redhat.com/show_bug.cgi?id=2239871 Branch: master-BZ-2239871 --- .../modules/proc_importing-dashboards.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc b/doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc index 2f6926b1..f3f53417 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_importing-dashboards.adoc @@ -18,7 +18,7 @@ grafanadashboard.integreatly.org/rhos-dashboard-1 created . Import the cloud dashboard: + [WARNING] -In the `stf-connectors.yaml` file, ensure you set the value of the collectd `virt` plugin parameter `hostname_format` to `name uuid hostname`, otherwise some of the panels on the cloud dashboard display no information. For more information about the `virt` plugin, see link:{defaultURL}/operational_measurements/collectd-plugins_assembly[collectd plugins]. +In the `enable-stf.yaml` file, ensure you set the value of the collectd `virt` plugin parameter `hostname_format` to `name uuid hostname`, otherwise some of the panels on the cloud dashboard display no information. For more information about the `virt` plugin, see link:{defaultURL}/operational_measurements/collectd-plugins_assembly[collectd plugins]. + [source,bash,options="nowrap"] ---- From f94a9963de8610f4a85d85cbb447882208c57586 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Tue, 24 Oct 2023 11:09:56 -0400 Subject: [PATCH 05/10] Clean up the STF install (#505) * Clean up the STF install for OCP 4.12 and later Clean up the STF installation documentation along with a command that will wait for the STO CSV to be ready and then automatically show the dependencies. Also hide contents that are no longer applicable when the supported base version of OCP is greater than 4.10, since OCP 4.10 is now EOL. * Adjust the ifeval to be < 4.12 --- ...ly_installing-the-core-components-of-stf.adoc | 3 +++ .../proc_deploying-observability-operator.adoc | 2 +- ...roc_deploying-service-telemetry-operator.adoc | 16 ++++++++++------ 3 files changed, 14 insertions(+), 7 deletions(-) diff --git a/doc-Service-Telemetry-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc b/doc-Service-Telemetry-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc index 2766dddd..16f7db86 100644 --- a/doc-Service-Telemetry-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc +++ b/doc-Service-Telemetry-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc @@ -44,7 +44,10 @@ endif::[] include::../modules/con_deploying-stf-to-the-openshift-environment.adoc[leveloffset=+1] include::../modules/proc_deploying-observability-operator.adoc[leveloffset=+2] + +ifeval::[{SupportedOpenShiftVersion} < 4.12] include::../modules/proc_deploying-certificate-manager-for-openshift-operator.adoc[leveloffset=+2] +endif::[] include::../modules/proc_deploying-service-telemetry-operator.adoc[leveloffset=+2] diff --git a/doc-Service-Telemetry-Framework/modules/proc_deploying-observability-operator.adoc b/doc-Service-Telemetry-Framework/modules/proc_deploying-observability-operator.adoc index df21123e..3fd2d71e 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_deploying-observability-operator.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_deploying-observability-operator.adoc @@ -41,5 +41,5 @@ EOF ---- $ oc wait --for jsonpath="{.status.phase}"=Succeeded csv --namespace=openshift-operators -l operators.coreos.com/observability-operator.openshift-operators -clusterserviceversion.operators.coreos.com/observability-operator.v0.0.26-230906073415 condition met +clusterserviceversion.operators.coreos.com/observability-operator.v0.0.25 condition met ---- diff --git a/doc-Service-Telemetry-Framework/modules/proc_deploying-service-telemetry-operator.adoc b/doc-Service-Telemetry-Framework/modules/proc_deploying-service-telemetry-operator.adoc index 39cec062..38ca6620 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_deploying-service-telemetry-operator.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_deploying-service-telemetry-operator.adoc @@ -9,7 +9,9 @@ Deploy Service Telemetry Operator on {OpenShift} to provide the supporting Opera .Prerequisites * Installation of Observability Operator which uses Prometheus to store metrics. For more information, see xref:deploying-observability-operator_assembly-installing-the-core-components-of-stf[]. +ifeval::[{SupportedOpenShiftVersion} < 4.12] * Installation of Certificate Manager for OpenShift on {OpenShift} versions prior to 4.12. For more information, see xref:deploying-certificate-manager-for-openshift-operator_assembly-installing-the-core-components-of-stf[] +endif::[] .Procedure @@ -126,16 +128,18 @@ EOF ---- endif::[] -. Validate the Service Telemetry Operator and the dependent operators have their phase as Succeeded. You may need to re-run the command several times until all Operators are available: +. Validate the Service Telemetry Operator and the dependent operators have their phase as Succeeded: + [source,bash,options="nowrap",role="white-space-pre"] ---- -$ oc get csv --namespace service-telemetry +$ oc wait --for jsonpath="{.status.phase}"=Succeeded csv --namespace=service-telemetry -l operators.coreos.com/service-telemetry-operator.service-telemetry ; oc get csv --namespace service-telemetry + +clusterserviceversion.operators.coreos.com/service-telemetry-operator.v1.5.1698100836 condition met NAME DISPLAY VERSION REPLACES PHASE -amq7-interconnect-operator.v1.10.16 Red Hat Integration - AMQ Interconnect 1.10.16 amq7-interconnect-operator.v1.10.4 Succeeded -cert-manager-operator.v1.11.4 cert-manager Operator for Red Hat OpenShift 1.11.4 Succeeded +amq7-interconnect-operator.v1.10.17 Red Hat Integration - AMQ Interconnect 1.10.17 amq7-interconnect-operator.v1.10.4 Succeeded +cert-manager-operator.v1.12.0 cert-manager Operator for Red Hat OpenShift 1.12.0 cert-manager-operator.v1.11.4 Succeeded observability-operator.v0.0.25 Observability Operator 0.0.25 observability-operator.v0.0.22 Succeeded -service-telemetry-operator.v1.5.1691275411 Service Telemetry Operator 1.5.1691275411 Succeeded -smart-gateway-operator.v5.0.1691275406 Smart Gateway Operator 5.0.1691275406 Succeeded +service-telemetry-operator.v1.5.1698100836 Service Telemetry Operator 1.5.1698100836 Succeeded +smart-gateway-operator.v5.0.1698100831 Smart Gateway Operator 5.0.1698100831 Succeeded ---- From 741aba4974b7dacb0096f958d223b51367ce2058 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Tue, 24 Oct 2023 13:16:36 -0400 Subject: [PATCH 06/10] Provide the preferred STF object for deployment (#507) Provide the preferred ServiceTelemetry object for deployments rather than asking the administrator to build a configuration. The provided object will result in a metrics-focused deployment without extra configuration options, which will be a foundation for disconnected installations in the future. --- ...-servicetelemetry-object-in-openshift.adoc | 155 +++++------------- 1 file changed, 42 insertions(+), 113 deletions(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_creating-a-servicetelemetry-object-in-openshift.adoc b/doc-Service-Telemetry-Framework/modules/proc_creating-a-servicetelemetry-object-in-openshift.adoc index 718c21c5..232ae45d 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_creating-a-servicetelemetry-object-in-openshift.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_creating-a-servicetelemetry-object-in-openshift.adoc @@ -6,138 +6,70 @@ Create a `ServiceTelemetry` object in {OpenShift} to result in the Service Telem .Procedure -. To create a `ServiceTelemetry` object that results in an {ProjectShort} deployment that uses the default values, create a `ServiceTelemetry` object with an empty `spec` parameter: +. To create a `ServiceTelemetry` object that results in an {ProjectShort} using the core components for metrics delivery, create a `ServiceTelemetry` object: + [source,yaml,options="nowrap",role="white-space-pre"] ---- $ oc apply -f - < Date: Tue, 24 Oct 2023 22:46:22 -0400 Subject: [PATCH 07/10] Fix various RHOSP links and versions (#508) Fix various links to RHOSP documentation as the paths are different between RHOSP 16.2 and 17.1. Guides were updated but there is no auto-redirect, so we'll need to verify every link that uses defaultURL parameter. This covers the initial ones while working through documentation. Update some older version links and add a new parameter for 17.1 paths specifically. --- common/global/rhosp_attributes.adoc | 5 +++-- common/global/stf-attributes.adoc | 6 +++++- doc-Service-Telemetry-Framework/master.adoc | 12 ++++++------ ...rcloud-for-stf-using-director-operator.adoc | 18 +++++++++++------- ...t-openstack-platform-overcloud-for-stf.adoc | 8 ++++++-- 5 files changed, 31 insertions(+), 18 deletions(-) diff --git a/common/global/rhosp_attributes.adoc b/common/global/rhosp_attributes.adoc index a463d3df..8544c71f 100644 --- a/common/global/rhosp_attributes.adoc +++ b/common/global/rhosp_attributes.adoc @@ -15,7 +15,7 @@ :osp_long: Red Hat OpenStack Platform :osp_acro: RHOSP -:osp_curr_ver: 17.1-Beta +:osp_curr_ver: 17.1 :osp_curr_ver_no_beta: 17.1 :osp_z_stream: 0 @@ -29,5 +29,6 @@ :defaultURL: https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/{osp_curr_ver}/html :defaultCephURL: https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/{CephVernum}/html -:setup-tlse: {defaultURL}/hardening_red_hat_openstack_platform/assembly_securing-rhos-with-tls-and-pki_security_and_hardening#proc_implementing-tls-e-with-ansible_encryption-and-key-management[Implementing TLS-e with Ansible] +// Specific links +:setup-tlse: {defaultURL}/hardening_red_hat_openstack_platform/assembly_securing-rhos-with-tls-and-pki_security_and_hardening#proc_implementing-tls-e-with-ansible_encryption-and-key-management[Implementing TLS-e with Ansible] diff --git a/common/global/stf-attributes.adoc b/common/global/stf-attributes.adoc index f4a9091a..5650ae75 100644 --- a/common/global/stf-attributes.adoc +++ b/common/global/stf-attributes.adoc @@ -28,6 +28,10 @@ ifeval::[{vernum} >= 17.0] :include_when_17: endif::[] +ifeval::[{vernum} == 17.1] +:include_when_17_1: +endif::[] + ifeval::[{ProductVersion} < 1.5] :include_before_stf15: endif::[] @@ -47,7 +51,7 @@ ifeval::["{build}" == "upstream"] :MessageBus: Apache{nbsp}Qpid{nbsp}Dispatch{nbsp}Router :SupportedOpenShiftVersion: 4.12 :NextSupportedOpenShiftVersion: 4.14 -:CodeReadyContainersVersion: 2.6.0 +:CodeReadyContainersVersion: 2.19.0 endif::[] ifeval::["{build}" == "downstream"] diff --git a/doc-Service-Telemetry-Framework/master.adoc b/doc-Service-Telemetry-Framework/master.adoc index d4d7c6dc..b0d9d717 100644 --- a/doc-Service-Telemetry-Framework/master.adoc +++ b/doc-Service-Telemetry-Framework/master.adoc @@ -1,7 +1,7 @@ = Service Telemetry Framework 1.5 OpenStack Documentation Team :imagesdir: images -:vernum: 17.0 +:vernum: 17.1 :toc: left :toclevels: 3 :icons: font @@ -32,9 +32,9 @@ include::assemblies/assembly_installing-the-core-components-of-stf.adoc[leveloff include::assemblies/assembly_completing-the-stf-configuration.adoc[leveloffset=+1] ifeval::["{build}" == "downstream"] -ifdef::include_when_16_2[] +ifdef::include_when_16_2,include_when_17_1[] include::assemblies/assembly_completing-the-stf-configuration-using-director-operator.adoc[leveloffset=+1] -endif::include_when_16_2[] +endif::include_when_16_2,include_when_17_1[] endif::[] //advanced features @@ -46,7 +46,7 @@ include::assemblies/assembly_renewing-the-amq-interconnect-certificate.adoc[leve // removing include::assemblies/assembly_removing-stf-from-the-openshift-environment.adoc[leveloffset=+1] -//collectd plugins - // upgrading to 1.5 -include::assemblies/assembly_upgrading-service-telemetry-framework-to-version-1-5.adoc[leveloffset=+1] +// NOTE: this is no longer being rendered because the expectation is to move from STF 1.4 on OCP 4.8 to STF 1.5 on OCP 4.10, both of which are EOL now. +// if this affects you, please open a customer case to help manage the upgrade, or simply perform a greenfield deployment of STF 1.5 on OCP 4.14. +//include::assemblies/assembly_upgrading-service-telemetry-framework-to-version-1-5.adoc[leveloffset=+1] diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-using-director-operator.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-using-director-operator.adoc index 69d8ff10..63d52520 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-using-director-operator.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf-using-director-operator.adoc @@ -10,9 +10,9 @@ When you deploy the {OpenStack} ({OpenStackShort}) overcloud deployment using di .Procedure // NOTE: not required until available for RHOSP 17.1 -//ifdef::include_when_13,include_when_17[] -//. xref:getting-ca-certificate-from-stf-for-overcloud-configuration_assembly-completing-the-stf-configuration[] -//endif::include_when_13,include_when_17[] +ifdef::include_when_13,include_when_17[] +. xref:getting-ca-certificate-from-stf-for-overcloud-configuration_assembly-completing-the-stf-configuration[] +endif::include_when_13,include_when_17[] . xref:retrieving-the-qdr-route-address_assembly-completing-the-stf-configuration[Retrieving the {MessageBus} route address] . xref:creating-the-base-configuration-for-director-operator-for-stf_assembly-completing-the-stf-configuration-using-director-operator[Creating the base configuration for director Operator for {ProjectShort}] @@ -23,7 +23,11 @@ When you deploy the {OpenStack} ({OpenStackShort}) overcloud deployment using di .Additional resources -* For more information about deploying an OpenStack cloud using director Operator, see https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/{vernum}/html/rhosp_director_operator_for_openshift_container_platform/index -ifdef::include_when_16_1[] -* To collect data through {MessageBus}, see https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/{vernum}/html/operational_measurements/collectd-plugins_assembly#collectd_plugin_amqp1[the amqp1 plug-in]. -endif::include_when_16_1[] +ifdef::include_when_16_2[] +* For more information about deploying an OpenStack cloud using director Operator, see https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html/rhosp_director_operator_for_openshift_container_platform/index +* To collect data through {MessageBus}, see https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html/operational_measurements/collectd-plugins_assembly#collectd_plugin_amqp1[the amqp1 plug-in]. +endif::[] +ifdef::include_when_17_1[] +* For more information about deploying an OpenStack cloud using director Operator, see https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/17.1/html/deploying_an_overcloud_in_a_red_hat_openshift_container_platform_cluster_with_director_operator/index +* To collect data through {MessageBus}, see https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/17.1/html/managing_overcloud_observability/collectd-plugins_assembly#collectd_plugin_amqp1[the amqp1 plug-in]. +endif::[] diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf.adoc index c1c73f78..2b7617c3 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf.adoc @@ -17,7 +17,11 @@ endif::include_when_13,include_when_17[] . xref:validating-clientside-installation_assembly-completing-the-stf-configuration[Validating client-side installation] .Additional resources +ifdef::include_when_16_2[] * For more information about deploying an OpenStack cloud using director, see link:{defaultURL}/director_installation_and_usage/index[Director Installation and Usage]. -ifdef::include_when_16_1[] * To collect data through {MessageBus}, see link:{defaultURL}/operational_measurements/collectd-plugins_assembly#collectd_plugin_amqp1[the amqp1 plug-in]. -endif::include_when_16_1[] +endif::[] +ifdef::include_when_17_1[] +* For more information about deploying an OpenStack cloud using director, see link:{defaultURL}/installing_and_managing_red_hat_openstack_platform_with_director/index[Installing and managing Red Hat OpenStack Platform with director]. +* To collect data through {MessageBus}, see link:{defaultURL}/managing_overcloud_observability/collectd-plugins_assembly#collectd_plugin_amqp1[the amqp1 plug-in]. +endif::[] From 0c8886780c585598603e0d25b7488b56f67f7bf2 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Wed, 25 Oct 2023 09:48:03 -0400 Subject: [PATCH 08/10] Update and adjust dashboard procedures (#509) Update and adjust the dashboard installation procedures based on testing. --- .../assemblies/assembly_advanced-features.adoc | 4 ++-- .../proc_setting-up-grafana-to-host-the-dashboard.adoc | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc b/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc index 13100ea2..28916ec4 100644 --- a/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc +++ b/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc @@ -23,8 +23,8 @@ endif::include_when_16[] include::../modules/con_dashboards.adoc[leveloffset=+1] include::../modules/proc_setting-up-grafana-to-host-the-dashboard.adoc[leveloffset=+2] ifdef::include_when_16[] -include::../modules/proc_overriding-the-default-grafana-container-image.adoc[leveloffset=+2] -//TODO: Add dashboards back when we have working code for OSP13 +// TODO: either rewrite or drop this procedure. We now provide the preferred downstream RHEL Grafana workload image in the deployment procedure. +//include::../modules/proc_overriding-the-default-grafana-container-image.adoc[leveloffset=+2] include::../modules/proc_importing-dashboards.adoc[leveloffset=+2] endif::include_when_16[] include::../modules/proc_retrieving-and-setting-grafana-login-credentials.adoc[leveloffset=+2] diff --git a/doc-Service-Telemetry-Framework/modules/proc_setting-up-grafana-to-host-the-dashboard.adoc b/doc-Service-Telemetry-Framework/modules/proc_setting-up-grafana-to-host-the-dashboard.adoc index ee1a3014..d3de9443 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_setting-up-grafana-to-host-the-dashboard.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_setting-up-grafana-to-host-the-dashboard.adoc @@ -46,7 +46,7 @@ EOF + [source,bash,options="nowrap"] ---- -$ oc wait --for jsonpath="{.status.phase}"=Running csv -l operators.coreos.com/grafana-operator.service-telemetry --timeout=600s +$ oc wait --for jsonpath="{.status.phase}"=Succeeded csv -l operators.coreos.com/grafana-operator.service-telemetry --timeout=600s clusterserviceversion.operators.coreos.com/grafana-operator.v4.10.1 condition met ---- From 0c5a23616500b4272a55ed42e321dfb20b112046 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Wed, 25 Oct 2023 11:08:49 -0400 Subject: [PATCH 09/10] Add deprecation note for Grafana authentication (#510) Deprecate the basic auth login parameters for Grafana login. Preference is to use the Log in for OpenShift button going forward. Fix syntax issues in asciidoc. --- .../modules/proc_configuring-snmp-traps.adoc | 2 +- .../proc_configuring-tls-certificates-duration.adoc | 8 ++++---- .../modules/proc_overriding-a-managed-manifest.adoc | 6 ++++-- ...retrieving-and-setting-grafana-login-credentials.adoc | 9 +++++++-- 4 files changed, 16 insertions(+), 9 deletions(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-traps.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-traps.adoc index 221c16ed..e5d9e6dd 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-traps.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_configuring-snmp-traps.adoc @@ -52,7 +52,7 @@ For more information about available parameters for `snmpTraps`, see xref:config You can create alerts that are configured for delivery by SNMP traps by adding labels that are parsed by the prometheus-webhook-snmp middleware to define the trap information and delivered object identifiers (OID). Adding the `oid` or `severity` labels is only required if you need to change the default values for a particular alert definition. -NOTE:: When you set the oid label, the top-level SNMP trap OID changes, but the sub-OIDs remain defined by the global `trapOidPrefix` value plus the child OID values `.1.1.1` through `.1.1.9`. For more information about the MIB definition, see xref:overview-of-the-mib-definition_{context}[]. +NOTE: When you set the oid label, the top-level SNMP trap OID changes, but the sub-OIDs remain defined by the global `trapOidPrefix` value plus the child OID values `.1.1.1` through `.1.1.9`. For more information about the MIB definition, see xref:overview-of-the-mib-definition_{context}[]. .Procedure diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-tls-certificates-duration.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-tls-certificates-duration.adoc index ccb2fb01..14c6c2d9 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_configuring-tls-certificates-duration.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_configuring-tls-certificates-duration.adoc @@ -8,13 +8,13 @@ To configure the duration of the TLS certificates to use with {Project} ({Projec * You didn't deploy an instance of Service Telemetry Operator already. -NOTE:: When you create the `ServiceTelemetry` object, the required certificates and their secrets for {ProjectShort} are also created. -For more information about how to modify the certificates and the secrets, see: xref:assembly-renewing-the-amq-interconnect-certificate_assembly[] +NOTE: When you create the `ServiceTelemetry` object, the required certificates and their secrets for {ProjectShort} are also created. +For more information about how to modify the certificates and the secrets, see: xref:assembly-renewing-the-amq-interconnect-certificate_assembly[]. The following procedure is valid for new {ProjectShort} deployments. .Procedure -To edit the duration of the TLS certificate, you can set the QDR `caCertDuration`, for example `87600h` for 10 years: +. To edit the duration of the TLS certificate, you can set the QDR `caCertDuration`, for example `87600h` for 10 years: + [source,yaml,options="nowrap",role="white-space-pre"] ---- @@ -41,4 +41,4 @@ EOF ---- $ oc get secret default-interconnect-selfsigned -o jsonpath='{.data.tls\.crt}' | base64 -d | openssl x509 -in - -text | grep "Not After" Not After : Mar 9 21:00:16 2033 GMT ----- \ No newline at end of file +---- diff --git a/doc-Service-Telemetry-Framework/modules/proc_overriding-a-managed-manifest.adoc b/doc-Service-Telemetry-Framework/modules/proc_overriding-a-managed-manifest.adoc index 28bc958c..0a7c8ec6 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_overriding-a-managed-manifest.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_overriding-a-managed-manifest.adoc @@ -34,8 +34,10 @@ $ oc edit servicetelemetry default . To modify the `ServiceTelemetry` object, provide a manifest override parameter and the contents of the manifest to write to {OpenShiftShort} instead of the defaults provided by {ProjectShort}. + -NOTE: The trailing pipe (`|`) after entering the manifest override parameter indicates that the value provided is multi-line. - +[NOTE] +==== +The trailing pipe (`|`) after entering the manifest override parameter indicates that the value provided is multi-line. +==== + [source,yaml,options="nowrap"] ---- diff --git a/doc-Service-Telemetry-Framework/modules/proc_retrieving-and-setting-grafana-login-credentials.adoc b/doc-Service-Telemetry-Framework/modules/proc_retrieving-and-setting-grafana-login-credentials.adoc index 7d986a74..91814037 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_retrieving-and-setting-grafana-login-credentials.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_retrieving-and-setting-grafana-login-credentials.adoc @@ -2,7 +2,12 @@ = Retrieving and setting Grafana login credentials [role="_abstract"] -When Grafana is enabled, you can login using openshift authentication, or the default username and password set by the Grafana Operator. +When Grafana is enabled, you can login using OpenShift authentication, or the default username and password set by the Grafana Operator. + +[WARNING] +==== +Logging in using the default username and password set by the Grafana Operator is deprecated. Use the _Log in with OpenShift_ button to access the dashboards. +==== You can override the credentials in the `ServiceTelemetry` object to have {Project} ({ProjectShort}) set the username and password for Grafana instead. @@ -33,4 +38,4 @@ $ oc edit stf default [source,bash] ---- $ oc get po -l app=grafana -w ----- \ No newline at end of file +---- From c8386aba27662d5b845ee5c3bd07c67d33bcc1c6 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Wed, 25 Oct 2023 13:23:47 -0400 Subject: [PATCH 10/10] Update deprecated Grafana login warning (#511) Update the Grafana login deprecation warning with wording from the documentation team. --- .../proc_retrieving-and-setting-grafana-login-credentials.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/proc_retrieving-and-setting-grafana-login-credentials.adoc b/doc-Service-Telemetry-Framework/modules/proc_retrieving-and-setting-grafana-login-credentials.adoc index 91814037..b158ee74 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_retrieving-and-setting-grafana-login-credentials.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_retrieving-and-setting-grafana-login-credentials.adoc @@ -6,7 +6,7 @@ When Grafana is enabled, you can login using OpenShift authentication, or the de [WARNING] ==== -Logging in using the default username and password set by the Grafana Operator is deprecated. Use the _Log in with OpenShift_ button to access the dashboards. +Ensure that you log in to access the dashboards with the _Log in with OpenShift_ button, because the default username and password set by the Grafana Operator is deprecated. ==== You can override the credentials in the `ServiceTelemetry` object to have {Project} ({ProjectShort}) set the username and password for Grafana instead.