Skip to content

Commit de08ba8

Browse files
DOC-5279 started redesign of secrets pages
1 parent e69b352 commit de08ba8

File tree

3 files changed

+79
-30
lines changed

3 files changed

+79
-30
lines changed

content/integrate/redis-data-integration/data-pipelines/data-pipelines.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -416,11 +416,32 @@ find the preparation guides for the databases that RDI supports in the
416416
[Prepare source databases]({{< relref "/integrate/redis-data-integration/data-pipelines/prepare-dbs" >}})
417417
section.
418418

419+
## Provide authentication secrets
420+
421+
You must provide authentication secrets for your source and target databases
422+
before deploying a pipeline. You can supply the secrets to RDI directly
423+
or for K8s deployments, you can also use an external secret provider, such as
424+
[Vault](https://developer.hashicorp.com/vault) or
425+
[AWS Secrets Manager](https://aws.amazon.com/secrets-manager/).
426+
427+
See [Set secrets]({{< relref "/integrate/redis-data-integration/data-pipelines/set-secrets" >}}) and
428+
[Using an external secret provider]({{< relref "/integrate/redis-data-integration/data-pipelines/secret-providers" >}})
429+
for more information.
430+
431+
419432
## Deploy a pipeline
420433

421-
When your configuration is ready, you must deploy it to start using the pipeline. See
422-
[Deploy a pipeline]({{< relref "/integrate/redis-data-integration/data-pipelines/deploy" >}})
423-
to learn how to do this.
434+
When you have created your configuration, including the [jobs]({{< relref "/integrate/redis-data-integration/data-pipelines/data-pipelines#job-files" >}}), you are
435+
ready to deploy. Use [Redis Insight]({{< relref "/develop/tools/insight/rdi-connector" >}})
436+
to configure and deploy pipelines for both VM and K8s installations.
437+
438+
For VM installations, you can also use the
439+
[`redis-di deploy`]({{< relref "/integrate/redis-data-integration/reference/cli/redis-di-deploy" >}})
440+
command to deploy a pipeline:
441+
442+
```bash
443+
redis-di deploy --dir <path to pipeline folder>
444+
```
424445

425446
## Pipeline lifecycle
426447

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
Title: Using an external secret provider
3+
alwaysopen: false
4+
categories:
5+
- docs
6+
- integrate
7+
- rs
8+
- rdi
9+
description: |
10+
Configure RDI to obtain authentication secrets for your source and target databases
11+
from an external provider.
12+
group: di
13+
linkTitle: External secret providers
14+
summary: Redis Data Integration keeps Redis in sync with the primary database in near
15+
real time.
16+
type: integration
17+
weight: 3
18+
---
19+
20+
For K8s deployments, you can use an external secret provider, such as
21+
[Vault](https://developer.hashicorp.com/vault) or
22+
[AWS Secrets Manager](https://aws.amazon.com/secrets-manager/) to provide
23+
the authentication secrets for your source and target databases.
24+
See the sections below to learn how to do this. If you prefer to set the secrets for RDI manually, see
25+
[Set secrets]({{< relref "/integrate/redis-data-integration/data-pipelines/set-secrets" >}})
26+
for more information.
27+
28+
## Configure an external provider
29+
30+
### Vault
31+
32+
### AWS Secret Manager
33+
34+
## Secret rotation
35+
36+
*Secret rotation* is a technique where secrets are changed automatically
37+
by the provider according to a schedule.
38+
RDI versions 1.10.0 and above let you configure the pipeline to
39+
restart the appropriate K8s pods automatically whenever a secret rotates in
40+
the external provider that you have configured.

content/integrate/redis-data-integration/data-pipelines/deploy.md renamed to content/integrate/redis-data-integration/data-pipelines/set-secrets.md

Lines changed: 15 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,34 @@
11
---
2-
Title: Deploy a pipeline
3-
aliases: /integrate/redis-data-integration/ingest/data-pipelines/data-type-handling/
2+
Title: Set secrets
3+
aliases:
4+
- /integrate/redis-data-integration/ingest/data-pipelines/data-type-handling/
5+
- /integrate/redis-data-integration/data-pipelines/deploy/
46
alwaysopen: false
57
categories:
68
- docs
79
- integrate
810
- rs
911
- rdi
10-
description: Learn how to deploy an RDI pipeline
12+
description: Set authentication secrets for your source and target databases.
1113
group: di
12-
linkTitle: Deploy
14+
linkTitle: Set secrets
1315
summary: Redis Data Integration keeps Redis in sync with the primary database in near
1416
real time.
1517
type: integration
1618
weight: 2
1719
---
1820

19-
The sections below explain how to deploy a pipeline after you have created the required
20-
[configuration]({{< relref "/integrate/redis-data-integration/data-pipelines/data-pipelines" >}}).
21-
22-
## Set secrets
23-
24-
Before you deploy your pipeline, you must set the authentication secrets for the
21+
Before you
22+
[deploy]({{< relref "/integrate/redis-data-integration/data-pipelines/data-pipelines#deploy-a-pipeline" >}})
23+
your pipeline, you must set the authentication secrets for the
2524
source and target databases. Each secret has a name that you can pass to the
2625
[`redis-di set-secret`]({{< relref "/integrate/redis-data-integration/reference/cli/redis-di-set-secret" >}})
27-
command (VM deployment) or the `rdi-secret.sh` script (K8s deployment) to set the secret value.
28-
You can then refer to these secrets in the `config.yaml` file using the syntax "`${SECRET_NAME}`"
29-
(the sample [config.yaml file]({{< relref "/integrate/redis-data-integration/data-pipelines/data-pipelines#the-configyaml-file" >}}) shows these secrets in use).
26+
command (VM deployment) or the `rdi-secret.sh` script (K8s deployment) to set the secret value.
27+
For K8s, you can also configure RDI to obtain the secrets from an
28+
[external provider]({{< relref "/integrate/redis-data-integration/data-pipelines/secret-providers" >}}).
29+
30+
The `config.yaml` file accesses these secrets with the syntax "`${SECRET_NAME}`"
31+
(the sample [config.yaml file]({{< relref "/integrate/redis-data-integration/data-pipelines/data-pipelines#the-configyaml-file" >}}) shows the secrets in use).
3032

3133
The table below lists all valid secret names. Note that the
3234
username and password are required for the source and target, but the other
@@ -249,17 +251,3 @@ kubectl create secret generic target-db-ssl --namespace=rdi \
249251
```
250252

251253
Note that the certificate paths contained in the secrets `SOURCE_DB_CACERT`, `SOURCE_DB_CERT`, and `SOURCE_DB_KEY` (for the source database) and `TARGET_DB_CACERT`, `TARGET_DB_CERT`, and `TARGET_DB_KEY` (for the target database) are internal to RDI, so you *must* use the values shown in the example above. You should only change the certificate paths when you create the `source-db-ssl` and `target-db-ssl` secrets.
252-
253-
## Deploy a pipeline
254-
255-
When you have created your configuration, including the [jobs]({{< relref "/integrate/redis-data-integration/data-pipelines/data-pipelines#job-files" >}}), you are
256-
ready to deploy. Use [Redis Insight]({{< relref "/develop/tools/insight/rdi-connector" >}})
257-
to configure and deploy pipelines for both VM and K8s installations.
258-
259-
For VM installations, you can also use the
260-
[`redis-di deploy`]({{< relref "/integrate/redis-data-integration/reference/cli/redis-di-deploy" >}})
261-
command to deploy a pipeline:
262-
263-
```bash
264-
redis-di deploy --dir <path to pipeline folder>
265-
```

0 commit comments

Comments
 (0)