README
¶
Table of Contents
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.
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
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
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).
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
Distributed under the Apache 2.0 License. See LICENSE for more information.
Contact
Tim Seagren - LinkedIn - seagrentime@gmail.com
Project Link: https://github.com/chaospuppy/imageswap
Acknowledgments
- douglasmakey's admissionscontroller was used for large portions of the
server,pod, andhookpackages - morvencaos's mutating webhook tutorial was leveraged for it's Kubernetes CSA and webhook CA patch scripts (
internal/deploy/webhook-create-signed-cert.shandinternal/deploy/webhook-patch-ca-bundle.shrespectively) - KinD with registry
Documentation
¶
Overview ¶
Copyright © 2021 Tim Seagren
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cmd root.go Copyright © 2021 Tim Seagren Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
|
Package cmd root.go Copyright © 2021 Tim Seagren Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. |
|
Package pods has been modified from its original state, which can be found here: https://github.com/douglasmakey/admissioncontroller/blob/master/pods/ Package pods has been modified from its original state, which can be found here: https://github.com/douglasmakey/admissioncontroller/blob/master/pods/
|
Package pods has been modified from its original state, which can be found here: https://github.com/douglasmakey/admissioncontroller/blob/master/pods/ Package pods has been modified from its original state, which can be found here: https://github.com/douglasmakey/admissioncontroller/blob/master/pods/ |
|
Package server has been renamed and modified from its original state, which can be found here: https://github.com/douglasmakey/admissioncontroller/blob/master/http/ Package server has been renamed and modified from its original state, which can be found here: https://github.com/douglasmakey/admissioncontroller/blob/master/http/
|
Package server has been renamed and modified from its original state, which can be found here: https://github.com/douglasmakey/admissioncontroller/blob/master/http/ Package server has been renamed and modified from its original state, which can be found here: https://github.com/douglasmakey/admissioncontroller/blob/master/http/ |