From 9476f4adb6ab42995b9898d34530720b72f45e8c Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Thu, 2 Nov 2023 13:45:25 -0400 Subject: [PATCH] Use ObservabilityOperator parameter to refer to OBO/COO --- common/global/stf-attributes.adoc | 2 ++ .../modules/con_observability-strategy.adoc | 4 ++-- .../modules/con_stf-architecture.adoc | 3 ++- .../modules/con_support-for-stf.adoc | 2 +- .../modules/proc_deploying-observability-operator.adoc | 6 +++--- .../modules/proc_deploying-service-telemetry-operator.adoc | 2 +- 6 files changed, 11 insertions(+), 8 deletions(-) diff --git a/common/global/stf-attributes.adoc b/common/global/stf-attributes.adoc index 5650ae75..8627eb74 100644 --- a/common/global/stf-attributes.adoc +++ b/common/global/stf-attributes.adoc @@ -37,6 +37,7 @@ ifeval::[{ProductVersion} < 1.5] endif::[] ifeval::["{build}" == "upstream"] +:ObservabilityOperator: Observability{nbsp}Operator :OpenShift: OpenShift :OpenShiftShort: OKD :OpenStack: OpenStack @@ -55,6 +56,7 @@ ifeval::["{build}" == "upstream"] endif::[] ifeval::["{build}" == "downstream"] +:ObservabilityOperator: Cluster{nbsp}Observability{nbsp}Operator :OpenShift: Red{nbsp}Hat{nbsp}OpenShift{nbsp}Container{nbsp}Platform :OpenShiftShort: OCP :OpenStack: Red{nbsp}Hat{nbsp}OpenStack{nbsp}Platform diff --git a/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc b/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc index 997e317c..77e4f74b 100644 --- a/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc @@ -15,13 +15,13 @@ The following values are available: |value |meaning | use_redhat -| Red Hat supported components are requested by {ProjectShort}. This includes Prometheus and Alertmanager from the Observability Operator, but no resource requests to Elastic Cloud on Kubernetes (ECK) Operator. If enabled, resources are also requested from the Grafana Operator (community component). +| Red Hat supported components are requested by {ProjectShort}. This includes Prometheus and Alertmanager from the {ObservabilityOperator}, but no resource requests to Elastic Cloud on Kubernetes (ECK) Operator. If enabled, resources are also requested from the Grafana Operator (community component). | use_hybrid | In addition to the Red Hat supported components, Elasticsearch and Grafana resources are also requested (if specified in the ServiceTelemetry object) | use_community -| The community version of Prometheus Operator is used instead of Observability Operator. Elasticsearch and Grafana resources are also requested (if specified in the ServiceTelemetry object) +| The community version of Prometheus Operator is used instead of {ObservabilityOperator}. Elasticsearch and Grafana resources are also requested (if specified in the ServiceTelemetry object) | none | No storage or alerting components are deployed diff --git a/doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc b/doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc index 0726fcd7..667ab877 100644 --- a/doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc @@ -13,7 +13,8 @@ {ProjectShort} is capable of dealing with both metrics and events information from {OpenStack} ({OpenStackShort}) but the default installation is focused on collection, transport, and storage of metrics information. -Event data can be enabled on {OpenStack}, transported via the message bus, and then forwarded to a user-provided Elasticsearch from the Smart Gateways, but this architecture is deprecated. The discussion in this guide will be focused on the default deployment configuration. For more information about {ProjectShort} when configured with events, see . +Event data can be enabled on {OpenStack}, transported via the message bus, and then forwarded to a user-provided Elasticsearch from the Smart Gateways, but this architecture is deprecated. The discussion in this guide will be focused on the default deployment configuration. +// For more information about {ProjectShort} when configured with events, see . Tracked via https://issues.redhat.com/browse/STF-1552 {ProjectShort} consists of the following components: diff --git a/doc-Service-Telemetry-Framework/modules/con_support-for-stf.adoc b/doc-Service-Telemetry-Framework/modules/con_support-for-stf.adoc index 79a0bf9d..f9bc7c19 100644 --- a/doc-Service-Telemetry-Framework/modules/con_support-for-stf.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_support-for-stf.adoc @@ -2,7 +2,7 @@ = Support for {Project} [role="_abstract"] -Red Hat supports the core Operators and workloads, including {MessageBus}, Observability Operator (Prometheus, Alertmanager), Service Telemetry Operator, and Smart Gateway Operator. Red Hat does not support the community Operators or workload components, inclusive of Elasticsearch, Grafana, and their Operators. +Red Hat supports the core Operators and workloads, including {MessageBus}, {ObservabilityOperator} (Prometheus, Alertmanager), Service Telemetry Operator, and Smart Gateway Operator. Red Hat does not support the community Operators or workload components, inclusive of Elasticsearch, Grafana, and their Operators. You can only deploy {ProjectShort} in a fully connected network environment. You cannot deploy {ProjectShort} in {OpenShift}-disconnected environments or network proxy environments. 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 3fd2d71e..33b29be0 100644 --- a/doc-Service-Telemetry-Framework/modules/proc_deploying-observability-operator.adoc +++ b/doc-Service-Telemetry-Framework/modules/proc_deploying-observability-operator.adoc @@ -1,15 +1,15 @@ :_content-type: PROCEDURE [id="deploying-observability-operator_{context}"] -= Deploying Observability Operator += Deploying {ObservabilityOperator} [role="_abstract"] // TODO: https://access.redhat.com/articles/7011708 covers migration to OBO from community-operators Prometheus Operator. This documentation references community-operators as the installation CatalogSource. It is hoping OBO is available from redhat-operators CatalogSource prior to STF 1.5.3. If so, then we will need to update this. -{Project} ({ProjectShort}) uses other supporting Operators as part of the deployment. {ProjectShort} can resolve most dependencies automatically, but you need to pre-install some Operators, such as Observability Operator, which provides an instance of Prometheus. +{Project} ({ProjectShort}) uses other supporting Operators as part of the deployment. {ProjectShort} can resolve most dependencies automatically, but you need to pre-install some Operators, such as {ObservabilityOperator}, which provides an instance of Prometheus. .Procedure -. To store metrics in Prometheus, enable the Observability Operator by using the community-operators CatalogSource: +. To store metrics in Prometheus, enable the {ObservabilityOperator} by using the community-operators CatalogSource: + [WARNING] ==== 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 38ca6620..d169ac5a 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 @@ -8,7 +8,7 @@ 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[]. +* Installation of {ObservabilityOperator} 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::[]