Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,8 @@
//
// * observability/monitoring/configuring-the-monitoring-stack.adoc

// The ultimate solution DOES NOT NEED separate IDs, it is just needed for now so that the tests will not break

// tag::CPM[]
[id="monitoring-adding-a-secret-to-the-alertmanager-configuration-cpm_{context}"]
= Adding a secret to the Alertmanager configuration for core platform monitoring
// end::CPM[]

// tag::UWM[]
[id="monitoring-adding-a-secret-to-the-alertmanager-configuration-uwm_{context}"]
= Adding a secret to the Alertmanager configuration for monitoring of user-defined projects
// end::UWM[]
[id="monitoring-adding-a-secret-to-the-alertmanager-configuration_{context}"]
= Adding a secret to the Alertmanager configuration

// Set attributes to distinguish between cluster monitoring example (core platform monitoring - CPM) and user workload monitoring (UWM) examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,8 @@

:_mod-docs-content-type: PROCEDURE

// The ultimate solution DOES NOT NEED separate IDs, it is just needed for now so that the tests will not break
// tag::CPM[]
[id="assigning-tolerations-to-monitoring-components-cpm_{context}"]
= Assigning tolerations to monitoring components for core platform monitoring
// end::CPM[]

// tag::UWM[]
[id="assigning-tolerations-to-monitoring-components-uwm_{context}"]
= Assigning tolerations to monitoring components for monitoring for user-defined projects
// end::UWM[]
[id="assigning-tolerations-to-monitoring-components_{context}"]
= Assigning tolerations to monitoring components

// Set attributes to distinguish between cluster monitoring example (core platform monitoring - CPM) and user workload monitoring (UWM) examples.
// tag::CPM[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,8 @@

:_mod-docs-content-type: PROCEDURE

// The ultimate solution DOES NOT NEED separate IDs, it is just needed for now so that the tests will not break

// tag::CPM[]
[id="attaching-additional-labels-to-your-time-series-and-alerts-cpm_{context}"]
= Attaching additional labels to your time series and alerts for core platform monitoring
// end::CPM[]

// tag::UWM[]
[id="attaching-additional-labels-to-your-time-series-and-alerts-uwm_{context}"]
= Attaching additional labels to your time series and alerts for monitoring of user-defined projects
// end::UWM[]
[id="attaching-additional-labels-to-your-time-series-and-alerts_{context}"]
= Attaching additional labels to your time series and alerts

// Set attributes to distinguish between cluster monitoring example (core platform monitoring - CPM) and user workload monitoring (UWM) examples

Expand Down
15 changes: 4 additions & 11 deletions modules/monitoring-configurable-monitoring-components.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,8 @@

:_mod-docs-content-type: REFERENCE

// The ultimate solution DOES NOT NEED separate IDs, it is just needed for now so that the tests will not break

// tag::CPM[]
[id="configurable-monitoring-components-cpm_{context}"]
= Configurable monitoring components for core platform monitoring
// end::CPM[]

// tag::UWM[]
[id="configurable-monitoring-components-uwm_{context}"]
= Configurable monitoring components for monitoring for user-defined projects
// end::UWM[]
[id="configurable-monitoring-components_{context}"]
= Configurable monitoring components

// Set attributes to distinguish between cluster monitoring example (core platform monitoring - CPM) and user workload monitoring (UWM) examples.
// tag::CPM[]
Expand Down Expand Up @@ -65,6 +56,7 @@ endif::openshift-dedicated,openshift-rosa[]
// end::CPM[]
|====

ifndef::openshift-dedicated,openshift-rosa[]
[WARNING]
====
Different configuration changes to the `ConfigMap` object result in different outcomes:
Expand All @@ -81,6 +73,7 @@ Different configuration changes to the `ConfigMap` object result in different ou

Each procedure that requires a change in the config map includes its expected outcome.
====
endif::openshift-dedicated,openshift-rosa[]

// Unset the source code block attributes just to be safe.
:!configmap-name:
Expand Down
13 changes: 2 additions & 11 deletions modules/monitoring-configuring-a-persistent-volume-claim.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,8 @@

:_mod-docs-content-type: PROCEDURE

// The ultimate solution DOES NOT NEED separate IDs, it is just needed for now so that the tests will not break

// tag::CPM[]
[id="configuring-a-persistent-volume-claim-cpm_{context}"]
= Configuring a persistent volume claim for core platform monitoring
// end::CPM[]

// tag::UWM[]
[id="configuring-a-persistent-volume-claim-uwm_{context}"]
= Configuring a persistent volume claim for monitoring of user-defined projects
// end::UWM[]
[id="configuring-a-persistent-volume-claim_{context}"]
= Configuring a persistent volume claim

// Set attributes to distinguish between cluster monitoring example (core platform monitoring - CPM) and user workload monitoring (UWM) examples

Expand Down
13 changes: 2 additions & 11 deletions modules/monitoring-configuring-external-alertmanagers.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,8 @@

:_mod-docs-content-type: PROCEDURE

// The ultimate solution DOES NOT NEED separate IDs, it is just needed for now so that the tests will not break

// tag::CPM[]
[id="monitoring-configuring-external-alertmanagers-cpm_{context}"]
= Configuring external Alertmanager instances for core platform monitoring
// end::CPM[]

// tag::UWM[]
[id="monitoring-configuring-external-alertmanagers-uwm_{context}"]
= Configuring external Alertmanager instances for monitoring of user-defined projects
// end::UWM[]
[id="monitoring-configuring-external-alertmanagers_{context}"]
= Configuring external Alertmanager instances

// Set attributes to distinguish between cluster monitoring example (core platform monitoring - CPM) and user workload monitoring (UWM) examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,8 @@

:_mod-docs-content-type: PROCEDURE

// The ultimate solution DOES NOT NEED separate IDs and titles, it is just needed for now so that the tests will not break

// tag::CPM[]
[id="configuring-pod-topology-spread-constraints-cpm_{context}"]
= Configuring pod topology spread constraints for core platform monitoring
// end::CPM[]

// tag::UWM[]
[id="configuring-pod-topology-spread-constraints-uwm_{context}"]
= Configuring pod topology spread constraints for monitoring of user-defined projects
// end::UWM[]
[id="configuring-pod-topology-spread-constraints_{context}"]
= Configuring pod topology spread constraints

// Set attributes to distinguish between cluster monitoring example (core platform monitoring - CPM) and user workload monitoring (UWM) examples

Expand Down
12 changes: 2 additions & 10 deletions modules/monitoring-configuring-remote-write-storage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,8 @@

:_mod-docs-content-type: PROCEDURE

// The ultimate solution DOES NOT NEED separate IDs, it is just needed for now so that the tests will not break
// tag::CPM[]
[id="configuring-remote-write-storage-cpm_{context}"]
= Configuring remote write storage for core platform monitoring
// end::CPM[]

// tag::UWM[]
[id="configuring-remote-write-storage-uwm_{context}"]
= Configuring remote write storage for monitoring of user-defined projects
// end::UWM[]
[id="configuring-remote-write-storage_{context}"]
= Configuring remote write storage

// Set attributes to distinguish between cluster monitoring example (core platform monitoring - CPM) and user workload monitoring (UWM) examples
// tag::CPM[]
Expand Down
12 changes: 2 additions & 10 deletions modules/monitoring-creating-cluster-id-labels-for-metrics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,8 @@

:_mod-docs-content-type: PROCEDURE

// The ultimate solution DOES NOT NEED separate IDs, it is just needed for now so that the tests will not break
// tag::CPM[]
[id="creating-cluster-id-labels-for-metrics-cpm_{context}"]
= Creating cluster ID labels for metrics for core platform monitoring
// end::CPM[]

// tag::UWM[]
[id="creating-cluster-id-labels-for-metrics-uwm_{context}"]
= Creating cluster ID labels for metrics for monitoring of user-defined projects
// end::UWM[]
[id="creating-cluster-id-labels-for-metrics_{context}"]
= Creating cluster ID labels for metrics

// Set attributes to distinguish between cluster monitoring example (core platform monitoring - CPM) and user workload monitoring (UWM) examples
// tag::CPM[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,8 @@

:_mod-docs-content-type: REFERENCE

// The ultimate solution DOES NOT NEED separate IDs, it is just needed for now so that the tests will not break
// tag::CPM[]
[id="example-remote-write-authentication-settings-cpm_{context}"]
= Example remote write authentication settings for core platform monitoring
// end::CPM[]

// tag::UWM[]
[id="example-remote-write-authentication-settings-uwm_{context}"]
= Example remote write authentication settings for monitoring of user-defined projects
// end::UWM[]
[id="example-remote-write-authentication-settings_{context}"]
= Example remote write authentication settings

// Set attributes to distinguish between cluster monitoring example (core platform monitoring - CPM) and user workload monitoring (UWM) examples
// tag::CPM[]
Expand All @@ -36,14 +28,8 @@ monitoring for user-defined projects
// end::UWM[]
in the `{namespace-name}` namespace.

// tag::CPM[]
[id="remote-write-sample-yaml-aws-sigv4-cmp_{context}"]
== Sample YAML for AWS Signature Version 4 authentication for core platform monitoring
// end::CPM[]
// tag::UWM[]
[id="remote-write-sample-yaml-aws-sigv4-uwm_{context}"]
== Sample YAML for AWS Signature Version 4 authentication for monitoring of user-defined projects
// end::UWM[]
[id="remote-write-sample-yaml-aws-sigv4_{context}"]
== Sample YAML for AWS Signature Version 4 authentication

The following shows the settings for a `sigv4` secret named `sigv4-credentials` in the `{namespace-name}` namespace.

Expand Down Expand Up @@ -94,14 +80,8 @@ data:
<5> The name of the AWS profile that is being used to authenticate.
<6> The unique identifier for the Amazon Resource Name (ARN) assigned to your role.

// tag::CPM[]
[id="remote-write-sample-yaml-basic-auth-cmp_{context}"]
== Sample YAML for Basic authentication for core platform monitoring
// end::CPM[]
// tag::UWM[]
[id="remote-write-sample-yaml-basic-auth-uwm_{context}"]
== Sample YAML for Basic authentication for monitoring of user-defined projects
// end::UWM[]
[id="remote-write-sample-yaml-basic-auth_{context}"]
== Sample YAML for Basic authentication

The following shows sample Basic authentication settings for a `Secret` object named `rw-basic-auth` in the `{namespace-name}` namespace:

Expand Down Expand Up @@ -147,14 +127,8 @@ data:
<2> The key that contains the username in the specified `Secret` object.
<3> The key that contains the password in the specified `Secret` object.

// tag::CPM[]
[id="remote-write-sample-yaml-bearer-token-cmp_{context}"]
== Sample YAML for authentication with a bearer token using a `Secret` Object for core platform monitoring
// end::CPM[]
// tag::UWM[]
[id="remote-write-sample-yaml-bearer-token-uwm_{context}"]
== Sample YAML for authentication with a bearer token using a `Secret` Object for monitoring of user-defined projects
// end::UWM[]
[id="remote-write-sample-yaml-bearer-token_{context}"]
== Sample YAML for authentication with a bearer token using a `Secret` Object

The following shows bearer token settings for a `Secret` object named `rw-bearer-auth` in the `{namespace-name}` namespace:

Expand Down Expand Up @@ -196,14 +170,8 @@ data:
<2> The name of the `Secret` object that contains the authentication credentials.
<3> The key that contains the authentication token in the specified `Secret` object.

// tag::CPM[]
[id="remote-write-sample-yaml-oauth-20-cmp_{context}"]
== Sample YAML for OAuth 2.0 authentication for core platform monitoring
// end::CPM[]
// tag::UWM[]
[id="remote-write-sample-yaml-oauth-20-uwm_{context}"]
== Sample YAML for OAuth 2.0 authentication for monitoring of user-defined projects
// end::UWM[]
[id="remote-write-sample-yaml-oauth-20_{context}"]
== Sample YAML for OAuth 2.0 authentication

The following shows sample OAuth 2.0 settings for a `Secret` object named `oauth2-credentials` in the `{namespace-name}` namespace:

Expand Down Expand Up @@ -258,14 +226,8 @@ data:
<4> The OAuth 2.0 scopes for the authorization request. These scopes limit what data the tokens can access.
<5> The OAuth 2.0 authorization request parameters required for the authorization server.

// tag::CPM[]
[id="remote-write-sample-yaml-tls-cmp_{context}"]
== Sample YAML for TLS client authentication for core platform monitoring
// end::CPM[]
// tag::UWM[]
[id="remote-write-sample-yaml-tls-uwm_{context}"]
== Sample YAML for TLS client authentication for monitoring of user-defined projects
// end::UWM[]
[id="remote-write-sample-yaml-tls_{context}"]
== Sample YAML for TLS client authentication

The following shows sample TLS client settings for a `tls` `Secret` object named `mtls-bundle` in the `{namespace-name}` namespace.

Expand Down
12 changes: 2 additions & 10 deletions modules/monitoring-example-remote-write-queue-configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,8 @@

:_mod-docs-content-type: REFERENCE

// The ultimate solution DOES NOT NEED separate IDs, it is just needed for now so that the tests will not break
// tag::CPM[]
[id="example-remote-write-queue-configuration-cpm_{context}"]
= Example remote write queue configuration for core platform monitoring
// end::CPM[]

// tag::UWM[]
[id="example-remote-write-queue-configuration-uwm_{context}"]
= Example remote write queue configuration for monitoring of user-defined projects
// end::UWM[]
[id="example-remote-write-queue-configuration_{context}"]
= Example remote write queue configuration

// Set attributes to distinguish between cluster monitoring example (core platform monitoring - CPM) and user workload monitoring (UWM) examples
// tag::CPM[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,8 @@

:_mod-docs-content-type: PROCEDURE

// The ultimate solution DOES NOT NEED separate IDs, it is just needed for now so that the tests will not break

// tag::CPM[]
[id="modifying-retention-time-and-size-for-prometheus-metrics-data-cpm_{context}"]
= Modifying the retention time and size for Prometheus metrics data for core platform monitoring
// end::CPM[]

// tag::UWM[]
[id="modifying-retention-time-and-size-for-prometheus-metrics-data-uwm_{context}"]
= Modifying the retention time and size for Prometheus metrics data for user-defined monitoring
// end::UWM[]
[id="modifying-retention-time-and-size-for-prometheus-metrics-data_{context}"]
= Modifying retention time and size for Prometheus metrics data

// Set attributes to distinguish between cluster monitoring example (core platform monitoring - CPM) and user workload monitoring (UWM) examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,8 @@

:_mod-docs-content-type: PROCEDURE

// The ultimate solution DOES NOT NEED separate IDs, it is just needed for now so that the tests will not break

// tag::CPM[]
[id="moving-monitoring-components-to-different-nodes-cpm_{context}"]
= Moving monitoring components to different nodes for core platform monitoring
// end::CPM[]

// tag::UWM[]
[id="moving-monitoring-components-to-different-nodes-uwm_{context}"]
= Moving monitoring components to different nodes for monitoring for user-defined projects
// end::UWM[]
[id="moving-monitoring-components-to-different-nodes_{context}"]
= Moving monitoring components to different nodes

// Set attributes to distinguish between cluster monitoring example (core platform monitoring - CPM) and user workload monitoring (UWM) examples.
// tag::CPM[]
Expand Down
13 changes: 2 additions & 11 deletions modules/monitoring-resizing-a-persistent-volume.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,8 @@

:_mod-docs-content-type: PROCEDURE

// The ultimate solution DOES NOT NEED separate IDs, it is just needed for now so that the tests will not break

// tag::CPM[]
[id="resizing-a-persistent-volume-cpm_{context}"]
= Resizing a persistent volume for core platform monitoring
// end::CPM[]

// tag::UWM[]
[id="resizing-a-persistent-volume-uwm_{context}"]
= Resizing a persistent volume for monitoring of user-defined projects
// end::UWM[]
[id="resizing-a-persistent-volume_{context}"]
= Resizing a persistent volume

// Set attributes to distinguish between cluster monitoring example (core platform monitoring - CPM) and user workload monitoring (UWM) examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
:_mod-docs-content-type: CONCEPT

[id="retention-time-and-size-for-prometheus-metrics-data_{context}"]
= The retention time and size for Prometheus metrics
= Retention time and size for Prometheus metrics

By default, Prometheus retains metrics data for the following durations:

Expand Down
Loading