diff options
| author | Kubernetes Submit Queue <k8s-merge-robot@users.noreply.github.com> | 2016-09-13 02:42:45 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-09-13 02:42:45 -0700 |
| commit | bdf35f8f96ed2d73f0a7a0d30d6c71501f99d3fd (patch) | |
| tree | d6c365e9a5bbcc242227d4b9dfff14107140f60b | |
| parent | 57aa7022f10d287461dfc2c870355d3d77adb4e4 (diff) | |
| parent | 60b3b6930fd561d3db24580c89ccc610cabfb216 (diff) | |
Merge pull request #32315 from liggitt/api-group-suffix
Automatic merge from submit-queue
Doc API group suffix, add test to catch new groups
Spawned from discussion in https://github.com/kubernetes/kubernetes/pull/31887
Doc and add tests to ensure new API groups are suffixed.
Also changed the doc to reference an API group containing the suffix as a starting point for new API groups.
| -rw-r--r-- | adding-an-APIGroup.md | 13 | ||||
| -rwxr-xr-x | api_changes.md | 2 |
2 files changed, 9 insertions, 6 deletions
diff --git a/adding-an-APIGroup.md b/adding-an-APIGroup.md index 4b87ccf3..f1bd182d 100644 --- a/adding-an-APIGroup.md +++ b/adding-an-APIGroup.md @@ -49,19 +49,19 @@ We plan on improving the way the types are factored in the future; see [#16062](https://github.com/kubernetes/kubernetes/pull/16062) for the directions in which this might evolve. -1. Create a folder in pkg/apis to hold you group. Create types.go in +1. Create a folder in pkg/apis to hold your group. Create types.go in pkg/apis/`<group>`/ and pkg/apis/`<group>`/`<version>`/ to define API objects in your group; 2. Create pkg/apis/`<group>`/{register.go, `<version>`/register.go} to register this group's API objects to the encoding/decoding scheme (e.g., -[pkg/apis/extensions/register.go](../../pkg/apis/extensions/register.go) and -[pkg/apis/extensions/v1beta1/register.go](../../pkg/apis/extensions/v1beta1/register.go); +[pkg/apis/authentication/register.go](../../pkg/apis/authentication/register.go) and +[pkg/apis/authentication/v1beta1/register.go](../../pkg/apis/authentication/v1beta1/register.go); 3. Add a pkg/apis/`<group>`/install/install.go, which is responsible for adding the group to the `latest` package, so that other packages can access the group's meta through `latest.Group`. You probably only need to change the name of group -and version in the [example](../../pkg/apis/extensions/install/install.go)). You +and version in the [example](../../pkg/apis/authentication/install/install.go)). You need to import this `install` package in {pkg/master, pkg/client/unversioned}/import_known_versions.go, if you want to make your group accessible to other packages in the kube-apiserver binary, binaries that uses @@ -83,7 +83,10 @@ cmd/libs/go2idl/ tool. with the comment `// +k8s:conversion-gen=<internal-pkg>`, to catch the attention of our generation tools. For most APIs the only target you need is `k8s.io/kubernetes/pkg/apis/<group>` (your internal API). - 4. Run hack/update-all.sh. + 3. Make sure your `pkg/apis/<group>` and `pkg/apis/<group>/<version>` directories + have a doc.go file with the comment `+groupName=<group>.k8s.io`, to correctly + generate the DNS-suffixed group name. + 5. Run hack/update-all.sh. 2. Generate files for Ugorji codec: diff --git a/api_changes.md b/api_changes.md index 0b0b7987..afdbaae7 100755 --- a/api_changes.md +++ b/api_changes.md @@ -519,7 +519,7 @@ hack/update-codecgen.sh This section is under construction, as we make the tooling completely generic. At the moment, you'll have to make a new directory under `pkg/apis/`; copy the -directory structure from `pkg/apis/extensions`. Add the new group/version to all +directory structure from `pkg/apis/authentication`. Add the new group/version to all of the `hack/{verify,update}-generated-{deep-copy,conversions,swagger}.sh` files in the appropriate places--it should just require adding your new group/version to a bash array. See [docs on adding an API group](adding-an-APIGroup.md) for |