Skip to content

Commit f57b065

Browse files
Merge pull request #615 from redis/DOC-4206-rdi-context-info
DOC-4206 add section about contexts
2 parents 916fc83 + aff1da6 commit f57b065

File tree

1 file changed

+42
-2
lines changed

1 file changed

+42
-2
lines changed

content/integrate/redis-data-integration/ingest/quick-start-guide.md

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,44 @@ the `config.yaml` file and then edit the following settings:
7272

7373
At this point, the pipeline is ready to deploy.
7474

75+
### Create a context (optional) {#create-context}
76+
77+
To manage and inspect RDI, you can use the
78+
[`redis-di`]({{< relref "/integrate/redis-data-integration/ingest/reference/cli" >}})
79+
CLI command, which has several subcommands for different purposes. Most of these commands require you
80+
to pass at least two options, `--rdi-host` and `--rdi-port`, to specify the host and port of your
81+
RDI installation. You can avoid typing these options repeatedly by saving the
82+
information in a *context*.
83+
84+
When you activate a context, the saved values of
85+
`--rdi-host`, `--rdi-port`, and a few other options are passed automatically whenever
86+
you use `redis-di`. If you have more than one RDI installation, you can create a context
87+
for each of them and select the one you want to be active using its unique name.
88+
89+
To create a context, use the
90+
[`redis-di add-context`]({{< relref "/integrate/redis-data-integration/ingest/reference/cli/redis-di-add-context" >}})
91+
command:
92+
93+
```bash
94+
redis-di add-context --rdi-host <host> --rdi-port <port> --cluster-host <Redis DB host> --cluster-api-port <Redis DB API port> --cluster-user <Redis DB username> <unique-context-name>
95+
```
96+
97+
These options are required but there are also a few others you can save, such as TLS credentials, if
98+
you are using them (see the
99+
[reference page]({{< relref "/integrate/redis-data-integration/ingest/reference/cli/redis-di-add-context" >}})
100+
for details). When you have created a context, use
101+
[`redis-di set-context`]({{< relref "/integrate/redis-data-integration/ingest/reference/cli/redis-di-set-context" >}})
102+
to activate it:
103+
104+
```bash
105+
redis-di set-context <context name>
106+
```
107+
108+
There are also subcommands to
109+
[list]({{< relref "/integrate/redis-data-integration/ingest/reference/cli/redis-di-list-contexts" >}})
110+
and [delete]({{< relref "/integrate/redis-data-integration/ingest/reference/cli/redis-di-delete-context" >}})
111+
contexts.
112+
75113
### Deploy the pipeline
76114

77115
You can use Redis Insight to deploy the pipeline by adding a connection to the RDI API
@@ -81,13 +119,15 @@ endpoint (which has the same IP address as your RDI VM and uses port 8083) and t
81119
redis-di deploy --dir <path to pipeline folder>
82120
```
83121

84-
where the path is the one you supplied earlier during the installation. RDI first
122+
where the path is the one you supplied earlier during the installation. (You may also need
123+
to supply `--rdi-host` and `--rdi-port` options if you are not using a
124+
[context](#create-context) as described above.) RDI first
85125
validates your pipeline and then deploys it if the configuration is correct.
86126

87127
Once the pipeline is running, you can use Redis Insight to view the data flow using the
88128
pipeline metrics. You can also connect to your target database to see the keys that RDI has written there.
89129

90-
### View RDI's reponse to data changes
130+
### View RDI's response to data changes
91131

92132
Once the pipeline has loaded a *snapshot* of all the existing data from the source,
93133
it enters *change data capture (CDC)* mode (see the

0 commit comments

Comments
 (0)