Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(conf): add description about cluster_rpc and cluster_rpc_sync #14278

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

chore(conf): add description about cluster_rpc and cluster_rpc_sync #14278

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
80acb28
chore(conf): add discription about cluster_rpc and cluster_rpc_sync
chronolaw Feb 14, 2025
9d9b326
more details
chronolaw Feb 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions kong.conf.default
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -345,6 +345,13 @@
# - certificate content
# - base64 encoded certificate content

#cluster_rpc = # Enable/disable cluster rpc framework.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

# The default value is `off`.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment on lines +348 to +349
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#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
Copy link

@EuclidYongSun EuclidYongSun Feb 28, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

# The default value is `off`.
# If cluster_rpc is `off`, then cluster_rpc_sync will always be `off`.
Comment on lines +351 to +353
Copy link
Contributor

@lena-larionova lena-larionova Feb 28, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#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.


#------------------------------------------------------------------------------
# HYBRID MODE DATA PLANE
#------------------------------------------------------------------------------
Expand Down