chore(conf): add description about cluster_rpc and cluster_rpc_sync #14278
Conversation
bungle
changed the title
|
per the blog: https://konghq.com/blog/product-releases/incremental-config-sync-tech-preview
|
Yes, |
| @@ -345,6 +345,13 @@ | |||
| # - certificate content | |||
| # - base64 encoded certificate content | |||
|
|
|||
| #cluster_rpc = # Enable/disable cluster rpc framework. | |||
| # The default value is `off`. | |||
There was a problem hiding this comment.
Suggestions for the description:
The settings to enable or disable the RPC based communication between control plane and data plane nodes.
The valid values are on and off, default is off.
This should be set to on when cluster_rpc_sync is set to on.
| #cluster_rpc = # Enable/disable cluster rpc framework. | ||
| # The default value is `off`. | ||
|
|
||
| #cluster_rpc_sync = # Enable/disable cluster rpc sync protocol |
There was a problem hiding this comment.
Suggestions for the description:
The settings to enable or disable the feature of incremental synchronization of configuration changes.
The valid values are on and off, default is off.
To enable this feature, cluster_rpc set as on is required, otherwise this field is ignored.
There was a problem hiding this comment.
And should we mention it needs to be set to on for both control plane and data plane nodes in hybrid mode.
It needs to be set to on for data plane nodes for Konnect.
| @@ -345,6 +345,13 @@ | |||
| # - certificate content | |||
| # - base64 encoded certificate content | |||
|
|
|||
| #cluster_rpc = # Enable/disable cluster rpc framework. | |||
There was a problem hiding this comment.
And should we mention it needs to be set to on for both control plane and data plane nodes in hybrid mode.
It needs to be set to on for data plane nodes for Konnect.
| #cluster_rpc = # Enable/disable cluster rpc framework. | ||
| # The default value is `off`. |
There was a problem hiding this comment.
| #cluster_rpc = # Enable/disable cluster rpc framework. | |
| # The default value is `off`. | |
| #cluster_rpc = off # The setting to enable or disable RPC-based | |
| # communication between control plane and data plane nodes. | |
| # The valid values are `on` and `off.` Set to `on` to enable. | |
| # If `cluster_rpc_sync` is set to `on`, this parameter | |
| # must also be set to `on`. |
I used Euclid's suggestion and rephrased it for readability.
You don't need to say what the default value is in the description, that goes next to the parameter itself.
| #cluster_rpc_sync = # Enable/disable cluster rpc sync protocol | ||
| # The default value is `off`. | ||
| # If cluster_rpc is `off`, then cluster_rpc_sync will always be `off`. |
There was a problem hiding this comment.
| #cluster_rpc_sync = # Enable/disable cluster rpc sync protocol | |
| # The default value is `off`. | |
| # If cluster_rpc is `off`, then cluster_rpc_sync will always be `off`. | |
| #cluster_rpc_sync = off # The setting to enable or disable the incremental | |
| # synchronization of configuration changes. | |
| # The valid values are `on` and `off.` To enable, set this | |
| # value to `on`, and set `cluster_rpc` to `on`. | |
| # This setting will be ignored if `cluster_rpc` is `off`. | |
| # | |
| # In hybrid mode, this setting must be configured | |
| # on both control plane and data plane nodes. |
Summary
KAG-6373
We need someone else to make it more readable.
Checklist
changelog/unreleased/kongorskip-changeloglabel added on PR if changelog is unnecessary. README.mdIssue reference
Fix #[issue number]