airshipctl/docs/source/cli/airshipctl_secret_generate_encryptionkey.md
Sirisha Gopigiri 21f015b502 Updating cmd files for documentation
This PS updates cmd related to root, completion, document and
version subcommands. It also updates minor details in other
subcommands.

The description and examples are updated for the airshipctl
commands, which will be inturn used for generating documentation.
Please ignore the .md file changes in this PS. They are added for zuul
gates to pass. Here is the PS with generated documention
files https://review.opendev.org/c/airship/airshipctl/+/789250

Relates-To: #280
Change-Id: I562c15c0d25b2e9731c0eb03854d1d348eb435f2
2021-06-09 09:56:21 +00:00

47 lines
1.1 KiB
Markdown

## airshipctl secret generate encryptionkey
Airshipctl command to generate a secure encryption key or passphrase
### Synopsis
Generates a secure encryption key or passphrase.
If regex arguments are passed the encryption key created would match the regular expression passed.
```
airshipctl secret generate encryptionkey [flags]
```
### Examples
```
Generates a secure encryption key or passphrase.
# airshipctl secret generate encryptionkey
Generates a secure encryption key or passphrase matching the regular expression
# airshipctl secret generate encryptionkey --regex Xy[a-c][0-9]!a*
```
### Options
```
-h, --help help for encryptionkey
--limit int limit number of characters for + or * regex (default 5)
--regex string regular expression string
```
### Options inherited from parent commands
```
--airshipconf string path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
--debug enable verbose output
```
### SEE ALSO
* [airshipctl secret generate](airshipctl_secret_generate.md) - Airshipctl command to generate secrets