Merge pull request #142 from infrawatch/jof-1898197-minor-edits

JoanneOFlynn2018 · web-flow · commit dfc030c96437 · 2020-11-17T11:16:02.000Z
Jof 1898197 minor edits
diff --git a/doc-Service-Telemetry-Framework/modules/con_architecture.adoc b/doc-Service-Telemetry-Framework/modules/con_architecture.adoc
@@ -62,7 +62,7 @@
 
 [[osp-stf-overview]]
 .Service Telemetry Framework architecture overview
-image::OpenStack_STF_Overview_37_1019_arch.png[]
+image::OpenStack_STF_Overview_37_1019_arch.png[Service Telemetry Framework architecture overview]
 
 ifeval::["{build}" == "downstream"]
 
@@ -83,7 +83,7 @@ Server-side {ProjectShort} monitoring infrastructure consists of the following l
 
 [[osp-stf-server-side-monitoring]]
 .Server-side STF monitoring infrastructure
-image::STF_Overview_37_0819_deployment_prereq.png[]
+image::STF_Overview_37_0819_deployment_prereq.png[Server-side STF monitoring infrastructure]
 
 For more information about how to deploy {OpenShift}, see the  https://access.redhat.com/documentation/en-us/openshift_container_platform/{SupportedOpenShiftVersion}/[{OpenShiftShort} product documentation]. You can install {OpenShiftShort} on cloud platforms or on bare metal.
 For more information about {ProjectShort} performance and scaling, see https://access.redhat.com/articles/4907241.
diff --git a/doc-Service-Telemetry-Framework/modules/con_configuring-multiple-clouds.adoc b/doc-Service-Telemetry-Framework/modules/con_configuring-multiple-clouds.adoc
@@ -31,4 +31,4 @@ You can configure multiple {OpenStack} clouds to target a single instance of {Pr
 
 [[osp-stf-multiple-clouds]]
 .Two {OpenStack} clouds connect to {ProjectShort}
-image::OpenStack_STF_Overview_37_0919_topology.png[]
+image::OpenStack_STF_Overview_37_0919_topology.png[An exmaple of two {OpenStack} clouds connecting to {ProjectShort}]
diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-custom-alerts.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-custom-alerts.adoc
@@ -31,7 +31,7 @@ You can add custom alerts to the `PrometheusRule` object that you created in xre
 +
 [source,bash]
 ----
-oc edit prometheusrules prometheus-alarm-rules
+$ oc edit prometheusrules prometheus-alarm-rules
 ----
 
 . Edit the PrometheusRules manifest.
@@ -40,6 +40,6 @@ oc edit prometheusrules prometheus-alarm-rules
 
 .Additional resources
 
-For more information about configuring alerting rules, see https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/.
+* For more information about configuring alerting rules, see https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/.
 
-For more information about PrometheusRules objects, see https://github.com/coreos/prometheus-operator/blob/master/Documentation/user-guides/alerting.md
+* For more information about PrometheusRules objects, see https://github.com/coreos/prometheus-operator/blob/master/Documentation/user-guides/alerting.md
diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-ephemeral-storage.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-ephemeral-storage.adoc
@@ -32,7 +32,7 @@ To configure {ProjectShort} components for ephemeral storage, add `...storage.st
 +
 [source,bash]
 ----
-oc project service-telemetry
+$ oc project service-telemetry
 ----
 
 . Edit the ServiceTelemetry object:
diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-high-availability.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-high-availability.adoc
@@ -32,7 +32,7 @@ To configure {ProjectShort} for high availability, add `highAvailability.enabled
 +
 [source,bash]
 ----
-oc project service-telemetry
+$ oc project service-telemetry
 ----
 
 . Use the oc command to edit the ServiceTelemetry object:
diff --git a/doc-Service-Telemetry-Framework/modules/proc_configuring-manifest-overrides.adoc b/doc-Service-Telemetry-Framework/modules/proc_configuring-manifest-overrides.adoc
@@ -35,14 +35,14 @@ The `oc edit` command loads the default system editor. To override the default e
 +
 [source,bash]
 ----
-oc project service-telemetry
+$ oc project service-telemetry
 ----
 
 . Load the `ServiceTelemetry` object into an editor:
 +
 [source,bash]
 ----
-oc edit servicetelemetry default
+$ oc edit servicetelemetry default
 ----
 
 . To modify the `ServiceTelemetry` object, provide a manifest override parameter and the contents of the manifest to write to {OpenShiftShort} instead of the defaults provided by {ProjectShort}.
diff --git a/doc-Service-Telemetry-Framework/modules/proc_creating-a-servicetelemetry-object-in-openshift.adoc b/doc-Service-Telemetry-Framework/modules/proc_creating-a-servicetelemetry-object-in-openshift.adoc
@@ -33,7 +33,7 @@ Create a `ServiceTelemetry` object in {OpenShiftShort} to result in the creation
 +
 [source,bash]
 ----
-oc apply -f - <<EOF
+$ oc apply -f - <<EOF
 apiVersion: infra.watch/v1beta1
 kind: ServiceTelemetry
 metadata:
@@ -111,7 +111,7 @@ spec:
 +
 [source,yaml]
 ----
-oc apply -f - <<EOF
+$ oc apply -f - <<EOF
 apiVersion: infra.watch/v1beta1
 kind: ServiceTelemetry
 metadata:
@@ -129,7 +129,7 @@ EOF
 +
 [source,bash]
 ----
-oc logs --selector name=service-telemetry-operator -c ansible
+$ oc logs --selector name=service-telemetry-operator -c ansible
 ----
 +
 [options="nowrap", subs="+quotes"]
@@ -140,7 +140,8 @@ localhost                  : ok=55   changed=0    unreachable=0    failed=0    s
 
 . View the pods and the status of each pod to determine that all workloads are operating nominally:
 +
-NOTE: If you set `backends.events.elasticsearch.enabled: true`, the notification Smart Gateways will `Error` and `CrashLoopBackOff` for a period of time before ElasticSearch starts.
+NOTE: If you set `backends.events.elasticsearch.enabled: true`, the notification Smart Gateways reports `Error` and `CrashLoopBackOff` error messages for a period of time before ElasticSearch starts.
+
 +
 [source,bash,options="nowrap",subs="+quotes"]
 ----
diff --git a/doc-Service-Telemetry-Framework/modules/proc_creating-an-alert-route-in-alertmanager.adoc b/doc-Service-Telemetry-Framework/modules/proc_creating-an-alert-route-in-alertmanager.adoc
@@ -49,20 +49,21 @@ To deploy a custom Alertmanager route with {ProjectShort}, an `alertmanagerConfi
 +
 [source,bash]
 ----
-oc project service-telemetry
+$ oc project service-telemetry
 ----
 
 . Edit the `ServiceTelemetry` object for your {ProjectShort} deployment
 +
 [source,bash]
 ----
-oc edit stf default
+$ oc edit stf default
 ----
 
-. Add a new parameter, `alertmanagerConfigManifest` and the `Secret` object contents to define the `alertmanager.yaml` configuration for Alertmanager:
+. Add a new parameter, `alertmanagerConfigManifest`, and the `Secret` object contents to define the `alertmanager.yaml` configuration for Alertmanager:
 +
 [NOTE]
-This loads the default template that is already managed by Service Telemetry Operator. To validate the changes are populating correctly, change a value, return the `alertmanager-default` secret, and verify that the new value is loaded into memory, for example, changing the value `global.resolve_timeout` from `5m` to `10m`.
+This step loads the default template that is already managed by Service Telemetry Operator. To verify that the changes are populating correctly, change a value, return the `alertmanager-default` secret, and verify that the new value is loaded into memory. For example, change the value `global.resolve_timeout` from `5m` to `10m`.
+
 +
 [source,yaml,options="nowrap"]
 ----
@@ -119,7 +120,7 @@ receivers:
 +
 [source,bash]
 ----
-oc run curl --generator=run-pod/v1 --image=radial/busyboxplus:curl -i --tty
+$ oc run curl --generator=run-pod/v1 --image=radial/busyboxplus:curl -i --tty
 ----
 
 . Run `curl` against the `alertmanager-operated` service to retrieve the status and `configYAML` contents and review the supplied configuration matches the configuration loaded into Alertmanager:
diff --git a/doc-Service-Telemetry-Framework/modules/proc_creating-an-alert-rule-in-prometheus.adoc b/doc-Service-Telemetry-Framework/modules/proc_creating-an-alert-rule-in-prometheus.adoc
@@ -32,14 +32,14 @@ Prometheus evaluates alert rules to trigger notifications. If the rule condition
 +
 [source,bash]
 ----
-oc project service-telemetry
+$ oc project service-telemetry
 ----
 
 . Create a `PrometheusRule` object that contains the alert rule. The Prometheus Operator loads the rule into Prometheus:
 +
 [source,bash,options="nowrap"]
 ----
-oc apply -f - <<EOF
+$ oc apply -f - <<EOF
 apiVersion: monitoring.coreos.com/v1
 kind: PrometheusRule
 metadata:
@@ -62,7 +62,7 @@ EOF
 +
 [source,bash]
 ----
-oc run curl --generator=run-pod/v1 --image=radial/busyboxplus:curl -i --tty
+$ oc run curl --generator=run-pod/v1 --image=radial/busyboxplus:curl -i --tty
 ----
 
 . Run `curl` to access the `prometheus-operated` service to return the rules loaded into memory:
diff --git a/doc-Service-Telemetry-Framework/modules/proc_deleting-the-default-smart-gateways.adoc b/doc-Service-Telemetry-Framework/modules/proc_deleting-the-default-smart-gateways.adoc
@@ -27,7 +27,7 @@ After you configure {ProjectShort} for multiple clouds, you can delete the defau
 
 TIP: If you do not want any Smart Gateways deployed, define an empty clouds object using the `clouds: {}` parameter.
 
-WARNING: The `cloudsRemoveOnMissing` parameter is disabled by default. If you enable the `cloudsRemoveOnMissing` parameter, you remove any manually created `SmartGateway` objects in the current namespace without any possibility to restore. 
+WARNING: The `cloudsRemoveOnMissing` parameter is disabled by default. If you enable the `cloudsRemoveOnMissing` parameter, you remove any manually created `SmartGateway` objects in the current namespace without any possibility to restore.
 
 .Procedure
 
@@ -50,9 +50,9 @@ spec:
 
 . Save the modifications.
 
-. Verify that the Smart Gateways have been removed. This can take several minutes while the Operators reconcile the changes:
+. Verify that the Operator deleted the Smart Gateways. This can take several minutes while the Operators reconcile the changes:
 +
 [source,bash]
 ----
-oc get smartgateways
+$ oc get smartgateways
 ----
diff --git a/doc-Service-Telemetry-Framework/modules/proc_deploying-smart-gateways.adoc b/doc-Service-Telemetry-Framework/modules/proc_deploying-smart-gateways.adoc
@@ -45,13 +45,13 @@ You have determined your naming scheme and have created your list of clouds obje
 . Change to the `service-telemetry` namespace:
 +
 ----
-oc project service-telemetry
+$ oc project service-telemetry
 ----
 
 . Edit the `default` ServiceTelemetry object and add a `clouds` parameter with your configuration:
 +
 ----
-oc edit stf default
+$ oc edit stf default
 ----
 +
 ----
@@ -85,7 +85,7 @@ spec:
 . Verify that each Smart Gateway is running. This can take several minutes depending on the number of Smart Gateways:
 +
 ----
-oc get po -l app=smart-gateway
+$ oc get po -l app=smart-gateway
 ----
 +
 ----
diff --git a/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-to-the-openshift-environment.adoc b/doc-Service-Telemetry-Framework/modules/proc_deploying-stf-to-the-openshift-environment.adoc
@@ -76,7 +76,7 @@ Create a namespace to hold the {ProjectShort} components. The `service-telemetry
 +
 [source,bash]
 ----
-oc new-project service-telemetry
+$ oc new-project service-telemetry
 ----
 
 [id="creating-an-operatorgroup"]
@@ -90,7 +90,7 @@ Create an OperatorGroup in the namespace so that you can schedule the Operator p
 +
 [source,bash]
 ----
-oc apply -f - <<EOF
+$ oc apply -f - <<EOF
 apiVersion: operators.coreos.com/v1
 kind: OperatorGroup
 metadata:
@@ -117,7 +117,7 @@ Before you install ElasticSearch, you must have access to the resources on the O
 +
 [source,bash]
 ----
-oc apply -f - <<EOF
+$ oc apply -f - <<EOF
 apiVersion: operators.coreos.com/v1alpha1
 kind: CatalogSource
 metadata:
@@ -149,7 +149,7 @@ Before you deploy {ProjectShort} on {OpenShift}, you must enable the catalog sou
 ifeval::["{build}" == "upstream"]
 [source,bash]
 ----
-oc apply -f - <<EOF
+$ oc apply -f - <<EOF
 apiVersion: operators.coreos.com/v1alpha1
 kind: CatalogSource
 metadata:
@@ -169,7 +169,7 @@ endif::[]
 ifeval::["{build}" == "downstream"]
 [source,bash]
 ----
-oc apply -f - <<EOF
+$ oc apply -f - <<EOF
 apiVersion: operators.coreos.com/v1alpha1
 kind: CatalogSource
 metadata:
@@ -187,7 +187,7 @@ EOF
 ----
 endif::[]
 
-. To validate the creation of your CatalogSource, use the `oc get catalogsources` command.
+. To validate the creation of your CatalogSource, use the `oc get catalogsources` command:
 +
 ifeval::["{build}" == "upstream"]
 [source,bash,options="nowrap",subs="+quotes"]
@@ -232,18 +232,19 @@ endif::[]
 [id="subscribing-to-the-amq-certificate-manager-operator"]
 == Subscribing to the AMQ Certificate Manager Operator
 
-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 and is not compatible with the dependency management of Operator Lifecycle Manager when used with other namespace-scoped operators.
+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.
 
 .Procedure
 
 . Subscribe to the AMQ Certificate Manager Operator, create the subscription, and validate the AMQ7 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
+$ oc apply -f - <<EOF
 apiVersion: operators.coreos.com/v1alpha1
 kind: Subscription
 metadata:
@@ -258,7 +259,7 @@ spec:
 EOF
 ----
 
-. To validate your `ClusterServiceVersion`, use the `oc get csv` command. Ensure that amq7-cert-manager.v1.0.0 has a phase `Succeeded`.
+. To validate your `ClusterServiceVersion`, use the `oc get csv` command:
 +
 [source,bash,options="nowrap",subs="+quotes"]
 ----
@@ -267,6 +268,8 @@ $ oc get --namespace openshift-operators csv
 NAME                       DISPLAY                                         VERSION   REPLACES   PHASE
 amq7-cert-manager.v1.0.0   Red Hat Integration - AMQ Certificate Manager   1.0.0                Succeeded
 ----
++
+Ensure that amq7-cert-manager.v1.0.0 has a phase `Succeeded`.
 
 [id="subscribing-to-elastic-cloud-on-kubernetes-operator"]
 == Subscribing to the Elastic Cloud on Kubernetes Operator
@@ -279,7 +282,7 @@ Before you install the Service Telemetry Operator and if you plan to store event
 +
 [source,bash]
 ----
-oc apply -f - <<EOF
+$ oc apply -f - <<EOF
 apiVersion: operators.coreos.com/v1alpha1
 kind: Subscription
 metadata:
@@ -307,7 +310,7 @@ elastic-cloud-eck.v1.2.1   Elastic Cloud on Kubernetes                     1.2.1
 [id="subscribing-to-the-service-telemetry-operator"]
 == Subscribing to the Service Telemetry Operator
 
-You must subscribe to the Service Telemetry Operator which will manage the {ProjectShort} instances.
+You must subscribe to the Service Telemetry Operator, which manages the {ProjectShort} instances.
 
 .Procedure
 
@@ -316,7 +319,7 @@ You must subscribe to the Service Telemetry Operator which will manage the {Proj
 ifeval::["{build}" == "upstream"]
 [source,bash]
 ----
-oc apply -f - <<EOF
+$ oc apply -f - <<EOF
 apiVersion: operators.coreos.com/v1alpha1
 kind: Subscription
 metadata:
@@ -334,7 +337,7 @@ endif::[]
 ifeval::["{build}" == "downstream"]
 [source,bash]
 ----
-oc apply -f - <<EOF
+$ oc apply -f - <<EOF
 apiVersion: operators.coreos.com/v1alpha1
 kind: Subscription
 metadata:
diff --git a/doc-Service-Telemetry-Framework/modules/proc_preparing-your-openshift-environment-for-stf.adoc b/doc-Service-Telemetry-Framework/modules/proc_preparing-your-openshift-environment-for-stf.adoc
@@ -62,9 +62,9 @@ The amount of resources that you require to run {ProjectShort} depends on your e
 
 .Additional resources
 
-For recommendations about sizing for metrics collection see https://access.redhat.com/articles/4907241.
+* For recommendations about sizing for metrics collection, see https://access.redhat.com/articles/4907241.
 
-For information about sizing requirements for ElasticSearch, see https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-managing-compute-resources.html
+* For information about sizing requirements for ElasticSearch, see https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-managing-compute-resources.html.
 
 [id="node-tuning-operator"]
 == Node tuning operator
@@ -77,10 +77,10 @@ In an {OpenShiftShort} deployment, the default node tuning operator specificatio
 
 [source,bash]
 ----
-oc get Tuned/default -o yaml -n openshift-cluster-node-tuning-operator
+$ oc get Tuned/default -o yaml -n openshift-cluster-node-tuning-operator
 ----
 
-The output of the default specification is documented at https://docs.openshift.com/container-platform/{SupportedOpenShiftVersion}/scalability_and_performance/using-node-tuning-operator.html#custom-tuning-default-profiles-set_node-tuning-operator[Default profiles set on a cluster]. The assignment of profiles is managed in the `recommend` section where profiles are applied to a node when certain conditions are met. When scheduling ElasticSearch to a node in {ProjectShort}, one of the following profiles is applied:
+The output of the default specification is documented at https://docs.openshift.com/container-platform/{SupportedOpenShiftVersion}/scalability_and_performance/using-node-tuning-operator.html#custom-tuning-default-profiles-set_node-tuning-operator[Default profiles set on a cluster]. You can manage the assignment of profiles in the `recommend` section where profiles are applied to a node when certain conditions are met. When scheduling ElasticSearch to a node in {ProjectShort}, one of the following profiles is applied:
 
 * `openshift-control-plane-es`
 * `openshift-node-es`
@@ -89,6 +89,6 @@ When scheduling an ElasticSearch pod, there must be a label present that matches
 
 .Additional resources
 
-For more information about virtual memory usage by ElasticSearch, see https://www.elastic.co/guide/en/elasticsearch/reference/current/vm-max-map-count.html
+* For more information about virtual memory usage by ElasticSearch, see https://www.elastic.co/guide/en/elasticsearch/reference/current/vm-max-map-count.html
 
-For more information about how the profiles are applied to nodes, see https://docs.openshift.com/container-platform/{SupportedOpenShiftVersion}/scalability_and_performance/using-node-tuning-operator.html#custom-tuning-specification_node-tuning-operator[Custom tuning specification].
+* For more information about how the profiles are applied to nodes, see https://docs.openshift.com/container-platform/{SupportedOpenShiftVersion}/scalability_and_performance/using-node-tuning-operator.html#custom-tuning-specification_node-tuning-operator[Custom tuning specification].
diff --git a/doc-Service-Telemetry-Framework/modules/proc_removing-stf-from-the-openshift-environment.adoc b/doc-Service-Telemetry-Framework/modules/proc_removing-stf-from-the-openshift-environment.adoc
@@ -41,7 +41,7 @@ To remove the operational resources for {ProjectShort} from {OpenShiftShort}, de
 +
 [source,bash]
 ----
-oc delete project service-telemetry
+$ oc delete project service-telemetry
 ----
 
 . Verify that the resources have been deleted from the namespace:
diff --git a/doc-Service-Telemetry-Framework/modules/proc_setting-up-grafana-to-host-the-dashboard.adoc b/doc-Service-Telemetry-Framework/modules/proc_setting-up-grafana-to-host-the-dashboard.adoc

Original file line number	Diff line number	Diff line change
@@ -32,7 +32,7 @@ To configure {ProjectShort} components for ephemeral storage, add `...storage.st
`32`	`32`	`+`
`33`	`33`	`[source,bash]`
`34`	`34`	`----`
`35`		`-oc project service-telemetry`
	`35`	`+$ oc project service-telemetry`
`36`	`36`	`----`
`37`	`37`
`38`	`38`	`. Edit the ServiceTelemetry object:`
Original file line number	Diff line number	Diff line change
@@ -33,7 +33,7 @@ Create a `ServiceTelemetry` object in {OpenShiftShort} to result in the creation
`33`	`33`	`+`
`34`	`34`	`[source,bash]`
`35`	`35`	`----`
`36`		`-oc apply -f - <<EOF`
	`36`	`+$ oc apply -f - <<EOF`
`37`	`37`	`apiVersion: infra.watch/v1beta1`
`38`	`38`	`kind: ServiceTelemetry`
`39`	`39`	`metadata:`
`@@ -111,7 +111,7 @@ spec:`
`111`	`111`	`+`
`112`	`112`	`[source,yaml]`
`113`	`113`	`----`
`114`		`-oc apply -f - <<EOF`
	`114`	`+$ oc apply -f - <<EOF`
`115`	`115`	`apiVersion: infra.watch/v1beta1`
`116`	`116`	`kind: ServiceTelemetry`
`117`	`117`	`metadata:`
`@@ -129,7 +129,7 @@ EOF`
`129`	`129`	`+`
`130`	`130`	`[source,bash]`
`131`	`131`	`----`
`132`		`-oc logs --selector name=service-telemetry-operator -c ansible`
	`132`	`+$ oc logs --selector name=service-telemetry-operator -c ansible`
`133`	`133`	`----`
`134`	`134`	`+`
`135`	`135`	`[options="nowrap", subs="+quotes"]`
`@@ -140,7 +140,8 @@ localhost : ok=55 changed=0 unreachable=0 failed=0 s`
`140`	`140`
`141`	`141`	`. View the pods and the status of each pod to determine that all workloads are operating nominally:`
`142`	`142`	`+`
`143`		-NOTE: If you set `backends.events.elasticsearch.enabled: true`, the notification Smart Gateways will `Error` and `CrashLoopBackOff` for a period of time before ElasticSearch starts.
	`143`	+NOTE: If you set `backends.events.elasticsearch.enabled: true`, the notification Smart Gateways reports `Error` and `CrashLoopBackOff` error messages for a period of time before ElasticSearch starts.
	`144`	`+`
`144`	`145`	`+`
`145`	`146`	`[source,bash,options="nowrap",subs="+quotes"]`
`146`	`147`	`----`