Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/unclearParadigm/schmusek8ser
simple k8s helper to once and for all solve the :latest image problem on your k8s manifests
https://github.com/unclearParadigm/schmusek8ser
Last synced: 3 months ago
JSON representation
simple k8s helper to once and for all solve the :latest image problem on your k8s manifests
- Host: GitHub
- URL: https://github.com/unclearParadigm/schmusek8ser
- Owner: unclearParadigm
- Created: 2024-08-16T19:30:37.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-20T03:55:03.000Z (3 months ago)
- Last Synced: 2024-08-20T23:45:41.845Z (3 months ago)
- Language: Python
- Size: 153 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# schmusek8ser
schmusek8ser (pronounced 'schmusekadser') is a Python REST API able to connect to Kubernetes clusters and forcing pulls of `:latest` tags of deployments in a cluster.
This is particularily helpful for workloads which are mostly stateless and which you'd like to keep up to date with the latest tag automagically. No need to play around with [FluxCD](https://fluxcd.io),
and no need to expose your Kubernetes API to Source Code Repository hosters such as Gitlab/Github and the likes. Install `schmusk8ser` either as manifest in your K8s cluster, or run it on a machine
that can access the K8s API of your choice.
## Features
- [x] 🔑 authentication using simple and secure API Tokens
- [x] 🚀 easy to use REST-API
- [x] 🖹 audit logging
- [x] 📲 [ntfy.sh Notification dispatch support](https://ntfy.sh) for push notifications
- [x] 🔄 allow restarts of Deployments with `imagePullPolicy: always`
- [ ] ⬆️ functionality to bump a container image to a newer tag (e.g. from `:1.0.0` to `:2.0.0`)
- [ ] 🐋 deployable as docker/podman container
- [ ] 🇰 K8s manifests available
- [ ] 👷 Helm charts
- [ ] container images on quay.io
## Getting started
### running `schmusek8ser`
```bash
git clone https://github.com/unclearParadigm/schmusek8ser
cd schmusek8ser
pip install -r requirements.txt
python3 -m main.py
```
### usage
```bash
# generate an API key that authenticates requests to schmusek8ser
curl -X GET http://localhost:8080/apikey/new?for=testingapikey
# schmusek8ser will generate a new API key for you
# {
# "status_code": 200,
# "success": true,
# "payload": {
# "apiKey": "eyJ3aG9zZSI6ICJoZXJiZXJ0IiwgInRva2VuIjogInY/XCJXa0RcIidKdTlBJCRuWEVae1psKEpmXCJdTmNxQFM/LTJmMjlkNzg2LTdmOTUtNGI1MC1iNzA0LWJkNjIyZTJmOGE3MyJ9",
# "for": "testingapikey",
# "note": "This API key is not yet activated. Update the schmusek8ser configuration with this key"
# }
# }
# restart schmusek8ser with the newly added API key
export SCHMUSEK8SER_AUTHORIZED_API_KEYS__0="eyJ3aG9zZSI6ICJoZXJiZXJ0IiwgInRva2VuIjogInY/XCJXa0RcIidKdTlBJCRuWEVae1psKEpmXCJdTmNxQFM/LTJmMjlkNzg2LTdmOTUtNGI1MC1iNzA0LWJkNjIyZTJmOGE3MyJ9"
python3 -m main.py
# restart a deployment (and force pull image) for a deployment called "io-rtrace-apps-reddit" in namespace "default"
curl --request POST \
--url 'http://localhost:8080/restart?namespace=default&deployment=io-rtrace-apps-reddit' \
--header 'X-API-KEY: eyJ3aG9zZSI6ICJtZSIsICJ0b2tlbiI6ICJmWUwpMlhMYFpMWmNuNG9EKUBdK3VGeSxtd0I1VDJUNi04Mzk0MWQ0Ni1jYWU4LTQ1N2YtODhkMi1mNzc0NzJiNzMyODgifQ=='
```
### Configuration
`schmusek8ser` is configurable through environment variables. All configuration variables (as well as their defaults) are available in the [config.py](config.py)
| Variable | Data Type | Description |
|:------------------------------------|:----------|:-------------------------------------------------------------------------|
| SCHMUSEK8SER_LISTEN_PORT | number | the Listen TCP port of the HTTP API |
| SCHMUSEK8SER_LISTEN_HOST | string | the Listen Host of the HTTP API (e.g. localhost) |
| SCHMUSEK8SER_AUTHORIZED_API_KEYS__0 | string | an API key retreived through the `/apikey/new?for=` endpoint |
| SCMUSERK8SER_AUTHORIZED_API_KEYS__1 | string | another API key - you can add more by incrementing the postfix |
| SCMUSERK8SER_AUTHORIZED_API_KEYS__2 | string | guess you get the idea now ^^ |
| SCHMUSEK8SER_K8S_KUBECONFIG_PATH | string | path to the kubeconfig used to authenticate to the K8s API |
| SCHMUSEK8SER_K8S_KUBECONFIG_CTX | string | context that shall be used if kubeconfig contains more clusters |
| SCHMUSEK8SER_NTFY_ENABLE | bool | whether to enable NTFY notification services |
| SCHMUSEK8SER_NTFY_BASE_URL | string | the ntfy server to use (by default uses [ntfy.rtrace.io](ntfy.rtrace.io) |
| SCHMUSEK8SER_NTFY_TOPIC | string | the topic the notifications should be pushed to (make sure to change) |
## Contributing
Contributions to `schmusek8ser` are welcome! If you have any ideas for improvements or new features, feel free to open an issue or submit a pull request.
## License
`schmusek8ser` is licensed under the MIT License, allowing you to use, modify, and distribute the software freely.