airshipctl/docs/source/cli/airshipctl_config_set-credentials.md
Drew Walters 0d7dc4de24 Add automated CLI documentation
This change creates a tool that generates CLI documentation each time
`make update-golden` is executed.

Change-Id: I4bcdf299cd424f4cff1ecf6503822d304e9a3947
Signed-off-by: Drew Walters <andrew.walters@att.com>
2020-05-13 19:43:10 +00:00

1.9 KiB

airshipctl config set-credentials

Manage user credentials

Synopsis

Create or modify a user credential in the airshipctl config file.

Note that specifying more than one authentication method is an error.

airshipctl config set-credentials NAME [flags]

Examples


# Create a new user credential with basic auth
airshipctl config set-credentials exampleUser \
  --username=exampleUser \
  --password=examplePassword

# Change the client-key of a user named admin
airshipctl config set-credentials admin \
  --client-key=$HOME/.kube/admin.key

# Change the username and password of the admin user
airshipctl config set-credentials admin \
  --username=admin \
  --password=uXFGweU9l35qcif

# Embed client certificate data of the admin user
airshipctl config set-credentials admin \
  --client-certificate=$HOME/.kube/admin.crt \
  --embed-certs

Options

      --client-certificate string   path to a certificate
      --client-key string           path to a key file
      --embed-certs                 if set, embed the client certificate/key into the credential
  -h, --help                        help for set-credentials
      --password string             password for the credential; mutually exclusive with token flag.
      --token string                token to use for the credential; mutually exclusive with username and password flags.
      --username string             username for the credential; mutually exclusive with token flag.

Options inherited from parent commands

      --airshipconf string   Path to file for airshipctl configuration. (default "$HOME/.airship/config")
      --debug                enable verbose output
      --kubeconfig string    Path to kubeconfig associated with airshipctl configuration. (default "$HOME/.airship/kubeconfig")

SEE ALSO