development.md

Bootkube Development

Requirements

• Go 1.10+

Building

First, clone the repo into the proper location in your GOPATH:

go get -u github.com/kubernetes-sigs/bootkube
cd $(go env GOPATH | cut -d: -f1)/src/github.com/kubernetes-sigs/bootkube

Then build:

make clean
make all

Local Development Environments

To easily launch local, single-node vagrant development clusters:

make clean-vm-single
make run-single

You can also launch a multi-node cluster:

make clean-vm-multi
make run-multi

Each of these commands will recompile bootkube, then render new assets and provision a new cluster.

Additionally, if you wish to run upstream Kubernetes conformance tests against these local clusters:

make conformance-single

make conformance-multi

Running PR Tests

The basic test suite should run automatically on PRs, but can also be triggered manually.

Jobs prefixed with tku- are running on the new Jenkins instance.

Commenting on the PR:

• ok to test: whitelists an external contributor's PR as safe to test.
• coreosbot run [job_name]: re-runs the named job. The job name is always the same as the build context reported to GitHub. So if there is a failed build for tku-bootkube-e2e-calico, you can re-trigger it by commenting, coreosbot run tku-bootkube-e2e-calico.

Running PR Tests (legacy Jenkins)

The basic test suite should run automatically on PRs, but can also be triggered manually.

Commenting on the PR:

• ok to test: whitelists an external contributor's PR as safe to test.
• coreosbot run e2e: re-runs the end-to-end test suite.
• coreosbot run e2e calico: re-runs the Calico end-to-end test suite.
• coreosbot run e2e checkpointer: can be used to specifically test new checkpointer code.
  • This will build a new checkpointer image from the PR, and includes that image as part of the checkpointer daemonset.
• coreosbot run conformance: run upstream Kubernetes conformance tests