Secrets API Reference¶

Secrets¶

class apolo_sdk.Secrets¶

Secured secrets subsystems. Secrets can be passed as mounted files and environment variables into a running job.

async list(cluster_name: str | None = None, org_name: str | None = None) → AsyncContextManager[AsyncIterator[Secret]][source]¶

List user’s secrets, async iterator. Yields Secret instances.

Parameters:

async add(key: str, value: bytes, cluster_name: str | None = None, org_name: str | None = None) → None[source]¶

Add a secret with name key and content value.

Parameters:

key (str) – secret’s name.
vale (bytes) – secret’s value.
cluster_name (str) – cluster to create a secret. Default is current cluster.
org_name (str) – org to create a secrets. Default is current org.

async get(key: str, cluster_name: str | None = None, org_name: str | None = None, project_name: str | None = None) → bytes[source]¶

Get a secret key value.

Parameters:

key (str) – secret’s name.
cluster_name (str) – cluster to look for a secret. Default is current cluster.
org_name (str) – org to look for a secrets. Default is current org.
project_name (str) – project to look for a secrets. Default is current project.

Returns:

The secret value as bytes.

async rm(key: str, cluster_name: str | None = None, org_name: str | None = None) → None[source]¶

Delete a secret key.

Parameters:

key (str) – secret’s name.
cluster_name (str) – cluster to look for a secret. Default is current cluster.
org_name (str) – org to look for a secrets. Default is current org.

class apolo_sdk.Secret¶

Read-only dataclass for describing secret instance.

org_name¶: Org secret resource belongs to, str or None if there is no such org.