search

jetstack / vault-unsealer

Vault Unseal automation
Apache License 2.0
129 stars 28 forks source link

vault-unseal -h does not output help text #41

Open pgporada opened 5 years ago

pgporada commented 5 years ago

I just installed vault-unsealer from commit 59b05dd. The help text does not appear when running the following command.

$ vault-unsealer -h
Usage of vault-unsealer:

$ vault-unsealer --help
Usage of vault-unsealer:

I think I was expecting to see the following text.

$ vault-unsealer 
This is a CLI tool to help automate the setup and management of
Hashicorp Vault.

It will continuously attempt to unseal the target Vault instance, by retrieving
unseal keys from a Google Cloud, AWS KMS keyring or local in path

Usage:
  vault-unsealer [command]

Available Commands:
  help        Help about any command
  init        Initialise the target Vault instance
  unseal      A brief description of your command
  version     Print the version number of vault-unsealer

Flags:
      --aws-kms-key-id string                The ID or ARN of the AWS KMS key to encrypt values
      --aws-ssm-key-prefix string            The Key Prefix for SSM Parameter store
      --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 vault-unsealer
      --local-key-dir string                 Directory of key shares in path
      --mode string                          Select the mode to use 'google-cloud-kms-gcs' => Google Cloud Storage with encryption using Google KMS; 'aws-kms-ssm' => AWS SSM parameter store using AWS KMS encryption; local => Use local keys in path (default "google-cloud-kms-gcs")
      --secret-shares int                    Total count of secret shares that exist (default 1)
      --secret-threshold int                 Minimum required secret shares to unseal (default 1)

Use "vault-unsealer [command] --help" for more information about a command.
JoshVanL commented 5 years ago

Hi @pgporada, thanks for bringing this up, that is indeed quite confusing. I went ahead and created a PR for this which should fix the issue. https://github.com/jetstack/vault-unsealer/pull/42 Cheers