https://github.com/estahn/k8s-image-swapper

Mirror images into your own registry and swap image references automatically.
https://github.com/estahn/k8s-image-swapper

golang kubernetes kubernetes-webhook mutating-webhook

Last synced: 5 days ago
JSON representation

Mirror images into your own registry and swap image references automatically.

• Host: GitHub
• URL: https://github.com/estahn/k8s-image-swapper
• Owner: estahn
• License: mit
• Created: 2020-12-10T11:19:54.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T10:14:50.000Z (about 1 month ago)
• Last Synced: 2024-10-29T12:17:12.842Z (about 1 month ago)
• Topics: golang, kubernetes, kubernetes-webhook, mutating-webhook
• Language: Go
• Homepage: https://estahn.github.io/k8s-image-swapper/
• Size: 6.42 MB
• Stars: 534
• Watchers: 8
• Forks: 44
• Open Issues: 29
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-k8s - k8s-image-swapper
• awesome-devops - k8s-image-swaper - :wheel_of_dharma: Mirror images into your own registry and swap image references automatically. (Kubernetes)

README

        


  

  
k8s-image-swapper

  
Mirror images into your own registry and swap image references automatically.


---

`k8s-image-swapper` is a mutating webhook for Kubernetes, downloading images into your own registry and pointing the images to that new location.

It is an alternative to a [docker pull-through proxy](https://docs.docker.com/registry/recipes/mirror/).

**Amazon ECR** and **Google Container Registry** are currently supported.

## :zap: Benefits

Using `k8s-image-swapper` will improve the overall availability, reliability, durability and resiliency of your

Kubernetes cluster by keeping 3rd-party images mirrored into your own registry.

`k8s-image-swapper` will transparently consolidate all images into a single registry without the need to adjust manifests

therefore reducing the impact of external registry failures, rate limiting, network issues, change or removal of images

while reducing data traffic and therefore cost.

**TL;DR:**

* Protect against:

  * external registry failure ([quay.io outage](https://www.reddit.com/r/devops/comments/f9kiej/quayio_is_experiencing_an_outage/))

  * image pull rate limiting ([docker.io rate limits](https://www.docker.com/blog/scaling-docker-to-serve-millions-more-developers-network-egress/))

  * accidental image changes

  * removal of images

* Use in air-gaped environments without the need to change manifests

* Reduce NAT ingress traffic/cost

## :book: Documentation

A comprehensive guide on getting started and a list of configuration options can be found in the documentation.

[![Documentation](https://img.shields.io/badge/Documentation-2FA4E7?style=for-the-badge&logo=ReadMe&logoColor=white)](https://estahn.github.io/k8s-image-swapper/index.html)

## :question: Community

You have questions, need support and or just want to talk about `k8s-image-swapper`?

Here are ways to get in touch with the community:

[![Slack channel](https://img.shields.io/badge/Slack_Channel-4A154B?style=for-the-badge&logo=slack&logoColor=white)](http://slack.kubernetes.io/)

[![GitHub Discussions](https://img.shields.io/badge/GITHUB_DISCUSSION-181717?style=for-the-badge&logo=github&logoColor=white)](https://github.com/estahn/k8s-image-swapper/discussions)

## :heart_decoration: Sponsor

Does your company use `k8s-image-swapper`?

Help keep the project bug-free and feature rich by [sponsoring the project](https://github.com/sponsors/estahn).

## :office: Commercial Support

Does your company require individual support or addition of features within a guaranteed timeframe?

Contact me via [email](mailto:[email protected]) to discuss.

## :octocat: Badges

[![Release](https://img.shields.io/github/release/estahn/k8s-image-swapper.svg?style=for-the-badge)](https://github.com/estahn/k8s-image-swapper/releases/latest)

[![Artifact Hub](https://img.shields.io/badge/Artifact_Hub-417598?style=for-the-badge&logo=artifacthub&logoColor=white)](https://artifacthub.io/packages/helm/estahn/k8s-image-swapper)

[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=for-the-badge)](/LICENSE.md)

[![Codecov branch](https://img.shields.io/codecov/c/github/estahn/k8s-image-swapper/main.svg?style=for-the-badge)](https://codecov.io/gh/estahn/k8s-image-swapper)

[![Go Doc](https://img.shields.io/badge/godoc-reference-blue.svg?style=for-the-badge)](http://godoc.org/github.com/estahn/k8s-image-swapper)

## :star2: Stargazers over time

[![Stargazers over time](https://starchart.cc/estahn/k8s-image-swapper.svg)](https://starchart.cc/estahn/k8s-image-swapper)