Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document how to build and deploy the sample-apiserver #73447


Updated explanation of how to generate code in sample-apiserver

  • Loading branch information...
MikeSpreitzer committed May 16, 2019
commit 9a4081faf71c6b61fb6a53b7930dbe4289dd0c90
@@ -24,19 +24,26 @@ HEAD of this repo will match HEAD of,, and
`sample-apiserver` is synced from
Code changes are made in that location, merged into `` and later synced here.

## Fetch Dependencies

Using `godep` will work.

Using Go modules (`GO111MODULE=on`) will enable `go build` to work,
without putting dependencies anywhere obvious.

## Normal Build and Deploy

### Changes to the Types

If you change the API object type definitions in any of the
`pkg/apis/.../types.go` files then you will need to update the files
generated from the type definitions. There is no convenient script to
do this in the context of `$GOPATH/src/`.
However, if you have fetched the whole `` repository
then there _is_ a convenient script that you can use. With
`$GOPATH/src/` as
your current working directory, invoke `hack/`; the
script takes no arguments.
generated from the type definitions. To do this, invoke
`hack/` with `sample-apiserver` as your current
working directory; the script takes no arguments. But this requires
certain dependencies to appear on your `$GOPATH` or in a local
`vendor` directory. If you used Go modules then issue the command `go
mod vendor` before `hack/`, to first create a local
`vendor` directory with the needed dependencies.

### Build the Binary

ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.