Documentation for version v1.1.0 is no longer actively maintained. The version you are currently viewing is a static snapshot. For up-to-date documentation, see the latest version.
Development
Update generated files
Run make update to regenerate files if you make the following changes:
- Add/edit/remove command line flags and/or their help text
- Add/edit/remove commands or subcommands
- Add new API types
Run generate-proto.sh to regenerate files if you make the following changes:
- Add/edit/remove protobuf message or service definitions. These changes require the
proto compiler and compiler plugin
protoc-gen-goversion v1.0.0.
The following files are automatically generated from the source code:
- The clientset
- Listers
- Shared informers
- Documentation
- Protobuf/gRPC types
You can run make verify to ensure that all generated files (clientset, listers, shared informers, docs) are up to date.
Test
To run unit tests, use make test.
Vendor dependencies
If you need to add or update the vendored dependencies, see Vendoring dependencies.
Getting Started
To help you get started, see the documentation.