Skip to content

Commit 452c610

Browse files
woraayj
authored andcommitted
Update STYLE-GUIDE.md (istio#343)
* Update STYLE-GUIDE.md Mention the CRD kind must match proto message. * Update STYLE-GUIDE.md Mention `apiVersion` must match proto package. * Update STYLE-GUIDE.md Explain apiVersion = group/version.
1 parent b068214 commit 452c610

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

STYLE-GUIDE.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,14 @@ naming convention:
3838
## Versioning
3939

4040
When defining Kubernetes Custom Resource Definition (CRD) using
41-
proto3, the proto versioning should match the Kubernetes versioning,
42-
see the following example.
41+
`proto3`, follow the following guidelines:
42+
* The proto `package` name must match the Kubernetes `apiVersion`,
43+
excluding the `.io` DNS suffix and reversing the DNS segment
44+
ordering. The Kubernetes `apiVersion` has the format of
45+
`group/version`.
46+
* The proto message type must match the CRD `kind` name.
47+
48+
#### Example
4349

4450
The Kubernetes CRD:
4551

0 commit comments

Comments
 (0)