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 this mount of the volume should be read-only",
         "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:

• containerPath (str)

• readOnly (bool)

• subPath (str | None)

• volumeName (str)

field containerPath: Annotated[str, Field(title='Path inside container', description='Absolute path at which to mount the volume in the lab container', examples=['/home'], pattern='^/.*'), AfterValidator(_reject_reserved_paths)] [Required] (name 'container_path')

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

Constraints:

• pattern = ^/.*

• func = <function _reject_reserved_paths at 0x7f78b914d300>

field readOnly: Annotated[bool, Field(title='Is read-only', description='Whether this mount of the volume should be read-only', examples=[True])] = False (name 'read_only')

Whether this mount of the volume should be read-only

field subPath: Annotated[str | None, Field(title='Sub-path of source to mount', description='Mount only this sub-path of the volume source', examples=['groups'])] = None (name 'sub_path')

Mount only this sub-path of the volume source

field volumeName: Annotated[str, Field(title='Volume name', description='Name of the volume to mount')] [Required] (name 'volume_name')

Name of the volume to mount