Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/manics/repo2kaniko
repo2kaniko is a plugin for repo2docker that lets you use Kaniko
https://github.com/manics/repo2kaniko
jupyter kaniko repo2docker
Last synced: 2 months ago
JSON representation
repo2kaniko is a plugin for repo2docker that lets you use Kaniko
- Host: GitHub
- URL: https://github.com/manics/repo2kaniko
- Owner: manics
- License: bsd-3-clause
- Created: 2023-11-06T00:13:59.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-08T04:03:02.000Z (3 months ago)
- Last Synced: 2024-10-09T10:20:42.360Z (3 months ago)
- Topics: jupyter, kaniko, repo2docker
- Language: Python
- Homepage:
- Size: 120 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# repo2kaniko
[](https://github.com/manics/repo2kaniko/actions/workflows/build.yml)
[](https://quay.io/repository/manics/repo2kaniko?tab=tags)
`repo2kaniko` is a plugin for [repo2docker](http://repo2docker.readthedocs.io) that lets you use [Kaniko](https://github.com/GoogleContainerTools/kaniko) instead of Docker.
Kaniko must run in a standalone container, can only build images, and can only store images in a registry.
It has the big advantage that it is completely unprivileged and doesn't require any host configuration, unlike e.g. Podman which requires your system to have the correct cgroups configuration.
It does not use a local Docker store, so it is not possible to separate the build and push steps.
**This means the repo2docker `--push`/`--no-push` arguments have no effect.**
The default in this plugin is to automatically push the image to a registry after it is built.
Set Traitlet `KanikoEngine.push_image=False` or environment variable `KANIKO_PUSH_IMAGE=0` to disable pushing the image.
Kaniko does not cache layers locally, instead it uses a registry for caching.
You should probably use a dedicated local private registry for speed and not the remote registry used for storing the built image.
Use `KanikoEngine.cache_registry_credentials` or `KANIKO_CACHE_REGISTRY_CREDENTIALS` to specify the credentials for the cache registry.
These behave similarly to `ContainerEngine.registry_credentials` and `CONTAINER_ENGINE_REGISTRY_CREDENTIALS`.
## Running
Kaniko must be run in a standalone container with no other applications, and can only build one image.
In practice this means Kaniko must be run in a separate container from repo2docker.
Communication between repo2docker and Kaniko is done using a network socket and a helper utility (`kaniko-runner`).
1. Create a new network to isolate Kaniko and repo2docker
```
podman network create repo2kaniko
```
2. Run the `kaniko-runner` container with a shared empty workspace volume that must be mounted to `/workspace`
```
podman run -d --rm -p 12321:12321 --name kaniko-runner --network repo2kaniko \
-v /tmp/workspace:/workspace:z kaniko-runner -address=tcp://0.0.0.0:12321
```
3. Run repo2docker with the kaniko plugin
```
podman run -it --rm -v /tmp/workspace:/workspace:z repo2kaniko \
repo2docker --engine=kaniko --no-run --debug \
--user-id=1000 --user-name=jovyan
--image-name registry.example.com/r2d-test \
--KanikoEngine.registry_credentials=registry=registry.example.com
--KanikoEngine.registry_credentials=username=registry-user
--KanikoEngine.registry_credentials=password=registry-password
--KanikoEngine.kaniko_address=tcp://kaniko-runner:12321"
https://github.com/binderhub-ci-repos/minimal-dockerfile
```
To use a local registry as a cache:
```
./ci/run-local-registry.sh
REGISTRY=...
```
Add the following to the `repo2docker` command:
```
--KanikoEngine.cache_registry=$REGISTRY/cache \
--KanikoEngine.cache_registry_credentials=username=user \
--KanikoEngine.cache_registry_credentials=password=password \
--KanikoEngine.cache_registry_insecure=true \
```
## BinderHub
You can use repo2kaniko with a recent version of BinderHub
([1.0.0-0.dev.git.3350.he7995d6 or later](https://hub.jupyter.org/helm-chart/#development-releases-binderhub))
by adding the following to your configuration:
```yaml
config:
KubernetesBuildExecutor:
docker_host:
build_image: "quay.io/manics/repo2kaniko:"
repo2docker_extra_args:
- --engine=kaniko
- --debug
imageCleaner:
enabled: false
```
If you want to use a local registry as a cache use something like this:
```yaml
config:
KubernetesBuildExecutor:
repo2docker_extra_args:
- --engine=kaniko
- --debug
- --KanikoEngine.cache_registry=cache-registry-docker-registry:5000/cache
- --KanikoEngine.cache_registry_credentials=username=user
- --KanikoEngine.cache_registry_credentials=password=password
- --KanikoEngine.cache_registry_insecure=true
```