Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/s-soroosh/configme
https://github.com/s-soroosh/configme
Last synced: 22 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/s-soroosh/configme
- Owner: s-soroosh
- License: mit
- Created: 2020-11-29T11:35:13.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-03-22T09:52:35.000Z (over 3 years ago)
- Last Synced: 2023-05-25T03:10:19.353Z (over 1 year ago)
- Language: Java
- Size: 139 KB
- Stars: 9
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
ConfigME
========
A Kubernetes operator to load the configmap data from different datasources.
There are situations where services in a Kubernetes cluster may need data provided by different datasources
like HTTP-API, files in a GitServer or kafka topic to name a few.
If the data is cacheable, mapping them to a ConfigMap would contribute to the resiliency of the service as it wouldn't be dependent to the availability of the other service.
## Alternatives:
### caching the data in every pod
Not to mention that while the external service is down your service can't scale or the pods being respawned.
### A central Cache like Redis, Memcached
Well, this solution is already better than the previous one...
but really? you want to spend your resoures to implement a thing identical to what K8s already provides?
## How to install the operator
The simplest way to install the Configme on your K8s cluster is running the following command:
**⚠ WARNING:** it will create a new namespace called **configme-operator** and deploy the operator in it.
If it is not desirable, consider to edit the file according to your requirements.
```bash
kubectl apply -f https://raw.githubusercontent.com/psycho-ir/configme/master/crd/ConfigSource.yml
kubectl apply -f https://raw.githubusercontent.com/psycho-ir/configme/master/deployment/operator.yml
```
## How to define ConfigSource
Configme introduces a new Custom Resource Definition in your cluster called **ConfigSource**.
A ConfigSource defining a mapping from a http endpoint to a Configmap in your cluster will look like this:
```yaml
apiVersion: configme.javaworm.com/v1beta1
kind: ConfigSource
metadata:
name: simple-http-configsource
namespace: test-configme
spec:
sourceType: http
targetConfigMapName: todos-config
sourceConfig:
url: https://jsonplaceholder.typicode.com/todos
intervalSeconds: 10
```
The example above will call the url https://jsonplaceholder.typicode.com/todos every 10 seconds and update the ConfigMap called `todos-config` in namespace `test-configme`.
### What if the endpoint is secured
It is quite simple to load the configuration from a secured http endpoint.
Configme currently supports bearer tokens loaded from a secret living in the same namespace as ConfgiSource itself is living.
If you are interested in any other authentication method, feel free to open an issue (you are very welcomed to contribute to the code as well!)
The following example shows how to do setup bearer authentication method:
```yaml
apiVersion: configme.javaworm.com/v1beta1
kind: ConfigSource
metadata:
name: bearer-http-configsource
namespace: test-configme
spec:
sourceType: http
targetConfigMapName: bearer-http-config
sourceConfig:
url: https://jsonplaceholder.typicode.com/todos
intervalSeconds: 5
authenticationMethod: bearer
authenticationConfig:
tokenType: Bearer
secretName: source-credentials
tokenSecretKey: default-token-secret
```
### Load config files from Github repositories
Given that Github has the possibility to provide the files in raw format, it's quite easy to fetch the load configs from Github through `sourceType: http`.
The example below shows how to load the configuration from master branch of a private repository:
```yaml
apiVersion: v1
data:
token: base64(GITHUB_TOKEN)
kind: Secret
metadata:
name: github-credentials
type: Opaque
---
apiVersion: configme.javaworm.com/v1beta1
kind: ConfigSource
metadata:
name: bearer-http-configsource
spec:
sourceType: http
targetConfigMapName: readme-config
sourceConfig:
url: https://raw.githubusercontent.com/psycho-ir/private-repository/master/config.json
intervalSeconds: 5
authenticationMethod: bearer
authenticationConfig:
tokenType: Bearer
secretName: github-credentials
tokenSecretKey: token
```
## TODO
- [X] Handle http errors may happen
- [X] Native image build
- [x] Docker Image
- [ ] Different Authentications methods
- [x] none
- [x] bearer
- [ ] basic
- [ ] api-key
- ...
- [X] How to use document
- [X] Provide configs as **is** and **Gzip**
- [ ] Schema support for fetched configuration