add a note about SSL with JDBC #331
Conversation
docs/sink_config_options.rst
Outdated
| will need to configure SSL via the ``connection.url`` parameter. For example, with mysql it would | ||
| look like: | ||
|
|
||
| ..sourcecode bash: |
There was a problem hiding this comment.
You can use properties instead of bash for the highlighting if you want. LGTM
|
@cotedm One small thing but LGTM. |
docs/sink_config_options.rst
Outdated
|
|
||
| In the connector configuration you will notice there are no security parameters. This is because | ||
| SSL is not part of the JDBC standard and will depend on the JDBC driver in use. In general, you | ||
| will need to configure SSL via the ``connection.url`` parameter. For example, with mysql it would |
There was a problem hiding this comment.
nit: mysql should either be monotype font to indicate protocol in the connection url or MySQL to match the product name
docs/sink_config_options.rst
Outdated
| @@ -3,6 +3,19 @@ | |||
| JDBC Sink Configuration Options | |||
| ------------------------------- | |||
|
|
|||
| Security | |||
There was a problem hiding this comment.
nit: maybe emphasize which connection this security refers to? Kafka security is via worker config, but new users may not always realize that. maybe "Database Connection Security" or something like that?
docs/source_config_options.rst
Outdated
| Security | ||
| ^^^^^^^^ | ||
|
|
||
| In the connector configuration you will notice there are no security parameters. This is because |
There was a problem hiding this comment.
if you're going to repeat text, it is possible to include the same text via an include. @joel-hamill recently started using these to make repeated text more manageable. seems reasonable to do here, and he might have more guidance on how it makes best sense to manage this going forward.
There was a problem hiding this comment.
yeah this makes sense, I gave the include directive a shot in the latest commit. I can already see just in making a couple of changes how mistake prone this repeated text would be if copied in multiple places. If it looks ok to @joel-hamill then I'll merge.
|
@joel-hamill I added you as a reviewer to make sure I'm using this |
docs/db_connection_security.rst
Outdated
| @@ -0,0 +1,12 @@ | |||
| Database Connection Security | |||
There was a problem hiding this comment.
@cotedm for the include, the convention is to nest in an /includes folder (e.g. connect-jdbc/docs/includes/db_connection_security.rst). also, not an issue here, but eventually if you have more than one string to include, you can do this by referencing the specific line numbers for your include (see https://github.com/confluentinc/docs#content-reuse).
There was a problem hiding this comment.
i've added more explanation here as well https://github.com/confluentinc/docs/pull/650
There was a problem hiding this comment.
thanks @joel-hamill! how's this look? If it's good, I think we're ok to merge :)
| will need to configure SSL via the ``connection.url`` parameter. For example, with MySQL it would | ||
| look like: | ||
|
|
||
| ..sourcecode properties: |
There was a problem hiding this comment.
this should be .. sourceode:: properties. right now it is rendering weirdly because it's not being interpreted as an rst command
There was a problem hiding this comment.
yeah, the output is messed up
| will need to configure SSL via the ``connection.url`` parameter. For example, with MySQL it would | ||
| look like: | ||
|
|
||
| ..sourcecode properties: |
There was a problem hiding this comment.
yeah, the output is messed up
|
@joel-hamill I pushed a fix for the formatting issue if you want to verify. Then I think we're good to merge. |
This is to update the docs to explain SSL config a bit more for this connector.