cli-docs-before.man

.nh
.TH gwsm 8

.SH NAME
.PP
gwsm \- interact with config map and secret manager variables


.SH SYNOPSIS
.PP
gwsm

.PP
\fBUsage\fP:

.PP
.RS

.nf
gwsm [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...]

.fi
.RE


.SH COMMANDS
.SH version, v
.PP
Print version info

.SH s3
.PP
simple S3 commands

.SS get
.PP
[object path] [destination path]

.SH secretsmanager, sm
.PP
Secrets Manager commands

.PP
\fB\-\-binary, \-b\fP: get the SecretBinary value

.SS list
.PP
display table of all secrets with meta data

.SS describe
.PP
print description of secret to STDOUT

.PP
\fB\-\-secret\-id, \-s\fP="": Specific Secret to describe, will bypass select/search

.SS get, view
.PP
select from list or pass in specific secret

.PP
\fB\-\-secret\-id, \-s\fP="": Specific Secret to view, will bypass select/search

.SS edit, e
.PP
interactive edit of a secret String Value

.PP
\fB\-\-secret\-id, \-s\fP="": Specific Secret to edit, will bypass select/search

.SS create, c
.PP
create new secret in Secrets Manager

.PP
\fB\-\-description, \-\-desc\fP="": Additional description text.

.PP
\fB\-\-interactive, \-i\fP: Open interactive editor to create secret value.

.PP
\fB\-\-secret\-id, \-s\fP="": Secret name

.PP
\fB\-\-tags\fP="": key=value tags (CSV list)

.PP
\fB\-\-value, \-v\fP="": Secret Value. Will store as a string, unless binary flag is set.

.SS put
.PP
non\-interactive update to a specific secret

.PP
\fB\-\-description, \-\-desc\fP="": Additional description text.

.PP
\fB\-\-interactive, \-i\fP: Open interactive editor to create secret value.

.PP
\fB\-\-secret\-id, \-s\fP="": Secret name

.PP
\fB\-\-tags\fP="": key=value tags (CSV list)

.PP
\fB\-\-value, \-v\fP="": Secret Value. Will store as a string, unless binary flag is set.

.SS delete, del
.PP
delete a specific secret

.PP
\fB\-\-force, \-f\fP: Bypass recovery window (30 days) and immediately delete Secret.

.PP
\fB\-\-secret\-id, \-s\fP="": Specific Secret to delete

.SH local, l
.PP
Interact with local env files

.SS view, v
.PP
View values based on local settings

.PP
\fB\-\-configmap, \-c\fP="": Path to configmap.yaml

.PP
\fB\-\-secret\-suffix\fP="": Suffix used to find ENV variables that denote the Secret Manager Secrets to lookup (default: \_NAME)

.PP
\fB\-\-secrets, \-s\fP="": Path to secrets.yml (default: .docker/secrets.yml)

.SS ansible, legacy, a
.PP
View value from ansible\-vault encrypted Kube Secret file.

.PP
\fB\-\-accessor, \-a\fP="": Accessor key to pull data out of Data block. (default: .env)

.PP
\fB\-\-encrypted\-env\-file, \-e\fP="": Path to encrypted Kube Secret file

.PP
\fB\-\-vault\-password\-file\fP="": vault password file \fB\fCVAULT\_PASSWORD\_FILE\fR

.SH namespace, ns
.PP
Interact with env on a running Pod within a Namespace

.SS view, v
.PP
View values configured withing a namespace

.PP
\fB\-\-cmd\fP="": Command to inspect (default: node)

.PP
\fB\-\-exclude\fP="": List (csv) of specific env vars to exclude values from display. Set to "" to remove any exclusions. (default: PATH,SHLVL,HOSTNAME)

.PP
\fB\-\-filter\-prefix, \-f\fP="": List of prefixes (csv) used to filter values from display. Set to "" to remove any filters. (default: npm\fI,KUBERNETES\fP,API\_PORT)

.PP
\fB\-\-namespace, \-n\fP="": Kube Namespace list Pods from

.SH diff, d
.PP
View diff of local vs. namespace

.PP
\fB\-\-cmd\fP="": Command to inspect (default: node)

.PP
\fB\-\-configmap, \-c\fP="": Path to configmap.yaml

.PP
\fB\-\-exclude\fP="": List (csv) of specific env vars to exclude values from display. Set to "" to remove any exclusions. (default: PATH,SHLVL,HOSTNAME)

.PP
\fB\-\-filter\-prefix, \-f\fP="": List of prefixes (csv) used to filter values from display. Set to "" to remove any filters. (default: npm\fI,KUBERNETES\fP,API\_PORT)

.PP
\fB\-\-namespace, \-n\fP="": Kube Namespace list Pods from

.PP
\fB\-\-secret\-suffix\fP="": Suffix used to find ENV variables that denote the Secret Manager Secrets to lookup (default: \_NAME)

.PP
\fB\-\-secrets, \-s\fP="": Path to secrets.yml (default: .docker/secrets.yml)

.SH diff:legacy, diff:ansible
.PP
View diff of local (ansible encrypted) vs. namespace

.PP
\fB\-\-accessor, \-a\fP="": Accessor key to pull data out of Data block. (default: .env)

.PP
\fB\-\-dotenv\fP="": Path to .env file on Pod (default: $PWD/.env)

.PP
\fB\-\-encrypted\-env\-file, \-e\fP="": Path to encrypted Kube Secret file

.PP
\fB\-\-namespace, \-n\fP="": Kube Namespace list Pods from

.PP
\fB\-\-vault\-password\-file\fP="": vault password file \fB\fCVAULT\_PASSWORD\_FILE\fR