Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phenixblue/imageswap-webhook
Image Swap Mutating Admission Webhook for Kubernetes
https://github.com/phenixblue/imageswap-webhook
admission-controllers admission-webhook image imageswap kubernetes mutating webhook
Last synced: 8 days ago
JSON representation
Image Swap Mutating Admission Webhook for Kubernetes
- Host: GitHub
- URL: https://github.com/phenixblue/imageswap-webhook
- Owner: phenixblue
- License: apache-2.0
- Created: 2018-11-13T07:52:29.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-19T12:02:22.000Z (about 1 year ago)
- Last Synced: 2025-01-16T06:11:40.627Z (15 days ago)
- Topics: admission-controllers, admission-webhook, image, imageswap, kubernetes, mutating, webhook
- Language: Python
- Homepage:
- Size: 446 KB
- Stars: 154
- Watchers: 5
- Forks: 53
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://github.com/phenixblue/imageswap-webhook/releases/latest)
[](https://github.com/tmobile/magtape/blob/master/LICENSE)
# ImageSwap Mutating Admission Controller for Kubernetes
The ImageSwap [webhook](https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/#admission-webhooks) enables you to define one or more mappings to automatically swap image definitions within Kubernetes Pods with a different registry. This is useful to easily transition from external to internal image registries, work around rate limiting issues, or to maintain consistency with manifests in environments that are airgapped and unable to access commonly used image registries (DockerHub, Quay, GCR, etc.)
**An existing image:**
```
nginx/nginx:latest
```
**can be swapped to:**
```
registry.example.com/nginx/nginx:latest
```
## NOTICE
Find version/environment specific notices and information [here](./docs/notice.md)
## Overview
- [Prereqs](#prereqs)
- [Quickstart](#quickstart)
- [Internals](./docs/internals.md)
- [Configuration](./docs/configuration.md)
- [Advance Install](./docs/advanced_install.md)
- [Operations](./docs/operations.md)
- [Contributing](./CONTRIBUTING.md)
- [Adopters](./ADOPTERS.md)
### Quickstart
You can use the following command to install ImageSwap from this repo with sane defaults
**NOTE:** The quickstart installation is not meant for production use. Please read through the [Cautions](#cautions) sections, and as always, use your best judgement when configuring ImageSwap for production scenarios.
```shell
$ kubectl apply -f https://raw.githubusercontent.com/phenixblue/imageswap-webhook/v1.5.3/deploy/install.yaml
```
#### This will do the following
- Create the `imageswap-system` namespace
- Create cluster and namespace scoped roles/rolebindings
- Deploy the ImageSwap workload and related configs
#### Once this is complete you can do the following to test
Create and label a test namespace
```shell
$ kubectl create ns test1
$ kubectl label ns test1 k8s.twr.io/imageswap=enabled
```
Deploy some test workloads
```shell
# These examples assume you're in the root directory of this repo
# Example with without expected prefix
$ kubectl apply -f ./testing/deployments/test-deploy01.yaml -n test1
# Example with expected prefix
$ kubectl apply -f ./testing/deployments/test-deploy02.yaml -n test1
```