@atomist/automation-client-ext-vault

Extension for resolving placeholders and secrets in client configuration from vault

Usage no npm install needed!

<script type="module">
  import atomistAutomationClientExtVault from 'https://cdn.skypack.dev/@atomist/automation-client-ext-vault';
</script>

README

@atomist/automation-client-ext-vault

An extension to an Atomist automation-client to resolve secret and configuration values in client configuration from Hashicorp Vault.

Usage

  1. First install the dependency in your automation-client project
$ npm install @atomist/automation-client-ext-vault
  1. Install the support in your atomist.config.ts
import { configureVaultLookup } from "@atomist/automation-client-ext-vault";

export const configuration: Configuration = {
    postProcessors: [
        configureVaultLookup({ token: "<your vault token>", endpoint: "<vault endpoint url>" }),
    ],
}

If the token and endpoint options aren't provided, this falls back to lookup from environment variables VAULT_TOKEN and VAULT_ADDR.

Support

General support questions should be discussed in the #support channel on our community Slack team at atomist-community.slack.com.

If you find a problem, please create an issue.

Development

You will need to install [node][] to build and test this project.

Build and Test

Command Reason
npm install install all the required packages
npm run build lint, compile, and test
npm run lint run tslint against the TypeScript
npm run compile compile all TypeScript into JavaScript
npm test run tests and ensure everything is working
npm run clean remove stray compiled JavaScript files and build directory

Created by Atomist. Need Help? Join our Slack team.