mirror of
https://github.com/vmware-tanzu/velero.git
synced 2025-12-23 06:15:21 +00:00
db139cf07c
* Refactor image builds to use buildx for multi arch image building Signed-off-by: Rob Reus <rob@devrobs.nl> * Adding image build sanity checks to Makefile Signed-off-by: Rob Reus <rob@devrobs.nl> * Making locally building of docker images possible Signed-off-by: Rob Reus <rob@devrobs.nl> * Adding docs on building container images using buildx Signed-off-by: Rob Reus <rob@devrobs.nl> * Adding changelog and implementing feedback from PR Signed-off-by: Rob Reus <rob@devrobs.nl> * Making GOPROXY used in the build containers configurable Signed-off-by: Rob Reus <rob@devrobs.nl>
141 lines
5.0 KiB
Markdown
141 lines
5.0 KiB
Markdown
# Build from source
|
|
|
|
## Prerequisites
|
|
|
|
* Access to a Kubernetes cluster, version 1.7 or later.
|
|
* A DNS server on the cluster
|
|
* `kubectl` installed
|
|
* [Go][5] installed (minimum version 1.8)
|
|
|
|
## Get the source
|
|
|
|
### Option 1) Get latest (recommended)
|
|
|
|
```bash
|
|
mkdir $HOME/go
|
|
export GOPATH=$HOME/go
|
|
go get github.com/vmware-tanzu/velero
|
|
```
|
|
|
|
Where `go` is your [import path][4] for Go.
|
|
|
|
For Go development, it is recommended to add the Go import path (`$HOME/go` in this example) to your path.
|
|
|
|
### Option 2) Release archive
|
|
|
|
Download the archive named `Source code` from the [release page][22] and extract it in your Go import path as `src/github.com/vmware-tanzu/velero`.
|
|
|
|
Note that the Makefile targets assume building from a git repository. When building from an archive, you will be limited to the `go build` commands described below.
|
|
|
|
## Build
|
|
|
|
There are a number of different ways to build `velero` depending on your needs. This section outlines the main possibilities.
|
|
|
|
When building by using `make`, it will place the binaries under `_output/bin/$GOOS/$GOARCH`. For example, you will find the binary for darwin here: `_output/bin/darwin/amd64/velero`, and the binary for linux here: `_output/bin/linux/amd64/velero`. `make` will also splice version and git commit information in so that `velero version` displays proper output.
|
|
|
|
Note: `velero install` will also use the version information to determine which tagged image to deploy. If you would like to overwrite what image gets deployed, use the `image` flag (see below for instructions on how to build images).
|
|
|
|
### Build the binary
|
|
|
|
To build the `velero` binary on your local machine, compiled for your OS and architecture, run one of these two commands:
|
|
|
|
```bash
|
|
go build ./cmd/velero
|
|
```
|
|
|
|
```bash
|
|
make local
|
|
```
|
|
|
|
### Cross compiling
|
|
|
|
To build the velero binary targeting linux/amd64 within a build container on your local machine, run:
|
|
|
|
```bash
|
|
make build
|
|
```
|
|
|
|
For any specific platform, run `make build-<GOOS>-<GOARCH>`.
|
|
|
|
For example, to build for the Mac, run `make build-darwin-amd64`.
|
|
|
|
Velero's `Makefile` has a convenience target, `all-build`, that builds the following platforms:
|
|
|
|
* linux-amd64
|
|
* linux-arm
|
|
* linux-arm64
|
|
* linux-ppc64le
|
|
* darwin-amd64
|
|
* windows-amd64
|
|
|
|
## Making images and updating Velero
|
|
|
|
If after installing Velero you would like to change the image used by its deployment to one that contains your code changes, you may do so by updating the image:
|
|
|
|
```bash
|
|
kubectl -n velero set image deploy/velero velero=myimagerepo/velero:$VERSION
|
|
```
|
|
|
|
To build a Velero container image, you need to configure `buildx` first.
|
|
|
|
### Buildx
|
|
|
|
Docker Buildx is a CLI plugin that extends the docker command with the full support of the features provided by Moby BuildKit builder toolkit. It provides the same user experience as docker build with many new features like creating scoped builder instances and building against multiple nodes concurrently.
|
|
|
|
More information in the [docker docs][23] and in the [buildx github][24] repo.
|
|
|
|
### Image building
|
|
|
|
Set the `$REGISTRY` environment variable. For example, if you want to build the `gcr.io/my-registry/velero:main` image, set `$REGISTRY` to `gcr.io/my-registry`. If this variable is not set, the default is `velero`.
|
|
|
|
Optionally, set the `$VERSION` environment variable to change the image tag or `$BIN` to change which binary to build a container image for. Then, run:
|
|
|
|
```bash
|
|
make container
|
|
```
|
|
_Note: To build build container images for both `velero` and `velero-restic-restore-helper`, run: `make all-containers`_
|
|
|
|
|
|
### Cross platform building
|
|
|
|
Docker `buildx` platforms currently supported:
|
|
* `linux/amd64`
|
|
* `linux/arm64`
|
|
* `linux/arm/v7`
|
|
* `linux/ppc64le`
|
|
|
|
For any specific platform, run `BUILDX_PLATFORMS=<GOOS>/<GOARCH> make container`
|
|
|
|
For example, to build an image for arm64, run:
|
|
|
|
```bash
|
|
BUILDX_PLATFORMS=linux/arm64 make container
|
|
```
|
|
_Note: By default, `$BUILDX_PLATFORMS` is set to `linux/amd64`_
|
|
|
|
To push your image to the registry, run the `make container` command with `$BUILDX_OUTPUT_TYPE` set to `registry`. For example:
|
|
|
|
```bash
|
|
REGISTRY=myrepo BUILDX_PLATFORMS=linux/arm64 BUILDX_OUTPUT_TYPE=registry make container
|
|
```
|
|
|
|
With `buildx`, you can also build all supported platforms at the same time and push a multi-arch image to the registry. For example:
|
|
|
|
```bash
|
|
REGISTRY=myrepo VERSION=foo BUILDX_PLATFORMS=linux/amd64,linux/arm64,linux/arm/v7,linux/ppc64le BUILDX_OUTPUT_TYPE=registry make all-containers
|
|
```
|
|
_Note: when building for more than 1 platform at the same time, you need to set `BUILDX_OUTPUT_TYPE` to `registry` as local multi-arch images are not supported [yet][25]._
|
|
|
|
Note: if you want to update the image but not change its name, you will have to trigger Kubernetes to pick up the new image. One way of doing so is by deleting the Velero deployment pod:
|
|
|
|
```bash
|
|
kubectl -n velero delete pods -l deploy=velero
|
|
```
|
|
|
|
[4]: https://blog.golang.org/organizing-go-code
|
|
[5]: https://golang.org/doc/install
|
|
[22]: https://github.com/vmware-tanzu/velero/releases
|
|
[23]: https://docs.docker.com/buildx/working-with-buildx/
|
|
[24]: https://github.com/docker/buildx
|
|
[25]: https://github.com/moby/moby/pull/38738
|