This repository has been archived on 2024-07-26. You can view files and clone it, but cannot push or open issues or pull requests.
drone-kaniko/README.md

120 lines
3.6 KiB
Markdown
Raw Normal View History

2019-01-08 10:51:32 +00:00
# drone-kaniko
2018-11-21 14:45:09 +00:00
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/).
2019-06-01 13:00:26 +00:00
Example .drone.yml for Drone 1.0 (pushing to Docker Hub):
```yaml
kind: pipeline
name: default
steps:
- name: publish
2019-01-08 10:51:32 +00:00
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
```
2019-06-01 13:00:26 +00:00
Pushing to GCR:
```yaml
kind: pipeline
name: default
steps:
- name: publish
image: banzaicloud/drone-kaniko
settings:
registry: gcr.io
repo: example.com/example-project
2019-06-01 13:00:26 +00:00
tags: ${DRONE_COMMIT_SHA}
cache: true
json_key:
2019-06-01 13:00:26 +00:00
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
```
2018-11-24 16:29:40 +00:00
## Test that it can build
2018-11-21 14:45:09 +00:00
```bash
2019-01-08 10:51:32 +00:00
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
2018-11-21 14:45:09 +00:00
```
2018-11-25 14:59:05 +00:00
## 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
2019-01-08 10:51:32 +00:00
docker build -t banzaicloud/drone-kaniko .
2018-11-25 14:59:05 +00:00
```
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
2018-11-25 14:59:05 +00:00
```
2019-06-01 13:00:26 +00:00
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:
2018-11-25 14:59:05 +00:00
```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
2018-11-25 14:59:05 +00:00
```
2019-06-01 13:00:26 +00:00
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
2019-06-01 13:00:26 +00:00
```