Skip to content

Commit

Permalink
Update BUILD.md with instructions to build and push controller images (
Browse files Browse the repository at this point in the history
…#1694)

* Update BUILD.md with instructions to build and push images

Signed-off-by: Ivan Sim <ivan.sim@kasten.io>

* Apply suggestion

Signed-off-by: Ivan Sim <ivan.sim@kasten.io>
Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
  • Loading branch information
3 people committed Oct 25, 2022
1 parent 88ce028 commit a878179
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,22 @@ make release-controller \
IMAGE=<your_registry>/<your_controller_image> \
VERSION=<your_image_tag>
```
If `VERSION` is not specified, the Makefile will auto-generate one for you.

Update the `IMAGE` variable to reference the image registry you'd like to push
your image to. You must have write permissions on the registry. If `IMAGE` is
not specified, the Makefile will use the default of `kanisterio/controller`.

The `VERSION` variable is useful for versioning your image with a custom tag.
If `VERSION` is not specified, the Makefile will auto-generate one for your
image.

For example, the following command will build and push your image to the
registry at `ghcr.io/myregistry/kanister`, with the tag `20221003`:
```sh
make release-controller \
IMAGE=ghcr.io/myregistry/kanister \
VERSION=20221003
```

You can test your Kanister controller locally by using Helm to deploy the local
Helm chart:
Expand Down

0 comments on commit a878179

Please sign in to comment.