You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/monitoring-configuring-remote-write-storage.adoc
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@
7
7
= Configuring remote write storage
8
8
9
9
[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.
11
11
Doing so has no impact on how or for how long Prometheus stores metrics.
12
12
13
13
.Prerequisites
@@ -23,7 +23,7 @@ Doing so has no impact on how or for how long Prometheus stores metrics.
23
23
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.
24
24
* You have set up authentication credentials in a `Secret` object for the remote write endpoint.
25
25
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
+
27
27
+
28
28
[CAUTION]
29
29
====
@@ -36,8 +36,8 @@ Follow these steps to configure remote write for default platform monitoring in
36
36
37
37
[NOTE]
38
38
====
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.
41
41
====
42
42
43
43
. Edit the `cluster-monitoring-config``ConfigMap` object in the `openshift-monitoring` project:
@@ -68,8 +68,8 @@ data:
68
68
+
69
69
<1> The URL of the remote write endpoint.
70
70
<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.
73
73
74
74
. Add write relabel configuration values after the authentication credentials:
Copy file name to clipboardExpand all lines: modules/monitoring-supported-remote-write-authentication-settings.adoc
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@
7
7
= Supported remote write authentication settings
8
8
9
9
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.
11
11
The following table provides details about supported authentication methods for use with remote write.
12
12
13
13
[options="header"]
@@ -16,15 +16,15 @@ The following table provides details about supported authentication methods for
|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.
20
20
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.
22
22
23
23
|authorization|`authorization`|Authorization sets the `Authorization` header on every remote write request using the configured token.
24
24
25
25
|OAuth 2.0|`oauth2`|An OAuth 2.0 configuration uses the client credentials grant type.
26
26
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.
28
28
29
29
|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.
30
30
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:
50
50
----
51
51
<1> The URL of the remote write endpoint.
52
52
<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.
54
54
55
55
[NOTE]
56
56
====
@@ -115,9 +115,9 @@ data:
115
115
<5> The name of the AWS profile that is being used to authenticate.
116
116
<6> The unique identifier for the Amazon Resource Name (ARN) assigned to your role.
117
117
118
-
.Sample YAML for basic authentication
118
+
.Sample YAML for Basic authentication
119
119
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:
0 commit comments