Managing secrets

You can use secrets to interact with external services.

Creating secrets

Creating a secret on the command line

To create a secret, use the pyflyte create secret command:

$ pyflyte create secret --project my_project --domain my_domain my_secret

You’ll be prompted to enter a secret value in the terminal:

Enter secret value: ...

Creating a secret from a file

To create a secret from a file, run the following command:

$ pyflyte create secret --project my_project --domain my_domain my_file_secret -f /path/to/file

Listing secrets

You can list existing secrets with the pyflyte get secret command:

$ pyflyte get secret --project my_project --domain my_domain

Using secrets in workflow code

Note that secrets are stored per project/domain pair. A workflow can only access secrets created within its own project and domain.

Using a secret created on the command line

To use a secret created on the command line, see the example code below. To run the example code:

1. Create a secret on the command line with the key my_secret.
2. Copy the following example code to a new file and save it as using_secrets.py.
3. Run the script with pyflyte run --remote using_secrets.py main.

import flytekit as fl

@fl.task(secret_requests=[union.Secret(key="my_secret")])
def t1():
    secret_value = union.current_context().secrets.get(key="my_secret")
    # do something with the secret. For example, communication with an external API.
    ...

With env_var, you can automatically load the secret into the environment. This is useful with libraries that expect the secret to have a specific name:

import flytekit as fl

@fl.task(secret_requests=[union.Secret(key="my_union_api_key", env_var="FLYTE_API_KEY")])
def t1():
    # Authenticates the remote with FLYTE_API_KEY
    remote = union.FlyteRemote(default_project="flytesnacks", default_domain="development")

Using a secret created from a file

To use a secret created from a file in your workflow code, you must mount it as a file. To run the example code below:

1. Create a secret from a file with the key my_secret.
2. Copy the example code below to a new file and save it as using_secrets_file.py.
3. Run the script with pyflyte run --remote using_secrets_file.py main.

import flytekit as fl

@fl.task(
    secret_requests=[
        fl.Secret(key="my_file_secret", mount_requirement=fl.Secret.MountType.FILE),
    ]
)
def t1():
    path_to_secret_file = union.current_context().secrets.get_secrets_file("my_file_secret")
    with open(path_to_secret_file, "r") as f:
        secret_value = f.read()
    # do something with the secret. For example, communication with an external API.
    ...

Updating secrets

To update a secret, run the pyflyte update secret command. You will be prompted to enter a new value:

$ pyflyte update secret --project my_project --domain my_domain my_secret

Deleting secrets

To delete a secret, use the pyflyte delete secret command:

$ pyflyte delete secret --project my_project --domain my_domain my_secret