From c721799f29aa6b44b4f0a581e5be6404f999734b Mon Sep 17 00:00:00 2001 From: Ti Chi Robot Date: Mon, 3 Jul 2023 09:50:12 +0800 Subject: [PATCH] add encode password description for ticdc doc (#14042) (#14065) --- ticdc/ticdc-open-api.md | 2 +- ticdc/ticdc-sink-to-kafka.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/ticdc/ticdc-open-api.md b/ticdc/ticdc-open-api.md index 2359abf8a77dd..38b36c95846c2 100644 --- a/ticdc/ticdc-open-api.md +++ b/ticdc/ticdc-open-api.md @@ -167,7 +167,7 @@ The configuration parameters of sink are as follows: ### Example -The following request creates a replication task with an ID of `test5` and a `sink_uri` of `blackhome://`. +The following request creates a replication task with an ID of `test5` and a `sink_uri` of `blackhole://`. {{< copyable "shell-regular" >}} diff --git a/ticdc/ticdc-sink-to-kafka.md b/ticdc/ticdc-sink-to-kafka.md index cc41ddd388561..73411a3801b49 100644 --- a/ticdc/ticdc-sink-to-kafka.md +++ b/ticdc/ticdc-sink-to-kafka.md @@ -68,14 +68,14 @@ The following are descriptions of sink URI parameters and values that can be con | `key` | The path of the certificate key file needed to connect to the downstream Kafka instance (optional). | | `insecure-skip-verify` | Whether to skip certificate verification when connecting to the downstream Kafka instance (optional, `false` by default, introduced in v6.5.3). | | `sasl-user` | The identity (authcid) of SASL/PLAIN or SASL/SCRAM authentication needed to connect to the downstream Kafka instance (optional). | -| `sasl-password` | The password of SASL/PLAIN or SASL/SCRAM authentication needed to connect to the downstream Kafka instance (optional). | +| `sasl-password` | The password of SASL/PLAIN or SASL/SCRAM authentication needed to connect to the downstream Kafka instance (optional). If it contains special characters, they need to be URL encoded. | | `sasl-mechanism` | The name of SASL authentication needed to connect to the downstream Kafka instance. The value can be `plain`, `scram-sha-256`, `scram-sha-512`, or `gssapi`. | | `sasl-gssapi-auth-type` | The gssapi authentication type. Values can be `user` or `keytab` (optional). | | `sasl-gssapi-keytab-path` | The gssapi keytab path (optional).| | `sasl-gssapi-kerberos-config-path` | The gssapi kerberos configuration path (optional). | | `sasl-gssapi-service-name` | The gssapi service name (optional). | | `sasl-gssapi-user` | The user name of gssapi authentication (optional). | -| `sasl-gssapi-password` | The password of gssapi authentication (optional). | +| `sasl-gssapi-password` | The password of gssapi authentication (optional). If it contains special characters, they need to be URL encoded. | | `sasl-gssapi-realm` | The gssapi realm name (optional). | | `sasl-gssapi-disable-pafxfast` | Whether to disable the gssapi PA-FX-FAST (optional). | | `dial-timeout` | The timeout in establishing a connection with the downstream Kafka. The default value is `10s`. |