Skip to content

Output clean up and minor clarity changes #475

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 16, 2023
Merged

Output clean up and minor clarity changes #475

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
652ff0d
Output clean up and minor clarity changes
leifmadsen Jun 15, 2023
1c8bc32
Make content consistent
leifmadsen Jun 15, 2023
30a782e
Merge branch 'master' into lmadsen-output-updates
leifmadsen Jun 15, 2023
acc8e18
Adjust the oc edit procedures (#477)
leifmadsen Jun 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 38 additions & 6 deletions ...ry-Framework/modules/con_primary-parameters-of-the-servicetelemetry-object.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You can configure each of these configuration parameters to provide different fe

Use the `backends` parameter to control which storage back ends are available for storage of metrics and events, and to control the enablement of Smart Gateways that the `clouds` parameter defines. For more information, see xref:clouds_assembly-installing-the-core-components-of-stf[].

Currently, you can use Prometheus as the metrics storage back end and Elasticsearch as the events storage back end.
You can use Prometheus as the metrics storage back end and Elasticsearch as the events storage back end. You can use the Service Telemetry Operator to create other custom resource objects that the Prometheus Operator and Elastic Cloud on Kubernetes Operator watch to create Prometheus and Elasticsearch workloads.

[discrete]
=== Enabling Prometheus as a storage back end for metrics
Expand All @@ -29,7 +29,14 @@ To enable Prometheus as a storage back end for metrics, you must configure the `

.Procedure

* Configure the `ServiceTelemetry` object:
. Edit the `ServiceTelemetry` object:
+
[source,bash]
----
$ oc edit stf default
----

. Set the value of the backends.metrics.prometheus.enabled parameter to `true`:
+
[source,yaml]
----
Expand All @@ -39,6 +46,7 @@ metadata:
name: default
namespace: service-telemetry
spec:
[...]
backends:
metrics:
prometheus:
Expand All @@ -57,7 +65,7 @@ Use the `pvcStorageRequest` parameter to define the minimum required volume size

.Procedure

* List the available storage classes:
. List the available storage classes:
+
[source,bash,options="nowrap"]
----
Expand All @@ -68,7 +76,14 @@ standard (default) kubernetes.io/cinder Delete WaitForFirstCons
standard-csi cinder.csi.openstack.org Delete WaitForFirstConsumer true 20h
----

* Configure the `ServiceTelemetry` object:
. Edit the `ServiceTelemetry` object:
+
[source,bash]
----
$ oc edit stf default
----

. Set the value of the backends.metrics.prometheus.enabled parameter to `true` and the value of backends.metrics.prometheus.storage.strategy to `persistent`:
+
[source,yaml]
----
Expand All @@ -78,6 +93,7 @@ metadata:
name: default
namespace: service-telemetry
spec:
[...]
backends:
metrics:
prometheus:
Expand All @@ -96,7 +112,14 @@ To enable Elasticsearch as a storage back end for events, you must configure the

.Procedure

* Configure the `ServiceTelemetry` object:
. Edit the `ServiceTelemetry` object:
+
[source,bash]
----
$ oc edit stf default
----

. Set the value of the backends.events.elasticsearch.enabled parameter to `true`:
+
[source,yaml]
----
Expand All @@ -106,6 +129,7 @@ metadata:
name: default
namespace: service-telemetry
spec:
[...]
backends:
events:
elasticsearch:
Expand Down Expand Up @@ -135,7 +159,14 @@ standard (default) kubernetes.io/cinder Delete WaitForFirstCons
standard-csi cinder.csi.openstack.org Delete WaitForFirstConsumer true 20h
----

. Configure the `ServiceTelemetry` object:
. Edit the `ServiceTelemetry` object:
+
[source,bash]
----
$ oc edit stf default
----

. Set the value of the backends.events.elasticsearch.enabled parameter to `true` and the value of backends.events.elasticsearch.storage.strategy to `persistent`:
+
[source,yaml]
----
Expand All @@ -145,6 +176,7 @@ metadata:
name: default
namespace: service-telemetry
spec:
[...]
backends:
events:
elasticsearch:
Expand Down
22 changes: 11 additions & 11 deletions ...try-Framework/modules/proc_creating-a-servicetelemetry-object-in-openshift.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,17 +168,17 @@ NOTE: If you set the `backends.events.elasticsearch.enabled` parameter to `true`
$ oc get pods

NAME READY STATUS RESTARTS AGE
alertmanager-default-0 2/2 Running 0 17m
default-cloud1-ceil-meter-smartgateway-6484b98b68-vd48z 2/2 Running 0 17m
default-cloud1-coll-meter-smartgateway-799f687658-4gxpn 2/2 Running 0 17m
alertmanager-default-0 3/3 Running 0 4m7s
default-cloud1-ceil-meter-smartgateway-669c6cdcf9-xvdvx 3/3 Running 0 3m46s
default-cloud1-coll-meter-smartgateway-585855c59d-858rf 3/3 Running 0 3m46s
ifndef::include_when_13[]
default-cloud1-sens-meter-smartgateway-c7f4f7fc8-c57b4 2/2 Running 0 17m
default-cloud1-sens-meter-smartgateway-6f8dffb645-hhgkw 3/3 Running 0 3m46s
endif::[]
default-interconnect-54658f5d4-pzrpt 1/1 Running 0 17m
elastic-operator-66b7bc49c4-sxkc2 1/1 Running 0 52m
interconnect-operator-69df6b9cb6-7hhp9 1/1 Running 0 50m
prometheus-default-0 2/2 Running 1 17m
prometheus-operator-6458b74d86-wbdqp 1/1 Running 0 51m
service-telemetry-operator-864646787c-hd9pm 1/1 Running 0 51m
smart-gateway-operator-79778cf548-mz5z7 1/1 Running 0 51m
default-interconnect-6994ff546-fx7jn 1/1 Running 0 4m18s
elastic-operator-9f44cdf6c-csvjq 1/1 Running 0 19m
interconnect-operator-646bfc886c-gx55n 1/1 Running 0 25m
prometheus-default-0 3/3 Running 0 3m33s
prometheus-operator-54d644d8d7-wzdlh 1/1 Running 0 20m
service-telemetry-operator-54f6f7b6d-nfhwx 1/1 Running 0 18m
smart-gateway-operator-9bbd7c56c-76w67 1/1 Running 0 18m
----
8 changes: 4 additions & 4 deletions ...elemetry-Framework/modules/proc_deploying-stf-to-the-openshift-environment.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,8 +157,8 @@ EOF
----
$ oc get csv --selector=operators.coreos.com/amq7-interconnect-operator.service-telemetry

NAME DISPLAY VERSION REPLACES PHASE
amq7-interconnect-operator.v1.10.10 Red Hat Integration - AMQ Interconnect 1.10.10 amq7-interconnect-operator.v1.10.4 Succeeded
NAME DISPLAY VERSION REPLACES PHASE
amq7-interconnect-operator.v1.10.15 Red Hat Integration - AMQ Interconnect 1.10.15 amq7-interconnect-operator.v1.10.4 Succeeded
----

. To store metrics in Prometheus, you must enable the Prometheus Operator by using the community-operators CatalogSource:
Expand Down Expand Up @@ -191,7 +191,7 @@ EOF
+
[source,bash,options="nowrap",role="white-space-pre"]
----
oc get csv --selector=operators.coreos.com/prometheus.service-telemetry
$ oc get csv --selector=operators.coreos.com/prometheus.service-telemetry

NAME DISPLAY VERSION REPLACES PHASE
prometheusoperator.0.56.3 Prometheus Operator 0.56.3 prometheusoperator.0.47.0 Succeeded
Expand Down Expand Up @@ -293,7 +293,7 @@ EOF
----
endif::[]

. Validate the Service Telemetry Operator and the dependent operators:
. Validate the Service Telemetry Operator and the dependent operators have their phase as Succeeded:
+
[source,bash,options="nowrap",role="white-space-pre"]
----
Expand Down