https://github.com/gopaddle-io/configurator
Synchronize and Version Control ConfigMaps & Secrets across Deployment Rollouts.
https://github.com/gopaddle-io/configurator
containers crd deployment docker go golang hacktoberfest hacktoberfest2021 helm k8s kubernetes secrets
Last synced: 2 months ago
JSON representation
Synchronize and Version Control ConfigMaps & Secrets across Deployment Rollouts.
- Host: GitHub
- URL: https://github.com/gopaddle-io/configurator
- Owner: gopaddle-io
- License: other
- Created: 2020-11-11T14:33:28.000Z (over 5 years ago)
- Default Branch: v0.0.2
- Last Pushed: 2024-01-29T21:07:12.000Z (about 2 years ago)
- Last Synced: 2024-11-15T01:39:51.847Z (over 1 year ago)
- Topics: containers, crd, deployment, docker, go, golang, hacktoberfest, hacktoberfest2021, helm, k8s, kubernetes, secrets
- Language: Go
- Homepage:
- Size: 148 MB
- Stars: 113
- Watchers: 4
- Forks: 45
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://stackshare.io/gopaddleio/gopaddle) [](https://opensource.org/licenses/Apache-2.0) [](https://twitter.com/configuratork8s)
[](https://discord.gg/dr24Z4BmP8)
# Configurator
Configurator is a version control and a sync service that keeps Kubernetes ConfigMaps and Secrets in sync with the deployments. When a ConfigMap content is changed, Configurator creates a custom resource of type CustomConfigMap (CCM) with a postfix. CCM with a postfix acts like ConfigMap revision. Configurator then copies the modified contents of the ConfigMap in to the CCM resource and triggers a rolling update on deployments using the ConfigMap. Configurator keeps the ConfigMap contents in sync with the deployment revisions with the help of annotations and works well for both rolling updates and rollbacks. Configurator supports GitOps workflows as well.
# Supported Versions
- K8s 1.16+
# Contributing
Check the [CONTRIBUTING.md](/CONTRIBUTING.md) file to start contributing to the project
Check out the [Configurator website](https://gopaddle-io.github.io/configurator/) for quick and easy navigation of all documentaion and additional resources.
Join the community at our [discord server]((https://discord.gg/dr24Z4BmP8))
# How to install Configurator
Configurator can be installed using Helm chart.
### Pre-requisite
* [Install Helm](https://helm.sh/docs/intro/install/)
* [Install kubectl in your local environment](https://kubernetes.io/docs/tasks/tools/)
* Add the contents of the Kubernetes configuration file to your local ~/.kube/config file
* Check if you could access your kubernetes cluster using kubectl command
```sh
$ kubectl version
```
### Add configurator helm repository
Choose Configurator helm repostry based on the Configuration version. To use Configurator version 0.0.2, add the repo below:
```sh
$ helm repo add gopaddle_configurator https://github.com/gopaddle-io/configurator/raw/v0.0.2/helm
```
### Install configurator to cluster
To install Configurator in the cluster.
```sh
$ helm install configurator gopaddle_configurator/configurator --version 0.4.0-alpha
```
### Removing Configurator
To remove Configurator from the cluster.
```sh
$ helm delete configurator gopaddle_configurator/configurator
```
### License
[Apache License Version 2.0](/LICENSE.md)
### Pull Requests
1. Fetch the latest code from master branch and resolve any conflicts before sending a pull request.
2. Make sure you build and test the changes before sending a pull request.
3. Ensure the README is updated with any interface or architecture changes.
## Maintainers
Configurator is maintained by [gopaddle.io](https://gopaddle.io) team.