Skip to content

Commit 781c75e

Browse files
committed
refactor: Descriptions on Well-Known Annotations/Labels/Taints
1 parent 031f87e commit 781c75e

File tree

1 file changed

+15
-10
lines changed
  • content/en/docs/reference/labels-annotations-taints

1 file changed

+15
-10
lines changed

content/en/docs/reference/labels-annotations-taints/_index.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This document serves both as a reference to the values and as a coordination poi
1919

2020
Example: `app.kubernetes.io/component: "database"`
2121

22-
Used on: All Objects
22+
Used on: All Objects (typically used on [workload resources](/docs/reference/kubernetes-api/workload-resources/)).
2323

2424
The component within the architecture.
2525

@@ -29,7 +29,7 @@ One of the [recommended labels](/docs/concepts/overview/working-with-objects/com
2929

3030
Example: `app.kubernetes.io/created-by: "controller-manager"`
3131

32-
Used on: All Objects
32+
Used on: All Objects (typically used on [workload resources](/docs/reference/kubernetes-api/workload-resources/)).
3333

3434
The controller/user who created this resource.
3535

@@ -41,17 +41,17 @@ Starting from v1.9, this label is deprecated.
4141

4242
Example: `app.kubernetes.io/instance: "mysql-abcxzy"`
4343

44-
Used on: All Objects
44+
Used on: All Objects (typically used on [workload resources](/docs/reference/kubernetes-api/workload-resources/)).
4545

46-
A unique name identifying the instance of an application.
46+
A unique name identifying the instance of an application. To assign a non-unique name, use [app.kubernetes.io/name](#app-kubernetes-io-name).
4747

4848
One of the [recommended labels](/docs/concepts/overview/working-with-objects/common-labels/#labels).
4949

5050
### app.kubernetes.io/managed-by
5151

5252
Example: `app.kubernetes.io/managed-by: "helm"`
5353

54-
Used on: All Objects
54+
Used on: All Objects (typically used on [workload resources](/docs/reference/kubernetes-api/workload-resources/)).
5555

5656
The tool being used to manage the operation of an application.
5757

@@ -61,7 +61,7 @@ One of the [recommended labels](/docs/concepts/overview/working-with-objects/com
6161

6262
Example: `app.kubernetes.io/name: "mysql"`
6363

64-
Used on: All Objects
64+
Used on: All Objects (typically used on [workload resources](/docs/reference/kubernetes-api/workload-resources/)).
6565

6666
The name of the application.
6767

@@ -71,19 +71,24 @@ One of the [recommended labels](/docs/concepts/overview/working-with-objects/com
7171

7272
Example: `app.kubernetes.io/part-of: "wordpress"`
7373

74-
Used on: All Objects
74+
Used on: All Objects (typically used on [workload resources](/docs/reference/kubernetes-api/workload-resources/)).
7575

76-
The name of a higher level application this one is part of.
76+
The name of a higher-level application this one is part of.
7777

7878
One of the [recommended labels](/docs/concepts/overview/working-with-objects/common-labels/#labels).
7979

8080
### app.kubernetes.io/version
8181

8282
Example: `app.kubernetes.io/version: "5.7.21"`
8383

84-
Used on: All Objects
84+
Used on: All Objects (typically used on [workload resources](/docs/reference/kubernetes-api/workload-resources/)).
85+
86+
The current version of the application.
87+
88+
Common forms of values include:
8589

86-
The current version of the application (e.g., a semantic version, revision hash, etc.).
90+
- [semantic version](https://semver.org/spec/v1.0.0.html)
91+
- the Git [revision hash](https://git-scm.com/book/en/v2/Git-Tools-Revision-Selection#_single_revisions) for the source code.
8792

8893
One of the [recommended labels](/docs/concepts/overview/working-with-objects/common-labels/#labels).
8994

0 commit comments

Comments
 (0)