Skip to content

Commit 998e4b4

Browse files
committed
RHDEVDOCS-5308-fix-typod-in-configuring-remote-write-storage
1 parent a0a0e75 commit 998e4b4

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

modules/monitoring-configuring-remote-write-storage.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
= Configuring remote write storage
88

99
[role="_abstract"]
10-
You can configure remote write storage to enable Prometheus to send ingested metrics to remote systems for long-term storage.
10+
You can configure remote write storage to enable Prometheus to send ingested metrics to remote systems for long-term storage.
1111
Doing so has no impact on how or for how long Prometheus stores metrics.
1212

1313
.Prerequisites
@@ -23,7 +23,7 @@ Doing so has no impact on how or for how long Prometheus stores metrics.
2323
See the link:https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage[Prometheus remote endpoints and storage documentation] for information about endpoints that are compatible with the remote write feature.
2424
* You have set up authentication credentials in a `Secret` object for the remote write endpoint.
2525
You must create the secret in the same namespace as the Prometheus object for which you configure remote write: the `openshift-monitoring` namespace for default platform monitoring or the `openshift-user-workload-monitoring` namespace for user workload monitoring.
26-
26+
2727
+
2828
[CAUTION]
2929
====
@@ -36,8 +36,8 @@ Follow these steps to configure remote write for default platform monitoring in
3636

3737
[NOTE]
3838
====
39-
If you configure remote write for the Prometheus instance that monitors user-defined projects, make similar edits to the `user-workload-monitoring-config` config map in the `openshift-user-workload-monitoring` namespace.
40-
Note that the Prometheus config map component is called `prometheus` in the `user-workload-monitoring-config` `ConfigMap` object and not `prometheusK8s`, as it is in the `cluster-monitoring-config` `ConfigMap` object.
39+
If you configure remote write for the Prometheus instance that monitors user-defined projects, make similar edits to the `user-workload-monitoring-config` config map in the `openshift-user-workload-monitoring` namespace.
40+
Note that the Prometheus config map component is called `prometheus` in the `user-workload-monitoring-config` `ConfigMap` object and not `prometheusK8s`, as it is in the `cluster-monitoring-config` `ConfigMap` object.
4141
====
4242

4343
. Edit the `cluster-monitoring-config` `ConfigMap` object in the `openshift-monitoring` project:
@@ -68,8 +68,8 @@ data:
6868
+
6969
<1> The URL of the remote write endpoint.
7070
<2> The authentication method and credentials for the endpoint.
71-
Currently supported authentication methods are AWS Signature Version 4, authentication using HTTP an `Authorization` request header, basic authentication, OAuth 2.0, and TLS client.
72-
See _Supported remote write authentication settings_ below for sample configurations of supported authentication methods.
71+
Currently supported authentication methods are AWS Signature Version 4, authentication using HTTP in an `Authorization` request header, Basic authentication, OAuth 2.0, and TLS client.
72+
See _Supported remote write authentication settings_ for sample configurations of supported authentication methods.
7373

7474
. Add write relabel configuration values after the authentication credentials:
7575
+

modules/monitoring-supported-remote-write-authentication-settings.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
= Supported remote write authentication settings
88

99
You can use different methods to authenticate with a remote write endpoint.
10-
Currently supported authentication methods are AWS Signature Version 4, basic authentication, authorization, OAuth 2.0, and TLS client.
10+
Currently supported authentication methods are AWS Signature Version 4, Basic authentication, authentication using HTTP in an `Authorization` request header, OAuth 2.0, and TLS client.
1111
The following table provides details about supported authentication methods for use with remote write.
1212

1313
[options="header"]
@@ -16,15 +16,15 @@ The following table provides details about supported authentication methods for
1616
|Authentication method|Config map field|Description
1717

1818
|AWS Signature Version 4|`sigv4`|This method uses AWS Signature Version 4 authentication to sign requests.
19-
You cannot use this method simultaneously with authorization, OAuth 2.0, or basic authentication.
19+
You cannot use this method simultaneously with authorization, OAuth 2.0, or Basic authentication.
2020

21-
|basic authentication|`basicAuth`|Basic authentication sets the authorization header on every remote write request with the configured username and password.
21+
|Basic authentication|`basicAuth`|Basic authentication sets the authorization header on every remote write request with the configured username and password.
2222

2323
|authorization|`authorization`|Authorization sets the `Authorization` header on every remote write request using the configured token.
2424

2525
|OAuth 2.0|`oauth2`|An OAuth 2.0 configuration uses the client credentials grant type.
2626
Prometheus fetches an access token from `tokenUrl` with the specified client ID and client secret to access the remote write endpoint.
27-
You cannot use this method simultaneously with authorization, AWS Signature Version 4, or basic authentication.
27+
You cannot use this method simultaneously with authorization, AWS Signature Version 4, or Basic authentication.
2828

2929
|TLS client|`tlsConfig`|A TLS client configuration specifies the CA certificate, the client certificate, and the client key file information used to authenticate with the remote write endpoint server using TLS.
3030
The sample configuration assumes that you have already created a CA certificate file, a client certificate file, and a client key file.
@@ -50,7 +50,7 @@ data:
5050
----
5151
<1> The URL of the remote write endpoint.
5252
<2> The required configuration details for the authentication method for the endpoint.
53-
Currently supported authentication methods are Amazon Web Services (AWS) Signature Version 4, authorization, basic authentication, OAuth 2.0, and TLS client.
53+
Currently supported authentication methods are Amazon Web Services (AWS) Signature Version 4, authentication using HTTP in an `Authorization` request header, Basic authentication, OAuth 2.0, and TLS client.
5454

5555
[NOTE]
5656
====
@@ -115,9 +115,9 @@ data:
115115
<5> The name of the AWS profile that is being used to authenticate.
116116
<6> The unique identifier for the Amazon Resource Name (ARN) assigned to your role.
117117

118-
.Sample YAML for basic authentication
118+
.Sample YAML for Basic authentication
119119

120-
The following shows sample basic authentication settings for a `Secret` object named `rw-basic-auth` in the `openshift-monitoring` namespace:
120+
The following shows sample Basic authentication settings for a `Secret` object named `rw-basic-auth` in the `openshift-monitoring` namespace:
121121

122122
[source,yaml]
123123
----

0 commit comments

Comments
 (0)