diff options
| author | Tim Hockin <thockin@google.com> | 2015-10-09 16:54:49 -0700 |
|---|---|---|
| committer | Tim Hockin <thockin@google.com> | 2015-10-14 15:31:37 -0700 |
| commit | 7707173defcebeb95d061638e0dcfe0ace605d3a (patch) | |
| tree | 1c5e58b8b7e589d6dae5f293f90a898b508d8e70 | |
| parent | e2dd98e6052420a1198bcb632c5353f10d5b2894 (diff) | |
update docs on experimental annotations
| -rw-r--r-- | api-conventions.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/api-conventions.md b/api-conventions.md index 7ad1dbc6..2568d952 100644 --- a/api-conventions.md +++ b/api-conventions.md @@ -713,7 +713,7 @@ Therefore, resources supporting auto-generation of unique labels should have a ` Annotations have very different intended usage from labels. We expect them to be primarily generated and consumed by tooling and system extensions. I'm inclined to generalize annotations to permit them to directly store arbitrary json. Rigid names and name prefixes make sense, since they are analogous to API fields. -In fact, experimental API fields, including those used to represent fields of newer alpha/beta API versions in the older stable storage version, may be represented as annotations with the form `something.experimental.kubernetes.io/name`. For example `net.experimental.kubernetes.io/policy` might represent an experimental network policy field. +In fact, in-development API fields, including those used to represent fields of newer alpha/beta API versions in the older stable storage version, may be represented as annotations with the form `something.alpha.kubernetes.io/name` or `something.beta.kubernetes.io/name` (depending on our confidence in it). For example `net.alpha.kubernetes.io/policy` might represent an experimental network policy field. Other advice regarding use of labels, annotations, and other generic map keys by Kubernetes components and tools: - Key names should be all lowercase, with words separated by dashes, such as `desired-replicas` |