idem-vault 2.1.1

No project description provided

About

Vault Cloud Provider for Idem

• idem-vault source code

• idem-vault documentation

What is Idem?

This project is built with idem, an idempotent, imperatively executed, declarative programming language written in Python. This project extends idem!

For more information:

• Idem Project Website

• Idem Project docs portal

Getting Started

Prerequisites

• Python 3.8+

• git (if installing from source, or contributing to the project)

Installation

Note

If wanting to contribute to the project, and setup your local development environment, see the CONTRIBUTING.rst document in the source repository for this project.

You can install idem-vault either from PyPI or from source.

Install from PyPI

pip install "idem-vault"

Install from source

Clone the idem-vault repository and install with pip.

# 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 idem-vault

Setup

After installation vault idem provider execution and state modules will be accessible to the pop hub. In order to use them we need to set up our credentials.

Create a new file called credentials.yaml and populate it with profiles. The default profile will be used automatically by idem unless you specify one with –acct-profile=profile_name on the cli.

credentials.yaml

vault:
  default:
    address: https://vault.example.com:8200
    token: my_token
    version: v1

Now encrypt the credentials file and add the encryption key and encrypted file path to the ENVIRONMENT.

idem encrypt credentials.yaml

output:

-A9ZkiCSOjWYG_lbGmmkVh4jKLFDyOFH4e4S1HNtNwI=

Add these to your environment:

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

You are ready to use idem-vault!

State Example

Example of using vault state in SLS:

my_state.sls:

ensure_sample_exists:
  vault.sample.present:
    - name: a_sample_name
    - description: Managed by Idem

Create sample state:

idem state my_state.sls

Delete sample state:

idem state my_state.sls --invert