VolumeMountConfig#

pydantic model controller.config.VolumeMountConfig#

The mount of a volume inside a container.

Parameters:

data (Any) –

Show JSON schema
{
   "title": "VolumeMountConfig",
   "description": "The mount of a volume inside a container.",
   "type": "object",
   "properties": {
      "containerPath": {
         "description": "Absolute path at which to mount the volume in the lab container",
         "examples": [
            "/home"
         ],
         "pattern": "^/.*",
         "title": "Path inside container",
         "type": "string"
      },
      "subPath": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Mount only this sub-path of the volume source",
         "examples": [
            "groups"
         ],
         "title": "Sub-path of source to mount"
      },
      "readOnly": {
         "default": false,
         "description": "Whether the volume should be mounted read-only in the container",
         "examples": [
            true
         ],
         "title": "Is read-only",
         "type": "boolean"
      },
      "volumeName": {
         "description": "Name of the volume to mount",
         "title": "Volume name",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "containerPath",
      "volumeName"
   ]
}

Fields:
Validators:
field containerPath: str [Required] (name 'container_path')#

Absolute path at which to mount the volume in the lab container

Constraints:
  • pattern = ^/.*

Validated by:
  • _validate_container_path

field readOnly: bool = False (name 'read_only')#

Whether the volume should be mounted read-only in the container

field subPath: str | None = None (name 'sub_path')#

Mount only this sub-path of the volume source

field volumeName: str [Required] (name 'volume_name')#

Name of the volume to mount