diff options
| author | Tim Hockin <thockin@google.com> | 2015-09-20 21:00:41 -0700 |
|---|---|---|
| committer | Tim Hockin <thockin@google.com> | 2015-09-20 21:00:41 -0700 |
| commit | efee6727cd73f876454bbcb7d7f2737f0ea3a0b5 (patch) | |
| tree | 90a317ff9e7babf38c37e1a32567c262f23f3c74 | |
| parent | c0e44162bc75fe062e183b27fccc578e837c19b2 (diff) | |
Clarify experimental annotation format
| -rw-r--r-- | api-conventions.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/api-conventions.md b/api-conventions.md index 31225e18..fb7cbe10 100644 --- a/api-conventions.md +++ b/api-conventions.md @@ -33,7 +33,7 @@ Documentation for other releases can be found at API Conventions =============== -Updated: 8/24/2015 +Updated: 9/20/2015 *This document is oriented at users who want a deeper understanding of the Kubernetes API structure, and developers wanting to extend the Kubernetes API. An introduction to @@ -712,7 +712,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 to represent fields of newer alpha/beta API versions in the older, stable storage version, may be represented as annotations with the prefix `experimental.kubernetes.io/`. +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. 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` |