diff options
| author | Harry Zhang <harryz@hyper.sh> | 2017-09-12 20:25:52 +0800 |
|---|---|---|
| committer | Harry Zhang <harryz@hyper.sh> | 2017-09-29 15:05:50 +0800 |
| commit | 2fd09512fae246e8822f55755439785e0afdfae2 (patch) | |
| tree | c8ae5a6c7d7ac1f9bbe34fc405a8c26338d53686 | |
| parent | 95ac59f60d718d3bb1d378a5718a4bb6f9f867bd (diff) | |
Clarify taint key name convension
| -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 e2c7bab6..5800d989 100644 --- a/contributors/devel/api-conventions.md +++ b/contributors/devel/api-conventions.md @@ -1228,10 +1228,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 @@ -1241,7 +1242,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 |