Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/config-ninja/config-ninja
Manage your system configuration files in the cloud
https://github.com/config-ninja/config-ninja
aws config configuration python
Last synced: 3 months ago
JSON representation
Manage your system configuration files in the cloud
- Host: GitHub
- URL: https://github.com/config-ninja/config-ninja
- Owner: config-ninja
- License: mit
- Created: 2023-12-24T23:39:40.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-04-12T03:12:00.000Z (7 months ago)
- Last Synced: 2024-04-13T20:10:57.904Z (7 months ago)
- Topics: aws, config, configuration, python
- Language: Python
- Homepage: https://config-ninja.readthedocs.org/home.html
- Size: 4.57 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: changelog/CHANGELOG.md.j2
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starts - config-ninja/config-ninja - Manage your system configuration files in the cloud (python)
README
# Config Ninja 🥷
[](https://github.com/astral-sh/ruff)
[](https://github.com/config-ninja/config-ninja/actions/workflows/push-poe.yaml)
[](https://config-ninja.github.io/config-ninja/reports/pylint-report.txt)
[](https://codecov.io/gh/config-ninja/config-ninja)
[](https://results.pre-commit.ci/latest/github/config-ninja/config-ninja/main)
[](https://config-ninja.github.io/config-ninja/reports/mypy-html)
[](https://config-ninja.github.io/config-ninja/config_ninja.html)
[](https://config-ninja.readthedocs.io/en/latest/home.html)
[](https://badge.fury.io/py/config-ninja)
[](https://pepy.tech/project/config-ninja)
Similar to [`confd`](https://github.com/kelseyhightower/confd), manage your system configuration files by populating [Jinja2](https://jinja.palletsprojects.com/en/3.1.x/) templates with data from a remote provider.
## Installation
`config-ninja` is installed using the official installer or with `pip` / `pipx`. If your system supports `systemd`, you can then enable `config-ninja` as a `systemd` service.
### Official Installer
The recommended way to install `config-ninja` is with the official installer:
```sh
curl -sSL https://config-ninja.github.io/config-ninja/install.py | python3 -
```
To view available installation options, run the installer with the `--help` flag:
```sh
curl -sSL https://config-ninja.github.io/config-ninja/install.py | python3 - --help
```
```
usage: install [-h] [--version VERSION] [--pre] [--uninstall] [--force] [--path PATH] [--backends BACKENDS]
Installs the latest (or given) version of config-ninja
options:
-h, --help show this help message and exit
--version VERSION install named version
--pre allow pre-release versions to be installed
--uninstall uninstall config-ninja
--force respond 'yes' to confirmation prompts; overwrite existing installations
--path PATH install config-ninja to this directory
--backends BACKENDS comma-separated list of package extras to install, or 'none' to install no backends
```
#### With `pip` / `pipx`
Alternatively, use `pip` / `pipx` to install [all available backends] (or choose a specific one):
```sh
pip install 'config-ninja[all]'
```
### Enable the `systemd` Service
After installing `config-ninja`, enable it as a `systemd` service for the current user:
```sh
# omit '--user' to install the agent at the system level
config-ninja self install --user
```
[all available backends]: https://config-ninja.github.io/config-ninja/config_ninja/contrib.html#available-backends
## How It Works
To demonstrate how the mechanics work locally:
1. create a settings file for `config-ninja`:
```sh
cat <config-ninja-settings.yaml
CONFIG_NINJA_OBJECTS:
example-0:
dest:
format: json
path: ./.local/settings.json
source:
backend: local
format: toml
init:
kwargs:
path: ./.local/config.toml
EOF
```
2. start `config-ninja` in `monitor` mode:
```sh
config-ninja monitor
```
3. in a separate shell, create the `config.toml`:
```sh
cat <./.local/config.toml
[example-0]
a = "first value"
b = "second value
EOF
```
4. Inspect the `settings.json` file created by `config-ninja`:
```sh
cat ./.local/settings.json
```
```json
{
"example-0": {
"a": "first value",
"b": "second value"
}
}
```
5. Make changes to the data in `config.toml`, and `config-ninja` will update `settings.json` accordingly:
```sh
cat <>./.local/config.toml
[example-1]
c = "third value"
d = "fourth value
EOF
cat ./.local/settings.json
```
```json
{
"example-0": {
"a": "first value",
"b": "second value"
},
"example-1": {
"c": "third value",
"d": "fourth value"
}
}
```
Chances are, you'll want to update the `config-ninja-settings.yaml` file to use a remote backend (instead of `local`). See [config_ninja.contrib](https://config-ninja.github.io/config-ninja/config_ninja/contrib.html) for a list of supported config providers.
## Configuration Architecture
The `config-ninja` agent monitors the backend source for changes. When the source data is changed, the agent updates the local configuration file with the new data:
```mermaid
sequenceDiagram
loop polling
config-ninja->>backend: query for changes
end
backend->>+config-ninja: [backend changed] fetch config
config-ninja->>-filesystem: write updated configuration file
```