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:

  • cluster_name (str) – cluster to list secrets. Default is current cluster.

  • org_name (str) – org to list secrets. Default is current org.

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 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.

Secret

class apolo_sdk.Secret

Read-only dataclass for describing secret instance.

key

The secret key, str.

owner

The secret owner username, str.

cluster_name

Cluster secret resource belongs to, str.

org_name

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

uri

URI of the secret resource, yarl.URL.