kubernetes
/
kops
mirror of https://github.com/kubernetes/kops.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update documentation for api changes now that CRDs are being verified

This commit is contained in:
Peter Rifel 2019-10-01 18:06:15 -05:00
parent 4ec951a14d
commit 5ba50ef022
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/development/api_updates.md
View File

@ -10,8 +10,8 @@ that directory directly (the unversioned API) and in the versioned subdirectorie
## Updating the generated API code
To generate the API code simply run `make apimachinery && make` to update the generated API machinery code (conversion functions). Note
that `make apimachinery` (currently) only updates the autogenerated code; it does not trigger a rebuild, hence the
To generate the API code simply run `make apimachinery && make crds && make` to update the generated API machinery code (conversion functions). Note
that `make apimachinery` and `make crds` (currently) only update the autogenerated code; it does not trigger a rebuild, hence the
need for `&& make`.
## Adding a field
@ -20,7 +20,7 @@ The most common task you will do will be to add a new field. This is relatively
it is backwards compatible (you have to make sure that the field is optional).
* Add the field to pkg/apis/kops, and then also to each versioned copy: pkg/apis/kops/v1alpha1, pkg/apis/kops/v1alpha2, etc
* Run the apimachinery update as above (`make apimachinery && make`)
* Run the apimachinery update as above (`make apimachinery && make crds && make`)
* You likely want to update the validation logic
* You likely want to update the defaulting logic