Update host endpoint controller configuration #1933
+107
−20
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
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
ctauchen
reviewed
Mar 5, 2025
| @@ -4,6 +4,8 @@ description: API for KubeControllersConfiguration resource. | |||
|
|
|||
| # Kubernetes controllers configuration | |||
|
|
|||
| import Selectors from '@site/calico/_includes/content/_selectors.mdx'; | |||
There was a problem hiding this comment.
For consistency, please move to between the front matter and H1.
| @@ -28,6 +28,9 @@ $[prodname] creates a wildcard host endpoint for each node, with the host endpoi | |||
| $[prodname] will ensure these managed host endpoints maintain the same labels and IP addresses as its node by periodic syncs. | |||
| This means that policy targeting these automatic host endpoints will function correctly with the policy put in place to select those nodes, even if over time the node's IPs or labels change. | |||
|
|
|||
| $[prodname] is also able to create and manage custom host endpoints for nodes, based on user specified templates. | |||
| This allows you to fine tune which interfaces should be included in the host endpoint and for which nodes these host endpoints should be created. The host endpoint templates can be enabled by updating [KubeControllersConfig](../../reference/resources/kubecontrollersconfig) | |||
There was a problem hiding this comment.
Suggested change
| This allows you to fine tune which interfaces should be included in the host endpoint and for which nodes these host endpoints should be created. The host endpoint templates can be enabled by updating [KubeControllersConfig](../../reference/resources/kubecontrollersconfig) | |
| This allows you to fine-tune which interfaces should be included in the host endpoint and for which nodes these host endpoints should be created. | |
| The host endpoint templates can be enabled by updating [KubeControllersConfig](../../reference/resources/kubecontrollersconfig.mdx). |
| | hostEndpoint | Controls allocation of host endpoints | | [HostEndpoint](#hostendpoint) | | | ||
| | reconcilerPeriod | Period to perform reconciliation with the $[prodname] datastore | | [Duration string][parse-duration] | 5m | | ||
| | syncLabels | When enabled, Kubernetes node labels will be copied to $[prodname] node objects. | Enabled, Disabled | string | Enabled | | ||
| | hostEndpoint | Configure the host endpoint controller | | [HostEndpoint](#hostendpoint) | | |
There was a problem hiding this comment.
Suggested change
| | hostEndpoint | Configure the host endpoint controller | | [HostEndpoint](#hostendpoint) | | | |
| | hostEndpoint | Configures the host endpoint controller | | [HostEndpoint](#hostendpoint) | | |
| | ------------------------- | ---------------------------------------------------------------- | ----------------- | --------------------- | -------- | | ||
| | autoCreate | When enabled, automatically create a host endpoints | Enabled, Disabled | string | Disabled | | ||
| | createDefaultHostEndpoint | When enabled, default host endpoint will be created | Enabled, Disabled | string | Enabled | | ||
| | templates | Controlls creation of custom host endpoints | | [Template](#template) | | |
There was a problem hiding this comment.
Suggested change
| | templates | Controlls creation of custom host endpoints | | [Template](#template) | | | |
| | templates | Controls creation of custom host endpoints | | [Template](#template) | | |
| | Field | Description | Accepted Values | Schema | Default | | ||
| | ------------------------- | ----------------------------------------------------------------------------------- | ------------------- | ---------------------- | -------- | | ||
| | name | Unique name used as suffix for host endpoints created based on this template | Alphanumeric string | string | | | ||
| | nodeSelector | Selects the nodes for which this template should create host endpoint | | [Selector](#selectors) | all() | |
There was a problem hiding this comment.
Suggested change
| | nodeSelector | Selects the nodes for which this template should create host endpoint | | [Selector](#selectors) | all() | | |
| | nodeSelector | Selects the nodes for which this template should create host endpoints | | [Selector](#selectors) | all() | |
Comment on lines
101
to
105
| ### Label | ||
| | Field | Description | Accepted Values | Schema | Default | | ||
| | ------------------------- | ---------------------------------------------------------------- | ------------------- | --------- | -------- | | ||
| | name | Name for the label | Alphanumeric string | string | | | ||
| | value | Label value | Alphanumeric string | string | | |
There was a problem hiding this comment.
This section seems not to add much value. I had a look at other resources, and none had a similar section.
Do we really need this?
| | autoCreate | When enabled, automatically create a host endpoint for each node | Enabled, Disabled | string | Disabled | | ||
| | Field | Description | Accepted Values | Schema | Default | | ||
| | ------------------------- | ---------------------------------------------------------------- | ----------------- | --------------------- | -------- | | ||
| | autoCreate | When enabled, automatically create a host endpoints | Enabled, Disabled | string | Disabled | |
There was a problem hiding this comment.
Suggested change
| | autoCreate | When enabled, automatically create a host endpoints | Enabled, Disabled | string | Disabled | | |
| | autoCreate | When enabled, automatically create host endpoints | Enabled, Disabled | string | Disabled | |
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.
Update host endpoint configuration docs to include auto host endpoint updates
Product Version(s):
Calico, Calico Enterprise, and Calico Cloud
Issue:
Link to docs preview:
SME review:
DOCS review:
Additional information:
Merge checklist: