This is a CLI tool to help automate the setup and management of Hashicorp Vault.
Usage:
bank-vaults [command]
Available Commands:
completion Generate completion script
configure Configures a Vault based on a YAML/JSON configuration file
help Help about any command
init Initialize the target Vault instance
unseal Unseals Vault with unseal keys stored in one of the supported Cloud Provider options.
Flags:
--alibaba-access-key-id string The Alibaba AccessKeyID to use
--alibaba-access-key-secret string The Alibaba AccessKeySecret to use
--alibaba-kms-key-id string The ID of the Alibaba KMS key to encrypt values
--alibaba-kms-region string The region where the Alibaba KMS key relies
--alibaba-oss-bucket string The name of the Alibaba OSS bucket to store values in
--alibaba-oss-endpoint string The name of the Alibaba OSS endpoint to store values in
--alibaba-oss-prefix string The prefix to use for values store in Alibaba OSS
--aws-kms-encryption-context stringToString The encryption context that AWS KMS will use to encrypt values (default [Tool=bank-vaults])
--aws-kms-key-id strings The ID or ARN of the AWS KMS key to encrypt values
--aws-kms-region strings The region of the AWS KMS key to encrypt values
--aws-s3-bucket strings The name of the AWS S3 bucket to store values in
--aws-s3-prefix string The prefix to use for storing values in AWS S3
--aws-s3-region strings The region to use for storing values in AWS S3 (default [us-east-1])
--aws-s3-sse-algo strings The algorithm to use for the S3 SSE
--azure-key-vault-name string The name of the Azure Key Vault to encrypt and store values in
--azure-key-vault-prefix string The prefix to use for secret names in Azure Key Vault
--file-path string The path prefix of the files where to store values in
--google-cloud-kms-crypto-key string The name of the Google Cloud KMS crypt key to use
--google-cloud-kms-key-ring string The name of the Google Cloud KMS key ring to use
--google-cloud-kms-location string The Google Cloud KMS location to use (eg. 'global', 'europe-west1')
--google-cloud-kms-project string The Google Cloud KMS project to use
--google-cloud-storage-bucket string The name of the Google Cloud Storage bucket to store values in
--google-cloud-storage-prefix string The prefix to use for values store in Google Cloud Storage
-h, --help help for bank-vaults
--hsm-key-label string The label of the HSM private key (default "bank-vaults")
--hsm-module-path string The library path of the HSM device
--hsm-pin string The pin of the HSM token to login with
--hsm-slot-id int The ID of the HSM slot
--hsm-token-label string The label of the token in a HSM slot
--k8s-secret-labels stringToString The labels of the K8S Secret to store values in (default [])
--k8s-secret-name string The name of the K8S Secret to store values in
--k8s-secret-namespace string The namespace of the K8S Secret to store values in
--mode string Select the mode to use:
'google-cloud-kms-gcs' => Google Cloud Storage using Google KMS encryption;
'aws-kms-s3' => AWS S3 Object Storage using AWS KMS encryption;
'azure-key-vault' => Azure Key Vault secret;
'alibaba-kms-oss' => Alibaba OSS using Alibaba KMS encryption;
'vault' => Remote Vault;
'oci' => Oracle KMS;
'k8s' => Kubernetes Secrets;
'hsm-k8s' => Kubernetes Secrets encrypted with HSM;
'hsm' => HSM object on device, using HSM encryption;
'dev' => Dev (vault server -dev) mode
'file' => File mode (default "k8s")
--oci-bucket-name string The Oracle bucket to use
--oci-bucket-namespace string The namespace associated with the Oracle bucket
--oci-bucket-prefix string The prefix to use for the Oracle bucket
--oci-cryptographic-endpoint string The cryptographic endpoint associated with the Oracle key
--oci-key-ocid string The Oracle key OCID to use
--once Run configure/unseal only once
--pre-flight-checks should the key store be tested first to validate access rights (default true)
--secret-shares int Total count of secret shares that exist (default 5)
--secret-threshold int Minimum required secret shares to unseal (default 3)
--store-root-token should the root token be stored in the key store (default true)
--vault-addr string The URL of the remote Vault to use as KV. Example: https://vault.myvault.org:8200
--vault-auth-path string Auth path for Kubernetes auth type
--vault-role string Vault Role to authenticate as
--vault-token string Vault token
--vault-token-path string Path to file containing Vault token
--vault-unseal-keys-path string Path at the remote URL to store Unseal Keys
Use "bank-vaults [command] --help" for more information about a command.
Options (49)
| Option | Description | Source |
|---|---|---|
--alibaba-access-key-id string | The Alibaba AccessKeyID to use | help |
--alibaba-access-key-secret string | The Alibaba AccessKeySecret to use | help |
--alibaba-kms-key-id string | The ID of the Alibaba KMS key to encrypt values | help |
--alibaba-kms-region string | The region where the Alibaba KMS key relies | help |
--alibaba-oss-bucket string | The name of the Alibaba OSS bucket to store values in | help |
--alibaba-oss-endpoint string | The name of the Alibaba OSS endpoint to store values in | help |
--alibaba-oss-prefix string | The prefix to use for values store in Alibaba OSS | help |
--aws-kms-encryption-context stringToString | The encryption context that AWS KMS will use to encrypt values (default [Tool=bank-vaults]) | help |
--aws-kms-key-id strings | The ID or ARN of the AWS KMS key to encrypt values | help |
--aws-kms-region strings | The region of the AWS KMS key to encrypt values | help |
--aws-s3-bucket strings | The name of the AWS S3 bucket to store values in | help |
--aws-s3-prefix string | The prefix to use for storing values in AWS S3 | help |
--aws-s3-region strings | The region to use for storing values in AWS S3 (default [us-east-1]) | help |
--aws-s3-sse-algo strings | The algorithm to use for the S3 SSE | help |
--azure-key-vault-name string | The name of the Azure Key Vault to encrypt and store values in | help |
--azure-key-vault-prefix string | The prefix to use for secret names in Azure Key Vault | help |
--file-path string | The path prefix of the files where to store values in | help |
--google-cloud-kms-crypto-key string | The name of the Google Cloud KMS crypt key to use | help |
--google-cloud-kms-key-ring string | The name of the Google Cloud KMS key ring to use | help |
--google-cloud-kms-location string | The Google Cloud KMS location to use (eg. | help |
--google-cloud-kms-project string | The Google Cloud KMS project to use | help |
--google-cloud-storage-bucket string | The name of the Google Cloud Storage bucket to store values in | help |
--google-cloud-storage-prefix string | The prefix to use for values store in Google Cloud Storage | help |
-h, --help | help for bank-vaults | help |
--hsm-key-label string | The label of the HSM private key (default "bank-vaults") | help |
--hsm-module-path string | The library path of the HSM device | help |
--hsm-pin string | The pin of the HSM token to login with | help |
--hsm-slot-id int | The ID of the HSM slot | help |
--hsm-token-label string | The label of the token in a HSM slot | help |
--k8s-secret-labels stringToString | The labels of the K8S Secret to store values in (default []) | help |
--k8s-secret-name string | The name of the K8S Secret to store values in | help |
--k8s-secret-namespace string | The namespace of the K8S Secret to store values in | help |
--mode string | Select the mode to use: 'google-cloud-kms-gcs' => Google Cloud Storage using Google KMS encryption; | help |
--oci-bucket-name string | The Oracle bucket to use | help |
--oci-bucket-namespace string | The namespace associated with the Oracle bucket | help |
--oci-bucket-prefix string | The prefix to use for the Oracle bucket | help |
--oci-cryptographic-endpoint string | The cryptographic endpoint associated with the Oracle key | help |
--oci-key-ocid string | The Oracle key OCID to use | help |
--once | Run configure/unseal only once | help |
--pre-flight-checks | should the key store be tested first to validate access rights (default true) | help |
--secret-shares int | Total count of secret shares that exist (default 5) | help |
--secret-threshold int | Minimum required secret shares to unseal (default 3) | help |
--store-root-token | should the root token be stored in the key store (default true) | help |
--vault-addr string | The URL of the remote Vault to use as KV. | help |
--vault-auth-path string | Auth path for Kubernetes auth type | help |
--vault-role string | Vault Role to authenticate as | help |
--vault-token string | Vault token | help |
--vault-token-path string | Path to file containing Vault token | help |
--vault-unseal-keys-path string | Path at the remote URL to store Unseal Keys | help |