Comment on page

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. 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.
def _initialize(self) -> None:
"""Initialize the secrets store.
def create_secret(
secret: SecretRequestModel,
) -> SecretResponseModel:
"""Creates a new secret.
def get_secret(self, secret_id: UUID) -> SecretResponseModel:
"""Get a secret with a given name.
def list_secrets(
self, secret_filter_model: SecretFilterModel
) -> Page[SecretResponseModel]:
"""List all secrets matching the given filter criteria.
Note that returned secrets do not include any secret values. To fetch
the secret values, use `get_secret`.
def update_secret(
secret_id: UUID,
secret_update: SecretUpdateModel,
) -> SecretResponseModel:
"""Updates a secret.
Secret values that are specified as `None` in the update that are
present in the existing secret are removed from the existing secret.
Values that are present in both secrets are overwritten. All other
values in both the existing secret and the update are kept (merged).
def delete_secret(self, secret_id: UUID) -> None:
"""Deletes a secret.
This is a slimmed-down version of the real interface which aims to highlight the abstraction layer. In order to see the full definition and get the complete docstrings, please check the SDK docs .

Build your own custom secrets manager

If you want to create your own custom secrets store implementation, you can follow the following steps:
  1. 1.
    Create a class that inherits from the zenml.zen_stores.secrets_stores.base_secrets_store.BaseSecretsManager base class and implements the abstractmethods shown in the interface above. Use SecretsStoreType.CUSTOM as the TYPE value for your secrets store class.
  2. 2.
    If you need to provide any configuration, create a class that inherits from the SecretsStoreConfiguration class and add your configuration parameters there. Use that as the CONFIG_TYPE value for your secrets store class.
  3. 3.
    To configure the ZenML server to use your custom secrets store, make sure your code is available in the container image that is used to run the ZenML server. Then, use environment variables or helm chart values to configure the ZenML server to use your custom secrets store, as covered in the deployment guide.
ZenML Scarf