mirror of
https://github.com/aevea/action-kaniko.git
synced 2025-04-10 05:08:48 +02:00
Compare commits
53 commits
Author | SHA1 | Date | |
---|---|---|---|
![]() |
be5ce625a5 | ||
![]() |
58af85fb13 | ||
![]() |
9223ef89b8 | ||
![]() |
12a3a8cc81 | ||
![]() |
977090a03e | ||
![]() |
fd47216104 | ||
![]() |
8de7c88b27 | ||
![]() |
ef9c4ca42e | ||
![]() |
16c18d6aee | ||
![]() |
ec00be49b7 | ||
![]() |
4f9a6a7f2c | ||
![]() |
81a26cb33a | ||
![]() |
17bff7af73 | ||
![]() |
a95ae7d706 | ||
![]() |
10b098cb52 | ||
![]() |
4387eb381c | ||
![]() |
ca098255c5 | ||
![]() |
e54575cc70 | ||
![]() |
78060c4e9d | ||
![]() |
98d5caab7f | ||
![]() |
83ddee1c8b | ||
![]() |
57fd639926 | ||
![]() |
c97b90ade3 | ||
![]() |
1200c08dba | ||
![]() |
a4abaead48 | ||
![]() |
59bc747ae2 | ||
![]() |
548ad7dd4a | ||
![]() |
20173de989 | ||
![]() |
17f90e5aa4 | ||
![]() |
a5055cd007 | ||
![]() |
3e397648f8 | ||
![]() |
dc591110cc | ||
![]() |
8e9a423400 | ||
![]() |
f16a14fc0f | ||
![]() |
8bd3e02fd2 | ||
![]() |
571e42aef3 | ||
![]() |
e846d42497 | ||
![]() |
b7f0f661e3 | ||
![]() |
7033a0543d | ||
![]() |
e03153c634 | ||
![]() |
49888d43ab | ||
![]() |
418284a2f2 | ||
![]() |
5be93ca286 | ||
![]() |
5e25ae9c63 | ||
![]() |
6030da03d4 | ||
![]() |
daf41b1e54 | ||
![]() |
79ed56ad90 | ||
![]() |
94f437184e | ||
![]() |
51211d4483 | ||
![]() |
57d6d22cdf | ||
![]() |
3b9302effb | ||
![]() |
c076596480 | ||
![]() |
edea218783 |
9 changed files with 210 additions and 57 deletions
|
@ -1,3 +1,3 @@
|
|||
*
|
||||
!entrypoint.sh
|
||||
|
||||
.env*
|
||||
|
|
6
.github/workflows/pr.yml
vendored
6
.github/workflows/pr.yml
vendored
|
@ -6,6 +6,8 @@ jobs:
|
|||
runs-on: ubuntu-latest
|
||||
name: Verify commit messages
|
||||
steps:
|
||||
- uses: actions/checkout@v1
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Run commitsar
|
||||
uses: docker://aevea/commitsar
|
||||
uses: docker://aevea/commitsar@sha256:e4aed72de9a00b990a53c678ad51fbe9bd04e127a617d10beab0ef0204b1dfa0
|
||||
|
|
2
.github/workflows/push.yml
vendored
2
.github/workflows/push.yml
vendored
|
@ -11,7 +11,7 @@ jobs:
|
|||
- name: GitHub Package Registry
|
||||
uses: aevea/action-kaniko@master
|
||||
with:
|
||||
registry: docker.pkg.github.com
|
||||
registry: ghcr.io
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
image: kaniko
|
||||
cache: true
|
||||
|
|
11
.github/workflows/release.yml
vendored
11
.github/workflows/release.yml
vendored
|
@ -10,17 +10,22 @@ jobs:
|
|||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out code
|
||||
uses: actions/checkout@v1
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Release Notary Action
|
||||
uses: docker://aevea/release-notary
|
||||
uses: docker://aevea/release-notary@sha256:690915bf87458fd8eb1e1ff0be34b33377f920eda3f38b96c62ecbf897c831f4
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
entrypoint: release-notary
|
||||
args: publish
|
||||
|
||||
- name: GitHub Package Registry
|
||||
uses: aevea/action-kaniko@master
|
||||
with:
|
||||
registry: docker.pkg.github.com
|
||||
registry: ghcr.io
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
image: kaniko
|
||||
cache: true
|
||||
|
|
20
Dockerfile
20
Dockerfile
|
@ -1,6 +1,24 @@
|
|||
FROM gcr.io/kaniko-project/executor:debug
|
||||
FROM alpine as certs
|
||||
|
||||
RUN apk --update add ca-certificates
|
||||
|
||||
FROM gcr.io/kaniko-project/executor:v1.23.2-debug
|
||||
|
||||
SHELL ["/busybox/sh", "-c"]
|
||||
|
||||
RUN wget -O /kaniko/jq \
|
||||
https://github.com/jqlang/jq/releases/download/jq-1.7.1/jq-linux64 && \
|
||||
chmod +x /kaniko/jq && \
|
||||
wget -O /kaniko/reg \
|
||||
https://github.com/genuinetools/reg/releases/download/v0.16.1/reg-linux-386 && \
|
||||
chmod +x /kaniko/reg && \
|
||||
wget -O /crane.tar.gz \
|
||||
https://github.com/google/go-containerregistry/releases/download/v0.17.0/go-containerregistry_Linux_x86_64.tar.gz && \
|
||||
tar -xvzf /crane.tar.gz crane -C /kaniko && \
|
||||
rm /crane.tar.gz
|
||||
|
||||
COPY entrypoint.sh /
|
||||
COPY --from=certs /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/ca-certificates.crt
|
||||
|
||||
ENTRYPOINT ["/entrypoint.sh"]
|
||||
|
||||
|
|
24
Makefile
Normal file
24
Makefile
Normal file
|
@ -0,0 +1,24 @@
|
|||
build:
|
||||
docker build -t aevea/kaniko .
|
||||
|
||||
run: build
|
||||
docker run \
|
||||
-v $(shell pwd):/tmp \
|
||||
-e GITHUB_REPOSITORY \
|
||||
-e GITHUB_REF \
|
||||
-e GITHUB_ACTOR \
|
||||
-e GITHUB_TOKEN \
|
||||
-e GITHUB_WORKSPACE="/tmp" \
|
||||
-e INPUT_IMAGE \
|
||||
-e INPUT_CACHE \
|
||||
-e INPUT_CACHE_TTL \
|
||||
-e INPUT_CACHE_REGISTRY \
|
||||
-e INPUT_STRIP_TAG_PREFIX \
|
||||
-e INPUT_SKIP_UNCHANGED_DIGEST \
|
||||
aevea/kaniko
|
||||
|
||||
shell: build
|
||||
docker run \
|
||||
-ti \
|
||||
--entrypoint sh \
|
||||
aevea/kaniko
|
48
README.md
48
README.md
|
@ -1,5 +1,8 @@
|
|||
# Kaniko image builder
|
||||
|
||||
> [!WARNING]
|
||||
> The kaniko project no longer seems to [have maintainers](https://github.com/GoogleContainerTools/kaniko/issues/3348). Keep this in mind before deciding to use kaniko as your image builder.
|
||||
|
||||
This Action uses the [kaniko](https://github.com/GoogleContainerTools/kaniko) executor instead of the docker daemon. Kaniko builds the image
|
||||
by extracting the filesystem of the base image, making the changes in the user space, snapshotting any change and appending it to the base
|
||||
image filesystem.
|
||||
|
@ -39,19 +42,24 @@ the most used values. So, technically there is a single required argument
|
|||
|
||||
## Optional Arguments
|
||||
|
||||
| variable | description | required | default |
|
||||
|------------------|----------------------------------------------------------|----------|-----------------------------|
|
||||
| registry | Docker registry where the image will be pushed | false | docker.io |
|
||||
| username | Username used for authentication to the Docker registry | false | $GITHUB_ACTOR |
|
||||
| password | Password used for authentication to the Docker registry | false | |
|
||||
| tag | Image tag | false | latest |
|
||||
| cache | Enables build cache | false | false |
|
||||
| cache_ttl | How long the cache should be considered valid | false | |
|
||||
| cache_registry | Docker registry meant to be used as cache | false | |
|
||||
| cache_directory | Filesystem path meant to be used as cache | false | |
|
||||
| build_file | Dockerfile filename | false | Dockerfile |
|
||||
| extra_args | Additional arguments to be passed to the kaniko executor | false | |
|
||||
| strip_tag_prefix | Prefix to be stripped from the tag | false | |
|
||||
| variable | description | required | default |
|
||||
|-----------------------|-----------------------------------------------------------------|----------|-----------------|
|
||||
| registry | Docker registry where the image will be pushed | false | docker.io |
|
||||
| username | Username used for authentication to the Docker registry | false | $GITHUB_ACTOR |
|
||||
| password | Password used for authentication to the Docker registry | false | |
|
||||
| tag | Image tag | false | latest |
|
||||
| cache | Enables build cache | false | false |
|
||||
| cache_ttl | How long the cache should be considered valid | false | |
|
||||
| cache_registry | Docker registry meant to be used as cache | false | |
|
||||
| cache_directory | Filesystem path meant to be used as cache | false | |
|
||||
| build_file | Dockerfile filename | false | Dockerfile |
|
||||
| extra_args | Additional arguments to be passed to the kaniko executor | false | |
|
||||
| strip_tag_prefix | Prefix to be stripped from the tag | false | |
|
||||
| skip_unchanged_digest | Avoids pushing the image if the build generated the same digest | false | |
|
||||
| path | Path to the build context. Defaults to `.` | false | . |
|
||||
| tag_with_latest | Tags the built image with additional latest tag | false | |
|
||||
| target | Sets the target stage to build | false | |
|
||||
| debug | Enables trace for entrypoint.sh | false | |
|
||||
|
||||
**Here is where it gets specific, as the optional arguments become required depending on the registry targeted**
|
||||
|
||||
|
@ -79,7 +87,7 @@ with:
|
|||
cache_registry: aevea/cache
|
||||
```
|
||||
|
||||
### [docker.pkg.github.com](https://github.com/features/packages)
|
||||
### [ghcr.io](https://github.com/features/packages)
|
||||
|
||||
GitHub's docker registry is a bit special. It doesn't allow top-level images, so this action will prefix any image with the GitHub namespace.
|
||||
If you want to push your image like `aevea/action-kaniko/kaniko`, you'll only need to pass `kaniko` to this action.
|
||||
|
@ -89,7 +97,7 @@ passed by default, it will have to be explicitly set up.
|
|||
|
||||
```yaml
|
||||
with:
|
||||
registry: docker.pkg.github.com
|
||||
registry: ghcr.io
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
image: kaniko
|
||||
```
|
||||
|
@ -100,7 +108,7 @@ cache layers to that image instead
|
|||
|
||||
```yaml
|
||||
with:
|
||||
registry: docker.pkg.github.com
|
||||
registry: ghcr.io
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
image: kaniko
|
||||
cache: true
|
||||
|
@ -163,10 +171,16 @@ Example:
|
|||
|
||||
```yaml
|
||||
with:
|
||||
registry: docker.pkg.github.com
|
||||
registry: ghcr.io
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
image: kaniko
|
||||
strip_tag_prefix: pre-
|
||||
```
|
||||
|
||||
for the tag `pre-0.1` will push `kaniko:0.1`, as the `pre-` part will be stripped from the tag name.
|
||||
|
||||
## Outputs
|
||||
|
||||
### `image`
|
||||
|
||||
Full reference to the built image with registry and tag.
|
||||
|
|
19
action.yml
19
action.yml
|
@ -5,6 +5,10 @@ branding:
|
|||
icon: anchor
|
||||
color: orange
|
||||
inputs:
|
||||
path:
|
||||
description: Path to the build context
|
||||
required: false
|
||||
default: "."
|
||||
registry:
|
||||
description: "Docker registry where the image will be pushed"
|
||||
required: false
|
||||
|
@ -41,6 +45,21 @@ inputs:
|
|||
extra_args:
|
||||
description: "Additional arguments to be passed to the kaniko executor"
|
||||
required: false
|
||||
skip_unchanged_digest:
|
||||
description: "Avoids pushing the image if the build generated the same digest"
|
||||
required: false
|
||||
tag_with_latest:
|
||||
description: "Tags the built image with additional latest tag"
|
||||
required: false
|
||||
target:
|
||||
description: Sets the target stage to build
|
||||
required: false
|
||||
debug:
|
||||
description: Enables trace for entrypoint.sh
|
||||
required: false
|
||||
outputs:
|
||||
image:
|
||||
description: "Full reference to the built image with registry and tag"
|
||||
runs:
|
||||
using: "docker"
|
||||
image: "Dockerfile"
|
||||
|
|
135
entrypoint.sh
135
entrypoint.sh
|
@ -1,54 +1,84 @@
|
|||
#!/busybox/sh
|
||||
set -e pipefail
|
||||
if [ "$INPUT_DEBUG" = "true" ]; then
|
||||
set -o xtrace
|
||||
fi
|
||||
|
||||
export REGISTRY=${INPUT_REGISTRY:-"docker.io"}
|
||||
export IMAGE=${INPUT_IMAGE}
|
||||
export BRANCH=$(echo ${GITHUB_REF} | sed -E "s/refs\/(heads|tags)\///g" | sed -e "s/\//-/g")
|
||||
export TAG=${INPUT_TAG:-$([ "$BRANCH" == "master" ] && echo latest || echo $BRANCH)}
|
||||
export TAG=${TAG:-"latest"}
|
||||
export TAG=${TAG#$INPUT_STRIP_TAG_PREFIX}
|
||||
export USERNAME=${INPUT_USERNAME:-$GITHUB_ACTOR}
|
||||
export PASSWORD=${INPUT_PASSWORD:-$GITHUB_TOKEN}
|
||||
export IMAGE=$IMAGE:$TAG
|
||||
export REGISTRY="${INPUT_REGISTRY:-"docker.io"}"
|
||||
export IMAGE="$INPUT_IMAGE"
|
||||
export BRANCH=$(echo "$GITHUB_REF" | sed -E "s/refs\/(heads|tags)\///g" | sed -e "s/\//-/g")
|
||||
export TAG=${INPUT_TAG:-$([ "$BRANCH" = "master" ] && echo latest || echo "$BRANCH")}
|
||||
export TAG="${TAG:-"latest"}"
|
||||
export TAG="${TAG#$INPUT_STRIP_TAG_PREFIX}"
|
||||
export USERNAME="${INPUT_USERNAME:-$GITHUB_ACTOR}"
|
||||
export PASSWORD="${INPUT_PASSWORD:-$GITHUB_TOKEN}"
|
||||
export REPOSITORY="$IMAGE"
|
||||
export IMAGE="${IMAGE}:${TAG}"
|
||||
export CONTEXT_PATH="$INPUT_PATH"
|
||||
|
||||
function sanitize() {
|
||||
if [ "$INPUT_TAG_WITH_LATEST" = "true" ]; then
|
||||
export IMAGE_LATEST="${REPOSITORY}:latest"
|
||||
fi
|
||||
|
||||
ensure() {
|
||||
if [ -z "${1}" ]; then
|
||||
echo >&2 "Unable to find the ${2}. Did you set with.${2}?"
|
||||
echo >&2 "Unable to find the ${2} variable. Did you set with.${2}?"
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
sanitize "${REGISTRY}" "registry"
|
||||
sanitize "${USERNAME}" "username"
|
||||
sanitize "${PASSWORD}" "password"
|
||||
sanitize "${IMAGE}" "image"
|
||||
sanitize "${TAG}" "tag"
|
||||
ensure "${REGISTRY}" "registry"
|
||||
ensure "${USERNAME}" "username"
|
||||
ensure "${PASSWORD}" "password"
|
||||
ensure "${IMAGE}" "image"
|
||||
ensure "${TAG}" "tag"
|
||||
ensure "${CONTEXT_PATH}" "path"
|
||||
|
||||
if [ "$REGISTRY" == "docker.pkg.github.com" ]; then
|
||||
if [ "$REGISTRY" = "ghcr.io" ]; then
|
||||
IMAGE_NAMESPACE="$(echo $GITHUB_REPOSITORY | tr '[:upper:]' '[:lower:]')"
|
||||
export IMAGE="$IMAGE_NAMESPACE/$IMAGE"
|
||||
# Set `/` separator, unless image is pre-fixed with dash or slash
|
||||
[ -n "$REPOSITORY" ] && [[ ! "$REPOSITORY" =~ ^[-/] ]] && SEPARATOR="/"
|
||||
export IMAGE="$IMAGE_NAMESPACE$SEPARATOR$IMAGE"
|
||||
export REPOSITORY="$IMAGE_NAMESPACE$SEPARATOR$REPOSITORY"
|
||||
|
||||
if [ ! -z $INPUT_CACHE_REGISTRY ]; then
|
||||
export INPUT_CACHE_REGISTRY="$REGISTRY/$IMAGE_NAMESPACE/$INPUT_CACHE_REGISTRY"
|
||||
if [ -n "$IMAGE_LATEST" ]; then
|
||||
export IMAGE_LATEST="${IMAGE_NAMESPACE}/${IMAGE_LATEST}"
|
||||
fi
|
||||
|
||||
if [ -n "$INPUT_CACHE_REGISTRY" ]; then
|
||||
export INPUT_CACHE_REGISTRY="${REGISTRY}/${IMAGE_NAMESPACE}/${INPUT_CACHE_REGISTRY}"
|
||||
fi
|
||||
fi
|
||||
|
||||
if [ "$REGISTRY" == "docker.io" ]; then
|
||||
if [ "$REGISTRY" = "docker.io" ]; then
|
||||
export REGISTRY="index.${REGISTRY}/v1/"
|
||||
else
|
||||
export IMAGE="$REGISTRY/$IMAGE"
|
||||
export IMAGE="${REGISTRY}/${IMAGE}"
|
||||
|
||||
if [ -n "$IMAGE_LATEST" ]; then
|
||||
export IMAGE_LATEST="${REGISTRY}/${IMAGE_LATEST}"
|
||||
fi
|
||||
fi
|
||||
|
||||
export CACHE=${INPUT_CACHE:+"--cache=true"}
|
||||
export CACHE=$CACHE${INPUT_CACHE_TTL:+" --cache-ttl=$INPUT_CACHE_TTL"}
|
||||
export CACHE=$CACHE${INPUT_CACHE_REGISTRY:+" --cache-repo=$INPUT_CACHE_REGISTRY"}
|
||||
export CACHE=$CACHE${INPUT_CACHE_DIRECTORY:+" --cache-dir=$INPUT_CACHE_DIRECTORY"}
|
||||
export CONTEXT="--context $GITHUB_WORKSPACE"
|
||||
export DOCKERFILE="--dockerfile ${INPUT_BUILD_FILE:-Dockerfile}"
|
||||
export DESTINATION="--destination $IMAGE"
|
||||
export CACHE="${INPUT_CACHE:+"--cache=true"}"
|
||||
export CACHE="$CACHE"${INPUT_CACHE_TTL:+" --cache-ttl=$INPUT_CACHE_TTL"}
|
||||
export CACHE="$CACHE"${INPUT_CACHE_REGISTRY:+" --cache-repo=$INPUT_CACHE_REGISTRY"}
|
||||
export CACHE="$CACHE"${INPUT_CACHE_DIRECTORY:+" --cache-dir=$INPUT_CACHE_DIRECTORY"}
|
||||
export CONTEXT="--context $GITHUB_WORKSPACE/$CONTEXT_PATH"
|
||||
export DOCKERFILE="--dockerfile $CONTEXT_PATH/${INPUT_BUILD_FILE:-Dockerfile}"
|
||||
export TARGET=${INPUT_TARGET:+"--target=$INPUT_TARGET"}
|
||||
export DIGEST="--digest-file /kaniko/digest --image-name-tag-with-digest-file=/kaniko/image-tag-digest"
|
||||
|
||||
export ARGS="$CACHE $CONTEXT $DOCKERFILE $DESTINATION $INPUT_EXTRA_ARGS"
|
||||
echo $ARGS
|
||||
if [ -n "$INPUT_SKIP_UNCHANGED_DIGEST" ]; then
|
||||
export DESTINATION="--no-push --tarPath image.tar --destination $IMAGE"
|
||||
else
|
||||
export DESTINATION="--destination $IMAGE"
|
||||
if [ -n "$IMAGE_LATEST" ]; then
|
||||
export DESTINATION="$DESTINATION --destination $IMAGE_LATEST"
|
||||
fi
|
||||
fi
|
||||
|
||||
export ARGS="$CACHE $CONTEXT $DOCKERFILE $TARGET $DIGEST $DESTINATION $INPUT_EXTRA_ARGS"
|
||||
|
||||
cat <<EOF >/kaniko/.docker/config.json
|
||||
{
|
||||
|
@ -61,4 +91,45 @@ cat <<EOF >/kaniko/.docker/config.json
|
|||
}
|
||||
EOF
|
||||
|
||||
/kaniko/executor $ARGS
|
||||
# https://github.com/GoogleContainerTools/kaniko/issues/1803
|
||||
# https://github.com/GoogleContainerTools/kaniko/issues/1349
|
||||
export IFS=''
|
||||
# Removes a trailing new line
|
||||
ARGS=$(echo "${ARGS}" | sed 's/\n*$//')
|
||||
kaniko_cmd="/kaniko/executor ${ARGS} --reproducible --force"
|
||||
echo "Running kaniko command ${kaniko_cmd}"
|
||||
eval "${kaniko_cmd}"
|
||||
|
||||
echo "image=$IMAGE" >> "$GITHUB_OUTPUT"
|
||||
echo "digest=$(cat /kaniko/digest)" >> "$GITHUB_OUTPUT"
|
||||
echo "image-tag-digest<<EOF" >>"$GITHUB_OUTPUT"
|
||||
echo "$(cat /kaniko/image-tag-digest)" >>"$GITHUB_OUTPUT"
|
||||
echo 'EOF' >>"$GITHUB_OUTPUT"
|
||||
|
||||
|
||||
if [ -n "$INPUT_SKIP_UNCHANGED_DIGEST" ]; then
|
||||
export DIGEST="$(cat /kaniko/digest)"
|
||||
|
||||
/kaniko/crane auth login "$REGISTRY" -u "$USERNAME" -p "$PASSWORD"
|
||||
|
||||
export REMOTE=$(crane digest "${REGISTRY}/${REPOSITORY}:latest")
|
||||
|
||||
if [ "$DIGEST" = "$REMOTE" ]; then
|
||||
echo "refreshed=false" >> "$GITHUB_OUTPUT"
|
||||
echo "Digest hasn't changed, skipping, $DIGEST"
|
||||
echo "Done 🎉️"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
echo "Pushing image..."
|
||||
|
||||
/kaniko/crane push image.tar "$IMAGE"
|
||||
|
||||
if [ -n "$IMAGE_LATEST" ]; then
|
||||
echo "Tagging latest..."
|
||||
/kaniko/crane tag "$IMAGE" latest
|
||||
fi
|
||||
|
||||
echo "refreshed=false" >> "$GITHUB_OUTPUT"
|
||||
echo "Done 🎉️"
|
||||
fi
|
||||
|
|
Loading…
Add table
Reference in a new issue