From a14e9dd5fdc1e49e54ec82631b41630881a0512f Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Thu, 1 Jun 2023 16:34:19 -0400 Subject: [PATCH 1/2] Drop reference to ephemeral storage Ephemeral storage is only used for development systems and is not intended or supported for production deployments. Drop reference to ephemeral storage as it should not be used. Closes: rhbz#2189670 --- .../assembly_advanced-features.adoc | 7 --- ...reparing-your-ocp-environment-for-stf.adoc | 1 - .../modules/con_ephemeral-storage.adoc | 32 ------------ .../modules/con_observability-strategy.adoc | 2 +- .../proc_configuring-ephemeral-storage.adoc | 52 ------------------- 5 files changed, 1 insertion(+), 93 deletions(-) delete mode 100644 doc-Service-Telemetry-Framework/modules/con_ephemeral-storage.adoc delete mode 100644 doc-Service-Telemetry-Framework/modules/proc_configuring-ephemeral-storage.adoc diff --git a/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc b/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc index cb00819c..13100ea2 100644 --- a/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc +++ b/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc @@ -11,7 +11,6 @@ You can use the following operational features to provide additional functionali * xref:alerts_assembly-advanced-features[Configuring alerts] * xref:configuring-snmp-traps_assembly-advanced-features[Configuring SNMP traps] * xref:high-availability_assembly-advanced-features[Configuring high availability] -* xref:ephemeral-storage_assembly-advanced-features[Configuring ephemeral storage] * xref:observability-strategy-in-service-telemetry-framework_assembly-advanced-features[Configuring an alternate observability strategy] ifdef::include_when_16[] @@ -56,12 +55,6 @@ endif::include_when_13,include_when_17[] include::../modules/con_high-availability.adoc[leveloffset=+1] include::../modules/proc_configuring-high-availability.adoc[leveloffset=+2] -//Configuring ephemeral storage -include::../modules/con_ephemeral-storage.adoc[leveloffset=+1] -ifeval::["{build}" == "upstream"] -include::../modules/proc_configuring-ephemeral-storage.adoc[leveloffset=+2] -endif::[] - //Observability strategy include::../modules/con_observability-strategy.adoc[leveloffset=+1] include::../modules/proc_configuring-observability-strategy.adoc[leveloffset=+2] diff --git a/doc-Service-Telemetry-Framework/assemblies/assembly_preparing-your-ocp-environment-for-stf.adoc b/doc-Service-Telemetry-Framework/assemblies/assembly_preparing-your-ocp-environment-for-stf.adoc index 6fef49f7..0750256d 100644 --- a/doc-Service-Telemetry-Framework/assemblies/assembly_preparing-your-ocp-environment-for-stf.adoc +++ b/doc-Service-Telemetry-Framework/assemblies/assembly_preparing-your-ocp-environment-for-stf.adoc @@ -17,7 +17,6 @@ endif::[] include::../modules/con_observability-strategy.adoc[leveloffset=+1] include::../modules/con_persistent-volumes.adoc[leveloffset=+1] -include::../modules/con_ephemeral-storage.adoc[leveloffset=+2] include::../modules/con_resource-allocation.adoc[leveloffset=+1] include::../modules/con_network-considerations-for-service-telemetry-framework.adoc[leveloffset=+1] diff --git a/doc-Service-Telemetry-Framework/modules/con_ephemeral-storage.adoc b/doc-Service-Telemetry-Framework/modules/con_ephemeral-storage.adoc deleted file mode 100644 index f1d1c582..00000000 --- a/doc-Service-Telemetry-Framework/modules/con_ephemeral-storage.adoc +++ /dev/null @@ -1,32 +0,0 @@ -// Module included in the following assemblies: -// -// - -// This module can be included from assemblies using the following include statement: -// include::/con_ephemeral-storage.adoc[leveloffset=+1] - -// The file name and the ID are based on the module title. For example: -// * file name: con_my-concept-module-a.adoc -// * ID: [id='con_my-concept-module-a_{context}'] -// * Title: = My concept module A -// -// The ID is used as an anchor for linking to the module. Avoid changing -// it after the module has been published to ensure existing links are not -// broken. -// -// The `context` attribute enables module reuse. Every module's ID includes -// {context}, which ensures that the module has a unique ID even if it is -// reused multiple times in a guide. -// -// In the title, include nouns that are used in the body text. This helps -// readers and search engines find information quickly. -// Do not start the title with a verb. See also _Wording of headings_ -// in _The IBM Style Guide_. -[id="ephemeral-storage_{context}"] -= Ephemeral storage - -[role="_abstract"] -You can use ephemeral storage to run {Project} ({ProjectShort}) without persistently storing data in your {OpenShift} cluster. - -[WARNING] -If you use ephemeral storage, you might experience data loss if a pod is restarted, updated, or rescheduled onto another node. Use ephemeral storage only for development or testing, and not production environments. diff --git a/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc b/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc index 9ceff156..abba388b 100644 --- a/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc @@ -4,4 +4,4 @@ [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}. -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 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 storage is not required for {ProjectShort}. diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-ephemeral-storage.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-ephemeral-storage.adoc deleted file mode 100644 index ef316756..00000000 --- a/doc-Service-Telemetry-Framework/modules/proc_configuring-ephemeral-storage.adoc +++ /dev/null @@ -1,52 +0,0 @@ -[id='configuring-ephemeral-storage_{context}'] -= Configuring ephemeral storage - -[role="_abstract"] -To configure {ProjectShort} components for ephemeral storage, add `...storage.strategy: ephemeral` to the corresponding parameter. For example, to enable ephemeral storage for the Prometheus back end, set `backends.metrics.prometheus.storage.strategy: ephemeral`. Components that support configuration of ephemeral storage include `alerting.alertmanager`, `backends.metrics.prometheus`, and `backends.events.elasticsearch`. You can add ephemeral storage configuration at installation time or, if you already deployed {ProjectShort}, complete the following steps: - -.Procedure - -. Log in to {OpenShift}. -. Change to the `service-telemetry` namespace: -+ -[source,bash] ----- -$ oc project service-telemetry ----- - -. Edit the ServiceTelemetry object: -+ -[source,bash] ----- -$ oc edit stf default ----- - -. Add the `...storage.strategy: ephemeral` parameter to the `spec` section of the relevant component: -+ -[source,yaml] ----- -apiVersion: infra.watch/v1beta1 -kind: ServiceTelemetry -metadata: - name: default - namespace: service-telemetry -spec: - alerting: - enabled: true - alertmanager: - storage: - strategy: ephemeral - backends: - metrics: - prometheus: - enabled: true - storage: - strategy: ephemeral - events: - elasticsearch: - enabled: true - storage: - strategy: ephemeral ----- - -. Save your changes and close the object. From 2eb6d7da8b2c73c3d6ff9d73a9eb9b96edf7420a Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Fri, 2 Jun 2023 07:24:31 -0400 Subject: [PATCH 2/2] Update doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc --- .../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 abba388b..4d27531e 100644 --- a/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc @@ -4,4 +4,4 @@ [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}. -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 storage is not required for {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 `observabilityStrategy` to `none`, then storage backends will not be deployed so persistent storage will not be required by {ProjectShort}.