idem-vault 0.3.0

About

An Idem plugin to manage resources of HashiCorp’s Vault.

Getting Started

pip install idem-vault

# clone repo
git clone git@<your-project-path>/idem-vault.git
cd idem-vault

# Setup venv
python3 -m venv .venv
source .venv/bin/activate
pip install -e .

Usage

The first step is to setup the credential to Vault. Similarly to other Idem plugins, this is done via the acct tool. Create a credential.yaml file like following:

vault:
  default:
    address: http://127.0.0.1:8200
    token: Sb6lasdfsdf3ysfMNsdfd11

Encrypt the the credential file:

acct encrypt credentials.yaml

output:

-A9ZkiCSOjWYG_lbGmmkVh4jKLFDyOFH4e4S1HNtNwI=

Add the output token and the generated fernet file path to your environment:

export ACCT_KEY="-A9ZkiCSOjWYG_lbGmmkVh4jKLFDyOFH4e4S1HNtNwI="
export ACCT_FILE=$PWD/credentials.yaml.fernet

You are ready to use idem-vault to manage your Vault resources!!!

Tests

In order to run the idem-vault tests, you need a development vault environment to be running locally.

Run the vault server with docker enabling kv_v1.

$ docker run -p 8201:8201 -e VAULT_DEV_LISTEN_ADDRESS="0.0.0.0:8201" -e VAULT_DEV_ROOT_TOKEN_ID="abcdefghijk"  vault server -dev -dev-kv-v1

Start a second docker vault server enabling kv_v2

$ docker run -p 8200:8200 -e VAULT_DEV_LISTEN_ADDRESS="0.0.0.0:8200" -e VAULT_DEV_ROOT_TOKEN_ID="abcdefghijk" vault

Add the default credentials.yml to your environment.

$ export ACCT_FILE="$PWD/example/credentials.yml"

Install python test requirements and run the tests with pytest.

$ pip install -e . -r requirements/test.in
$ pytest tests

Alternatively, use nox to mimic the environment of the gitlab pipeline.

$ pip install nox
$ nox -p 3

Roadmap

Current Supported Resources states: kv_v2.secret

Acknowledgements

• Img Shields for making repository badges easy.