From 60e00b042b38730cc1646a55f1c2ab46434642bb Mon Sep 17 00:00:00 2001 From: Kevin Dorner Date: Wed, 21 Nov 2018 07:39:41 +0100 Subject: [PATCH] Fork drone-kaniko / initial commit --- .gitignore | 12 +++ Dockerfile | 11 +++ Dockerfile.test | 5 ++ LICENSE | 201 ++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 146 +++++++++++++++++++++++++++++++++++ plugin.sh | 109 ++++++++++++++++++++++++++ 6 files changed, 484 insertions(+) create mode 100644 .gitignore create mode 100644 Dockerfile create mode 100644 Dockerfile.test create mode 100644 LICENSE create mode 100644 README.md create mode 100755 plugin.sh diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f276527 --- /dev/null +++ b/.gitignore @@ -0,0 +1,12 @@ +# Binaries for programs and plugins +*.exe +*.exe~ +*.dll +*.so +*.dylib + +# Output of the go coverage tool, specifically when used with LiteIDE +*.out + +# kaniko base image cache files +sha256:* diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..7579cd5 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,11 @@ +FROM gcr.io/kaniko-project/executor:debug-v0.19.0 + +ENV HOME /root +ENV USER root +ENV SSL_CERT_DIR=/kaniko/ssl/certs +ENV DOCKER_CONFIG /kaniko/.docker/ +ENV DOCKER_CREDENTIAL_GCR_CONFIG /kaniko/.config/gcloud/docker_credential_gcr_config.json + +# add the wrapper which acts as a drone plugin +COPY plugin.sh /kaniko/plugin.sh +ENTRYPOINT [ "/kaniko/plugin.sh" ] diff --git a/Dockerfile.test b/Dockerfile.test new file mode 100644 index 0000000..094f1e7 --- /dev/null +++ b/Dockerfile.test @@ -0,0 +1,5 @@ +FROM alpine:3.8 + +RUN apk add --update git + +RUN apk add --update jq diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..f8fc7c3 --- /dev/null +++ b/README.md @@ -0,0 +1,146 @@ +# drone-kaniko + +A thin shim-wrapper around the official [Google Kaniko](https://cloud.google.com/blog/products/gcp/introducing-kaniko-build-container-images-in-kubernetes-and-google-container-builder-even-without-root-access) Docker image to make it behave like the [Drone Docker plugin](http://plugins.drone.io/drone-plugins/drone-docker/). + +Example .drone.yml for Drone 1.0 (pushing to Docker Hub): + +```yaml +kind: pipeline +name: default + +steps: +- name: publish + image: banzaicloud/drone-kaniko + settings: + registry: registry.example.com # if not provided index.docker.io is supposed + repo: registry.example.com/example-project + tags: ${DRONE_COMMIT_SHA} + cache: true + skip_tls_verify: false # set to true for testing registries ONLY with self-signed certs + build_args: + - COMMIT_SHA=${DRONE_COMMIT_SHA} + - COMMIT_AUTHOR_EMAIL=${DRONE_COMMIT_AUTHOR_EMAIL} + username: + from_secret: docker-username + password: + from_secret: docker-password +``` + +Pushing to GCR: + +```yaml +kind: pipeline +name: default + +steps: +- name: publish + image: banzaicloud/drone-kaniko + settings: + registry: gcr.io + repo: example.com/example-project + tags: ${DRONE_COMMIT_SHA} + cache: true + json_key: + from_secret: google-application-credentials +``` + +## Use `.tags` file for tagging + +Similarily to official +[drone-docker](https://github.com/drone-plugins/drone-docker) plugin you can use +`.tags` file to embed some custom logic for creating tags for an image. + +```yaml +kind: pipeline +name: default + +steps: +- name: build + image: golang + commands: + - go get + - go build + - make versiontags > .tags +- name: publish + image: banzaicloud/drone-kaniko + settings: + registry: registry.example.com + repo: registry.example.com/example-project + # tags: ${DRONE_COMMIT_SHA} <= it must be left undefined + username: + from_secret: docker-username + password: + from_secret: docker-password +``` + +## Auto tag + +Set `auto_tag: true`. + +```yaml +kind: pipeline +name: default + +steps: +- name: build + image: golang + commands: + - go get + - go build +- name: publish + image: banzaicloud/drone-kaniko + settings: + registry: registry.example.com + repo: registry.example.com/example-project + auto_tag: true # higher priority then .tags file + # tags: ${DRONE_COMMIT_SHA} <= it must be left undefined to use auto_tag + username: + from_secret: docker-username + password: + from_secret: docker-password +``` + +## Test that it can build + +```bash +docker run -it --rm -w /src -v $PWD:/src -e PLUGIN_USERNAME=${DOCKER_USERNAME} -e PLUGIN_PASSWORD=${DOCKER_PASSWORD} -e PLUGIN_REPO=banzaicloud/drone-kaniko-test -e PLUGIN_TAGS=test -e PLUGIN_DOCKERFILE=Dockerfile.test banzaicloud/drone-kaniko +``` + +## Test that caching works + +Start a Docker registry at 127.0.0.1:5000: + +```bash +docker run -d -p 5000:5000 --restart always --name registry --hostname registry.local registry:2 +``` + +Add the following lines to plugin.sh's final command and build a new image from it: + +```diff ++ --cache=true \ ++ --cache-repo=127.0.0.1:5000/${PLUGIN_REPO} \ +``` + +```bash +docker build -t banzaicloud/drone-kaniko . +``` + + +Warm up the alpine image to the cache: + +```bash +docker run -v $PWD:/cache gcr.io/kaniko-project/warmer:latest --verbosity=debug --image=alpine:3.8 +``` + + +Run the builder (on the host network to be able to access the registry, if any specified) with mounting the local disk cache, this example pushes to Docker Hub: + +```bash +docker run --net=host -it --rm -w /src -v $PWD:/cache -v $PWD:/src -e PLUGIN_USERNAME=${DOCKER_USERNAME} -e PLUGIN_PASSWORD=${DOCKER_PASSWORD} -e PLUGIN_REPO=banzaicloud/drone-kaniko-test -e PLUGIN_TAGS=test -e PLUGIN_DOCKERFILE=Dockerfile.test -e PLUGIN_CACHE=true banzaicloud/drone-kaniko +``` + +The very same example just pushing to GCR instead of Docker Hub: + +```bash +docker run --net=host -it --rm -w /src -v $PWD:/cache -v $PWD:/src -e PLUGIN_REGISTRY=gcr.io -e PLUGIN_REPO=paas-dev1/drone-kaniko-test -e PLUGIN_TAGS=test -e PLUGIN_DOCKERFILE=Dockerfile.test -e PLUGIN_CACHE=true -e PLUGIN_JSON_KEY="$(<$HOME/google-application-credentials.json)" banzaicloud/drone-kaniko +``` diff --git a/plugin.sh b/plugin.sh new file mode 100755 index 0000000..31e8cd3 --- /dev/null +++ b/plugin.sh @@ -0,0 +1,109 @@ +#!/busybox/sh + +set -euo pipefail + +export PATH=$PATH:/kaniko/ + +REGISTRY=${PLUGIN_REGISTRY:-index.docker.io} + +if [ "${PLUGIN_USERNAME:-}" ] || [ "${PLUGIN_PASSWORD:-}" ]; then + DOCKER_AUTH=`echo -n "${PLUGIN_USERNAME}:${PLUGIN_PASSWORD}" | base64 | tr -d "\n"` + + cat > /kaniko/.docker/config.json < /kaniko/gcr.json + export GOOGLE_APPLICATION_CREDENTIALS=/kaniko/gcr.json +fi + +DOCKERFILE=${PLUGIN_DOCKERFILE:-Dockerfile} +CONTEXT=${PLUGIN_CONTEXT:-$PWD} +LOG=${PLUGIN_LOG:-info} +EXTRA_OPTS="" + +if [[ -n "${PLUGIN_TARGET:-}" ]]; then + TARGET="--target=${PLUGIN_TARGET}" +fi + +if [[ "${PLUGIN_SKIP_TLS_VERIFY:-}" == "true" ]]; then + EXTRA_OPTS="--skip-tls-verify=true" +fi + +if [[ "${PLUGIN_CACHE:-}" == "true" ]]; then + CACHE="--cache=true" +fi + +if [ -n "${PLUGIN_CACHE_REPO:-}" ]; then + CACHE_REPO="--cache-repo=${REGISTRY}/${PLUGIN_CACHE_REPO}" +fi + +if [ -n "${PLUGIN_CACHE_TTL:-}" ]; then + CACHE_TTL="--cache-ttl=${PLUGIN_CACHE_TTL}" +fi + +if [ -n "${PLUGIN_BUILD_ARGS:-}" ]; then + BUILD_ARGS=$(echo "${PLUGIN_BUILD_ARGS}" | tr ',' '\n' | while read build_arg; do echo "--build-arg=${build_arg}"; done) +fi + +if [ -n "${PLUGIN_BUILD_ARGS_FROM_ENV:-}" ]; then + BUILD_ARGS_FROM_ENV=$(echo "${PLUGIN_BUILD_ARGS_FROM_ENV}" | tr ',' '\n' | while read build_arg; do echo "--build-arg ${build_arg}=$(eval "echo \$$build_arg")"; done) +fi + +# auto_tag, if set auto_tag: true, auto generate .tags file +# support format Major.Minor.Release or start with `v` +# docker tags: Major, Major.Minor, Major.Minor.Release and latest +if [[ "${PLUGIN_AUTO_TAG:-}" == "true" ]]; then + TAG=$(echo "${DRONE_TAG:-}" |sed 's/^v//g') + part=$(echo "${TAG}" |tr '.' '\n' |wc -l) + # expect number + echo ${TAG} |grep -E "[a-z-]" &>/dev/null && isNum=1 || isNum=0 + + if [ ! -n "${TAG:-}" ];then + echo "latest" > .tags + elif [ ${isNum} -eq 1 -o ${part} -gt 3 ];then + echo "${TAG},latest" > .tags + else + major=$(echo "${TAG}" |awk -F'.' '{print $1}') + minor=$(echo "${TAG}" |awk -F'.' '{print $2}') + release=$(echo "${TAG}" |awk -F'.' '{print $3}') + + major=${major:-0} + minor=${minor:-0} + release=${release:-0} + + echo "${major},${major}.${minor},${major}.${minor}.${release},latest" > .tags + fi +fi + +if [ -n "${PLUGIN_TAGS:-}" ]; then + DESTINATIONS=$(echo "${PLUGIN_TAGS}" | tr ',' '\n' | while read tag; do echo "--destination=${REGISTRY}/${PLUGIN_REPO}:${tag} "; done) +elif [ -f .tags ]; then + DESTINATIONS=$(cat .tags| tr ',' '\n' | while read tag; do echo "--destination=${REGISTRY}/${PLUGIN_REPO}:${tag} "; done) +elif [ -n "${PLUGIN_REPO:-}" ]; then + DESTINATIONS="--destination=${REGISTRY}/${PLUGIN_REPO}:latest" +else + DESTINATIONS="--no-push" + # Cache is not valid with --no-push + CACHE="" +fi + +/kaniko/executor -v ${LOG} \ + --context=${CONTEXT} \ + --dockerfile=${DOCKERFILE} \ + ${EXTRA_OPTS} \ + ${DESTINATIONS} \ + ${CACHE:-} \ + ${CACHE_TTL:-} \ + ${CACHE_REPO:-} \ + ${TARGET:-} \ + ${BUILD_ARGS:-} \ + ${BUILD_ARGS_FROM_ENV:-}