Skip to content

Commit dffe020

Browse files
maycmleemaycmlee
authored
[DOCS-12091] Add Secrets Management tabs for sources (#33429)
* add sm tabs * use set secrets intro shortcode * update key pass * fix commas * add descriptions * update * fix case * small edits
1 parent 6a46271 commit dffe020

File tree

15 files changed

+331
-112
lines changed

15 files changed

+331
-112
lines changed

‎content/en/observability_pipelines/sources/amazon_data_firehose.md‎

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ Use Observability Pipelines' Amazon Data Firehose source to receive logs from Am
1818

1919
Select and set up this source when you [set up a pipeline][1]. The information below is for the source settings in the pipeline UI.
2020

21-
- Enter the identifier for your Amazon Data Firehose address.
22-
- **Note**: Only enter the identifier for the address. Do **not** enter the actual address.
23-
- If left blank, the default is used: `SOURCE_AWS_DATA_FIREHOSE_ADDRESS`.
21+
<div class="alert alert-danger">Only enter the identifiers for the Amazon Data Firehose address and, if applicable, the TLS key pass. Do <b>not</b> enter the actual values.</div>
22+
23+
- Enter the identifier for your Amazon Data Firehose address. If you leave it blank, the [default](#set-secrets) is used.
2424

2525
### Optional settings
2626

@@ -33,17 +33,33 @@ Select an **AWS authentication** option. If you select **Assume role**:
3333
#### Enable TLS
3434

3535
Toggle the switch to **Enable TLS**. If you enable TLS, the following certificate and key files are required.<br>**Note**: All file paths are made relative to the configuration data directory, which is `/var/lib/observability-pipelines-worker/config/` by default. See [Advanced Worker Configurations][2] for more information. The file must be owned by the `observability-pipelines-worker group` and `observability-pipelines-worker` user, or at least readable by the group or user.
36-
- Enter the identifier for your Amazon Data Firehose key pass.
37-
- **Note**: Only enter the identifier for the key pass. Do **not** enter the actual key pass.
38-
- If left blank, the default is used: `SOURCE_AWS_DATA_FIREHOSE_KEY_PASS`.
36+
- Enter the identifier for your Amazon Data Firehose key pass. If you leave it blank, the [default](#set-secrets) is used.
3937
- `Server Certificate Path`: The path to the certificate file that has been signed by your Certificate Authority (CA) root file in DER or PEM (X.509).
40-
- `CA Certificate Path`: The path to the certificate file that is your Certificate Authority (CA) Root File in DER or PEM (X.509).
38+
- `CA Certificate Path`: The path to the certificate file that is your Certificate Authority (CA) root file in DER or PEM (X.509).
4139
- `Private Key Path`: The path to the `.key` private key file that belongs to your Server Certificate Path in DER or PEM (PKCS#8) format.
4240

43-
## Set the environment variables
41+
## Set secrets
42+
43+
{{% observability_pipelines/set_secrets_intro %}}
44+
45+
{{< tabs >}}
46+
{{% tab "Secrets Management" %}}
47+
48+
- Amazon Data Firehose address identifier:
49+
- References the socket address on which the Observability Pipelines Worker listens to receive logs.
50+
- The default identifier is `SOURCE_AWS_DATA_FIREHOSE_ADDRESS`.
51+
- Amazon Data Firehose TLS passphrase identifier (when TLS is enabled):
52+
- The default identifier is `SOURCE_AWS_DATA_FIREHOSE_KEY_PASS`.
53+
54+
{{% /tab %}}
55+
56+
{{% tab "Environment variables" %}}
4457

4558
{{% observability_pipelines/configure_existing_pipelines/source_env_vars/amazon_data_firehose %}}
4659

60+
{{% /tab %}}
61+
{{< /tabs >}}
62+
4763
## Send logs to the Observability Pipelines Worker over Amazon Data Firehose
4864

4965
{{% observability_pipelines/log_source_configuration/amazon_data_firehose %}}

‎content/en/observability_pipelines/sources/amazon_s3.md‎

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ Use Observability Pipelines' Amazon S3 source to receive logs from Amazon S3. Se
1313

1414
Select and set up this source when you [set up a pipeline][1]. The information below is for the source settings in the pipeline UI.
1515

16-
1. Enter the identifier for your Amazon S3 URL.
17-
- **Note**: Only enter the identifier for the URL. Do **not** enter the actual URL.
18-
- If left blank, the default is used: `SOURCE_AWS_S3_SQS_URL`.
16+
<div class="alert alert-danger">Only enter the identifiers for the Amazon S3 URL and, if applicable, the TLS key pass. Do <b>not</b> enter the actual values.</div>
17+
18+
1. Enter the identifier for your Amazon S3 URL. If you leave it blank, the [default](#set-secrets) is used.
1919
1. Enter the AWS region.
2020

2121
### Optional settings
@@ -29,17 +29,33 @@ Select an **AWS authentication** option. If you select **Assume role**:
2929
#### Enable TLS
3030

3131
Toggle the switch to **Enable TLS**. If you enable TLS, the following certificate and key files are required.<br>**Note**: All file paths are made relative to the configuration data directory, which is `/var/lib/observability-pipelines-worker/config/` by default. See [Advanced Worker Configurations][2] for more information. The file must be owned by the `observability-pipelines-worker group` and `observability-pipelines-worker` user, or at least readable by the group or user.
32-
- Enter the identifier for your Amazon S3 key pass.
33-
- **Note**: Only enter the identifier for the key pass. Do **not** enter the actual key pass.
34-
- If left blank, the default is used: `SOURCE_AWS_S3_KEY_PASS`.
32+
- Enter the identifier for your Amazon S3 key pass. If you leave it blank, the [default](#set-secrets) is used.
3533
- `Server Certificate Path`: The path to the certificate file that has been signed by your Certificate Authority (CA) root file in DER or PEM (X.509).
36-
- `CA Certificate Path`: The path to the certificate file that is your Certificate Authority (CA) Root File in DER or PEM (X.509).
34+
- `CA Certificate Path`: The path to the certificate file that is your Certificate Authority (CA) root file in DER or PEM (X.509).
3735
- `Private Key Path`: The path to the `.key` private key file that belongs to your Server Certificate Path in DER or PEM (PKCS#8) format.
3836

39-
## Set the environment variables
37+
## Set secrets
38+
39+
{{% observability_pipelines/set_secrets_intro %}}
40+
41+
{{< tabs >}}
42+
{{% tab "Secrets Management" %}}
43+
44+
- Amazon S3 URL identifier:
45+
- References the URL of the SQS queue to which the S3 bucket sends the notification events.
46+
- The default identifier is `SOURCE_AWS_S3_SQS_URL`.
47+
- Amazon S3 TLS passphrase identifier (when TLS is enabled):
48+
- The default identifier is `SOURCE_AWS_S3_KEY_PASS`.
49+
50+
{{% /tab %}}
51+
52+
{{% tab "Environment Variables" %}}
4053

4154
{{% observability_pipelines/configure_existing_pipelines/source_env_vars/amazon_s3 %}}
4255

56+
{{% /tab %}}
57+
{{< /tabs >}}
58+
4359
## AWS Authentication
4460

4561
{{% observability_pipelines/aws_authentication/instructions %}}

‎content/en/observability_pipelines/sources/datadog_agent.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ Use Observability Pipelines' Datadog Agent source to receive logs or metrics ({{
2525
## Set up the source in the pipeline UI
2626

2727
Optionally, toggle the switch to enable TLS. If you enable TLS, the following certificate and key files are required.
28-
- `Server Certificate Path`: The path to the certificate file that has been signed by your Certificate Authority (CA) Root File in DER or PEM (X.509) format.
29-
- `CA Certificate Path`: The path to the certificate file that is your Certificate Authority (CA) Root File in DER or PEM (X.509) format.
28+
- `Server Certificate Path`: The path to the certificate file that has been signed by your Certificate Authority (CA) root file in DER or PEM (X.509) format.
29+
- `CA Certificate Path`: The path to the certificate file that is your Certificate Authority (CA) root file in DER or PEM (X.509) format.
3030
- `Private Key Path`: The path to the `.key` private key file that belongs to your Server Certificate Path in DER or PEM (PKCS#8) format.
3131

3232
**Note**: All file paths are made relative to the configuration data directory, which is `/var/lib/observability-pipelines-worker/config/` by default. See [Advanced Worker Configurations][5] for more information. The file must be owned by the `observability-pipelines-worker group` and `observability-pipelines-worker` user, or at least readable by the group or user.

‎content/en/observability_pipelines/sources/fluent.md‎

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,24 +18,40 @@ Use Observability Pipelines' Fluentd or Fluent Bit source to receive logs from t
1818

1919
Select and set up this source when you [set up a pipeline][1]. The information below are for the source settings in the pipeline UI.
2020

21-
- 1. Enter the identifier for your Fluent address.
22-
- **Note**: Only enter the identifier for the address. Do **not** enter the actual address.
23-
- If left blank, the default is used: `SOURCE_FLUENT_ADDRESS`.
21+
<div class="alert alert-danger">Only enter the identifiers for the Fluent address and, if applicable, the TLS key pass. Do <b>not</b> enter the actual values.</div>
22+
23+
1. Enter the identifier for your Fluent address. If you leave it blank, the [default](#set-secrets) is used.
2424

2525
### Optional settings
2626

2727
Toggle the switch to **Enable TLS**. If you enable TLS, the following certificate and key files are required.<br>**Note**: All file paths are made relative to the configuration data directory, which is `/var/lib/observability-pipelines-worker/config/` by default. See [Advanced Worker Configurations][2] for more information. The file must be owned by the `observability-pipelines-worker group` and `observability-pipelines-worker` user, or at least readable by the group or user.
28-
- Enter the identifier for your Fluent key pass.
29-
- **Note**: Only enter the identifier for the key pass. Do **not** enter the actual key pass.
30-
- If left blank, the default is used: `SOURCE_FLUENT_KEY_PASS`.
31-
- `Server Certificate Path`: The path to the certificate file that has been signed by your Certificate Authority (CA) Root File in DER or PEM (X.509) format.
32-
- `CA Certificate Path`: The path to the certificate file that is your Certificate Authority (CA) Root File in DER or PEM (X.509) format.
28+
- Enter the identifier for your Fluent key pass. If you leave it blank, the [default](#set-secrets) is used.
29+
- `Server Certificate Path`: The path to the certificate file that has been signed by your Certificate Authority (CA) root file in DER or PEM (X.509) format.
30+
- `CA Certificate Path`: The path to the certificate file that is your Certificate Authority (CA) root file in DER or PEM (X.509) format.
3331
- `Private Key Path`: The path to the `.key` private key file that belongs to your Server Certificate Path in DER or PEM (PKCS#8) format.
3432

35-
## Set the environment variables
33+
## Set secrets
34+
35+
{{% observability_pipelines/set_secrets_intro %}}
36+
37+
{{< tabs >}}
38+
{{% tab "Secrets Management" %}}
39+
40+
- Fluent address identifier:
41+
- References the address on which the Observability Pipelines Worker listens for incoming log messages.
42+
- The default identifier is `SOURCE_FLUENT_ADDRESS`.
43+
- Fluent TLS passphrase identifier (when TLS is enabled):
44+
- The default identifier is `SOURCE_FLUENT_KEY_PASS`.
45+
46+
{{% /tab %}}
47+
48+
{{% tab "Environment Variables" %}}
3649

3750
{{% observability_pipelines/configure_existing_pipelines/source_env_vars/fluent %}}
3851

52+
{{% /tab %}}
53+
{{< /tabs >}}
54+
3955
## Send logs to the Observability Pipelines Worker over Fluent
4056

4157
{{% observability_pipelines/log_source_configuration/fluent %}}

‎content/en/observability_pipelines/sources/google_pubsub.md‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,27 @@ Select and set up this source when you [set up a pipeline][1]. The information b
2626
1. Select the decoder you want to use (Bytes, GELF, JSON, syslog).
2727
1. Optionally, toggle the switch to enable TLS. If you enable TLS, the following certificate and key files are required.<br>**Note**: All file paths are made relative to the configuration data directory, which is `/var/lib/observability-pipelines-worker/config/` by default. See [Advanced Worker Configurations][3] for more information. The file must be owned by the `observability-pipelines-worker group` and `observability-pipelines-worker` user, or at least readable by the group or user.
2828
- `Server Certificate Path`: The path to the certificate file that has been signed by your Certificate Authority (CA) root file in DER or PEM (X.509).
29-
- `CA Certificate Path`: The path to the certificate file that is your Certificate Authority (CA) Root File in DER or PEM (X.509).
29+
- `CA Certificate Path`: The path to the certificate file that is your Certificate Authority (CA) root file in DER or PEM (X.509).
3030
- `Private Key Path`: The path to the `.key` private key file that belongs to your Server Certificate Path in DER or PEM (PKCS #8) format.
3131

32-
## Set the environment variables
32+
## Set secrets
33+
34+
{{% observability_pipelines/set_secrets_intro %}}
35+
36+
{{< tabs >}}
37+
{{% tab "Secrets Management" %}}
38+
39+
There are no default secret identifiers for this source.
40+
41+
{{% /tab %}}
42+
43+
{{% tab "Environment Variables" %}}
3344

3445
{{% observability_pipelines/configure_existing_pipelines/source_env_vars/google_pubsub %}}
3546

47+
{{% /tab %}}
48+
{{< /tabs >}}
49+
3650
[1]: /observability_pipelines/configuration/set_up_pipelines/
3751
[2]: https://cloud.google.com/kubernetes-engine/docs/concepts/workload-identity
3852
[3]: /observability_pipelines/configuration/install_the_worker/advanced_worker_configurations/

‎content/en/observability_pipelines/sources/http_client.md‎

Lines changed: 38 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,28 +20,26 @@ Select and set up this source when you [set up a pipeline][1]. The information b
2020

2121
To configure your HTTP/S Client source:
2222

23-
1. Enter the identifier for your HTTP Client endpoint URL.
24-
- **Note**: Only enter the identifier for the endpoint URL. Do **not** enter the actual endpoint URL.
25-
- If left blank, the default is used: `SOURCE_HTTP_CLIENT_ENDPOINT_URL`.
23+
24+
<div class="alert alert-danger">Only enter the identifiers for the HTTP Client endpoint URL and, if applicable, your authorization strategy secrets. Do <b>not</b> enter the actual values.</div>
25+
26+
1. Enter the identifier for your HTTP Client endpoint URL. If you leave it blank, the [default](#set-secrets) is used.
2627
1. Select your authorization strategy. If you selected:
2728
- **Basic**:
28-
- Enter the identifier for your HTTP Client username.
29-
- If left blank, the default is used: `SOURCE_HTTP_CLIENT_USERNAME`.
30-
Enter the identifier for your HTTP Client password.
31-
- If left blank, the default is used: `SOURCE_HTTP_CLIENT_PASSWORD`.
32-
- **Bearer**: Enter the identifier for your bearer token.
33-
- If left blank, the default is used: `SOURCE_HTTP_CLIENT_BEARER_TOKEN`.
29+
- Enter the identifier for your HTTP Client username. If you leave it blank, the [default](#set-secrets) is used.
30+
- Enter the identifier for your HTTP Client password. If you leave it blank, the [default](#set-secrets) is used.
31+
- **Bearer**: Enter the identifier for your bearer token. If you leave it blank, the [default](#set-secrets) is used.
3432
1. Select the decoder you want to use on the HTTP messages. Logs pulled from the HTTP source must be in this format.
3533

3634
### Optional settings
3735

3836
#### Enable TLS
37+
3938
Toggle the switch to **Enable TLS**. If you enable TLS, the following certificate and key files are required.<br>**Note**: All file paths are made relative to the configuration data directory, which is `/var/lib/observability-pipelines-worker/config/` by default. See [Advanced Worker Configurations][2] for more information. The file must be owned by the `observability-pipelines-worker group` and `observability-pipelines-worker` user, or at least readable by the group or user.
40-
- Enter the identifier for your HTTP Client key pass.
39+
- Enter the identifier for your HTTP Client key pass. If you leave it blank, the [default](#set-secrets) is used.
4140
- **Note**: Only enter the identifier for the key pass. Do **not** enter the actual key pass.
42-
- If left blank, the default is used: `SOURCE_HTTP_CLIENT_KEY_PASS`
43-
- `Server Certificate Path`: The path to the certificate file that has been signed by your Certificate Authority (CA) Root File in DER or PEM (X.509) format.
44-
- `CA Certificate Path`: The path to the certificate file that is your Certificate Authority (CA) Root File in DER or PEM (X.509) format.
41+
- `Server Certificate Path`: The path to the certificate file that has been signed by your Certificate Authority (CA) root file in DER or PEM (X.509) format.
42+
- `CA Certificate Path`: The path to the certificate file that is your Certificate Authority (CA) root file in DER or PEM (X.509) format.
4543
- `Private Key Path`: The path to the `.key` private key file that belongs to your Server Certificate Path in DER or PEM (PKCS#8) format.
4644

4745
#### Scrape settings
@@ -51,9 +49,35 @@ Toggle the switch to **Enable TLS**. If you enable TLS, the following certificat
5149
- Since requests run concurrently, if a scrape takes longer than the interval given, a new scrape is started, which can consume extra resources. Set the timeout to a value lower than the scrape interval to prevent this from happening.
5250
- Enter the timeout for each scrape request.
5351

54-
## Set the environment variables
52+
## Set secrets
53+
54+
{{% observability_pipelines/set_secrets_intro %}}
55+
56+
{{< tabs >}}
57+
{{% tab "Secrets Management" %}}
58+
59+
- HTTP Client endpoint URL identifier:
60+
- References the endpoint from which the Observability Pipelines Worker collects log events.
61+
- The default identifier is `SOURCE_HTTP_CLIENT_ENDPOINT_URL`.
62+
- HTTP Client TLS passphrase identifier (when TLS is enabled):
63+
- The default identifier is `SOURCE_HTTP_CLIENT_KEY_PASS`.
64+
- If you are using basic authentication:
65+
- HTTP Client username identifier:
66+
- The default identifier is `SOURCE_HTTP_CLIENT_USERNAME`.
67+
- HTTP Client password identifier:
68+
- The default identifier is `SOURCE_HTTP_CLIENT_PASSWORD`.
69+
- If you are using bearer authentication:
70+
- HTTP Client bearer token identifier:
71+
- The default identifier is `SOURCE_HTTP_CLIENT_BEARER_TOKEN`.
72+
73+
{{% /tab %}}
74+
75+
{{% tab "Environment Variables" %}}
5576

5677
{{% observability_pipelines/configure_existing_pipelines/source_env_vars/http_client %}}
5778

79+
{{% /tab %}}
80+
{{< /tabs >}}
81+
5882
[1]: /observability_pipelines/configuration/set_up_pipelines/
5983
[2]: /observability_pipelines/configuration/install_the_worker/advanced_worker_configurations/

0 commit comments

Comments
 (0)