Стадия жизненного цикла модуля: General Availability
У модуля есть требования для установки

Deckhouse Kubernetes Platform устанавливает CRD, но не удаляет их при отключении модуля. Если вам больше не нужны созданные CRD, удалите их.

VolumeSnapshotClass

Scope: Cluster

v1 v1beta1
VolumeSnapshotClass определяет параметры для создания снимков томов, используемые нижележащей системой хранения. Для использования укажите имя VolumeSnapshotClass в объекте VolumeSnapshot. Non-namespaced ресурс.
  • apiVersion
    строка
    Версия API представления объекта. Серверы преобразуют распознанные схемы в последнее внутреннее значение и могут отклонять нераспознанные значения. Подробнее: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
  • deletionPolicy
    строка

    Управляет поведением при удалении VolumeSnapshotContent и его физического снимка при удалении связанного VolumeSnapshot. Поддерживаемые значения:

    • Retain — VolumeSnapshotContent и его физический снимок в нижележащей системе хранения сохраняются.
    • Delete — VolumeSnapshotContent и его физический снимок в нижележащей системе хранения удаляются.

    Допустимые значения: Delete, Retain

  • driver
    строка
    Имя драйвера хранения, который обрабатывает этот VolumeSnapshotClass.
  • kind
    строка
    Тип REST-ресурса, который представляет объект. Серверы могут определять это значение из конечной точки, на которую клиент отправляет запросы. Нельзя обновить после создания. Значение должно быть в формате CamelCase. Подробнее: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  • metadata
    объект
  • parameters
    объект
    Карта ключ-значение с параметрами, специфичными для драйвера хранения, используемыми при создании снимков. Kubernetes не интерпретирует эти параметры.
VolumeSnapshotClass определяет параметры для создания снимков томов, используемые нижележащей системой хранения. Для использования укажите имя VolumeSnapshotClass в объекте VolumeSnapshot. Non-namespaced ресурс.
  • apiVersion
    строка
    Версия API представления объекта. Серверы преобразуют распознанные схемы в последнее внутреннее значение и могут отклонять нераспознанные значения. Подробнее: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
  • deletionPolicy
    строка

    Управляет поведением при удалении VolumeSnapshotContent и его физического снимка при удалении связанного VolumeSnapshot. Поддерживаемые значения:

    • Retain — VolumeSnapshotContent и его физический снимок в нижележащей системе хранения сохраняются.
    • Delete — VolumeSnapshotContent и его физический снимок в нижележащей системе хранения удаляются.

    Допустимые значения: Delete, Retain

  • driver
    строка
    Имя драйвера хранения, который обрабатывает этот VolumeSnapshotClass.
  • kind
    строка
    Тип REST-ресурса, который представляет объект. Серверы могут определять это значение из конечной точки, на которую клиент отправляет запросы. Нельзя обновить после создания. Значение должно быть в формате CamelCase. Подробнее: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  • parameters
    объект
    Карта ключ-значение с параметрами, специфичными для драйвера хранения, используемыми при создании снимков. Kubernetes не интерпретирует эти параметры.

VolumeSnapshotContent

Scope: Cluster

v1 v1beta1
VolumeSnapshotContent представляет фактический объект снимка «на диске» в нижележащей системе хранения.
  • apiVersion
    строка
    Версия API представления объекта. Серверы преобразуют распознанные схемы в последнее внутреннее значение и могут отклонять нераспознанные значения. Подробнее: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
  • kind
    строка
    Тип REST-ресурса, который представляет объект. Серверы могут определять это значение из конечной точки, на которую клиент отправляет запросы. Нельзя обновить после создания. Значение должно быть в формате CamelCase. Подробнее: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  • metadata
    объект
  • spec
    объект
    Свойства VolumeSnapshotContent, созданного нижележащей системой хранения.
    • spec.deletionPolicy
      строка

      Обязательный параметр

      Управляет поведением при удалении VolumeSnapshotContent и его физического снимка при удалении связанного VolumeSnapshot. Поддерживаемые значения:

      • Retain — VolumeSnapshotContent и его физический снимок в нижележащей системе хранения сохраняются.
      • Delete — VolumeSnapshotContent и его физический снимок в нижележащей системе хранения удаляются.

      Для динамически созданных снимков автоматически заполняется CSI snapshotter sidecar значением поля DeletionPolicy, определенным в соответствующем VolumeSnapshotClass. Для существующих снимков необходимо указать при создании объекта VolumeSnapshotContent.

      Допустимые значения: Delete, Retain

    • spec.driver
      строка

      Обязательный параметр

      Имя CSI-драйвера, используемого для создания физического снимка в нижележащей системе хранения. Должно совпадать с именем, возвращаемым вызовом CSI GetPluginName() для этого драйвера.
    • spec.source
      объект

      Обязательный параметр

      Указывает, является ли снимок (или должен быть) динамически созданным или уже существует и требует только представления в виде объекта Kubernetes. Неизменяемо после создания.
      • spec.source.snapshotHandle
        строка
        CSI snapshot_id существующего снимка в нижележащей системе хранения, для которого было (или должно быть) создано представление в виде объекта Kubernetes. Неизменяемо.
      • spec.source.volumeHandle
        строка
        CSI volume_id тома, из которого должен быть динамически создан снимок. Неизменяемо.
    • spec.sourceVolumeMode
      строка
      Режим тома, снимок которого создается. Может быть Filesystem или Block. Если не указано, режим исходного тома неизвестен. Неизменяемо.
    • spec.volumeSnapshotClassName
      строка
      Имя VolumeSnapshotClass, из которого был (или будет) создан этот снимок. После создания снимка VolumeSnapshotClass может быть удален или пересоздан с другими значениями и не должен использоваться.
    • spec.volumeSnapshotRef
      объект

      Обязательный параметр

      Объект VolumeSnapshot (далее — референт), к которому привязан этот VolumeSnapshotContent. Поле VolumeSnapshot.Spec.VolumeSnapshotContentName должно ссылаться на имя этого VolumeSnapshotContent для валидности двунаправленной привязки. Для существующего объекта VolumeSnapshotContent необходимо указать имя и неймспейс объекта VolumeSnapshot для привязки. Неизменяемо после создания.
  • status
    объект
    Текущая информация о снимке.
    • status.creationTime
      целочисленный
      Временная метка создания точечного снимка нижележащей системой хранения. При динамическом создании снимка заполняется CSI snapshotter sidecar значением creation_time, возвращаемым из вызова gRPC CreateSnapshot CSI. Для существующего снимка заполняется значением creation_time, возвращаемым из вызова gRPC ListSnapshots CSI, если драйвер поддерживает это. Если не указано, время создания неизвестно. Формат — время в наносекундах Unix, закодированное как int64. В Unix команда date +%s%N возвращает текущее время в наносекундах с 1970-01-01 00:00:00 UTC.
    • status.error
      объект
      Последняя наблюдаемая ошибка при создании снимка, если есть. После успешного повтора поле очищается.
      • status.error.message
        строка
        Детали возникшей ошибки при создании снимка, если указаны. Примечание: сообщение может быть залогировано и не должно содержать конфиденциальную информацию.
      • status.error.time
        строка
        Временная метка, когда была обнаружена ошибка.
    • status.readyToUse
      булевый
      Указывает, готов ли снимок для восстановления тома. При динамическом создании снимка заполняется CSI snapshotter sidecar значением ready_to_use, возвращаемым из вызова gRPC CreateSnapshot CSI. Для существующего снимка заполняется значением ready_to_use, возвращаемым из вызова gRPC ListSnapshots CSI, если драйвер поддерживает это, иначе устанавливается в True. Если не указано, готовность снимка неизвестна.
    • status.restoreSize
      целочисленный
      Полный размер снимка в байтах. При динамическом создании снимка заполняется CSI snapshotter sidecar значением size_bytes, возвращаемым из вызова gRPC CreateSnapshot CSI. Для существующего снимка заполняется значением size_bytes, возвращаемым из вызова gRPC ListSnapshots CSI, если драйвер поддерживает это. При восстановлении тома из этого снимка размер тома не должен быть меньше restoreSize, если он указан, иначе восстановление завершится ошибкой. Если не указано, размер неизвестен.

      Допустимые значения: 0 <= X

    • status.snapshotHandle
      строка
      CSI snapshot_id снимка в нижележащей системе хранения. Если не указано, динамическое создание снимка либо завершилось ошибкой, либо все еще выполняется.
    • status.volumeGroupSnapshotHandle
      строка
      CSI group_snapshot_id группового снимка в нижележащей системе хранения.
VolumeSnapshotContent представляет фактический объект снимка «на диске» в нижележащей системе хранения.
  • apiVersion
    строка
    Версия API представления объекта. Серверы преобразуют распознанные схемы в последнее внутреннее значение и могут отклонять нераспознанные значения. Подробнее: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
  • kind
    строка
    Тип REST-ресурса, который представляет объект. Серверы могут определять это значение из конечной точки, на которую клиент отправляет запросы. Нельзя обновить после создания. Значение должно быть в формате CamelCase. Подробнее: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  • spec
    объект
    Свойства VolumeSnapshotContent, созданного нижележащей системой хранения.
    • spec.deletionPolicy
      строка

      Обязательный параметр

      Управляет поведением при удалении VolumeSnapshotContent и его физического снимка при удалении связанного VolumeSnapshot. Поддерживаемые значения:

      • Retain — VolumeSnapshotContent и его физический снимок в нижележащей системе хранения сохраняются.
      • Delete — VolumeSnapshotContent и его физический снимок в нижележащей системе хранения удаляются.

      Для динамически созданных снимков автоматически заполняется CSI snapshotter sidecar значением поля DeletionPolicy, определенным в соответствующем VolumeSnapshotClass. Для существующих снимков необходимо указать при создании объекта VolumeSnapshotContent.

      Допустимые значения: Delete, Retain

    • spec.driver
      строка

      Обязательный параметр

      Имя CSI-драйвера, используемого для создания физического снимка в нижележащей системе хранения. Должно совпадать с именем, возвращаемым вызовом CSI GetPluginName() для этого драйвера.
    • spec.source
      объект

      Обязательный параметр

      Указывает, является ли снимок (или должен быть) динамически созданным или уже существует и требует только представления в виде объекта Kubernetes. Неизменяемо после создания.
      • spec.source.snapshotHandle
        строка
        CSI snapshot_id существующего снимка в нижележащей системе хранения, для которого было (или должно быть) создано представление в виде объекта Kubernetes. Неизменяемо.
      • spec.source.volumeHandle
        строка
        CSI volume_id тома, из которого должен быть динамически создан снимок. Неизменяемо.
    • spec.volumeSnapshotClassName
      строка
      Имя VolumeSnapshotClass, из которого был (или будет) создан этот снимок. После создания снимка VolumeSnapshotClass может быть удален или пересоздан с другими значениями и не должен использоваться.
    • spec.volumeSnapshotRef
      объект

      Обязательный параметр

      Объект VolumeSnapshot (далее — референт), к которому привязан этот VolumeSnapshotContent. Поле VolumeSnapshot.Spec.VolumeSnapshotContentName должно ссылаться на имя этого VolumeSnapshotContent для валидности двунаправленной привязки. Для существующего объекта VolumeSnapshotContent необходимо указать имя и неймспейс объекта VolumeSnapshot для привязки. Неизменяемо после создания.
  • status
    объект
    Текущая информация о снимке.
    • status.creationTime
      целочисленный
      Временная метка создания точечного снимка нижележащей системой хранения. При динамическом создании снимка заполняется CSI snapshotter sidecar значением creation_time, возвращаемым из вызова gRPC CreateSnapshot CSI. Для существующего снимка заполняется значением creation_time, возвращаемым из вызова gRPC ListSnapshots CSI, если драйвер поддерживает это. Если не указано, время создания неизвестно. Формат — время в наносекундах Unix, закодированное как int64. В Unix команда date +%s%N возвращает текущее время в наносекундах с 1970-01-01 00:00:00 UTC.
    • status.error
      объект
      Последняя наблюдаемая ошибка при создании снимка, если есть. После успешного повтора поле очищается.
      • status.error.message
        строка
        Детали возникшей ошибки при создании снимка, если указаны. Примечание: сообщение может быть залогировано и не должно содержать конфиденциальную информацию.
      • status.error.time
        строка
        Временная метка, когда была обнаружена ошибка.
    • status.readyToUse
      булевый
      Указывает, готов ли снимок для восстановления тома. При динамическом создании снимка заполняется CSI snapshotter sidecar значением ready_to_use, возвращаемым из вызова gRPC CreateSnapshot CSI. Для существующего снимка заполняется значением ready_to_use, возвращаемым из вызова gRPC ListSnapshots CSI, если драйвер поддерживает это, иначе устанавливается в True. Если не указано, готовность снимка неизвестна.
    • status.restoreSize
      целочисленный
      Полный размер снимка в байтах. При динамическом создании снимка заполняется CSI snapshotter sidecar значением size_bytes, возвращаемым из вызова gRPC CreateSnapshot CSI. Для существующего снимка заполняется значением size_bytes, возвращаемым из вызова gRPC ListSnapshots CSI, если драйвер поддерживает это. При восстановлении тома из этого снимка размер тома не должен быть меньше restoreSize, если он указан, иначе восстановление завершится ошибкой. Если не указано, размер неизвестен.

      Допустимые значения: 0 <= X

    • status.snapshotHandle
      строка
      CSI snapshot_id снимка в нижележащей системе хранения. Если не указано, динамическое создание снимка либо завершилось ошибкой, либо все еще выполняется.

VolumeSnapshot

Scope: Namespaced

v1 v1beta1
VolumeSnapshot — это запрос пользователя на создание точечного снимка постоянного тома или на привязку к существующему снимку.
  • apiVersion
    строка
    Версия API представления объекта. Серверы преобразуют распознанные схемы в последнее внутреннее значение и могут отклонять нераспознанные значения. Подробнее: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
  • kind
    строка
    Тип REST-ресурса, который представляет объект. Серверы могут определять это значение из конечной точки, на которую клиент отправляет запросы. Нельзя обновить после создания. Значение должно быть в формате CamelCase. Подробнее: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  • metadata
    объект
  • spec
    объект
    Свойства снимка, запрошенного пользователем. Подробнее: https://kubernetes.io/docs/concepts/storage/volume-snapshots#volumesnapshots
    • spec.source
      объект

      Обязательный параметр

      Указывает источник создания снимка. Неизменяемо после создания.
      • spec.source.persistentVolumeClaimName
        строка
        Имя объекта PersistentVolumeClaim, представляющего том, из которого должен быть создан снимок. PVC должен находиться в том же неймспейсе, что и объект VolumeSnapshot. Указывается, если снимок не существует и его необходимо создать. Неизменяемо.
      • spec.source.volumeSnapshotContentName
        строка
        Имя существующего объекта VolumeSnapshotContent, представляющего существующий снимок тома. Указывается, если снимок уже существует и требуется только его представление в Kubernetes. Неизменяемо.
    • spec.volumeSnapshotClassName
      строка
      Имя VolumeSnapshotClass, запрошенного VolumeSnapshot. Может быть пустым для использования класса снимков по умолчанию. В кластере может быть несколько классов снимков по умолчанию: один для каждого CSI-драйвера. Если класс снимков не указан, проверяется VolumeSnapshotSource для определения связанного CSI-драйвера, и используется класс снимков по умолчанию для этого CSI-драйвера. Если для одного CSI-драйвера существует несколько VolumeSnapshotClass, помеченных как используемые по умолчанию, CreateSnapshot завершается ошибкой и создает событие. Не допускается пустая строка.
  • status
    объект
    Текущая информация о снимке. Перед использованием необходимо проверить успешность привязки между объектами VolumeSnapshot и VolumeSnapshotContent, убедившись, что оба объекта указывают друг на друга.
    • status.boundVolumeSnapshotContentName
      строка
      Имя объекта VolumeSnapshotContent, к которому привязан этот объект VolumeSnapshot. Если не указано, объект VolumeSnapshot еще не привязан к объекту VolumeSnapshotContent. Примечание: для предотвращения проблем с безопасностью перед использованием необходимо проверить успешность привязки между объектами VolumeSnapshot и VolumeSnapshotContent, убедившись, что оба объекта указывают друг на друга.
    • status.creationTime
      строка
      Временная метка создания точечного снимка нижележащей системой хранения. При динамическом создании снимка заполняется контроллером снимков значением creation_time, возвращаемым из вызова gRPC CreateSnapshot CSI. Для существующего снимка заполняется значением creation_time, возвращаемым из вызова gRPC ListSnapshots CSI, если драйвер поддерживает это. Если не указано, время создания снимка неизвестно.
    • status.error
      объект
      Последняя наблюдаемая ошибка при создании снимка, если есть. Полезно контроллерам верхнего уровня (например, контроллеру приложения) для решения о продолжении ожидания создания снимка по типу ошибки. Контроллер снимков продолжает повторные попытки при возникновении ошибки во время создания снимка. После успешного создания поле очищается.
      • status.error.message
        строка
        Детали возникшей ошибки при создании снимка, если указаны. Примечание: сообщение может быть залогировано и не должно содержать конфиденциальную информацию.
      • status.error.time
        строка
        Временная метка, когда была обнаружена ошибка.
    • status.readyToUse
      булевый
      Указывает, готов ли снимок для восстановления тома. При динамическом создании снимка заполняется контроллером снимков значением ready_to_use, возвращаемым из вызова gRPC CreateSnapshot CSI. Для существующего снимка заполняется значением ready_to_use, возвращаемым из вызова gRPC ListSnapshots CSI, если драйвер поддерживает это, иначе устанавливается в True. Если не указано, готовность снимка неизвестна.
    • status.restoreSize
      строка
      Минимальный размер тома, необходимый для создания тома из этого снимка. При динамическом создании снимка заполняется контроллером снимков значением size_bytes, возвращаемым из вызова gRPC CreateSnapshot CSI. Для существующего снимка заполняется значением size_bytes, возвращаемым из вызова gRPC ListSnapshots CSI, если драйвер поддерживает это. При восстановлении тома из этого снимка размер тома не должен быть меньше restoreSize, если он указан, иначе восстановление завершится ошибкой. Если не указано, размер неизвестен.

      Шаблон: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

    • status.volumeGroupSnapshotName
      строка
      Имя VolumeGroupSnapshot, частью которого является этот VolumeSnapshot.
VolumeSnapshot — это запрос пользователя на создание точечного снимка постоянного тома или на привязку к существующему снимку.
  • apiVersion
    строка
    Версия API представления объекта. Серверы преобразуют распознанные схемы в последнее внутреннее значение и могут отклонять нераспознанные значения. Подробнее: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
  • kind
    строка
    Тип REST-ресурса, который представляет объект. Серверы могут определять это значение из конечной точки, на которую клиент отправляет запросы. Нельзя обновить после создания. Значение должно быть в формате CamelCase. Подробнее: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  • spec
    объект
    Свойства снимка, запрошенного пользователем. Подробнее: https://kubernetes.io/docs/concepts/storage/volume-snapshots#volumesnapshots
    • spec.source
      объект

      Обязательный параметр

      Указывает источник создания снимка. Неизменяемо после создания.
      • spec.source.persistentVolumeClaimName
        строка
        Имя объекта PersistentVolumeClaim, представляющего том, из которого должен быть создан снимок. PVC должен находиться в том же неймспейсе, что и объект VolumeSnapshot. Указывается, если снимок не существует и его необходимо создать. Неизменяемо.
      • spec.source.volumeSnapshotContentName
        строка
        Имя существующего объекта VolumeSnapshotContent, представляющего существующий снимок тома. Указывается, если снимок уже существует и требуется только его представление в Kubernetes. Неизменяемо.
    • spec.volumeSnapshotClassName
      строка
      Имя VolumeSnapshotClass, запрошенного VolumeSnapshot. Может быть пустым для использования класса снимков по умолчанию. В кластере может быть несколько классов снимков по умолчанию: один для каждого CSI-драйвера. Если класс снимков не указан, проверяется VolumeSnapshotSource для определения связанного CSI-драйвера, и используется класс снимков по умолчанию для этого CSI-драйвера. Если для одного CSI-драйвера существует несколько VolumeSnapshotClass, помеченных как используемые по умолчанию, CreateSnapshot завершается ошибкой и создает событие. Не допускается пустая строка.
  • status
    объект
    Текущая информация о снимке. Перед использованием необходимо проверить успешность привязки между объектами VolumeSnapshot и VolumeSnapshotContent, убедившись, что оба объекта указывают друг на друга.
    • status.boundVolumeSnapshotContentName
      строка
      Имя объекта VolumeSnapshotContent, к которому привязан этот объект VolumeSnapshot. Если не указано, объект VolumeSnapshot еще не привязан к объекту VolumeSnapshotContent. Примечание: для предотвращения проблем с безопасностью перед использованием необходимо проверить успешность привязки между объектами VolumeSnapshot и VolumeSnapshotContent, убедившись, что оба объекта указывают друг на друга.
    • status.creationTime
      строка
      Временная метка создания точечного снимка нижележащей системой хранения. При динамическом создании снимка заполняется контроллером снимков значением creation_time, возвращаемым из вызова gRPC CreateSnapshot CSI. Для существующего снимка заполняется значением creation_time, возвращаемым из вызова gRPC ListSnapshots CSI, если драйвер поддерживает это. Если не указано, время создания снимка неизвестно.
    • status.error
      объект
      Последняя наблюдаемая ошибка при создании снимка, если есть. Полезно контроллерам верхнего уровня (например, контроллеру приложения) для решения о продолжении ожидания создания снимка по типу ошибки. Контроллер снимков продолжает повторные попытки при возникновении ошибки во время создания снимка. После успешного создания поле очищается.
      • status.error.message
        строка
        Детали возникшей ошибки при создании снимка, если указаны. Примечание: сообщение может быть залогировано и не должно содержать конфиденциальную информацию.
      • status.error.time
        строка
        Временная метка, когда была обнаружена ошибка.
    • status.readyToUse
      булевый
      Указывает, готов ли снимок для восстановления тома. При динамическом создании снимка заполняется контроллером снимков значением ready_to_use, возвращаемым из вызова gRPC CreateSnapshot CSI. Для существующего снимка заполняется значением ready_to_use, возвращаемым из вызова gRPC ListSnapshots CSI, если драйвер поддерживает это, иначе устанавливается в True. Если не указано, готовность снимка неизвестна.
    • status.restoreSize
      строка
      Минимальный размер тома, необходимый для создания тома из этого снимка. При динамическом создании снимка заполняется контроллером снимков значением size_bytes, возвращаемым из вызова gRPC CreateSnapshot CSI. Для существующего снимка заполняется значением size_bytes, возвращаемым из вызова gRPC ListSnapshots CSI, если драйвер поддерживает это. При восстановлении тома из этого снимка размер тома не должен быть меньше restoreSize, если он указан, иначе восстановление завершится ошибкой. Если не указано, размер неизвестен.

      Шаблон: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

    • status.volumeGroupSnapshotName
      строка
      Имя VolumeGroupSnapshot, частью которого является этот VolumeSnapshot.