Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nirovision/mimiron
:robot: Easily manage your tfvars config via Mimiron
https://github.com/nirovision/mimiron
deployment git terraform
Last synced: 5 days ago
JSON representation
:robot: Easily manage your tfvars config via Mimiron
- Host: GitHub
- URL: https://github.com/nirovision/mimiron
- Owner: Nirovision
- License: mit
- Created: 2017-02-02T02:42:18.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-10-22T23:51:38.000Z (about 5 years ago)
- Last Synced: 2024-11-03T03:02:57.009Z (5 days ago)
- Topics: deployment, git, terraform
- Language: Python
- Homepage:
- Size: 166 KB
- Stars: 3
- Watchers: 5
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mimiron
[](https://travis-ci.org/ImageIntelligence/mimiron)
[](https://badge.fury.io/py/mimiron)
**Welcome to mimiron!**
> [Mimiron](http://www.wowhead.com/npc=33350/mimiron) is one of the Titanic Watchers. He once resided at the Temple of Invention, but is absent during the time of Loken's rebellion.
Mimiron is a CLI tool that aims provide a better workflow when manging Terraform variables.
When all of your Terraform config is completely modular, the only sane way to manage variables is to store them inside a `variables.json` file and pass that along when you run `terraform apply -var-file=variables.json`... but where do you store `variables.json` and how can you easily make changes?
Our approach is to store non-sensitive variables inside the same repository as our Terraform config. Sensitive variables like your AWS secret and master db password are stored elsewhere then accessed later whether it be via AWS KMS or Hashicorp Vault. The purpose of this project is to manage non-sensitive variables.
We want to make simple tasks such as bumping an image version simple and Mimiron is a small CLI tool that does that. Mimiron provides a few commands to help automate the cumbersome tasks away.
## Installation
```bash
sudo pip install --upgrade mimiron
```
... or if you're using a Mac (see [here](https://github.com/pypa/pip/issues/3165) why):
```bash
sudo pip install --upgrade --ignore-installed six mimiron
```
`mim` requires a configuration file at `~/.mimiron.json` before it can work. Take a look at [./data/example_config.json](./data/example_config.json) for an example.
| Root Key | Sub Key | Description
|-|-|-|
| terraformRepositories(array) | | |
| | path(string) | The path to a Terraform repository (cannot be relative but may contain ~). |
| | defaultEnvironment(string) | Projects representing multiple environments have a default (e.g. staging, production). |
| | defaultGitBranch(string) | Some `mim` commands will check if the current branch is this before running. |
| dockerhub(object) | | |
| | username(string) | The username to your DockerHub account. |
| | password(string) | The password to your DockerHub account. |
| | organization(string) | The organization your DockerHub belongs to (username if none). |
## Assumptions
* `mim` requires that you store your Docker image aritfacts on DockerHub. No support for other registries exist at this time.
* Terraform configuration is expected to exist at `/project/terraform/`.
* Terraform variables (tfvars) are stored in JSON files inside a directory named `/project/terraform/tfvars/`.
* Docker image artifacts are named `service_name_image` e.g. `web_marketing_image`.
## Usage
```
>>> mim --help
mimiron.py
usage:
mim (bump|b) [--env=] [--no-push]
mim (status|s) [--env=]
mim (deploy|d) [--env=] [--no-push] [--empty-commit]
commands:
(bump|b) bumps the with an image
(status|s) shows the currently used artifact id for
(deploy|d) triggers a deploy a chosen deployment repository
arguments:
the deployment artifact (Docker image) we are pushing
the application we're targeting
--env= overrides the default repo environment
--empty-commit creates an empty commit on the chosen repository
options:
--no-push make local changes without pushing to remote
-h --help shows this
-v --version shows version
```
## Development
```bash
git clone [email protected]:ImageIntelligence/mimiron.git && cd mimiron/
mkvirtualenv mimiron && workon mimiron
python setup.py develop && pip install -r requirements.txt
python mimiron/command_line.py --help
```
## Testing
```bash
python -m pytest test/
```
## Deployment
```bash
pip install twine
python setup.py sdist
twine upload dist/mimiron-0.4.0.tar.gz
```
**NOTE:** You might get warnings around having a misconfigured `~/.pypirc` file. Create one if you haven't and make sure it contains:
```
[pypi]
username =
password =
```
Ask another developer for the username and password.