This is the documentation for the latest development version of Velero. Both code and docs may be unstable, and these docs are not guaranteed to be up to date or correct. See the latest version.
make update to regenerate files if you make the following changes:
The following files are automatically generated from the source code:
You can run
make verify to ensure that all generated files (clientset, listers, shared informers, docs) are up to date.
You can run
make lint which executes golangci-lint inside the build image, or
make local-lint which executes outside of the build image.
make lint and
make local-lint will only run the linter against changes.
lint-all to run the linter against the entire code base.
The default linters are defined in the
Makefile via the
You can also override the default list of linters by running the command
$ make lint LINTERS=gosec
To run unit tests, use
If you need to add or update the vendored dependencies, see Vendoring dependencies.
If you are developing or using the main branch, note that you may need to update the Velero CRDs to get new changes as other development work is completed.
velero install --crds-only --dry-run -o yaml | kubectl apply -f -
NOTE: You could change the default CRD API version (v1beta1 or v1) if Velero CLI can’t discover the Kubernetes preferred CRD API version. The Kubernetes version < 1.16 preferred CRD API version is v1beta1; the Kubernetes version >= 1.16 preferred CRD API version is v1.