secrets

Get the latest docs
You are looking at documentation for an older release. Not what you want? Go to the current release documentation.

The cfy secrets command is used to manage Cloudify secrets (key-value pairs).

Optional flags

These will work on each command:

-v, --verbose - Show verbose output. You can supply this up to three times (i.e. -vvv)
-h, --help - Show this message and exit.

Commands

create

Usage

cfy secrets create [OPTIONS] KEY

Create a new secret (key-value pair)

KEY is the new secret’s key

Required flags

One of these flags:

-s, --secret-string TEXT - The string to use as the secret’s value.
-f, --secret-file TEXT - The name of the secret file that contains the value to be set.

Example

  
$ cfy secrets create test -s test_value
...

Secret `test` created

...

delete

Usage

cfy secrets delete [OPTIONS] KEY

Delete a secret.

KEY is the secret’s key.

Example

  
$ cfy secr del test
...

Deleting secret `test`...
Secret removed

...

get

Usage

cfy secrets get [OPTIONS] KEY

Get details for a single secret.

KEY is the secret’s key

Example

  
$ cfy secrets get test
...

Getting info for secret `test`...
Requested secret info:
created_by:     admin
key:            test
permission:     creator
tenant_name:    default_tenant
created_at:     2017-04-04 08:36:06.746 
updated_at:     2017-04-04 08:39:49.926 
value:          test_value2

...

list

Usage

cfy secrets list [OPTIONS]

List all secrets.

Optional flags

--sort-by TEXT - Key for sorting the list.
--descending - Sort list in descending order. [default: False]
-t, --tenant-name TEXT - The name of the tenant from which to list secrets. If unspecified, the current tenant is used. This argument cannot be used simultaneously with the all-tenants argument.
-a, --all-tenants - Include resources from all tenants associated with the user. This argument cannot be used simultaneously with the tenant-name argument.

Example

  
$ cfy secrets list
...

Listing all secrets...

Secrets:
+------+--------------------------+--------------------------+------------+----------------+------------+
| key  |        created_at        |        updated_at        | permission |  tenant_name   | created_by |
+------+--------------------------+--------------------------+------------+----------------+------------+
| test | 2017-04-04 08:36:06.746  | 2017-04-04 08:36:06.746  |  creator   | default_tenant |   admin    |
+------+--------------------------+--------------------------+------------+----------------+------------+

...

update

Usage

cfy secrets update [OPTIONS] KEY

Update an existing secret.

KEY is the secret’s key.

Required flags

One of these flags:

-s, --secret-string TEXT - The string to use as the secret’s value.
-f, --secret-file TEXT - The name of the secret file that contains the value to be set.

Example

  
$ cfy secrets update test -s test_value2
...

Secret `test` updated

...