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 5269a664..76d95135 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 @@ -19,19 +19,23 @@ ifdef::context[:parent-context: {context}] :context: assembly-preparing-your-ocp-environment-for-stf [role="_abstract"] -As you prepare your {OpenShiftShort} environment for {ProjectShort}, you must plan for persistent storage, adequate resources, and event storage: +As you prepare your {OpenShift} environment for {Project} ({ProjectShort}), you must plan for persistent storage, adequate resources, and event storage: * Ensure that persistent storage is available in your {OpenShift} cluster to permit a production grade deployment. For more information, see <>. * Ensure that enough resources are available to run the Operators and the application containers. For more information, see <>. * To install ElasticSearch, you must use a community catalog source. If you do not want to use a community catalog or if you do not want to store events, see <>. + +ifeval::["{build}" == "upstream"] * {ProjectShort} uses ElasticSearch to store events, which requires a larger than normal `vm.max_map_count`. The `vm.max_map_count` value is set by default in {OpenShift}. For more information about how to edit the value of `vm.max_map_count`, see <>. +endif::[] 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_metrics-retention-time-period.adoc[leveloffset=+1] +ifeval::["{build}" == "upstream"] include::../modules/con_node-tuning-operator.adoc[leveloffset=+1] - +endif::[] //reset the context ifdef::parent-context[:context: {parent-context}] diff --git a/doc-Service-Telemetry-Framework/modules/con_metrics-retention-time-period.adoc b/doc-Service-Telemetry-Framework/modules/con_metrics-retention-time-period.adoc index 6fa442a9..993e36e9 100644 --- a/doc-Service-Telemetry-Framework/modules/con_metrics-retention-time-period.adoc +++ b/doc-Service-Telemetry-Framework/modules/con_metrics-retention-time-period.adoc @@ -28,8 +28,9 @@ [role="_abstract"] The default retention time for metrics stored in {ProjectShort} is 24 hours, which provides enough data to allow for trends to develop for the purposes of alerting. To adjust {ProjectShort} for additional metrics retention time, set a new value in `backends.metrics.prometheus.storage.retention`, for example, `7d` for seven days. If you use long retention periods, returning data from heavily populated Prometheus systems can result in queries returning slowly. -For long-term storage, use systems designed for long-term data retention, for example, https://thanos.io/[Thanos]. +For long-term storage, use systems designed for long-term data retention, for example, Thanos. .Additional resources * For recommendations about Prometheus data storage and estimating storage space, see https://prometheus.io/docs/prometheus/latest/storage/#operational-aspects +* For more information about Thanos, see https://thanos.io/