第 11 章 VolumeSnapshot [snapshot.storage.k8s.io/v1]
- 描述
- VolumeSnapshot 是用户创建持久性卷时点快照或绑定到预先存在的快照的请求。
- 类型
-
object - 必填
-
spec
-
11.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： 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 |
|
| 标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| spec 定义用户请求的快照所需的特征。更多信息： https://kubernetes.io/docs/concepts/storage/volume-snapshots#volumesnapshots 必需。 |
|
|
| Status 代表快照的当前信息。在使用此对象前，消费者必须验证 VolumeSnapshot 和 VolumeSnapshotContent 对象之间的绑定是否成功（通过验证 VolumeSnapshot 和 VolumeSnapshotContent 点）。 |
11.1.1. .spec
- 描述
- spec 定义用户请求的快照所需的特征。更多信息： https://kubernetes.io/docs/concepts/storage/volume-snapshots#volumesnapshots 必需。
- 类型
-
object - 必填
-
source
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| source 指定从哪里创建快照。此字段在创建后是不可变的。必需。 |
|
|
| volume5-4Name 是 VolumeSnapshot 请求的 VolumeSnapshotClass 的名称。volumeSnapshotClassName 可能保留为 nil，以指示应使用默认的 SnapshotClass。给定集群可能有多个默认卷 SnapshotClasses：每个 CSI 驱动程序一个默认值。如果 VolumeSnapshot 没有指定 SnapshotClass，则会检查 VolumeSnapshotSource 找出相关的 CSI Driver 是什么，并使用与该 CSI Driver 相关的默认 VolumeSnapshotClass。如果一个给定的 CSI Driver 存在多个 VolumeSnapshotClass，且多个已被标记为默认值，CreateSnapshot 将失败并生成事件。此字段不允许使用空字符串。 |
11.1.2. .spec.source
- 描述
- source 指定从哪里创建快照。此字段在创建后是不可变的。必需。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| PersistentVolumeClaimName 指定代表应该创建快照的卷的 PersistentVolumeClaim 对象的名称。该 PVC 假定与 VolumeSnapshot 对象位于同一个命名空间中。如果快照不存在且需要创建，则应设置此字段。此字段不可变。 |
|
|
| volumeSnapshotContentName 指定代表现有卷快照的预先存在的 VolumeSnapshotContent 对象的名称。如果快照已存在且只需要 Kubernetes 中的表示，则应设置此字段。此字段不可变。 |
11.1.3. .status
- 描述
- Status 代表快照的当前信息。在使用此对象前，消费者必须验证 VolumeSnapshot 和 VolumeSnapshotContent 对象之间的绑定是否成功（通过验证 VolumeSnapshot 和 VolumeSnapshotContent 点）。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| boundVolumeSnapshotContentName 是这个 VolumeSnapshot 对象要绑定到的 VolumeSnapshotContent 对象的名称。如果没有指定，这表示 VolumeSnapshot 对象还没有成功绑定到 VolumeSnapshotContent 对象。注意：为了避免可能的安全问题，用户必须在使用此对象前验证 VolumeSnapshot 和 VolumeSnapshotContent 对象之间的绑定是否成功（通过验证 VolumeSnapshot 和 VolumeSnapshotContent 点）。 |
|
|
| creationTime 是底层存储系统执行点快照时的时间戳。在动态快照创建情形中，这个字段将由快照控制器填写，并带有从 CSI "CreateSnapshot" gRPC 调用返回的 "creation_time" 值。对于预先存在的快照，此字段将填充从 CSI "ListSnapshots" gRPC 调用返回的 "creation_time" 值（如果驱动程序支持）。如果没有指定，这可能表示快照的创建时间未知。 |
|
|
| error 是快照创建过程中最后观察到的错误（若有）。此字段对于上层控制器（即应用程序控制器）会很有帮助，以确定它们是否应该继续根据报告的错误类型创建快照。快照控制器会在快照创建过程中发生错误时保留重试。成功后，此错误字段将被清除。 |
|
|
| readyToUse 表示快照是否准备好用于恢复卷。在动态快照创建情况下，这个字段由快照控制器填充，并带有从 CSI "CreateSnapshot" gRPC 调用返回的 "ready_to_use" 值。对于预先存在的快照，此字段将填充从 CSI "ListSnapshots" gRPC 调用返回的 "ready_to_use" 值（如果驱动程序支持），否则此字段将被设置为 "True"。如果没有指定，这表示快照的就绪状态未知。 |
|
|
| restoreSize 代表从这个快照创建卷所需的最小卷大小。在动态快照创建情形中，这个字段将由快照控制器填写，并带有从 CSI "CreateSnapshot" gRPC 调用返回的 "size_bytes" 值。对于预先存在的快照，如果驱动程序支持，此字段将填充从 CSI "ListSnapshots" gRPC 调用返回的 "size_bytes" 值。当从这个快照恢复卷时，如果指定了 restoreSize，则卷的大小不能小于 restoreSize。如果没有指定，这表示大小未知。 |
|
|
| VolumeGroupSnapshotName 是这个 VolumeSnapshot 的一部分的 VolumeGroupSnapshot 的名称。 |
11.1.4. .status.error
- 描述
- error 是快照创建过程中最后观察到的错误（若有）。此字段对于上层控制器（即应用程序控制器）会很有帮助，以确定它们是否应该继续根据报告的错误类型创建快照。快照控制器会在快照创建过程中发生错误时保留重试。成功后，此错误字段将被清除。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 如果指定，消息是一个字符串，详细描述了快照创建过程中遇到的错误。注意：消息可能已记录，并且不应包含敏感信息。 |
|
|
| 时间是遇到错误时的时间戳。 |
