LabSecret#

pydantic model controller.config.LabSecret#

A secret to make available to lab containers.

Parameters:

data (Any) –

Show JSON schema
{
   "title": "LabSecret",
   "description": "A secret to make available to lab containers.",
   "type": "object",
   "properties": {
      "secretName": {
         "description": "Must name a ``Secret`` resource in the same namespace as the Nublado controller pod",
         "examples": [
            "credentials"
         ],
         "title": "Source secret name",
         "type": "string"
      },
      "secretKey": {
         "description": "Name of field inside the ``Secret`` named ``secretName`` containing the secret. Each secret key must be unique across all secrets in the list of source secrets, since it is also used as the key for the entry in the secret created in the user's lab environment.",
         "examples": [
            "butler-credentials"
         ],
         "title": "Key of secret",
         "type": "string"
      },
      "env": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "If set, also inject the value of this secret into the lab environment variable of this name",
         "examples": [
            "BUTLER_CREDENTIALS"
         ],
         "title": "Environment variable to set"
      },
      "path": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "If set, also mount the secret at this path inside the lab container",
         "examples": [
            "/opt/lsst/software/jupyterlab/butler-secret"
         ],
         "title": "Path at which to mount secret"
      }
   },
   "additionalProperties": false,
   "required": [
      "secretName",
      "secretKey"
   ]
}

Fields:
field env: str | None = None#

If set, also inject the value of this secret into the lab environment variable of this name

field path: str | None = None#

If set, also mount the secret at this path inside the lab container

field secretKey: str [Required] (name 'secret_key')#

Name of field inside the Secret named secretName containing the secret. Each secret key must be unique across all secrets in the list of source secrets, since it is also used as the key for the entry in the secret created in the user’s lab environment.

field secretName: str [Required] (name 'secret_name')#

Must name a Secret resource in the same namespace as the Nublado controller pod