Custom secret stores

Learning how to develop a custom secret store.

The secrets store acts as the one-stop shop for all the secrets to which your pipeline or stack components might need access. It is responsible for storing, updating and deleting only the secrets values for ZenML secrets, while the ZenML secret metadata is stored in the SQL database. The secrets store interface implemented by all available secrets store back-ends is defined in the zenml.zen_stores.secrets_stores.secrets_store_interface core module and looks more or less like this:

class SecretsStoreInterface(ABC):

"""ZenML secrets store interface.

All ZenML secrets stores must implement the methods in this interface.

"""

# ---------------------------------

# Initialization and configuration

# ---------------------------------

@abstractmethod

def _initialize(self) -> None:

"""Initialize the secrets store.

This method is called immediately after the secrets store is created.

It should be used to set up the backend (database, connection etc.).

"""

# ---------

# Secrets

# ---------

@abstractmethod

def store_secret_values(

self,

secret_id: UUID,

secret_values: Dict[str, str],

) -> None:

"""Store secret values for a new secret.

Args:

secret_id: ID of the secret.

secret_values: Values for the secret.

"""

@abstractmethod

def get_secret_values(self, secret_id: UUID) -> Dict[str, str]:

"""Get the secret values for an existing secret.

Args:

secret_id: ID of the secret.

Returns:

The secret values.

Raises:

KeyError: if no secret values for the given ID are stored in the

secrets store.

"""

@abstractmethod

def update_secret_values(

self,

secret_id: UUID,

secret_values: Dict[str, str],

) -> None:

"""Updates secret values for an existing secret.

Args:

secret_id: The ID of the secret to be updated.

secret_values: The new secret values.

Raises:

KeyError: if no secret values for the given ID are stored in the

secrets store.

"""

@abstractmethod