Merge branch 'master' into csibbitt-STF-1320-obo-migration

doc-Service-Telemetry-Framework/Makefile

@@ -4,6 +4,7 @@ ROOTDIR = $(realpath .)
 NAME = $(notdir $(ROOTDIR))
 DEST_DIR = $(BUILD_DIR)/$(NAME)
 DEST_HTML = $(DEST_DIR)/index-$(BUILD).html
+DEST_HTML_171 = $(DEST_DIR)/index-$(BUILD)-171.html
 DEST_HTML_170 = $(DEST_DIR)/index-$(BUILD)-170.html
 DEST_HTML_162 = $(DEST_DIR)/index-$(BUILD)-162.html
 DEST_HTML_13 = $(DEST_DIR)/index-$(BUILD)-13.html
@@ -23,10 +24,12 @@ endif
 
 all: html
 
-html: html-latest html170 html162 html13
+html: html-latest html171 html170 html162 html13
 
 html-latest: prepare $(IMAGES_TS) $(DEST_HTML)
 
+html171: prepare $(IMAGES_TS) $(DEST_HTML_171)
+
 html170: prepare $(IMAGES_TS) $(DEST_HTML_170)
 
 html162: prepare $(IMAGES_TS) $(DEST_HTML_162)
@@ -53,7 +56,10 @@ $(IMAGES_TS): $(IMAGES)
 	touch $(IMAGES_TS)
 
 $(DEST_HTML): $(SOURCES)
-	asciidoctor -a source-highlighter=highlightjs -a highlightjs-languages="yaml,bash" -a highlightjs-theme="monokai" --failure-level WARN -a build=$(BUILD) -a vernum=17.0 -b xhtml5 -d book -o $@ $<
+	asciidoctor -a source-highlighter=highlightjs -a highlightjs-languages="yaml,bash" -a highlightjs-theme="monokai" --failure-level WARN -a build=$(BUILD) -a vernum=17.1 -b xhtml5 -d book -o $@ $<
+
+$(DEST_HTML_171): $(SOURCES)
+	asciidoctor -a source-highlighter=highlightjs -a highlightjs-languages="yaml,bash" -a highlightjs-theme="monokai" --failure-level WARN -a build=$(BUILD) -a vernum=17.1 -b xhtml5 -d book -o $@ $<
 
 $(DEST_HTML_170): $(SOURCES)
 	asciidoctor -a source-highlighter=highlightjs -a highlightjs-languages="yaml,bash" -a highlightjs-theme="monokai" --failure-level WARN -a build=$(BUILD) -a vernum=17.0 -b xhtml5 -d book -o $@ $<

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]

doc-Service-Telemetry-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc

@@ -12,7 +12,6 @@ You can use Operators to load the {Project} ({ProjectShort}) components and obje
 * {MessageBus}
 * Smart Gateway
 * Prometheus and AlertManager
-* Elasticsearch
 * Grafana
 
 .Prerequisites
@@ -39,6 +38,7 @@ endif::[]
 .Additional resources
 
 * For more information about Operators, see the https://docs.openshift.com/container-platform/{NextSupportedOpenShiftVersion}/operators/understanding/olm-what-operators-are.html[_Understanding Operators_] guide.
+* For more information about Operator catalogs, see https://docs.openshift.com/container-platform/{NextSupportedOpenShiftVersion}/operators/understanding/olm-rh-catalogs.html[_Red Hat-provided Operator catalogs_].
 //* For more information about how to remove {ProjectShort} from the {OpenShift} environment, see xref:assembly-removing-stf-from-the-openshift-environment_{}[].
 
 include::../modules/proc_deploying-stf-to-the-openshift-environment.adoc[leveloffset=+1]

doc-Service-Telemetry-Framework/assemblies/assembly_preparing-your-ocp-environment-for-stf.adoc

@@ -11,20 +11,12 @@ To prepare your {OpenShift} environment for {Project} ({ProjectShort}), you must
 * Ensure that you have persistent storage available in your {OpenShift} cluster for a production-grade deployment. For more information, see <<persistent-volumes_assembly-preparing-your-ocp-environment-for-stf>>.
 * Ensure that enough resources are available to run the Operators and the application containers. For more information, see <<resource-allocation_assembly-preparing-your-ocp-environment-for-stf>>.
 * Ensure that you have a fully connected network environment. For more information, see xref:con-network-considerations-for-service-telemetry-framework_assembly-preparing-your-ocp-environment-for-stf[].
-ifeval::["{build}" == "upstream"]
-* {ProjectShort} uses Elasticsearch to store events, which requires a larger than normal `vm.max_map_count` value. 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 <<node-tuning-operator_assembly-preparing-your-ocp-environment-for-stf>>.
-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]
 
-ifeval::["{build}" == "upstream"]
-include::../modules/con_node-tuning-operator.adoc[leveloffset=+1]
-endif::[]
-
 //reset the context
 ifdef::parent-context[:context: {parent-context}]
 ifndef::parent-context[:!context:]

doc-Service-Telemetry-Framework/assemblies/assembly_removing-stf-from-the-openshift-environment.adoc

@@ -11,11 +11,15 @@ Remove {Project} ({ProjectShort}) from an {OpenShift} environment if you no long
 To remove {ProjectShort} from the {OpenShift} environment, you must perform the following tasks:
 
 . Delete the namespace.
+ifeval::["{build}" == "upstream"]
 . Remove the catalog source.
+endif::[]
 . Remove the cert-manager Operator.
 
 include::../modules/proc_deleting-the-namespace.adoc[leveloffset=+1]
+ifeval::["{build}" == "upstream"]
 include::../modules/proc_removing-the-catalogsource.adoc[leveloffset=+1]
+endif::[]
 include::../modules/proc_removing-the-cert-manager-operator.adoc[leveloffset=+1]
 
 //reset the context

doc-Service-Telemetry-Framework/modules/con_high-availability.adoc

@@ -10,7 +10,6 @@ With high availability, {Project} ({ProjectShort}) can rapidly recover from fail
 
 Enabling high availability has the following effects:
 
-* Three Elasticsearch pods run instead of the default one.
 * The following components run two pods instead of the default one:
 ** {MessageBus}
 ** Alertmanager

doc-Service-Telemetry-Framework/modules/con_observability-strategy.adoc

@@ -4,7 +4,7 @@
 [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}.
 
-Instead of having {ProjectShort} create custom resource requests, you can use your own deployments of these applications or other compatible applications.
+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.
 
@@ -21,4 +21,4 @@ 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`.
 
-To migrate an existing {ProjectShort} 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]

doc-Service-Telemetry-Framework/modules/con_persistent-volumes.adoc

@@ -2,7 +2,7 @@
 = Persistent volumes
 
 [role="_abstract"]
-{Project} ({ProjectShort}) uses persistent storage in {OpenShift} to request persistent volumes so that Prometheus and Elasticsearch can store metrics and events.
+{Project} ({ProjectShort}) uses persistent storage in {OpenShift} to request persistent volumes so that Prometheus can store metrics.
 
 When you enable persistent storage through the Service Telemetry Operator, the Persistent Volume Claims (PVC) requested in an {ProjectShort} deployment results in an access mode of RWO (ReadWriteOnce). If your environment contains pre-provisioned persistent volumes, ensure that volumes of RWO are available in the {OpenShift} default configured `storageClass`.
 
@@ -12,5 +12,3 @@ When you enable persistent storage through the Service Telemetry Operator, the P
 * For more information about recommended configurable storage technology in {OpenShift}, see https://docs.openshift.com/container-platform/{NextSupportedOpenShiftVersion}/scalability_and_performance/optimizing-storage.html#recommended-configurable-storage-technology_persistent-storage[Recommended configurable storage technology].
 
 * For more information about configuring persistent storage for Prometheus in {ProjectShort}, see xref:backends-configuring-persistent-storage-for-prometheus_assembly-installing-the-core-components-of-stf[].
-
-* For more information about configuring persistent storage for Elasticsearch in {ProjectShort}, see xref:backends-configuring-persistent-storage-for-elasticsearch_assembly-installing-the-core-components-of-stf[].