Jof 1967679 doc sweep (#197)

* https://bugzilla.redhat.com/show_bug.cgi?id=1967679 Sweep for edits pre 1.3 * Minor edits to Gnocchi file * Update doc-Service-Telemetry-Framework/modules/proc_creating-a-servicetelemetry-object-in-openshift.adoc * Update doc-Service-Telemetry-Framework/modules/proc_setting-up-grafana-to-host-the-dashboard.adoc Co-authored-by: Leif Madsen <[email protected]>
infrawatch · Jun 3, 2021 · 6f4137b · 6f4137b
1 parent 0afab09
commit 6f4137b
Show file tree

Hide file tree

Showing 12 changed files with 51 additions and 75 deletions.
diff --git a/common/stf-attributes.adoc b/common/stf-attributes.adoc
@@ -33,6 +33,7 @@ ifeval::["{build}" == "upstream"]
 :ProjectShort: STF
 :MessageBus: Apache{nbsp}Qpid{nbsp}Dispatch{nbsp}Router
 :SupportedOpenShiftVersion: 4.6
+:NextSupportedOpenShiftVersion: 4.7
 endif::[]
 
 ifeval::["{build}" == "downstream"]
@@ -48,4 +49,5 @@ ifeval::["{build}" == "downstream"]
 :ProjectShort: STF
 :MessageBus: AMQ{nbsp}Interconnect
 :SupportedOpenShiftVersion: 4.6
+:NextSupportedOpenShiftVersion: 4.7
 endif::[]
diff --git a/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc b/doc-Service-Telemetry-Framework/assemblies/assembly_advanced-features.adoc
@@ -55,6 +55,12 @@ include::../modules/con_dashboards.adoc[leveloffset=+1]
 include::../modules/proc_setting-up-grafana-to-host-the-dashboard.adoc[leveloffset=+2]
 include::../modules/ref_the-grafana-infrastructure-dashboard.adoc[leveloffset=+2]
 
+//Monitoring the resource usage of Openstack services
+include::../modules/proc_monitoring-resource-usage-of-openstack-services.adoc[leveloffset=+1]
+
+//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]
@@ -68,11 +74,7 @@ include::../modules/proc_querying-metrics-data-from-multiple-clouds.adoc[levelof
 include::../modules/con_ephemeral-storage.adoc[leveloffset=+1]
 include::../modules/proc_configuring-ephemeral-storage.adoc[leveloffset=+2]
 
-//Monitoring the resource usage of Openstack services
-include::../modules/proc_monitoring-resource-usage-of-openstack-services.adoc[leveloffset=+1]
 
-//Monitoring container health
-include::../modules/proc_monitoring-container-health-and-api-status.adoc[leveloffset=+1]
 
 //Exposing services as routes
 include::../modules/proc_creating-a-route-in-ocp.adoc[leveloffset=+1]

diff --git a/...emetry-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc b/...emetry-Framework/assemblies/assembly_installing-the-core-components-of-stf.adoc
@@ -25,13 +25,13 @@ You can use Operators to load the various application components and objects. Ea
 
 .Prerequisites
 
-* {OpenShift} ({OpenShiftShort}) version 4.5 or 4.6 is running.
+* {OpenShift} ({OpenShiftShort}) version {SupportedOpenShiftVersion} or {NextSupportedOpenShiftVersion} is running.
 * You have prepared your {OpenShift} ({OpenShiftShort}) environment and ensured that there is persistent storage and enough resources to run the {ProjectShort} components on top of the {OpenShiftShort} environment.
 
 
 ifeval::["{build}" == "downstream"]
 [IMPORTANT]
-{Project} ({ProjectShort}) is compatible with {OpenShift} versions 4.5 and 4.6.
+{Project} ({ProjectShort}) is compatible with {OpenShift} versions {SupportedOpenShiftVersion} and {NextSupportedOpenShiftVersion}.
 
 //For more information about migrating, see https://access.redhat.com/articles/5477371[Migrating Service Telemetry Framework v1.0 from OperatorSource to CatalogSource].
 endif::[]

diff --git a/doc-Service-Telemetry-Framework/modules/con_high-availability.adoc b/doc-Service-Telemetry-Framework/modules/con_high-availability.adoc
@@ -28,7 +28,7 @@
 [role="_abstract"]
 High availability is the ability of {Project} ({ProjectShort}) to rapidly recover from failures in its component services. Although {OpenShift} ({OpenShiftShort}) restarts a failed pod if nodes are available to schedule the workload, this recovery process might take more than one minute, during which time events and metrics are lost. A high availability configuration includes multiple copies of {ProjectShort} components, reducing recovery time to approximately 2 seconds. To protect against failure of an {OpenShiftShort} node, deploy {ProjectShort} to an {OpenShiftShort} cluster with three or more nodes.
 
-[NOTE]
+[WARNING]
 {ProjectShort} is not yet a fully fault tolerant system. Delivery of metrics and events during the recovery period is not guaranteed.
 
 Enabling high availability has the following effects:
@@ -39,8 +39,5 @@ Enabling high availability has the following effects:
 ** Alertmanager
 ** Prometheus
 ** Events Smart Gateway
-** Collectd Metrics Smart Gateway
+** Metrics Smart Gateway
 * Recovery time from a lost pod in any of these services reduces to approximately 2 seconds.
-
-[NOTE]
-The Ceilometer Metrics Smart Gateway is not yet HA.
diff --git a/...ce-Telemetry-Framework/modules/con_overview-of-the-servicetelemetry-object.adoc b/...ce-Telemetry-Framework/modules/con_overview-of-the-servicetelemetry-object.adoc
@@ -39,10 +39,7 @@ Each of these top-level configuration parameters provides various controls for a
 
 [IMPORTANT]
 ====
-Versions of Service Telemetry Operator prior to v1.1.0 used a flat API (`servicetelemetry.infra.watch/v1alpha1`) interface for creating the `ServiceTelemetry` object.
-In Service Telemetry Operator v1.1.0, there is a dictionary-based API interface (`servicetelemetry.infra.watch/v1beta1`) to allow for better control of {ProjectShort} deployments, including managing multi-cluster deployments natively, and allowing the management of additional storage backends in the future. Ensure that any previously created `ServiceTelemetry` objects are updated to the new interface.
-
-Support for `servicetelemetry.infra.watch/v1alpha1` will be removed in {ProjectShort} 1.3.
+Support for `servicetelemetry.infra.watch/v1alpha1` was removed from {ProjectShort} 1.3.
 ====
 
 

diff --git a/doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc b/doc-Service-Telemetry-Framework/modules/con_stf-architecture.adoc
@@ -62,7 +62,7 @@ If you plan to collect and store events, collectd or Ceilometer delivers event d
 Server-side {ProjectShort} monitoring infrastructure consists of the following layers:
 
 * {Project} {ProductVersion} ({ProjectShort})
-* {OpenShift} {SupportedOpenShiftVersion} ({OpenShiftShort}) or 4.6
+* {OpenShift} {SupportedOpenShiftVersion} ({OpenShiftShort}) or {NextSupportedOpenShiftVersion}
 * Infrastructure platform
 
 [[osp-stf-server-side-monitoring]]

diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-gnocchi-metrics.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-gnocchi-metrics.adoc
@@ -2,7 +2,7 @@
 
 [role="_abstract"]
 
-To send metrics to {Project} ({ProjectShort}} and gnocchi simultaneously, you must include an environment file to your deployment to enable an additional publisher.
+To send metrics to {Project} ({ProjectShort}} and Gnocchi simultaneously, you must include an environment file in your deployment to enable an additional publisher.
 
 .Prerequisites
 
@@ -68,4 +68,4 @@ sinks:
           - notifier://172.17.1.35:5666/?driver=amqp&topic=metering
 ----
 +
-Ensure that the `publishers` section of the file contains information for both notifier and gnocchi.
+Ensure that the `publishers` section of the file contains information for both notifier and Gnocchi.
diff --git a/...try-Framework/modules/proc_creating-a-servicetelemetry-object-in-openshift.adoc b/...try-Framework/modules/proc_creating-a-servicetelemetry-object-in-openshift.adoc
@@ -30,7 +30,7 @@ Create a `ServiceTelemetry` object in {OpenShiftShort} to result in the creation
 
 .Procedure
 
-. To create a `ServiceTelemetry` object that results in a default {ProjectShort} deployment, create a `ServiceTelemetry` object with an empty `spec` object:
+. To create a `ServiceTelemetry` object that results in an {ProjectShort} deployment that uses the default values, create a `ServiceTelemetry` object with an empty `spec` parameter.
 +
 [source,bash]
 ----
@@ -44,7 +44,25 @@ spec: {}
 EOF
 ----
 +
-Creating a default `ServiceTelemetry` object results in a {ProjectShort} deployment with the following defaults:
+To override a default value, you need to define only the parameter that you want to override. In this example, you enable ElasticSearch by setting `enabled` to `true`:
++
+[source,yaml]
+----
+$ oc apply -f - <<EOF
+apiVersion: infra.watch/v1beta1
+kind: ServiceTelemetry
+metadata:
+  name: default
+  namespace: service-telemetry
+spec:
+  backends:
+    events:
+      elasticsearch:
+        enabled: true
+EOF
+----
++
+Creating a `ServiceTelemetry` object with an empty `spec` parameter results in an {ProjectShort} deployment with the following defaults. To override these defaults, add the configuration to the spec parameter:
 +
 [source,yaml]
 ----
@@ -109,24 +127,6 @@ spec:
             subscriptionAddress: anycast/ceilometer/event.sample
 ----
 
-. Optional: To create a `ServiceTelemetry` object that results in collection and storage of events for the default cloud, enable the ElasticSearch backend:
-+
-[source,yaml]
-----
-$ oc apply -f - <<EOF
-apiVersion: infra.watch/v1beta1
-kind: ServiceTelemetry
-metadata:
-  name: default
-  namespace: service-telemetry
-spec:
-  backends:
-    events:
-      elasticsearch:
-        enabled: true
-EOF
-----
-
 . To view the {ProjectShort} deployment logs in the Service Telemetry Operator, use the `oc logs` command:
 +
 [source,bash]

diff --git a/doc-Service-Telemetry-Framework/modules/proc_deploying-smart-gateways.adoc b/doc-Service-Telemetry-Framework/modules/proc_deploying-smart-gateways.adoc
@@ -40,7 +40,7 @@ When you deploy {ProjectShort} for the first time, Smart Gateway manifests are c
 
 * You have determined your cloud naming scheme. For more information about determining your naming scheme, see xref:planning-amqp-address-prefixes_assembly-advanced-features[].
 
-* You have created your list of clouds objects.  For more information about creating the content for the `clouds` parameter, see xref:clouds_assembly-installing-the-core-components-of-stf[].
+* You have created your list of clouds objects. For more information about creating the content for the `clouds` parameter, see xref:clouds_assembly-installing-the-core-components-of-stf[].
 
 .Procedure
 

diff --git a/...ramework/modules/proc_enabling-the-operatorhub-io-community-catalog-source.adoc b/...ramework/modules/proc_enabling-the-operatorhub-io-community-catalog-source.adoc
@@ -24,7 +24,10 @@
 = Enabling the OperatorHub.io Community Catalog Source
 
 [role="_abstract"]
-Before you install ElasticSearch, you must have access to the resources on the OperatorHub.io Community Catalog Source:
+Before you install ElasticSearch, you must have access to the resources on the OperatorHub.io Community Catalog Source.
+
+[NOTE]
+All operators installed from this Catalog source are not supported by Red Hat. 
 
 .Procedure
 

diff --git a/...-Telemetry-Framework/modules/proc_setting-up-grafana-to-host-the-dashboard.adoc b/...-Telemetry-Framework/modules/proc_setting-up-grafana-to-host-the-dashboard.adoc
@@ -172,25 +172,23 @@ The `HOST/PORT` value is the Grafana route address.
 . To view the dashboard, click *Dashboards* and *Manage*.
 
 
-[id="viewing-and-editing-queries"]
-= Viewing and editing queries
+[id="proc-retrieving-and-setting-grafana-credentials"]
+= Retrieving and setting Grafana login credentials
 
 .Procedure
 
-. Log in to {OpenShift}. To view and edit queries, log in as the `admin` user.
+. Log in to {OpenShift}.
 . Change to the `service-telemetry` namespace:
 +
 [source,bash]
 ----
 $ oc project service-telemetry
 ----
-
-. To retrieve the default username and password, describe the Grafana object using the `oc describe` command:
+. To retrieve the default username and password, describe the Grafana object:
 +
 [source,bash]
 ----
 $ oc describe grafana default
 ----
-+
-[TIP]
-To set the admin username and password through the `ServiceTelemetry` object, use the `graphing.grafana.adminUser` and `graphing.grafana.adminPassword` parameters.
+
+.  To modify the default values of the Grafana administrator username and password through the ServiceTelemetry object, use the `graphing.grafana.adminUser` and `graphing.grafana.adminPassword` parameters.
diff --git a/...Framework/modules/proc_subscribing-to-the-amq-certificate-manager-operator.adoc b/...Framework/modules/proc_subscribing-to-the-amq-certificate-manager-operator.adoc
@@ -27,11 +27,11 @@
 You must subscribe to the AMQ Certificate Manager Operator before you deploy the other {ProjectShort} components because the AMQ Certificate Manager Operator runs globally-scoped. The AMQ Certificate Manager Operator is not compatible with the dependency management of Operator Lifecycle Manager when you use it with other namespace-scoped operators.
 
 [NOTE]
-If you are using {OpenShift} ({OpenShiftShort}) 4.5, go directly to step 3.
+The AMQ Certificate Manager is installed globally for all namespaces, so the `namespace` value provided is `openshift-operators`. You might not see your `amq7-cert-manager.v1.0.0` ClusterServiceVersion in the `service-telemetry` namespace for a few minutes until the processing executes against the namespace.
 
 .Procedure
 
-. If you are using {OpenShiftShort} 4.6, enable the Red Hat STF Operators CatalogSource:
+. Enable the Red Hat STF Operators CatalogSource:
 +
 [source,bash]
 ----
@@ -52,7 +52,7 @@ spec:
 EOF
 ----
 
-. If you are using {OpenShiftShort} 4.6, Subscribe to the AMQ Certificate Manager Operator via the `redhat-operators-stf` CatalogSource:
+. Subscribe to the AMQ Certificate Manager Operator via the `redhat-operators-stf` CatalogSource:
 
 +
 [source,bash]
@@ -73,30 +73,7 @@ spec:
 EOF
 ----
 
-. If you are using {OpenShiftShort} 4.5, subscribe to the AMQ Certificate Manager Operator, create the subscription, and validate the AMQ Certificate Manager:
-+
-[NOTE]
-The AMQ Certificate Manager is installed globally for all namespaces, so the `namespace` value provided is `openshift-operators`. You might not see your `amq7-cert-manager.v1.0.0` ClusterServiceVersion in the `service-telemetry` namespace for a few minutes until the processing executes against the namespace.
-
-+
-[source,bash]
-----
-$ oc apply -f - <<EOF
-apiVersion: operators.coreos.com/v1alpha1
-kind: Subscription
-metadata:
-  name: amq7-cert-manager
-  namespace: openshift-operators
-spec:
-  channel: alpha
-  installPlanApproval: Automatic
-  name: amq7-cert-manager
-  source: redhat-operators
-  sourceNamespace: openshift-marketplace
-EOF
-----
-
-. For {OpenShiftShort} versions 4.5 and {OpenShiftShort} 4.6, validate your `ClusterServiceVersion`:
+. Validate your `ClusterServiceVersion`:
 +
 [options="nowrap",subs="+quotes"]
 ----