feat(conf) implement 'node_id' for configurable node ID #10385
Conversation
|
@gszr Rebased. Thank you for the prompt review. |
|
At first glance test failures do not look related; I have logged the failure and restarted the job. |
|
Tests seem to be consistently failing but are not related. |
|
We will need to dig further. @hbagdi can you please run some local testing comparing your branch to |
hbagdi
force-pushed
the
feat/node-id
branch
2 times, most recently
from
aab9a61 to
adb2179
Compare
| @@ -1845,3 +1845,7 @@ | |||
| # behavior and explicitly instructs Kong which | |||
| # OpenResty installation to use. | |||
|
|
|||
| #node_id = # Node ID for the Kong node. Every Kong node | |||
| # in a Kong cluster must have a unique and | |||
There was a problem hiding this comment.
| # in a Kong cluster must have a unique and | |
| # in a Kong cluster must have an unique and |
There was a problem hiding this comment.
"a unique" is correct; please see https://preply.com/en/question/which-is-correct-a-unique-or-an-unique-49748
hbagdi
force-pushed
the
feat/node-id
branch
3 times, most recently
from
5d55be2 to
264659e
Compare
hbagdi
force-pushed
the
feat/node-id
branch
2 times, most recently
from
f52a24e to
368f8d2
Compare
|
@gszr @chronolaw This should be ready for another review. |
kong/pdk/node.lua
Outdated
| end | ||
| end | ||
| -- 3. generate a new id | ||
| if not node_id then | ||
| _NODE.get_id() |
There was a problem hiding this comment.
i think this can be preserved in the else branch above, so the new id is logged, as it was
There was a problem hiding this comment.
I did this to improve the readability of the code a bit. Is logging the new ID necessary?
If so, I can add another log at the end of these conditional blocks to log it unconditionally.
There was a problem hiding this comment.
IMO it's questionable that it achieves the goal of improving readability -- it introduces an unnecessary conditional. But let's not bikeshed over this; I can approve / merge if you are adamant on the change.
There was a problem hiding this comment.
Let's keep it as is and move on.
There was a problem hiding this comment.
I added a log at INFO level for node-id.
Kong automatically generates node IDs for each node in a cluster. Node IDs are the only unique identifiers that exist to track a Kong node within a cluster (no assumption is made that hostname is unique across all Kong nodes). When integrating closely with an orchestrator, a configurable node ID helps the operator to source the ID from the underlying orchestrator like kubernetes instead of letting Kong generating one. For most customers, letting Kong generate a Node ID will be sufficient.
Summary
Kong automatically generates node IDs for each node in a cluster. Node IDs are the only unique identifiers that exist to track a Kong node within a cluster (no assumption is made that hostname is unique across all Kong nodes).
When integrating closely with an orchestrator, a configurable node ID helps the operator to source the ID from the underlying orchestrator like Kubernetes instead of letting Kong generate one.
For most customers, letting Kong generate a Node ID will be sufficient.
Checklist
Full changelog
node_idconfiguration parameter