diff options
| author | Harry Zhang <harryz@hyper.sh> | 2017-10-18 20:47:59 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-10-18 20:47:59 -0500 |
| commit | cfddaf9e16a5d5ad3231f52973bd19a5f024e64c (patch) | |
| tree | 44fc83fc36c2f5fb53c331396d155821467e7b11 | |
| parent | be791ab46635a8eea1dfe6c36cf507a4abc3df6b (diff) | |
| parent | 2fd09512fae246e8822f55755439785e0afdfae2 (diff) | |
Merge pull request #1043 from resouer/inform-taint
Clarify taint key name convention
| -rw-r--r-- | contributors/devel/api-conventions.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/contributors/devel/api-conventions.md b/contributors/devel/api-conventions.md index c69617c1..88ba902c 100644 --- a/contributors/devel/api-conventions.md +++ b/contributors/devel/api-conventions.md @@ -1231,10 +1231,11 @@ policy field. The "name" portion of the annotation should follow the below conventions for annotations. When an annotation gets promoted to a field, the name transformation should then be mechanical: `foo-bar` becomes `fooBar`. -Other advice regarding use of labels, annotations, and other generic map keys by +Other advice regarding use of labels, annotations, taints, 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` + - Key names should be all lowercase, with words separated by dashes instead of camelCase + - For instance, prefer `foo.kubernetes.io/foo-bar over` `foo.kubernetes.io/fooBar`, prefer + `desired-replicas` over `DesiredReplicas` - Prefix the key with `kubernetes.io/` or `foo.kubernetes.io/`, preferably the latter if the label/annotation is specific to `foo` - For instance, prefer `service-account.kubernetes.io/name` over @@ -1244,7 +1245,6 @@ the resource doesn't need to know about, experimental fields that aren't intended to be generally used API fields, etc. Beware that annotations aren't automatically handled by the API conversion machinery. - ## WebSockets and SPDY Some of the API operations exposed by Kubernetes involve transfer of binary |