mirror of https://github.com/helm/helm
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
38 lines
1.7 KiB
38 lines
1.7 KiB
8 years ago
|
# Labels and Annotations
|
||
|
|
|
||
|
|
This part of the Best Practices Guide discusses the best practices for using
|
||
|
|
labels and annotations in your chart.
|
||
|
|
|
||
|
|
## Is it a Label or an Annotation?
|
||
|
|
|
||
|
|
An item of metadata should be a label under the following conditions:
|
||
|
|
|
||
|
|
- It is used by Kubernetes to identify this resource
|
||
|
|
- It is useful to expose to operators for the purpose of querying the system.
|
||
|
|
|
||
|
|
For example, we suggest using `chart: NAME-VERSION` as a label so that operators
|
||
|
|
can conveniently find all of the instances of a particular chart to use.
|
||
|
|
|
||
|
|
If an item of metadata is not used for querying, it should be set as an annotation
|
||
|
|
instead.
|
||
|
|
|
||
|
|
Helm hooks are always annotations.
|
||
|
|
|
||
|
|
## Standard Labels
|
||
|
|
|
||
|
|
The following table defines common labels that Helm charts use. Helm itself never requires that a particular label be present. Labels that are marked REC
|
||
|
|
are recommended, and _should_ be placed onto a chart for global consistency. Those marked OPT are optional. These are idiomatic or commonly in use, but are not relied upon frequently for operational purposes.
|
||
|
|
|
||
|
|
Name|Status|Description
|
||
|
|
-----|------|----------
|
||
|
|
heritage | REC | This should always be set to `Tiller`. It is for finding all things managed by Tiller.
|
||
|
|
release | REC | This should be the `{{ .Release.Name }}`.
|
||
|
|
chart | REC | This should be the chart name and version: `{{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }}`.
|
||
|
|
app | OPT | This should be the app name, reflecting the entire app. Often the chart's `{{ .Chart.Name }}` is used for this. This is used by many Kubernetes manifests, and is not Helm-specific.
|
||
|
|
component | OPT | This is a common label for marking the different roles that pieces may play in an application. For example, `component: frontend`
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|