[FLINK-39006] Fix outdated SSL configuration documentation#27548
[FLINK-39006] Fix outdated SSL configuration documentation#27548zenobiapanvelwalla wants to merge 3 commits intoapache:masterfrom
Conversation
This PR fixes FLINK-39006. The documentation referenced the `security.ssl.enabled` option as being supported for backward compatibility. This option has been removed and is no longer supported in Flink 2.x, so the documentation has been updated to reflect the current behavior.
| - **security.ssl.rest.enabled**: Enable SSL for *REST / external* connections. | ||
|
|
||
| *Note: For backwards compatibility, the **security.ssl.enabled** option still exists and enables SSL for both internal and REST endpoints.* | ||
| *Note: **security.ssl.enabled** option has been removed and is not supported for backward compatibility from Flink 2.x onwards* |
There was a problem hiding this comment.
Minor nit: We may want to tweak the wording around "Flink 2.x onwards" and instead say something like:
Note: The security.ssl.enabled option has been removed and is no longer supported for backward compatibility as of Flink 2.x.
There was a problem hiding this comment.
For consistency, we'll want to ensure this same change is reflected in the corresponding content.zh directory as well at /docs/content.zh/docs/deployment/security/security-ssl.md.
There was a problem hiding this comment.
Thanks for the suggestions! Updated the wording to clarify the behavior as of Flink 2.x.
There was a problem hiding this comment.
Thanks for the contributions — the documentation changes look good to me. Still awaiting CI to wrap up, but I don't really foresee any issues there. I'll approve once those wrap up.
There was a problem hiding this comment.
It looks like CI is currently failing due to an unrelated issue — going to go ahead and approve this as it looks good otherwise. Thanks again!
|
@flinkbot run azure |
github-actions
bot
added
the
community-reviewed
3 participants
This PR fixes FLINK-39006.
The documentation referenced the
security.ssl.enabledoption as being supported for backward compatibility. This option has been removed and is no longer supported in Flink 2.x, so the documentation has been updated to reflect the current behavior.What is the purpose of the change
security.ssl.enabled config option is no longer used in SecurityOptions.java [https://github.com/apache/flink/blob/release-1.20.3/flink-core/src/main/java/org/apache/flink/configuration/SecurityOptions.java#L677]. That is why the document needs to be updated, as rightly pointed out by issue reporter.