Use Recommended Labels in Examples #53389
Conversation
Update examples and documentation to use the app.kubernetes.io/name reccomended label in place of labels such as "app", "name", etc. Labels which do not have a recommended variant, such as "tier", "role", or "k8s-app", have not been modified. Blog posts have also not been modified.
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
size/XL
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Much appreciated! |
lmktfy
left a comment
lmktfy
left a comment
There was a problem hiding this comment.
I think if me merge this we would make the docs better, but I also think that we'd introduce some places we then ought to go and fix.
|
|
||
| 1. Run the following commands to delete all Pods, Deployments, and Services. | ||
|
|
||
| ```shell |
There was a problem hiding this comment.
It might be good to teach app.kubernetes.io/part-of here too. What do you think?
| selector: | ||
| matchLabels: | ||
| app: ssd-driver-pod | ||
| app.kubernetes.io/name: ssd-driver-pod |
There was a problem hiding this comment.
Hmm, not sure about this one. It's not exactly an app, and highlighting the difference may help people learn.
How about using driver-name: example-ssd-driver, and updating the running text?
(for an easy-ish life, rebase the PR and omit the DaemonSet parts, then we can get someone else to revisit them)
| selector: | ||
| matchLabels: | ||
| name: fluentd-elasticsearch | ||
| app.kubernetes.io/name: fluentd-elasticsearch |
There was a problem hiding this comment.
This seems fair. It's an app enough that we can use the label without quibbling. Many people would call Elasticsearch an app.
| namespace: dra-tutorial | ||
| labels: | ||
| app: pod | ||
| app.kubernetes.io/name: pod |
There was a problem hiding this comment.
Hmm. Not at all sure I support this specific change.
| name: audit-pod | ||
| labels: | ||
| app: audit-pod | ||
| app.kubernetes.io/name: audit-pod |
There was a problem hiding this comment.
If it needs a label, I would use a private label that is nothing to with app.
| spec: | ||
| selector: | ||
| app: hello | ||
| app.kubernetes.io/name: hello |
There was a problem hiding this comment.
For this one, the running text might need a tweak too to explain that some of these labels have a cluster-private meaning, and some have a definite public meaning.
| selector: | ||
| matchLabels: | ||
| app: hello | ||
| app.kubernetes.io/name: hello |
There was a problem hiding this comment.
For this one, the running text might need a tweak too to explain that some of these labels have a cluster-private meaning, and some have a definite public meaning.
| selector: | ||
| matchLabels: | ||
| app: curlpod | ||
| app.kubernetes.io/name: curlpod |
| name: my-daemonset | ||
| labels: | ||
| app: foo | ||
| app.kubernetes.io/name: foo |
There was a problem hiding this comment.
For a DaemonSet, I might not suggest an "app" label.
3 participants
Description
Update examples and documentation to use the "app.kubernetes.io/name" recommended label in place of labels such as "app", "name", etc.
Labels which do not have a recommended variant, such as "tier", "role", or "k8s-app", have not been modified. Blog posts have also not been modified.
Issue
N/A