[FLINK-35357][docs] Add kubernetes.operator.plugins.listeners config #845
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
1996fanrui
reviewed
Jun 29, 2024
| @@ -182,5 +182,11 @@ | |||
| <td>Map</td> | |||
| <td>Custom HTTP header for HttpArtifactFetcher. The header will be applied when getting the session job artifacts. Expected format: headerKey1:headerValue1,headerKey2:headerValue2.</td> | |||
| </tr> | |||
| <tr> | |||
| <td><h5>kubernetes.operator.plugins.listeners.<listener-name>.class</h5></td> | |||
There was a problem hiding this comment.
Actually, these html files are generated instead of changing manually.
As I understand, you need to update the KubernetesOperatorConfigOptions and run mvn clean install -DskipTests -Pgenerate-docs.
There was a problem hiding this comment.
Thank you for your advice. It seems I have some misconceptions about its construction. I will fix it。
1996fanrui
reviewed
Jul 2, 2024
| @@ -333,6 +333,14 @@ public static String operatorConfigKey(String key) { | |||
| + "WARNING: not intended to be used together with the cron-based " | |||
| + "periodic checkpoint triggering"); | |||
|
|
|||
| @Documentation.Section(SECTION_DYNAMIC) | |||
There was a problem hiding this comment.
Suggested change
| @Documentation.Section(SECTION_DYNAMIC) | |
| @SuppressWarnings("unused") | |
| @Documentation.Section(SECTION_DYNAMIC) |
Adding the @SuppressWarnings("unused") to avoid warning.
| public static final ConfigOption<String> PLUGINS_LISTENERS_CLASS = | ||
| operatorConfig("plugins.listeners.<listener-name>.class") | ||
| .stringType() | ||
| .defaultValue("") |
There was a problem hiding this comment.
Suggested change
| .defaultValue("") | |
| .noDefaultValue() |
|
hi @1996fanrui . Thank you very much for your advice, I have optimized it |
1996fanrui
approved these changes
Jul 2, 2024
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.
What is the purpose of the change
Brief change log
1.Edit docs/layouts/shortcodes/generated/dynamic_section.html
2.Add kubernetes.operator.plugins.listeners config
Verifying this change
Does this pull request potentially affect one of the following parts:
CustomResourceDescriptors: (yes / no) noDocumentation