`volume`¶

The volume configuration type allows creating, registering, and updating volumes.

AWSGCPRunpodKubernetes

`backend` - (Required) `"aws"` The volume backend. Must be `aws`.¶

`name` - (Optional) `str` The volume name.¶

`size` - (Optional) `str` The volume size. Must be specified when creating new volumes.¶

`auto_cleanup_duration` - (Optional) `int | str` Time to wait after volume is no longer used by any job before deleting it. Defaults to keep the volume indefinitely. Use the value `off` or `-1` to disable auto-cleanup.¶

`tags` - (Optional) `dict` The custom tags to associate with the volume. The tags are also propagated to the underlying backend resources. If there is a conflict with backend-level tags, does not override them.¶

`volume_id` - (Optional) `str` The volume ID. Must be specified when registering external volumes.¶

`region` - (Required) `str` The volume region.¶

`availability_zone` - (Optional) `str` The volume availability zone.¶

`backend` - (Required) `"gcp"` The volume backend. Must be `gcp`.¶

`name` - (Optional) `str` The volume name.¶

`size` - (Optional) `str` The volume size. Must be specified when creating new volumes.¶

`auto_cleanup_duration` - (Optional) `int | str` Time to wait after volume is no longer used by any job before deleting it. Defaults to keep the volume indefinitely. Use the value `off` or `-1` to disable auto-cleanup.¶

`tags` - (Optional) `dict` The custom tags to associate with the volume. The tags are also propagated to the underlying backend resources. If there is a conflict with backend-level tags, does not override them.¶

`volume_id` - (Optional) `str` The volume ID. Must be specified when registering external volumes.¶

`region` - (Required) `str` The volume region.¶

`availability_zone` - (Optional) `str` The volume availability zone.¶

`backend` - (Required) `"runpod"` The volume backend. Must be `runpod`.¶

`name` - (Optional) `str` The volume name.¶

`size` - (Optional) `str` The volume size. Must be specified when creating new volumes.¶

`auto_cleanup_duration` - (Optional) `int | str` Time to wait after volume is no longer used by any job before deleting it. Defaults to keep the volume indefinitely. Use the value `off` or `-1` to disable auto-cleanup.¶

`tags` - (Optional) `dict` The custom tags to associate with the volume. The tags are also propagated to the underlying backend resources. If there is a conflict with backend-level tags, does not override them.¶

`volume_id` - (Optional) `str` The volume ID. Must be specified when registering external volumes.¶

`region` - (Required) `str` The volume region.¶

Kubernetes backend volumes are mapped to PersistentVolumeClaim objects.

To create a new claim, specify size and optionally storage_class_name and/or access_modes:

type: volume
backend: kubernetes
name: new-volume
size: 100GB
# By default, storage_class_name is not set, and the decision is delegated to
# the DefaultStorageClass admission controller (if it is enabled)
storage_class_name: test-nfs
# access_modes defaults to [ReadWriteOnce]. For multi-attach-capable volumes
# use ReadWriteMany and/or ReadOnlyMany
access_modes:
  - ReadWriteMany

To reuse an existing claim, specify claim_name:

type: volume
backend: kubernetes
name: existing-volume
claim_name: existing-pvc

`backend` - (Required) `"kubernetes"` The volume backend. Must be `kubernetes`.¶

`name` - (Optional) `str` The volume name.¶

`size` - (Optional) `str` The requested volume size. Must be specified when creating new PVCs. Ignored if `claim_name` is set.¶

`auto_cleanup_duration` - (Optional) `int | str` Time to wait after volume is no longer used by any job before deleting it. Defaults to keep the volume indefinitely. Use the value `off` or `-1` to disable auto-cleanup.¶

`tags` - (Optional) `dict` The custom tags to associate with the volume. The tags are also propagated to the underlying backend resources. If there is a conflict with backend-level tags, does not override them.¶

`claim_name` - (Optional) `str` The `PersistentVolumeClaim` name. Must be specified when registering the existing PVC instead of creating a new one.¶

`storage_class_name` - (Optional) `str` The `StorageClass` name. Ignored if `claim_name` is set.¶

`access_modes` - (Optional) `list[str]` A list of accepted access modes. Ignored if `claim_name` is set. Defaults to `['ReadWriteOnce']`.¶

volume¶

backend - (Required) "aws" The volume backend. Must be aws.¶

name - (Optional) str The volume name.¶

size - (Optional) str The volume size. Must be specified when creating new volumes.¶

auto_cleanup_duration - (Optional) int | str Time to wait after volume is no longer used by any job before deleting it. Defaults to keep the volume indefinitely. Use the value off or -1 to disable auto-cleanup.¶

tags - (Optional) dict The custom tags to associate with the volume. The tags are also propagated to the underlying backend resources. If there is a conflict with backend-level tags, does not override them.¶

volume_id - (Optional) str The volume ID. Must be specified when registering external volumes.¶

region - (Required) str The volume region.¶

availability_zone - (Optional) str The volume availability zone.¶

backend - (Required) "gcp" The volume backend. Must be gcp.¶

name - (Optional) str The volume name.¶

size - (Optional) str The volume size. Must be specified when creating new volumes.¶

auto_cleanup_duration - (Optional) int | str Time to wait after volume is no longer used by any job before deleting it. Defaults to keep the volume indefinitely. Use the value off or -1 to disable auto-cleanup.¶

tags - (Optional) dict The custom tags to associate with the volume. The tags are also propagated to the underlying backend resources. If there is a conflict with backend-level tags, does not override them.¶

volume_id - (Optional) str The volume ID. Must be specified when registering external volumes.¶

region - (Required) str The volume region.¶

availability_zone - (Optional) str The volume availability zone.¶

backend - (Required) "runpod" The volume backend. Must be runpod.¶

name - (Optional) str The volume name.¶

size - (Optional) str The volume size. Must be specified when creating new volumes.¶

auto_cleanup_duration - (Optional) int | str Time to wait after volume is no longer used by any job before deleting it. Defaults to keep the volume indefinitely. Use the value off or -1 to disable auto-cleanup.¶

tags - (Optional) dict The custom tags to associate with the volume. The tags are also propagated to the underlying backend resources. If there is a conflict with backend-level tags, does not override them.¶

volume_id - (Optional) str The volume ID. Must be specified when registering external volumes.¶

region - (Required) str The volume region.¶

backend - (Required) "kubernetes" The volume backend. Must be kubernetes.¶

name - (Optional) str The volume name.¶

size - (Optional) str The requested volume size. Must be specified when creating new PVCs. Ignored if claim_name is set.¶

auto_cleanup_duration - (Optional) int | str Time to wait after volume is no longer used by any job before deleting it. Defaults to keep the volume indefinitely. Use the value off or -1 to disable auto-cleanup.¶

tags - (Optional) dict The custom tags to associate with the volume. The tags are also propagated to the underlying backend resources. If there is a conflict with backend-level tags, does not override them.¶

claim_name - (Optional) str The PersistentVolumeClaim name. Must be specified when registering the existing PVC instead of creating a new one.¶

storage_class_name - (Optional) str The StorageClass name. Ignored if claim_name is set.¶

access_modes - (Optional) list[str] A list of accepted access modes. Ignored if claim_name is set. Defaults to ['ReadWriteOnce'].¶

`volume`¶

`backend` - (Required) `"aws"` The volume backend. Must be `aws`.¶

`name` - (Optional) `str` The volume name.¶

`size` - (Optional) `str` The volume size. Must be specified when creating new volumes.¶

`auto_cleanup_duration` - (Optional) `int | str` Time to wait after volume is no longer used by any job before deleting it. Defaults to keep the volume indefinitely. Use the value `off` or `-1` to disable auto-cleanup.¶

`tags` - (Optional) `dict` The custom tags to associate with the volume. The tags are also propagated to the underlying backend resources. If there is a conflict with backend-level tags, does not override them.¶

`volume_id` - (Optional) `str` The volume ID. Must be specified when registering external volumes.¶

`region` - (Required) `str` The volume region.¶

`availability_zone` - (Optional) `str` The volume availability zone.¶

`backend` - (Required) `"gcp"` The volume backend. Must be `gcp`.¶

`name` - (Optional) `str` The volume name.¶

`size` - (Optional) `str` The volume size. Must be specified when creating new volumes.¶

`auto_cleanup_duration` - (Optional) `int | str` Time to wait after volume is no longer used by any job before deleting it. Defaults to keep the volume indefinitely. Use the value `off` or `-1` to disable auto-cleanup.¶

`tags` - (Optional) `dict` The custom tags to associate with the volume. The tags are also propagated to the underlying backend resources. If there is a conflict with backend-level tags, does not override them.¶

`volume_id` - (Optional) `str` The volume ID. Must be specified when registering external volumes.¶

`region` - (Required) `str` The volume region.¶

`availability_zone` - (Optional) `str` The volume availability zone.¶

`backend` - (Required) `"runpod"` The volume backend. Must be `runpod`.¶

`name` - (Optional) `str` The volume name.¶

`size` - (Optional) `str` The volume size. Must be specified when creating new volumes.¶

`auto_cleanup_duration` - (Optional) `int | str` Time to wait after volume is no longer used by any job before deleting it. Defaults to keep the volume indefinitely. Use the value `off` or `-1` to disable auto-cleanup.¶

`tags` - (Optional) `dict` The custom tags to associate with the volume. The tags are also propagated to the underlying backend resources. If there is a conflict with backend-level tags, does not override them.¶

`volume_id` - (Optional) `str` The volume ID. Must be specified when registering external volumes.¶

`region` - (Required) `str` The volume region.¶

`backend` - (Required) `"kubernetes"` The volume backend. Must be `kubernetes`.¶

`name` - (Optional) `str` The volume name.¶

`size` - (Optional) `str` The requested volume size. Must be specified when creating new PVCs. Ignored if `claim_name` is set.¶

`auto_cleanup_duration` - (Optional) `int | str` Time to wait after volume is no longer used by any job before deleting it. Defaults to keep the volume indefinitely. Use the value `off` or `-1` to disable auto-cleanup.¶

`tags` - (Optional) `dict` The custom tags to associate with the volume. The tags are also propagated to the underlying backend resources. If there is a conflict with backend-level tags, does not override them.¶

`claim_name` - (Optional) `str` The `PersistentVolumeClaim` name. Must be specified when registering the existing PVC instead of creating a new one.¶

`storage_class_name` - (Optional) `str` The `StorageClass` name. Ignored if `claim_name` is set.¶

`access_modes` - (Optional) `list[str]` A list of accepted access modes. Ignored if `claim_name` is set. Defaults to `['ReadWriteOnce']`.¶