From 02058c82b8a222feadb6c267102f09b03f1d40a9 Mon Sep 17 00:00:00 2001 From: infrawatch-bot Date: Tue, 5 Dec 2023 17:55:34 +0000 Subject: [PATCH] [ci skip] publishing updated documentation... --- index-upstream-162.html | 53 +++++++++++++++++++---------------------- index-upstream-171.html | 53 +++++++++++++++++++---------------------- index.html | 53 +++++++++++++++++++---------------------- 3 files changed, 75 insertions(+), 84 deletions(-) diff --git a/index-upstream-162.html b/index-upstream-162.html index 9e686815..4f2ab3bf 100644 --- a/index-upstream-162.html +++ b/index-upstream-162.html @@ -1100,7 +1100,7 @@

Deploying Observability Operator

-

The Cluster Observability Operator (COO) must be pre-installed before creating an instance of Service Telemetry Framework (STF) if the observabilityStrategy is set to use_redhat and the backends.metrics.prometheus.enabled is set to true in the ServiceTelemetry object. For more information about COO, see Cluster Observability Operator overview in the OpenShift Container Platform Documentation.

+

You must install the Cluster Observability Operator (COO) before you create an instance of Service Telemetry Framework (STF) if the observabilityStrategy is set to use_redhat and the backends.metrics.prometheus.enabled is set to true in the ServiceTelemetry object. For more information about COO, see Cluster Observability Operator overview in the OpenShift Container Platform Documentation.

Procedure
@@ -1109,7 +1109,7 @@ 

$ oc create -f - <<EOF
@@ -1129,7 +1129,7 @@ 

 

 
$ oc wait --for jsonpath="{.status.phase}"=Succeeded csv --namespace=openshift-operators -l operators.coreos.com/cluster-observability-operator.openshift-operators
@@ -1518,7 +1518,7 @@ 

 
Primary parameters of the ServiceTelemetry object

 

-
The ServiceTelemetry object comprises the following primary configuration parameters:

+
You can set the following primary configuration parameters of the ServiceTelemetry object to configure your STF deployment:

 

 

 
    
@@ -1542,15 +1542,12 @@ 
    
-
    You can configure each of these configuration parameters to provide different features in an STF deployment.
    
-

 
The backends parameter

 

-
Use the backends parameter to control which storage back ends are available for storage of metrics and events, and to control the enablement of Smart Gateways that the clouds parameter defines. For more information, see The clouds parameter.

+
Set the value of the backends parameter to allocate the storage back ends for metrics and events, and to enable the Smart Gateways that the clouds parameter defines. For more information, see The clouds parameter.

 

 

-
You can use Prometheus as the metrics storage back end and Elasticsearch as the events storage back end. The Service Telemetry Operator can create custom resource objects that the Prometheus Operator watches to create a Prometheus workload. For storage of events, an external deployment of Elasticsearch is required.

+
You can use Prometheus as the metrics storage back end and Elasticsearch as the events storage back end. The Service Telemetry Operator can create custom resource objects that the Prometheus Operator watches to create a Prometheus workload. You need an external deployment of Elasticsearch to store events.

 

 
Enabling Prometheus as a storage back end for metrics

 

@@ -1589,13 +1586,13 @@ 

 
Configuring persistent storage for Prometheus

 

-
Use the additional parameters that are defined in backends.metrics.prometheus.storage.persistent to configure persistent storage options for Prometheus, such as storage class and volume size.

+
Set the additional parameters in backends.metrics.prometheus.storage.persistent to configure persistent storage options for Prometheus, such as storage class and volume size.

 

 

-
Use storageClass to define the back end storage class. If you do not set this parameter, the Service Telemetry Operator uses the default storage class for the OpenShift cluster.

+
Define the back end storage class with the storageClass parameter. If you do not set this parameter, the Service Telemetry Operator uses the default storage class for the OpenShift cluster.

 

 

-
Use the pvcStorageRequest parameter to define the minimum required volume size to satisfy the storage request. If volumes are statically defined, it is possible that a volume size larger than requested is used. By default, Service Telemetry Operator requests a volume size of 20G (20 Gigabytes).

+
Define the minimum required volume size for the storage request with the pvcStorageRequest parameter. By default, Service Telemetry Operator requests a volume size of 20G (20 Gigabytes).

 

 

 
Procedure

@@ -1621,7 +1618,7 @@ 

 

 
apiVersion: infra.watch/v1beta1
@@ -1654,7 +1651,7 @@ 

 

-
Older versions of STF would manage Elasticsearch objects for the community supported Elastic Cloud on Kubernetes Operator (ECK). Elasticsearch management functionality is deprecated as of STF 1.5.3. Future versions of Service Telemetry Operator will continue to support forwarding to an existing Elasticsearch instance (which can be deployed and managed by ECK), but will not manage the creation of Elasticsearch objects. When upgrading an STF deployment, any existing Elasticsearch object and deployment will remain intact, but will no longer be managed by STF.

+
Previous versions of STF managed Elasticsearch objects for the community supported Elastic Cloud on Kubernetes Operator (ECK). Elasticsearch management functionality is deprecated in STF 1.5.3. You can still forward to an existing Elasticsearch instance that you deploy and manage with ECK, but you cannot manage the creation of Elasticsearch objects. When you upgrade your STF deployment, existing Elasticsearch objects and deployments remain, but are no longer managed by STF.

 

 
 
@@ -1675,7 +1672,7 @@