Repository navigation
DOCS-3093: Fix inaccuracies on the Node reference - #3137
Merged
Merged
Conversation
Correct statements on the Node page that a kind cluster running the release showed to be wrong.
Correct statements on the Node page that a kind cluster running the release showed to be wrong.
Correct statements on the Node page that a kind cluster running the release showed to be wrong.
Correct statements on the Node page that a kind cluster running the release showed to be wrong.
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The documented Node naming rules incorrectly exclude valid uppercase letters and underscores, with an additional consistency issue in v3.32.
4 open issues
What changed in this PR
Updates Calico Node reference documentation across current and versioned releases to correct datastore behavior, fields, VXLAN MAC handling, and WireGuard address descriptions.
Changes:
- Clarifies Kubernetes datastore Node behavior.
- Adds
addressesandinterfaces. - Corrects naming, VXLAN MAC, and WireGuard documentation.
| File | Description |
|---|---|
calico/reference/resources/node.mdx |
Updates the current Node reference. |
calico_versioned_docs/version-3.33/reference/resources/node.mdx |
Updates the v3.33 Node reference. |
calico_versioned_docs/version-3.32/reference/resources/node.mdx |
Updates the v3.32 Node reference. |
calico_versioned_docs/version-3.31/reference/resources/node.mdx |
Updates the v3.31 Node reference. |
Review effort: Lite
| | Field | Description | Accepted Values | Schema | | ||
| | ----- | -------------------------------- | --------------------------------------------------- | ------ | | ||
| | name | The name of this node. Required. | Alphanumeric string with optional `.`, `_`, or `-`. | string | | ||
| | name | The name of this node. Required. | Lowercase alphanumeric string with optional `.` or `-`. | string | |
| | Field | Description | Accepted Values | Schema | | ||
| | ----- | -------------------------------- | --------------------------------------------------- | ------ | | ||
| | name | The name of this node. Required. | Alphanumeric string with optional `.`, `_`, or `-`. | string | | ||
| | name | The name of this node. Required. | Lowercase alphanumeric string with optional `.` or `-`. | string | |
| | Field | Description | Accepted Values | Schema | | ||
| | ----- | -------------------------------- | --------------------------------------------------- | ------ | | ||
| | name | The name of this node. Required. | Alphanumeric string with optional `.`, `_`, or `-`. | string | | ||
| | name | The name of this node. Required. | Lowercase alphanumeric string with optional `.` or `-`. | string | |
| | Field | Description | Accepted Values | Schema | | ||
| | ----- | -------------------------------- | --------------------------------------------------- | ------ | | ||
| | name | The name of this node. Required. | Alphanumeric string with optional `.`, `_`, or `-`. | string | | ||
| | name | The name of this node. Required. | Lowercase alphanumeric string with optional `.` or `-`. | string | |
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This file contains hidden or 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
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.
Fixes statements on the Node reference that a kind cluster running each release showed to be wrong.
_and uppercase letters.addressesandinterfaces.vxlanTunnelMACAddrisn't set by the system on Linux. When unset, Felix derives the MAC address from the node name.Reproduced in every tree: v3.33.0 for next and 3.33 (native v3 CRD and API server mode), v3.32.2 for 3.32, and v3.31.7 for 3.31.
Not changed, for follow-up:
CALICO_ROUTER_IDis set. This needs an IPv6-only node to show.vxlanTunnelMACAddrV6behaves like the IPv4 field. This needs an IPv6 lab to show.NodeAddress,NodeInterfaceand the Status fields aren't documented. These come from source and weren't tested on a cluster.Preview: