-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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.
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
📖 Metadata propagation docs #5426
Merged
k8s-ci-robot
merged 1 commit into
kubernetes-sigs:main
from
enxebre:metadata-propagation-docs
Oct 25, 2021
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
33 changes: 33 additions & 0 deletions
33
docs/book/src/developer/architecture/controllers/metadata-propagation.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # Metadata propagation | ||
| Cluster API controllers implement consistent metadata (labels & annotations) propagation across the core API resources. | ||
| This behaviour tries to be consistent with kubernetes apps/v1 Deployment and ReplicaSet. | ||
| New providers should behave accordingly fitting within the following pattern: | ||
|
|
||
| ## KubeadmControlPlane | ||
enxebre marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Top-level labels and annotations do not propagate at all. | ||
| - `.labels` => Not propagated. | ||
| - `.annotations` => Not propagated. | ||
|
|
||
| MachineTemplate labels and annotations propagate to Machines, InfraMachines and BootstrapConfigs. | ||
| - `.spec.machineTemplate.metadata.labels` => `Machine.labels`, `InfraMachine.labels`, `BootstrapConfig.labels` | ||
| - `.spec.machineTemplate.metadata.annotations` => `Machine.annotations`, `InfraMachine.annotations`, `BootstrapConfig.annotations` | ||
|
|
||
| ## MachineDeployment | ||
| Top-level labels do not propagate at all. | ||
| Top-level annotations propagate to MachineSets top-level annotations. | ||
| - `.labels` => Not propagated. | ||
| - `.annotations` => MachineSet.annotations | ||
|
|
||
| Template labels propagate to MachineSets top-level and MachineSets template metadata. | ||
| Template annotations propagate to MachineSets template metadata. | ||
| - `.spec.template.metadata.labels` => `MachineSet.labels`, `MachineSet.spec.template.metadata.labels` | ||
| - `.spec.template.metadata.annotations` => `MachineSet.spec.template.metadata.annotations` | ||
|
|
||
| ## MachineSet | ||
| Top-level labels and annotations do not propagate at all. | ||
| - `.labels` => Not propagated. | ||
| - `.annotations` => Not propagated. | ||
|
|
||
| Template labels and annotations propagate to Machines, InfraMachines and BootstrapConfigs. | ||
| - `.spec.template.metadata.labels` => `Machine.labels`, `InfraMachine.labels`, `BootstrapConfig.labels` | ||
| - `.spec.template.metadata.annotations` => `Machine.annotations`, `InfraMachine.annotations`, `BootstrapConfig.labels` | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm ok merging this as-is, have we considered in alternative to add these details to each respective page?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As a recurring topic that crosses multiple CRDs I find it useful to have it all in one single place but I'm fine either way, happy to hear others thoughts.