From 33389e098a5074e23cadb99fea3028ba00301626 Mon Sep 17 00:00:00 2001 From: Chris Sibbitt Date: Mon, 8 May 2023 16:35:31 -0400 Subject: [PATCH 1/9] use_redhat and migration link --- .../modules/con_observability-strategy.adoc | 21 +++++++++++++++++-- .../modules/con_support-for-stf.adoc | 2 +- 2 files changed, 20 insertions(+), 3 deletions(-) diff --git a/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc b/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc index 9ceff156..baf8fcaf 100644 --- a/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc @@ -2,6 +2,23 @@ = Observability Strategy in Service Telemetry Framework [role="_abstract"] -{Project} ({ProjectShort}) does not include storage backends and alerting tools. {ProjectShort} uses community operators to deploy Prometheus, Alertmanager, Grafana, and Elasticsearch. {ProjectShort} makes requests to these community operators to create instances of each application configured to work with {ProjectShort}. +{Project} ({ProjectShort}) does not include event storage backends or dashboarding tools. {ProjectShort} can optionally use community operators to deploy Elasticsearch and Grafana for those purposes. {ProjectShort} makes requests to these community operators to create instances of each application configured to work with {ProjectShort}. -Instead of having Service Telemetry Operator create custom resource requests, you can use your own deployments of these applications or other compatible applications, and scrape the metrics Smart Gateways for delivery to your own Prometheus-compatible system for telemetry storage. If you set the observability strategy to use alternative backends instead, persistent or ephemeral storage is not required for {ProjectShort}. +Instead of having {ProjectShort} create custom resource requests, you can use your own deployments of these applications or other compatible applications. + +Use the observabilityStrategy property on the {ProjectShort} object to specify which type of obvservability components will be deployed. + +The following values supported: + +| value | meaning | +|-------|---------| +| use_redhat | Only Red Hat supported components are requested by Service Telemetry Operator. This includes Prometheus and Alertmanager from the Observability Operator, but no resource requests to Elasticsearch Operator or Grafana Operator. | +| use_hybrid | In addition to the Red Hat supported components, Elasticsearch and Grafana resources are also requested (if specified in the STF 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 STF object) | +| none | No storage or alerting components are deployed | + +Newly deployed STF environments as of 1.5.3 default to `use_redhat`. + +Existing STF deployments created before 1.5.3 default to `use_community`. + +To migrate an existing STF deployment to `use_redhat`, see https://access.redhat.com/articles/7011708[Migrating STF to fully supported operators] 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 bfb3ebbc..acc401aa 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}, Service Telemetry Operator, and Smart Gateway Operator. Red Hat does not support the community Operators or workload components, such as Elasticsearch, Prometheus, Alertmanager, Grafana, and their Operators. +Red Hat supports the core Operators and workloads, including {MessageBus}, Prometheus Operator, 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. From 5b58a44e3bb177fefc86298967f9baf3e3ca744c Mon Sep 17 00:00:00 2001 From: Chris Sibbitt Date: Tue, 9 May 2023 12:18:24 -0400 Subject: [PATCH 2/9] Update doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc Co-authored-by: Leif Madsen --- .../modules/con_observability-strategy.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc b/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc index baf8fcaf..87416698 100644 --- a/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc @@ -8,7 +8,7 @@ Instead of having {ProjectShort} create custom resource requests, you can use yo Use the observabilityStrategy property on the {ProjectShort} object to specify which type of obvservability components will be deployed. -The following values supported: +The following values are available: | value | meaning | |-------|---------| From c8eaeeaea333d810899a507ef63b176b5c9e374e Mon Sep 17 00:00:00 2001 From: Chris Sibbitt Date: Tue, 9 May 2023 12:18:40 -0400 Subject: [PATCH 3/9] Update doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc Co-authored-by: Leif Madsen --- .../modules/con_observability-strategy.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc b/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc index 87416698..0ae8bb12 100644 --- a/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc @@ -12,7 +12,7 @@ The following values are available: | value | meaning | |-------|---------| -| use_redhat | Only Red Hat supported components are requested by Service Telemetry Operator. This includes Prometheus and Alertmanager from the Observability Operator, but no resource requests to Elasticsearch Operator or Grafana Operator. | +| use_redhat | Only Red Hat supported components are requested by {ProjectShort}. This includes Prometheus and Alertmanager from the Observability Operator, but no resource requests to Elasticsearch Operator or Grafana Operator. | | use_hybrid | In addition to the Red Hat supported components, Elasticsearch and Grafana resources are also requested (if specified in the STF 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 STF object) | | none | No storage or alerting components are deployed | From 69c6600e8511d4c137bfc9c884adb22150e50ee8 Mon Sep 17 00:00:00 2001 From: Chris Sibbitt Date: Tue, 9 May 2023 12:18:49 -0400 Subject: [PATCH 4/9] Update doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc Co-authored-by: Leif Madsen --- .../modules/con_observability-strategy.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc b/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc index 0ae8bb12..33dca5cb 100644 --- a/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc @@ -13,7 +13,7 @@ The following values are available: | value | meaning | |-------|---------| | use_redhat | Only Red Hat supported components are requested by {ProjectShort}. This includes Prometheus and Alertmanager from the Observability Operator, but no resource requests to Elasticsearch Operator or Grafana Operator. | -| use_hybrid | In addition to the Red Hat supported components, Elasticsearch and Grafana resources are also requested (if specified in the STF object) | +| 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 STF object) | | none | No storage or alerting components are deployed | From 38189a52daca9e2ab8b350cdff12ef246fe768cc Mon Sep 17 00:00:00 2001 From: Chris Sibbitt Date: Tue, 9 May 2023 12:19:43 -0400 Subject: [PATCH 5/9] Apply suggestions from code review Co-authored-by: Leif Madsen --- .../modules/con_observability-strategy.adoc | 8 ++++---- .../modules/con_support-for-stf.adoc | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc b/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc index 33dca5cb..093643fb 100644 --- a/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc @@ -14,11 +14,11 @@ The following values are available: |-------|---------| | use_redhat | Only Red Hat supported components are requested by {ProjectShort}. This includes Prometheus and Alertmanager from the Observability Operator, but no resource requests to Elasticsearch Operator or Grafana Operator. | | 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 STF 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) | | none | No storage or alerting components are deployed | -Newly deployed STF environments as of 1.5.3 default to `use_redhat`. +Newly deployed {ProjectShort} environments as of 1.5.3 default to `use_redhat`. -Existing STF deployments created before 1.5.3 default to `use_community`. +Existing {ProjectShort} deployments created before 1.5.3 default to `use_community`. -To migrate an existing STF deployment to `use_redhat`, see https://access.redhat.com/articles/7011708[Migrating STF to fully supported operators] +To migrate an existing {ProjectShort} deployment to `use_redhat`, see https://access.redhat.com/articles/7011708[Migrating STF to fully supported operators] 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 acc401aa..79a0bf9d 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}, Prometheus Operator, 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}, 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. You can only deploy {ProjectShort} in a fully connected network environment. You cannot deploy {ProjectShort} in {OpenShift}-disconnected environments or network proxy environments. From 5d8961e35d64cdb0af593e3286a2e1141fc2259f Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Tue, 5 Sep 2023 14:18:25 -0400 Subject: [PATCH 6/9] Minor typo fix --- .../modules/con_observability-strategy.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc b/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc index ecd5de00..7b175c24 100644 --- a/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc @@ -6,7 +6,7 @@ Instead of having Service Telemetry Operator create custom resource requests, you can use your own deployments of these applications or other compatible applications, and scrape the metrics Smart Gateways for delivery to your own Prometheus-compatible system for telemetry storage. If you set the `observabilityStrategy` to `none`, then storage backends will not be deployed so persistent storage will not be required by {ProjectShort}. -Use the observabilityStrategy property on the {ProjectShort} object to specify which type of obvservability components will be deployed. +Use the observabilityStrategy property on the {ProjectShort} object to specify which type of observability components will be deployed. The following values are available: From 942672f3e3f174778c2f0c98c946989fdeba3484 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Thu, 7 Sep 2023 15:34:05 -0400 Subject: [PATCH 7/9] Visual tweak --- .../modules/con_observability-strategy.adoc | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc b/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc index 7b175c24..75c4537c 100644 --- a/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc @@ -17,8 +17,6 @@ The following values are available: | 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) | | none | No storage or alerting components are deployed | -Newly deployed {ProjectShort} environments as of 1.5.3 default to `use_redhat`. +Newly deployed {ProjectShort} environments as of 1.5.3 default to `use_redhat`. Existing {ProjectShort} deployments created before 1.5.3 default to `use_community`. -Existing {ProjectShort} deployments created before 1.5.3 default to `use_community`. - -To migrate an existing {ProjectShort} deployment to `use_redhat`, see https://access.redhat.com/articles/7011708[Migrating STF to fully supported operators] \ No newline at end of file +To migrate an existing {ProjectShort} deployment to `use_redhat`, see https://access.redhat.com/articles/7011708[Migrating STF to fully supported operators]. \ No newline at end of file From 0244c3d5aa8491bb1f6066a274081b63de7efaf4 Mon Sep 17 00:00:00 2001 From: Chris Sibbitt Date: Thu, 7 Sep 2023 17:14:25 -0400 Subject: [PATCH 8/9] Update doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc Co-authored-by: Leif Madsen --- .../modules/con_observability-strategy.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc b/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc index 75c4537c..0a98e391 100644 --- a/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc @@ -2,7 +2,7 @@ = Observability Strategy in Service Telemetry Framework [role="_abstract"] -{Project} ({ProjectShort}) does not include event storage backends or dashboarding tools. {ProjectShort} can optionally use community operators to deploy Elasticsearch and Grafana for those purposes. {ProjectShort} makes requests to these community operators to create instances of each application configured to work with {ProjectShort}. +{Project} ({ProjectShort}) does not include event storage backends or dashboarding tools. {ProjectShort} can optionally create datasource configurations for Grafana using the community operator to provide a dashboarding interface. Instead of having Service Telemetry Operator create custom resource requests, you can use your own deployments of these applications or other compatible applications, and scrape the metrics Smart Gateways for delivery to your own Prometheus-compatible system for telemetry storage. If you set the `observabilityStrategy` to `none`, then storage backends will not be deployed so persistent storage will not be required by {ProjectShort}. From 41c39dc5d58441e5607334ad1ceca6f7666effdb Mon Sep 17 00:00:00 2001 From: Chris Sibbitt Date: Thu, 7 Sep 2023 17:14:50 -0400 Subject: [PATCH 9/9] Update doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc Co-authored-by: Leif Madsen --- .../modules/con_observability-strategy.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc b/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc index 0a98e391..f113d88a 100644 --- a/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc @@ -12,7 +12,7 @@ The following values are available: | value | meaning | |-------|---------| -| use_redhat | Only Red Hat supported components are requested by {ProjectShort}. This includes Prometheus and Alertmanager from the Observability Operator, but no resource requests to Elasticsearch Operator or Grafana Operator. | +| 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). | | 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) | | none | No storage or alerting components are deployed |