Skip to main content
Made with idem, a Python implementation of Plugin Oriented Programming Documentation is published with Sphinx on docs.idemproject.io Made with pop, a Python implementation of Plugin Oriented Programming Made with Python

About

Vault Cloud Provider for Idem

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:

Getting Started

Prerequisites

  • Python 3.8+

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

Installation

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

Metadata

Release files for idem-vault 2.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for idem-vault 2.1.1
File Size Uploaded
idem-vault-2.1.1.tar.gz 16.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for idem-vault 2.1.1
File Interpreter ABI Platform
idem_vault-2.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 36.2 kB

Release files / idem-vault-2.1.1.tar.gz

Download URL idem-vault-2.1.1.tar.gz
Size 16.3 kB
Tags Source
SHA-256 checksum
How to use checksums
0634dc53876bdea8adf91b8bbe1693ff5ddd3480d0e587cf6093ac23020d1a52
BLAKE2b-256 checksum
How to use checksums
155c9714fd4d675c6d7843a8de22581d0a85ba510534dd0e99fd5f55158302d5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.9.6 readme-renderer/42.0 requests/2.31.0 requests-toolbelt/1.0.0 urllib3/2.0.4 tqdm/4.66.1 importlib-metadata/6.8.0 keyring/24.2.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.9.18

Release files / idem_vault-2.1.1-py3-none-any.whl

Download URL idem_vault-2.1.1-py3-none-any.whl
Size 19.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9690fcd629e91554ecdd857676fbe022b853a199bc15a936c36db1dcb6fb074d
BLAKE2b-256 checksum
How to use checksums
be031cad91e76c3fe2f3659b307f253d7d610d864470a42433648d37d2db9d6f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.9.6 readme-renderer/42.0 requests/2.31.0 requests-toolbelt/1.0.0 urllib3/2.0.4 tqdm/4.66.1 importlib-metadata/6.8.0 keyring/24.2.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.9.18

Release history Release notifications | RSS feed

This release

2.1.1 This release

2 release files

2.1.0

2 release files

2.0.0

2 release files

1.0.0

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page