Adjustments and reworking some layouts

doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc

@@ -27,7 +27,6 @@ The following optional features can provide additional functionality to the {Pro
 * xref:configuring-snmp-traps_assembly-advanced-features[]
 * xref:high-availability_assembly-advanced-features[]
 * xref:dashboards_assembly-advanced-features[]
-* xref:configuring-multiple-clouds_assembly-advanced-features[]
 * xref:ephemeral-storage_assembly-advanced-features[]
 * xref:monitoring-resource-usage-of-openstack-services_assembly-advanced-features[]
 * xref:creating-a-route-in-ocp_assembly-advanced-features[]
@@ -50,6 +49,8 @@ include::../modules/proc_configuring-snmp-traps.adoc[leveloffset=+1]
 include::../modules/con_high-availability.adoc[leveloffset=+1]
 include::../modules/proc_configuring-high-availability.adoc[leveloffset=+2]
 
+ifdef::include_when_16[]
+//TODO: Add dashboards back when we have working code for OSP13
 //Dashboards
 include::../modules/con_dashboards.adoc[leveloffset=+1]
 include::../modules/proc_setting-up-grafana-to-host-the-dashboard.adoc[leveloffset=+2]
@@ -59,22 +60,12 @@ include::../modules/proc_monitoring-resource-usage-of-openstack-services.adoc[le
 
 //Monitoring container health
 include::../modules/proc_monitoring-container-health-and-api-status.adoc[leveloffset=+1]
-
-//Connecting multiple clouds
-include::../modules/con_configuring-multiple-clouds.adoc[leveloffset=+1]
-include::../modules/proc_planning-amqp-address-prefixes.adoc[leveloffset=+2]
-include::../modules/proc_deploying-smart-gateways.adoc[leveloffset=+2]
-include::../modules/proc_deleting-the-default-smart-gateways.adoc[leveloffset=+2]
-include::../modules/proc_setting-a-unique-cloud-domain.adoc[leveloffset=+2]
-include::../modules/proc_creating-openstack-environment-file.adoc[leveloffset=+2]
-include::../modules/proc_querying-metrics-data-from-multiple-clouds.adoc[leveloffset=+2]
+endif::include_when_16[]
 
 //Configuring ephemeral storage
 include::../modules/con_ephemeral-storage.adoc[leveloffset=+1]
 include::../modules/proc_configuring-ephemeral-storage.adoc[leveloffset=+2]
 
-
-
 //Exposing services as routes
 include::../modules/proc_creating-a-route-in-ocp.adoc[leveloffset=+1]
 

doc-Service-Telemetry-Framework/assemblies/assembly_completing-the-stf-configuration.adoc

@@ -20,24 +20,43 @@ ifdef::context[:parent-context: {context}]
 :context: assembly-completing-the-stf-configuration
 
 [role="_abstract"]
-To collect metrics, events, or both, and to send them to the {Project} ({ProjectShort}) storage domain, you must configure the {OpenStack} overcloud to enable data collection and transport.
+For collection of metrics, events, or both, and to send them to the {Project} ({ProjectShort}) storage domain, you must configure the {OpenStack} overcloud to enable data collection and transport.
 
-To deploy data collection and transport to {ProjectShort} on {OpenStack} cloud nodes that employ routed L3 domains, such as distributed compute node (DCN) or spine-leaf, see xref:deploying-to-non-standard-network-topologies_assembly-completing-the-stf-configuration[].
+{ProjectShort} can support both single and multiple clouds, with the default configuration in {OpenStack} and {ProjectShort} set up for a single cloud installation. For a single {OpenStack} overcloud deployment with default configuration, see xref:configuring-red-hat-openstack-platform-overcloud-for-stf_assembly-completing-the-stf-configuration[].
 
+To plan your {OpenStack} installation and configuration {ProjectShort} for multiple clouds, see xref:configuring-multiple-clouds_assembly-completing-the-stf-configuration[].
 
-include::../modules/proc_deploying-to-non-standard-network-topologies.adoc[leveloffset=+1]
+As part of an {OpenStack} overcloud deployment, you might need to configure additional features in your environment:
+
+* To deploy data collection and transport to {ProjectShort} on {OpenStack} cloud nodes that employ routed L3 domains, such as distributed compute node (DCN) or spine-leaf, see xref:deploying-to-non-standard-network-topologies_assembly-completing-the-stf-configuration[].
+
+* To send metrics to both Gnocchi and {ProjectShort}, see xref:sending-metrics-to-gnocchi-and-to-stf_assembly-completing-the-stf-configuration[].
 
+// Basic overcloud deployment using default parameters
+include::../modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf.adoc[leveloffset=+1]
 ifdef::include_when_13[]
-include::../modules/proc_getting-ca-certificate-from-stf-for-overcloud-configuration.adoc[leveloffset=+1]
+include::../modules/proc_getting-ca-certificate-from-stf-for-overcloud-configuration.adoc[leveloffset=+2]
 endif::include_when_13[]
+include::../modules/proc_retrieving-the-qdr-route-address.adoc[leveloffset=+2]
+include::../modules/proc_creating-the-base-configuration-for-stf.adoc[leveloffset=+2]
+include::../modules/proc_configuring-the-stf-connection-for-the-overcloud.adoc[leveloffset=+2]
+include::../modules/proc_deploying-the-overcloud.adoc[leveloffset=+2]
+include::../modules/proc_validating-clientside-installation.adoc[leveloffset=+2]
 
-include::../modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf.adoc[leveloffset=+1]
-include::../modules/proc_retrieving-the-qdr-route-address.adoc[leveloffset=+1]
-include::../modules/proc_creating-the-base-configuration-for-stf.adoc[leveloffset=+1]
-include::../modules/proc_configuring-the-stf-connection-for-the-overcloud.adoc[leveloffset=+1]
-include::../modules/proc_deploying-the-overcloud.adoc[leveloffset=+1]
+//Sending metrics to Gnocchi and to STF
 include::../modules/proc_sending-metrics-to-gnocchi-and-to-stf.adoc[leveloffset=+1]
-include::../modules/proc_validating-clientside-installation.adoc[leveloffset=+2]
+
+// Gather information for deployment in non-standard network topologies in the OSP overcloud
+include::../modules/proc_deploying-to-non-standard-network-topologies.adoc[leveloffset=+1]
+
+//Connecting multiple clouds
+include::../modules/con_configuring-multiple-clouds.adoc[leveloffset=+1]
+include::../modules/proc_planning-amqp-address-prefixes.adoc[leveloffset=+2]
+include::../modules/proc_deploying-smart-gateways.adoc[leveloffset=+2]
+include::../modules/proc_deleting-the-default-smart-gateways.adoc[leveloffset=+2]
+include::../modules/proc_setting-a-unique-cloud-domain.adoc[leveloffset=+2]
+include::../modules/proc_creating-openstack-environment-file-for-multiple-clouds.adoc[leveloffset=+2]
+include::../modules/proc_querying-metrics-data-from-multiple-clouds.adoc[leveloffset=+2]
 
 //reset the context
 ifdef::parent-context[:context: {parent-context}]

doc-Service-Telemetry-Framework/master.adoc

@@ -3,6 +3,7 @@ OpenStack Documentation Team <rhos-docs@redhat.com>
 :imagesdir: images
 :vernum: 16.1
 :toc: left
+:toclevels: 3
 :icons: font
 :compat-mode:
 :doctype: book

doc-Service-Telemetry-Framework/modules/con_configuring-multiple-clouds.adoc

@@ -24,15 +24,16 @@
 = Configuring multiple clouds
 
 [role="_abstract"]
-You can configure multiple {OpenStack} clouds to target a single instance of {Project} ({ProjectShort}).
-
-.Procedure
-
-. Plan the AMQP address prefixes that you want to use for each cloud. For more information, see xref:planning-amqp-address-prefixes_assembly-advanced-features[].
-. Deploy metrics and events consumer Smart Gateways for each cloud to listen on the corresponding address prefixes. For more information, see xref:deploying-smart-gateways_assembly-advanced-features[].
-. Configure each cloud with a unique domain name. For more information, see xref:setting-a-unique-cloud-domain_assembly-advanced-features[].
-. Configure each cloud to send its metrics and events to {ProjectShort} on the correct address. For more information, see xref:creating-openstack-environment-file_assembly-advanced-features[].
+You can configure multiple {OpenStack} clouds to target a single instance of {Project} ({ProjectShort}). When configuring multiple clouds, every cloud must send metrics and events on their own unique message bus topic. In the {ProjectShort} deployment, Smart Gateway instances listen on these topics in order to save information to the common data store. Data that is stored by the Smart Gateway in the data storage domain is filtered by using the metadata created by each of the Smart Gateways.
 
 [[osp-stf-multiple-clouds]]
 .Two {OpenStack} clouds connect to {ProjectShort}
 image::OpenStack_STF_Overview_37_0919_topology.png[An example of two {OpenStack} clouds connecting to {ProjectShort}]
+
+To configure the {OpenStack} overcloud for a multiple cloud scenario, complete the following tasks:
+
+. Plan the AMQP address prefixes that you want to use for each cloud. For more information, see xref:planning-amqp-address-prefixes_assembly-completing-the-stf-configuration[].
+. Deploy metrics and events consumer Smart Gateways for each cloud to listen on the corresponding address prefixes. For more information, see xref:deploying-smart-gateways_assembly-completing-the-stf-configuration[].
+. Configure each cloud with a unique domain name. For more information, see xref:setting-a-unique-cloud-domain_assembly-completing-the-stf-configuration[].
+. Create the base configuration for {ProjectShort}. For more information, see xref:creating-the-base-configuration-for-stf_assembly-completing-the-stf-configuration[].
+. Configure each cloud to send its metrics and events to {ProjectShort} on the correct address. For more information, see xref:creating-openstack-environment-file-for-multiple-clouds_assembly-completing-the-stf-configuration[].

doc-Service-Telemetry-Framework/modules/con_overview-of-the-servicetelemetry-object.adoc

@@ -42,7 +42,7 @@ Each of these top-level configuration parameters provides various controls for a
 Support for `servicetelemetry.infra.watch/v1alpha1` was removed from {ProjectShort} 1.3.
 ====
 
-
+[id="backends_{context}"]
 == backends
 
 Use the `backends` parameter to control which storage backends are available for storage of metrics and events, and to control the enablement of Smart Gateways, as defined by the `clouds` parameter. For more information, see xref:clouds_assembly-installing-the-core-components-of-stf[].
@@ -70,12 +70,29 @@ spec:
         enabled: true
 ----
 
-
 === Enabling ElasticSearch as a storage backend for events
 
 To enable events support in {ProjectShort}, you must enable the Elastic Cloud for Kubernetes Operator. For more information, see xref:subscribing-to-the-elastic-cloud-on-kubernetes-operator_assembly-installing-the-core-components-of-stf[].
 
-By default, ElasticSearch storage of events is disabled. For more information, see xref:deploying-stf-to-the-openshift-environment-without-elasticsearch_assembly-installing-the-core-components-of-stf[].
+By default, ElasticSearch storage of events is disabled. For more information, see xref:deploying-stf-to-the-openshift-environment-with-elasticsearch_assembly-installing-the-core-components-of-stf[].
+
+.Procedure
+
+* To enable ElasticSearch as a storage backend for events, configure the `ServiceTelemetry` object:
++
+[source,yaml]
+----
+apiVersion: infra.watch/v1beta1
+kind: ServiceTelemetry
+metadata:
+  name: default
+  namespace: service-telemetry
+spec:
+  backends:
+    events:
+      elasticsearch:
+        enabled: true
+----
 
 [id="clouds_{context}"]
 == clouds
@@ -124,7 +141,6 @@ Use the `alerting` parameter to control creation of an link:https://prometheus.i
 
 Use the `graphing` parameter to control the creation of a link:https://grafana.com/docs/grafana/latest/getting-started/what-is-grafana/[Grafana] instance. By default, `graphing` is disabled. For more information, see xref:dashboards_assembly-advanced-features[].
 
-
 [id="highAvailability_{context}"]
 == highAvailability
 

doc-Service-Telemetry-Framework/modules/proc_configuring-red-hat-openstack-platform-overcloud-for-stf.adoc

@@ -28,6 +28,9 @@ To configure the {OpenStack} overcloud, you must configure the data collection a
 
 To configure the {OpenStack} overcloud, complete the following tasks:
 
+ifdef::include_when_13[]
+. xref:getting-ca-certificate-from-stf-for-overcloud-configuration_assembly-completing-the-stf-configuration[]
+endif::include_when_13[]
 . xref:retrieving-the-qdr-route-address_assembly-completing-the-stf-configuration[]
 . xref:creating-the-base-configuration-for-stf_assembly-completing-the-stf-configuration[]
 . xref:configuring-the-stf-connection-for-the-overcloud_assembly-completing-the-stf-configuration[]

doc-Service-Telemetry-Framework/modules/proc_configuring-the-stf-connection-for-the-overcloud.adoc

@@ -25,10 +25,13 @@
 = Configuring the {ProjectShort} connection for the overcloud
 
 [role="_abstract"]
-To configure the {ProjectShort} connection, you must create a file that contains the connection configuration of the {MessageBus} for the overcloud to the {ProjectShort} deployment. Enable the collection of events and storage of the events in {ProjectShort} and deploy the overcloud. The configuration is set up for a single cloud instance with the default message bus topics. For configuration of multiple cloud deployments, see xref:configuring-multiple-clouds_assembly-advanced-features[].
+To configure the {ProjectShort} connection, you must create a file that contains the connection configuration of the {MessageBus} for the overcloud to the {ProjectShort} deployment. Enable the collection of events and storage of the events in {ProjectShort} and deploy the overcloud. The configuration is set up for a single cloud instance with the default message bus topics. For configuration of multiple cloud deployments, see xref:configuring-multiple-clouds_assembly-completing-the-stf-configuration[].
 
 .Prerequisites
 
+ifdef::include_when_13[]
+* Retrieve the CA certificate from the {MessageBus} deployed by {ProjectShort}. For more information, see xref:getting-ca-certificate-from-stf-for-overcloud-configuration_assembly-completing-the-stf-configuration[].
+endif::include_when_13[]
 * Retrieve the {MessageBus} route address. For more information, see xref:retrieving-the-qdr-route-address_assembly-completing-the-stf-configuration[].
 
 .Procedure
@@ -38,36 +41,27 @@ To configure the {ProjectShort} connection, you must create a file that contains
 . Create a configuration file called `stf-connectors.yaml` in the `/home/stack` directory.
 
 . In the `stf-connectors.yaml` file, configure the `MetricsQdrConnectors` address to connect the {MessageBus} on the overcloud to the {ProjectShort} deployment.
-* Replace the `host` parameter with the value of `HOST/PORT` that you retrieved in xref:retrieving-the-qdr-route-address[]:
-+
+* Replace the `host` parameter with the value of `HOST/PORT` that you retrieved in xref:retrieving-the-qdr-route-address_assembly-completing-the-stf-configuration[].
 ifdef::include_when_13[]
+* Replace the `caCertFileContent` parameter with the contents retrieved in xref:getting-ca-certificate-from-stf-for-overcloud-configuration_assembly-completing-the-stf-configuration[].
+endif::include_when_13[]
++
 [source,yaml,options="nowrap",subs="+quotes"]
 ----
 parameter_defaults:
     MetricsQdrConnectors:
-    - host: default-interconnect-5671-service-telemetry.apps.stf.cloudops.psi.redhat.com
+    - host: default-interconnect-5671-service-telemetry.apps.infra.watch
       port: 443
       role: edge
       sslProfile: sslProfile
       verifyHostname: false
 
     MetricsQdrSSLProfiles:
     -   name: sslProfile
+ifdef::include_when_13[]
         caCertFileContent: |
           ----BEGIN CERTIFICATE----
           <snip>
           ----END CERTIFICATE----
-----
 endif::include_when_13[]
-ifdef::include_when_16[]
-[source,yaml,options="nowrap",subs="+quotes"]
-----
-parameter_defaults:
-    MetricsQdrConnectors:
-    - host: default-interconnect-5671-service-telemetry.apps.infra.watch
-      port: 443
-      role: edge
-      sslProfile: sslProfile
-      verifyHostname: false
 ----
-endif::include_when_16[]

doc-Service-Telemetry-Framework/modules/proc_creating-a-namespace.adoc

@@ -29,6 +29,7 @@ Create a namespace to hold the {ProjectShort} components. The `service-telemetry
 
 * Enter the following command:
 +
+[source,bash]
 ----
 $ oc new-project service-telemetry
 ----

doc-Service-Telemetry-Framework/modules/proc_creating-an-alert-rule-in-prometheus.adoc

@@ -55,9 +55,10 @@ spec:
     - name: ./openstack.rules
       rules:
         - alert: Metric Listener down
-          expr: collectd_qpid_router_status < 1 # To change the rule, edit the value of the expr parameter.
+          expr: collectd_qpid_router_status < 1 # <1>
 EOF
 ----
+<1> To change the rule, edit the value of the expr parameter.
 
 . To verify that the rules have been loaded into Prometheus by the Operator, create a pod with access to `curl`:
 +