Skip to content

Commit

Permalink
docs(cdc): Add flag for SASL mechanism.
Browse files Browse the repository at this point in the history 
Documents the new option sasl-mechanism under the kafka superflag.

This change was introduced in Dgraph v21.03.1 with PR hypermodeinc/dgraph#7765.

Example:

    --kafka="...; sasl-mechanism=SCRAM-SHA-512"
  • Loading branch information
@danielmai
danielmai committed Jul 14, 2021
1 parent bdc72d1 commit 1b66c54
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions content/enterprise-features/change-data-capture.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,15 +52,18 @@ dgraph alpha --cdc "file=local-file-path"
The `--cdc` option includes several sub-options that you can use to configure
CDC when running the `dgraph alpha` command:

| Sub-option | Example `dgraph alpha` command option | Notes |
|------------------|-------------------------------------------|----------------------------------------------------------------------|
| `ca-cert` | `--cdc "ca-cert=/cert-dir/ca.crt"` | Path and filename of the CA root certificate used for TLS encryption |
| `client-cert` | `--cdc "client-cert=/c-certs/client.crt"` | Path and filename of the client certificate used for TLS encryption |
| `client-key` | `--cdc "client-cert=/c-certs/client.key"` | Path and filename of the client certificate private key |
| `file` | `--cdc "file=/sink-dir/cdc-file"` | Path and filename of a local file sink (alternative to Kafka sink) |
| `kafka` | `--cdc "kafka=kafka-hostname; sasl-user=tstark; sasl-password=m3Ta11ic"` | Hostname(s) of the Kafka hosts. May require authentication using the `sasl-user` and `sasl-password` sub-options. |
| `sasl-user` | `--cdc "kafka=kafka-hostname; sasl-user=tstark; sasl-password=m3Ta11ic"` | SASL username for Kafka. Requires the `kafka` and `sasl-password` sub-options. |
| `sasl-password` | `--cdc "kafka=kafka-hostname; sasl-user=tstark; sasl-password=m3Ta11ic"` | SASL password for Kafka. Requires the `kafka` and `sasl-username` sub-options. |
| Sub-option | Example `dgraph alpha` command option | Notes |
|------------------|--------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
| `ca-cert` | `--cdc "ca-cert=/cert-dir/ca.crt"` | Path and filename of the CA root certificate used for TLS encryption |
| `client-cert` | `--cdc "client-cert=/c-certs/client.crt"` | Path and filename of the client certificate used for TLS encryption |
| `client-key` | `--cdc "client-cert=/c-certs/client.key"` | Path and filename of the client certificate private key |
| `file` | `--cdc "file=/sink-dir/cdc-file"` | Path and filename of a local file sink (alternative to Kafka sink) |
| `kafka` | `--cdc "kafka=kafka-hostname; sasl-user=tstark; sasl-password=m3Ta11ic"` | Hostname(s) of the Kafka hosts. May require authentication using the `sasl-user` and `sasl-password` sub-options. |
| `sasl-user` | `--cdc "kafka=kafka-hostname; sasl-user=tstark; sasl-password=m3Ta11ic"` | SASL username for Kafka. Requires the `kafka` and `sasl-password` sub-options. |
| `sasl-password` | `--cdc "kafka=kafka-hostname; sasl-user=tstark; sasl-password=m3Ta11ic"` | SASL password for Kafka. Requires the `kafka` and `sasl-username` sub-options. |
| `sasl-password` | `--cdc "kafka=kafka-hostname; sasl-user=tstark; sasl-password=m3Ta11ic"` | SASL password for Kafka. Requires the `kafka` and `sasl-username` sub-options. |
| `sasl-mechanism` | `--cdc "kafka=kafka-hostname; sasl-user=tstark; sasl-password=m3Ta11ic; sasl-mechanism=SCRAM-SHA-512"` | The SASL mechanism for Kafka (`PLAIN`, `SCRAM-SHA-256` or `SCRAM-SHA-512`) |


## CDC data format

Expand Down

0 comments on commit 1b66c54

Please sign in to comment.