https://github.com/eddieowens/ranvier
A system for maintaining dynamic app config
https://github.com/eddieowens/ranvier
config configmap configuration configuration-management dynamic-configuration golang kubernetes
Last synced: 5 months ago
JSON representation
A system for maintaining dynamic app config
- Host: GitHub
- URL: https://github.com/eddieowens/ranvier
- Owner: eddieowens
- License: apache-2.0
- Created: 2019-05-23T06:40:13.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-08-11T18:20:57.000Z (almost 7 years ago)
- Last Synced: 2024-11-16T01:11:44.833Z (over 1 year ago)
- Topics: config, configmap, configuration, configuration-management, dynamic-configuration, golang, kubernetes
- Language: Go
- Homepage:
- Size: 292 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ranvier
Ranvier (named after the French neurophysiologist), is a system for managing all of your application's config in a
centralized, transparent, and fault-tolerant way. It consists of
* A Git repository
* A "Node of Ranvier" server which will poll the specified Git repository
* A Ranvier client which will maintain the configuration within your application
## Setup
1. Create a Git repo with your JSON [config schema](https://github.com/eddieowens/ranvier/wiki/Config-schema-files)
files.
* See the [example repo](https://github.com/eddieowens/ranvier-config-example) for a simple example.
1. Setup the [Ranvier server](server/README.md) to point at your created Git repo.
1. Connect to your Ranvier server with one of the clients. Currently supported clients are
* [Go](client/README.md)
## Packages included in Ranvier
Ranvier consists of the following packages
1. [server](server/README.md) - All code for the Ranvier server is stored here. The server handles polling the Git repo which houses your config
files as well as exposing that config to your applications.
1. [client](client/README.md) - The Go client used to communicate with the server. Many more languages soon to be supported.
1. [lang](lang/README.md) - The engine for compiling your schema config files to actual config files.
1. [cli](ranvier/README.md) - A tool for interacting with Ranvier and supporting local dev while using Ranvier.
1. [commons](commons/README.md) - All common code shared amongst all of the packages within Ranvier.