Skip to content

Commit d1c12d1

Browse files
committed
clarify how to name kubernetes label and annotation keys
1 parent d122e5f commit d1c12d1

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

contributors/devel/sig-architecture/api-conventions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1602,6 +1602,8 @@ Kubernetes components and tools:
16021602
project.
16031603
- Such keys are effectively part of the kubernetes API and may be subject
16041604
to deprecation and compatibility policies.
1605+
- "kubernetes.io" is the preferred form for labels and annotations, "k8s.io" should not be used
1606+
for new map keys.
16051607
- Key names, including prefixes, should be precise enough that a user could
16061608
plausibly understand where it came from and what it is for.
16071609
- Key prefixes should carry as much context as possible.

0 commit comments

Comments
 (0)