Update ssl.mode for PG CDC doc #2678
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
StrikeW
reviewed
Oct 14, 2024
docs/guides/ingest-from-mysql-cdc.md
Outdated
| @@ -168,7 +168,8 @@ All the fields listed below are required. Note that the value of these parameter | |||
| |database.name| Name of the database. Note that RisingWave cannot read data from a built-in MySQL database, such as `mysql`, `sys`, etc.| | |||
| |table.name| Name of the table that you want to ingest data from. | | |||
| |server.id| Required if creating a shared source. A numeric ID of the database client. It must be unique across all database processes that are running in the MySQL cluster. If not specified, RisingWave will generate a random ID.| | |||
| |ssl.mode| Optional. The `ssl.mode` parameter determines the level of SSL/TLS encryption for secure communication with MySQL. It accepts three values: `disabled`, `preferred`, and `required`. The default value is `disabled`. When set to `required`, it enforces TLS for establishing a connection.| | |||
| |ssl.mode| Optional. The `ssl.mode` parameter determines the level of SSL/TLS encryption for secure communication with MySQL. Accepted values are `disabled`, `preferred`,`required`, `verify-ca`, and `verify-full`. The default value is `disabled`. When set to `required`, `verify-ca`, or `verify-full`, it enforces TLS for establishing a connection.| | |||
There was a problem hiding this comment.
Actually the risingwavelabs/risingwave#18015 is for Postgres source only, so we don't need to change doc of MySQL.
There was a problem hiding this comment.
Saw the supported values for ssl.mode in MySQL cdc also changed, so still no need to document this? 🤔
There was a problem hiding this comment.
You can scroll up a bit, mysql source will reject those PG specific options. The intention of code here is to make them a no-op.
docs/guides/ingest-from-mysql-cdc.md
Outdated
| @@ -168,7 +168,8 @@ All the fields listed below are required. Note that the value of these parameter | |||
| |database.name| Name of the database. Note that RisingWave cannot read data from a built-in MySQL database, such as `mysql`, `sys`, etc.| | |||
| |table.name| Name of the table that you want to ingest data from. | | |||
| |server.id| Required if creating a shared source. A numeric ID of the database client. It must be unique across all database processes that are running in the MySQL cluster. If not specified, RisingWave will generate a random ID.| | |||
| |ssl.mode| Optional. The `ssl.mode` parameter determines the level of SSL/TLS encryption for secure communication with MySQL. It accepts three values: `disabled`, `preferred`, and `required`. The default value is `disabled`. When set to `required`, it enforces TLS for establishing a connection.| | |||
| |ssl.mode| Optional. The `ssl.mode` parameter determines the level of SSL/TLS encryption for secure communication with MySQL. Accepted values are `disabled`, `preferred`,`required`, `verify-ca`, and `verify-full`. The default value is `disabled`. When set to `required`, `verify-ca`, or `verify-full`, it enforces TLS for establishing a connection.| | |||
| | ssl.root.cert | Optional. Specify the root certificate secret.| | |||
| @@ -202,7 +202,8 @@ Unless specified otherwise, the fields listed are required. Note that the value | |||
| |schema.name| Optional. Name of the schema. By default, the value is `public`. | | |||
| |table.name| Name of the table that you want to ingest data from. | | |||
| |slot.name| Optional. The [replication slot](https://www.postgresql.org/docs/14/logicaldecoding-explanation.html#LOGICALDECODING-REPLICATION-SLOTS) for this PostgreSQL source. By default, a unique slot name will be randomly generated. Each source should have a unique slot name. Valid replication slot names must contain only lowercase letters, numbers, and underscores, and be no longer than 63 characters.| | |||
| |ssl.mode| Optional. The `ssl.mode` parameter determines the level of SSL/TLS encryption for secure communication with Postgres. It accepts three values: `disabled`, `preferred`, and `required`. The default value is `disabled`. When set to `required`, it enforces TLS for establishing a connection.| | |||
| |ssl.mode| Optional. The `ssl.mode` parameter determines the level of SSL/TLS encryption for secure communication with Postgres. Accepted values are `disabled`, `preferred`, `required`, `verify-ca`, and `verify-full`. The default value is `disabled`. <ul><li>When set to `required`, it enforces TLS for establishing a connection; </li><li>When set to `verify-ca`, it verifies that the server is trustworthy by checking the certificate chain up to the root certificate stored on the client;</li><li>When set to `verify-full`, it verifies the certificate and also ensures the server hostname matches the name in the certificate.</li></ul> | | |||
| | ssl.root.cert | Optional. Specify the root certificate secret.| | |||
There was a problem hiding this comment.
I think we need to clarify the term secret, which is related to the our own secret manager. The user needs to CREATE SECRET first before filling in here.
WanYixian
changed the title
|
All updated, please take another look @StrikeW |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
verify-ca, andverify-fullfor SSL.modessl.root.certRelated code PR
risingwavelabs/risingwave#18015
Related doc issue
Resolve #2605
Rendered preview
PG:
MySQL:
Checklist
emile-00,hengm3467, &WanYixian).