mart-w/kanidm
1
0
Fork 0
mirror of https://github.com/kanidm/kanidm.git synced 2025-02-24 04:57:00 +01:00
Code Issues Actions 10 Packages Projects Releases Wiki Activity

Clean up Makefile documentation (#774)

Browse source 
- Add finalized changes that were not present at merge because I forgot
  to put the merge request into Draft mode while working.

Related https://github.com/kanidm/kanidm/issues/768

Signed-off-by: Kellin <kellin@retromud.org>
This commit is contained in:
Kellin 2022-05-24 20:31:06 -04:00 committed by GitHub
parent 89a193c3dc
commit b4094324d8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
DEVELOPER_README.md
View file

@ -166,9 +166,9 @@ Setting different developer profiles while building is done by setting the envir
For example: `KANIDM_BUILD_PROFILE=release_suse_generic cargo build --release --bin kanidmd`
### Building the development container
### Build a kanidm container
Build a development container with the current branch using:
Build a container with the current branch using:
make <TARGET>
@ -176,20 +176,22 @@ Check `make help` for a list of valid targets.
The following environment variables control the build:
|ENV variable|Definition|
|-|-|
|`IMAGE_BASE`|Base location of the container image. Defaults to `kanidm`.|
|`IMAGE_VERSION`|Determines the container's tag.|
|`CONTAINER_TOOL_ARGS`|Specify extra options for the container build tool.|
|`IMAGE_ARCH`|Passed to `--platforms` when the container is built. Defaults to `linux/amd64,linux/arm64`.|
|`CONTAINER_BUILD_ARGS`|Override default ARG settings during the container build.|
|`CONTAINER_TOOL`|Use an alternative container build tool. Defaults to `docker`.|
|`BOOK_VERSION`|Sets version used when building the documentation book. Defaults to `master`.|
|ENV variable|Definition|Default|
|-|-|-|
|`IMAGE_BASE`|Base location of the container image.|`kanidm`|
|`IMAGE_VERSION`|Determines the container's tag.|None|
|`CONTAINER_TOOL_ARGS`|Specify extra options for the container build tool.|None|
|`IMAGE_ARCH`|Passed to `--platforms` when the container is built.|`linux/amd64,linux/arm64`|
|`CONTAINER_BUILD_ARGS`|Override default ARG settings during the container build.|None|
|`CONTAINER_TOOL`|Use an alternative container build tool.|`docker`|
|`BOOK_VERSION`|Sets version used when building the documentation book.|`master`|
Build a development container using `podman`:
#### Container build examples
Build a `kanidm` container using `podman`:
CONTAINER_TOOL=podman make build/kanidmd
Build a development container and specify a redis build cache:
Build a `kanidm` container and use a redis build cache:
CONTAINER_BUILD_ARGS="--build-arg "SCCACHE_REDIS=redis://redis.dev.blackhats.net.au:6379"" make build/kanidmd
CONTAINER_BUILD_ARGS='--build-arg "SCCACHE_REDIS=redis://redis.dev.blackhats.net.au:6379"' make build/kanidmd