https://github.com/sevenmind/vault_config_provider

An Elixir Release Config Provider to pull vault secrets into app env.
https://github.com/sevenmind/vault_config_provider

Last synced: 21 days ago
JSON representation

An Elixir Release Config Provider to pull vault secrets into app env.

• Host: GitHub
• URL: https://github.com/sevenmind/vault_config_provider
• Owner: sevenmind
• License: mit
• Created: 2018-09-25T21:59:20.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-10-04T19:17:01.000Z (over 3 years ago)
• Last Synced: 2024-08-11T00:28:23.176Z (5 months ago)
• Language: Elixir
• Size: 25.4 KB
• Stars: 24
• Watchers: 7
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# VaultConfigProvider

[![Module Version](https://img.shields.io/hexpm/v/vault_config_provider.svg)](https://hex.pm/packages/vault_config_provider)

[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/vault_config_provider/)

[![Total Download](https://img.shields.io/hexpm/dt/vault_config_provider.svg)](https://hex.pm/packages/vault_config_provider)

[![License](https://img.shields.io/hexpm/l/vault_config_provider.svg)](https://github.com/sevenmind/vault_config_provider/blob/master/LICENSE.md)

[![Last Updated](https://img.shields.io/github/last-commit/sevenmind/vault_config_provider.svg)](https://github.com/sevenmind/vault_config_provider/commits/master)

VaultConfigProvider is an Elixir [release config provider](https://hexdocs.pm/elixir/Config.Provider.html) for loading secrets from [Vault](https://www.vaultproject.io/) into app env at runtime.

Built for [Vaultex](https://github.com/findmypast/vaultex).

## Installation

The package can be installed by adding `:vault_config_provider` to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [

    {:vault_config_provider, "~> 0.4.0"}

  ]

end

```

Configure [your release](https://hexdocs.pm/mix/Mix.Tasks.Release.html) and add VaultConfigProvider as a config provider:

```elixir

def project

  [

    releases: [

      config_providers: [{VaultConfigProvider, nil}]

    ]

  ]

```

## Configuration

Read the [Vaultex docs](https://github.com/findmypast/vaultex), and configure vaultex with your vault address and credentials. The Vault address can be set from the system environment or application environment.

VaultConfigProvider assumes vault auth credentials are already set in application environment by earlier config providers.

```elixir

config :vaultex,

  auth: {:kubernetes, %{jwt: File.read!("/tmp/token"), role: "my_role"}},

  vault_addr: "http://127.0.0.1"

# or

config :vaultex,

  auth: {:token, {"root"}}

```

## Usage

The provider will resolve secrets stored matching two patterns: strings or keyword lists. Keyword lists can contain transformations.

```elixir

config :my_app,

  username: "secret:secret/services/my_app key=username"

  

  username: "vault:secret/services/my_app#username"

  username: [

    path: "secret/services/my_app",

    key: "username",

    fun: &String.upcase/1

  ]

  user_config: "secret:secret/services/my_app" # %{"key" => "username}

```

A string address is expected to include `secret:/path` and `key=key_name` or `vault:path` and `#key_name`

A keyword address must contain the keys `key` and `path` and may contain optional `fun` function which will be applied to any returned values

## Copyright and License

Copyright (c) 2018 7Mind GmbH

This library licensed under the [MIT license](./LICENSE.md).