scottk/kubernetes
1
0
Fork 0
mirror of https://github.com/optim-enterprises-bv/kubernetes.git synced 2025-11-01 10:48:15 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
3e1a0148ed943dc426f4a0202f215a5050392668
kubernetes/docs/devel/adding-an-APIGroup.md
Chao Xu 3e1a0148ed add a guide on how to create an API group
2015-11-04 14:30:34 -08:00

3.8 KiB
Raw Blame History

WARNING WARNING WARNING WARNING WARNING

PLEASE NOTE: This document applies to the HEAD of the source tree

If you are using a released version of Kubernetes, you should refer to the docs that go with that version.

The latest 1.0.x release of this document can be found [here](http://releases.k8s.io/release-1.0/docs/devel/adding-an-APIGroup.md).

Documentation for other releases can be found at releases.k8s.io.

Adding an API Group

This document includes the steps to add an API group. You may also want to take a look at PR #16621 and PR #13146, which add API groups.

Please also read about API conventions and API changes before adding an API group.

Your core group package:

  1. creaet a folder in pkg/apis to hold you 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 scheme;

  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 need to import this install package in {pkg/master, pkg/client/unversioned, cmd/kube-version-change}/import_known_versions.go, if you want to make your group accessible to other packages in the kube-apiserver binary, binaries that uses the client package, or the kube-version-change tool.

Scripts changes and auto-generated code:

  1. Generate conversions and deep-copies:

    1. add your "group/" or "group/version" into hack/after-build/{update-generated-conversions.sh, update-generated-deep-copies.sh, verify-generated-conversions.sh, verify-generated-deep-copies.sh};
    2. run hack/update-generated-conversions.sh, hack/update-generated-deep-copies.sh.

  2. Generate files for Ugorji codec:

    1. touch types.generated.go in pkg/apis/<group>{/, <version>}, and run hack/update-codecgen.sh.

Client (optional):

We are overhauling pkg/client, so this section might be outdated. Currently, to add your group to the client package, you need to

  1. create pkg/client/unversioned/<group>.go, define a group client interface and implement the client. You can take pkg/client/unversioned/extensions.go as a reference.

  2. add the group client interface to the Interface in pkg/client/unversioned/client.go and add method to fetch the interface. Again, you can take how we add the Extensions group there as an example.

  3. if you need to support the group in kubectl, you'll also need to modify pkg/kubectl/cmd/util/factory.go.

Make the group/version selectable in unit tests (optional):

  1. add your group in pkg/api/testapi/testapi.go, then you can access the group in tests through testapi.<group>;

  2. add your "group/version" to KUBE_API_VERSIONS and KUBE_TEST_API_VERSIONS in hack/test-go.sh.

Analytics