diff options
| author | Eric Tune <etune@google.com> | 2019-07-30 08:49:53 -0700 |
|---|---|---|
| committer | Eric Tune <etune@google.com> | 2019-07-30 08:49:53 -0700 |
| commit | a2cdce51a0bbbc214f0e8813e0a877176ad3b6c9 (patch) | |
| tree | 0cb2e0f110fcd3dd8c2c9d708ef4fc25dcbd5530 | |
| parent | 562650a5a345f58a282a4627c464db64657fa50f (diff) | |
Document version string pattern
Document that the version portion of an apiVersion should be a DNS_LABEL.
This is required for CRDs, as encoded here:
https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/validation/validation.go#L176-L178
It seems like an eminently reasonable convention to have for built-in and aggregated APIs too.
| -rw-r--r-- | contributors/devel/sig-architecture/api-conventions.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/contributors/devel/sig-architecture/api-conventions.md b/contributors/devel/sig-architecture/api-conventions.md index f00d7c87..57fbfaad 100644 --- a/contributors/devel/sig-architecture/api-conventions.md +++ b/contributors/devel/sig-architecture/api-conventions.md @@ -86,6 +86,12 @@ word names ("extensions", "apps"), and any group name ending in "*.k8s.io" for its sole use. When choosing a group name, we recommend selecting a subdomain your group or organization owns, such as "widget.mycompany.com". +Version strings should match +[DNS_LABEL](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/architecture/identifiers.md) +format. + + + Resource collections should be all lowercase and plural, whereas kinds are CamelCase and singular. Group names must be lower case and be valid DNS subdomains. |