Table of Contents

1. About Imagswap
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Imageswap is a simple program written in Go that is used to perform image registry hostname transformations as a Kubernetes mutating webook.

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• Go 1.17.1
• Docker
• KinD

Installation

To compile only the imageswap binary:

go build -o imageswap main.go

Or, to output to build/_output/bin/

make build

Alternatively, to build the binary and create a container image to host it:

make build-image

(back to top)

Usage

Please see Makefile and internal/deploy/ for materials used to test the webhook locally using KinD. The manifests in internal/deploy/ can be used as a starting place for deploying

(back to top)

Roadmap

All dates are TBD, this project is passively developed

• Makefile test
  • Unit Testing
• Makefile fmt
• Makefile lint
  • golangcli-lint
• Validating webhook
• More complete examples
• CI pipeline
• Serve on 8080 (insecure)
• Helm Chart

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the Apache 2.0 License. See LICENSE for more information.

(back to top)

Contact

Tim Seagren - LinkedIn - [email protected]

Project Link: https://github.com/chaospuppy/imageswap

(back to top)

Acknowledgments

• douglasmakey's admissionscontroller was used for large portions of the server, pod, and hook packages
• morvencaos's mutating webhook tutorial was leveraged for it's Kubernetes CSA and webhook CA patch scripts (internal/deploy/webhook-create-signed-cert.sh and internal/deploy/webhook-patch-ca-bundle.sh respectively)
• KinD with registry

(back to top)