📖 Metadata propagation docs #5426
Merged
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
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
the
size/S
|
cc @sbueringer |
|
/retitle 📖 Metadata propagation docs |
enxebre
force-pushed
the
metadata-propagation-docs
branch
from
0cbac1d to
dfc2b26
Compare
killianmuldoon
suggested changes
Oct 19, 2021
docs/book/src/developer/architecture/controllers/metadata-propagation.md
Show resolved
Hide resolved
enxebre
force-pushed
the
metadata-propagation-docs
branch
from
dfc2b26 to
66ea9c2
Compare
k8s-ci-robot
added
size/M
enxebre
force-pushed
the
metadata-propagation-docs
branch
from
66ea9c2 to
8cef9f1
Compare
sbueringer
reviewed
Oct 19, 2021
|
|
||
| ## KubeadmControlPlane | ||
| Top-level labels and annotations do not propagate at all. | ||
| MachineTemplate labels and annotations propagate to Machines, InfraMachines and BootstrapConfig. |
There was a problem hiding this comment.
Suggested change
| MachineTemplate labels and annotations propagate to Machines, InfraMachines and BootstrapConfig. | |
| MachineTemplate labels and annotations propagate to Machines, InfraMachines and BootstrapConfigs. |
nit (plural like the others in the list)
There was a problem hiding this comment.
(similar below for MachineSets)
enxebre
force-pushed
the
metadata-propagation-docs
branch
from
8cef9f1 to
5da280d
Compare
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
/lgtm |
Comment on lines
7
to
13
| Top-level labels and annotations do not propagate at all. | ||
| MachineTemplate labels and annotations propagate to Machines, InfraMachines and BootstrapConfigs. | ||
|
|
||
| - .labels => | ||
| - .annotations => | ||
| - .spec.machineTemplate.metadata.labels => Machine.labels, InfraMachine.labels, BootstrapConfig.labels | ||
| - .spec.machineTemplate.metadata.annotations => Machine.annotations, InfraMachine.annotations, BootstrapConfig.annotations |
There was a problem hiding this comment.
Might be we should match explanation with the rule in => notation
Suggested change
| Top-level labels and annotations do not propagate at all. | |
| MachineTemplate labels and annotations propagate to Machines, InfraMachines and BootstrapConfigs. | |
| - .labels => | |
| - .annotations => | |
| - .spec.machineTemplate.metadata.labels => Machine.labels, InfraMachine.labels, BootstrapConfig.labels | |
| - .spec.machineTemplate.metadata.annotations => Machine.annotations, InfraMachine.annotations, BootstrapConfig.annotations | |
| Top-level labels and annotations do not propagate at all. | |
| - `KubeadmControlPlane.labels` => (not propagated) | |
| - `KubeadmControlPlane.annotations` => (not propagated) | |
| MachineTemplate labels and annotations propagate to Machines, InfraMachines and BootstrapConfigs. | |
| - `KubeadmControlPlane.spec.machineTemplate.metadata.labels` => `Machine.labels`, `InfraMachine.labels`, `BootstrapConfig.labels` | |
| - `KubeadmControlPlane.spec.machineTemplate.metadata.annotations` => `Machine.annotations`, `InfraMachine.annotations`, `BootstrapConfig.annotations` |
enxebre
force-pushed
the
metadata-propagation-docs
branch
from
5da280d to
4dca31c
Compare
k8s-ci-robot
removed
the
lgtm
|
/lgtm |
k8s-ci-robot
added
the
lgtm
vincepri
reviewed
Oct 25, 2021
Comment on lines
+1
to
+4
| # 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: |
There was a problem hiding this comment.
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.
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.
|
/approve |
k8s-ci-robot
added
the
approved
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: fabriziopandini, vincepri The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
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.
What this PR does / why we need it:
Add metadata propagation docs
Which issue(s) this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when PR gets merged):Fixes #5397