Skip to content

Commit

Permalink
Merge pull request #1043 from resouer/inform-taint
Browse files Browse the repository at this point in the history
Clarify taint key name convention
  • Loading branch information
Harry Zhang authored Oct 19, 2017
2 parents be791ab + 2fd0951 commit cfddaf9
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions contributors/devel/api-conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit cfddaf9

Please sign in to comment.