From 90d11aafe58aad468163c9c05dc4682bf2080655 Mon Sep 17 00:00:00 2001 From: windsonsea Date: Tue, 12 Nov 2024 09:42:39 +0800 Subject: [PATCH] [zh] Add storage-version-migration-v1alpha1.md --- .../storage-version-migration-v1alpha1.md | 1023 +++++++++++++++++ 1 file changed, 1023 insertions(+) create mode 100644 content/zh-cn/docs/reference/kubernetes-api/config-and-storage-resources/storage-version-migration-v1alpha1.md diff --git a/content/zh-cn/docs/reference/kubernetes-api/config-and-storage-resources/storage-version-migration-v1alpha1.md b/content/zh-cn/docs/reference/kubernetes-api/config-and-storage-resources/storage-version-migration-v1alpha1.md new file mode 100644 index 0000000000..43848b791a --- /dev/null +++ b/content/zh-cn/docs/reference/kubernetes-api/config-and-storage-resources/storage-version-migration-v1alpha1.md @@ -0,0 +1,1023 @@ +--- +api_metadata: + apiVersion: "storagemigration.k8s.io/v1alpha1" + import: "k8s.io/api/storagemigration/v1alpha1" + kind: "StorageVersionMigration" +content_type: "api_reference" +description: "StorageVersionMigration 表示存储的数据向最新存储版本的一次迁移。" +title: "StorageVersionMigration v1alpha1" +weight: 9 +--- + + +`apiVersion: storagemigration.k8s.io/v1alpha1` + +`import "k8s.io/api/storagemigration/v1alpha1"` + +## StorageVersionMigration {#StorageVersionMigration} + + +StorageVersionMigration 表示将表示存储的数据向最新存储版本的一次迁移。 + +
+ +- **apiVersion**: storagemigration.k8s.io/v1alpha1 + +- **kind**: StorageVersionMigration + + +- **metadata** (}}">ObjectMeta) + + 标准的对象元数据。更多信息: + https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +- **spec** (}}">StorageVersionMigrationSpec) + + 迁移的规约。 + + +- **status** (}}">StorageVersionMigrationStatus) + + 迁移的状态。 + +## StorageVersionMigrationSpec {#StorageVersionMigrationSpec} + +存储版本迁移的规约。 + +
+ + +- **continueToken** (string) + + 在 list 操作中用来获取下一批要迁移的对象时要所用的令牌。 + 当 `.status.conditions` 指示迁移处于 “Running” 状态时,用户可以使用此令牌检查迁移的进度。 + +- **resource** (GroupVersionResource),必需 + + 正在被迁移的资源。迁移程序向提供资源的端点发送请求。不可变更。 + + + **组、版本和资源的名称。** + + + + - **resource.group** (string) + + 组的名称。 + + - **resource.resource** (string) + + 资源的名称。 + + - **resource.version** (string) + + 版本的名称。 + +## StorageVersionMigrationStatus {#StorageVersionMigrationStatus} + + +存储版本迁移的状态。 + +
+ + +- **conditions** ([]MigrationCondition) + + **补丁策略:基于键 `type` 合并** + + **Map:合并时将保留 type 键的唯一值** + + 迁移当前状态的最新可用观察结果。 + + + **描述迁移在某一时间点的状态。** + + + + - **conditions.status** (string),必需 + + 状况的状态,可选值为 True、False 或 Unknown。 + + - **conditions.type** (string),必需 + + 状况的类别。 + + + + - **conditions.lastUpdateTime** (Time) + + 上一次更新此状况的时间。 + + + **Time 是 time.Time 的包装器,支持正确编码为 YAML 和 JSON。为 time 包提供的许多工厂方法提供了包装器。** + + + + - **conditions.message** (string) + + 一条人类可读的消息,指示关于转换的细节。 + + - **conditions.reason** (string) + + 上次状况转换的原因。 + + +- **resourceVersion** (string) + + 在执行迁移时,要与垃圾收集(GC)缓存进行比较的资源版本(ResourceVerion)。 + 这是 kube-controller-manager 第一次观察到 StorageVersionMigration + 资源时所给定组、版本和资源的当前资源版本。 + +## StorageVersionMigrationList {#StorageVersionMigrationList} + + +StorageVersionMigrationList 是 StorageVersionMigration 对象的集合。 + +
+ +- **apiVersion**: storagemigration.k8s.io/v1alpha1 + +- **kind**: StorageVersionMigrationList + + +- **metadata** (}}">ListMeta) + + 标准的列表元数据。更多信息: + https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +- **items** ([]}}">StorageVersionMigration),必需 + + **补丁策略:基于键 `type` 合并** + + **Map:合并时将保留 type 键的唯一值** + + items 是 StorageVersionMigration 的列表。 + + +## 操作 {#Operations} + +
+ +### `get` 读取指定的 StorageVersionMigration + +#### HTTP 请求 + +GET /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name} + + +#### 参数 + +- **name** (**路径参数**): string,必需 + + StorageVersionMigration 的名称。 + +- **pretty** (**查询参数**): string + + }}">pretty + + +#### 响应 + +200 (}}">StorageVersionMigration): OK + +401: Unauthorized + + +### `get` 读取指定 StorageVersionMigration 的状态 + +#### HTTP 请求 + +GET /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name}/status + + +#### 参数 + +- **name** (**路径参数**): string,必需 + + StorageVersionMigration 的名称。 + +- **pretty** (**查询参数**): string + + }}">pretty + + +#### 响应 + +200 (}}">StorageVersionMigration): OK + +401: Unauthorized + + +### `list` 列举或监视类别为 StorageVersionMigration 的对象 + +#### HTTP 请求 + +GET /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations + + +#### 参数 + +- **allowWatchBookmarks** (**查询参数**): boolean + + }}">allowWatchBookmarks + +- **continue** (**查询参数**): string + + }}">continue + +- **fieldSelector** (**查询参数**): string + + }}">fieldSelector + +- **labelSelector** (**查询参数**): string + + }}">labelSelector + +- **limit** (**查询参数**): integer + + }}">limit + +- **pretty** (**查询参数**): string + + }}">pretty + +- **resourceVersion** (**查询参数**): string + + }}">resourceVersion + +- **resourceVersionMatch** (**查询参数**): string + + }}">resourceVersionMatch + +- **sendInitialEvents** (**查询参数**): boolean + + }}">sendInitialEvents + +- **timeoutSeconds** (**查询参数**): integer + + }}">timeoutSeconds + +- **watch** (**查询参数**): boolean + + }}">watch + + +#### 响应 + +200 (}}">StorageVersionMigrationList): OK + +401: Unauthorized + + +### `create` 创建 StorageVersionMigration + +#### HTTP 请求 + +POST /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations + + +#### 参数 + +- **body**: }}">StorageVersionMigration,必需 + +- **dryRun** (**查询参数**): string + + }}">dryRun + +- **fieldManager** (**查询参数**): string + + }}">fieldManager + +- **fieldValidation** (**查询参数**): string + + }}">fieldValidation + +- **pretty** (**查询参数**): string + + }}">pretty + + +#### 响应 + +200 (}}">StorageVersionMigration): OK + +201 (}}">StorageVersionMigration): Created + +202 (}}">StorageVersionMigration): Accepted + +401: Unauthorized + + +### `update` 替换指定的 StorageVersionMigration + +#### HTTP 请求 + +PUT /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name} + + +#### 参数 + +- **name** (**路径参数**): string,必需 + + StorageVersionMigration 的名称。 + +- **body**: }}">StorageVersionMigration,必需 + +- **dryRun** (**查询参数**): string + + }}">dryRun + +- **fieldManager** (**查询参数**): string + + }}">fieldManager + +- **fieldValidation** (**查询参数**): string + + }}">fieldValidation + +- **pretty** (**查询参数**): string + + }}">pretty + + +#### 响应 + +200 (}}">StorageVersionMigration): OK + +201 (}}">StorageVersionMigration): Created + +401: Unauthorized + + +### `update` 替换指定 StorageVersionMigration 的状态 + +#### HTTP 请求 + +PUT /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name}/status + + +#### 参数 + +- **name** (**路径参数**): string,必需 + + StorageVersionMigration 的名称。 + +- **body**: }}">StorageVersionMigration,必需 + +- **dryRun** (**查询参数**): string + + }}">dryRun + +- **fieldManager** (**查询参数**): string + + }}">fieldManager + +- **fieldValidation** (**查询参数**): string + + }}">fieldValidation + +- **pretty** (**查询参数**): string + + }}">pretty + + +#### 响应 + +200 (}}">StorageVersionMigration): OK + +201 (}}">StorageVersionMigration): Created + +401: Unauthorized + + +### `patch` 部分更新指定的 StorageVersionMigration + +#### HTTP 请求 + +PATCH /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name} + + +#### 参数 + +- **name** (**路径参数**): string,必需 + + StorageVersionMigration 的名称。 + +- **body**: }}">Patch,必需 + +- **dryRun** (**查询参数**): string + + }}">dryRun + +- **fieldManager** (**查询参数**): string + + }}">fieldManager + +- **fieldValidation** (**查询参数**): string + + }}">fieldValidation + +- **force** (**查询参数**): boolean + + }}">force + +- **pretty** (**查询参数**): string + + }}">pretty + + +#### 响应 + +200 (}}">StorageVersionMigration): OK + +201 (}}">StorageVersionMigration): Created + +401: Unauthorized + + +### `patch` 部分更新指定 StorageVersionMigration 的状态 + +#### HTTP 请求 + +PATCH /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name}/status + + +#### 参数 + +- **name** (**路径参数**): string,必需 + + StorageVersionMigration 的名称。 + +- **body**: }}">Patch,必需 + +- **dryRun** (**查询参数**): string + + }}">dryRun + +- **fieldManager** (**查询参数**): string + + }}">fieldManager + +- **fieldValidation** (**查询参数**): string + + }}">fieldValidation + +- **force** (**查询参数**): boolean + + }}">force + +- **pretty** (**查询参数**): string + + }}">pretty + + +#### 响应 + +200 (}}">StorageVersionMigration): OK + +201 (}}">StorageVersionMigration): Created + +401: Unauthorized + + +### `delete` 删除 StorageVersionMigration + +#### HTTP 请求 + +DELETE /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations/{name} + + +#### 参数 + +- **name** (**路径参数**): string,必需 + + StorageVersionMigration 的名称。 + +- **body**: }}">DeleteOptions + +- **dryRun** (**查询参数**): string + + }}">dryRun + +- **gracePeriodSeconds** (**查询参数**): integer + + }}">gracePeriodSeconds + +- **pretty** (**查询参数**): string + + }}">pretty + +- **propagationPolicy** (**查询参数**): string + + }}">propagationPolicy + + +#### 响应 + +200 (}}">Status): OK + +202 (}}">Status): Accepted + +401: Unauthorized + + +### `deletecollection` 删除 StorageVersionMigration 的集合 + +#### HTTP 请求 + +DELETE /apis/storagemigration.k8s.io/v1alpha1/storageversionmigrations + + +#### 参数 + +- **body**: }}">DeleteOptions + +- **continue** (**查询参数**): string + + }}">continue + +- **dryRun** (**查询参数**): string + + }}">dryRun + +- **fieldSelector** (**查询参数**): string + + }}">fieldSelector + +- **gracePeriodSeconds** (**查询参数**): integer + + }}">gracePeriodSeconds + +- **labelSelector** (**查询参数**): string + + }}">labelSelector + +- **limit** (**查询参数**): integer + + }}">limit + +- **pretty** (**查询参数**): string + + }}">pretty + +- **propagationPolicy** (**查询参数**): string + + }}">propagationPolicy + +- **resourceVersion** (**查询参数**): string + + }}">resourceVersion + +- **resourceVersionMatch** (**查询参数**): string + + }}">resourceVersionMatch + +- **sendInitialEvents** (**查询参数**): boolean + + }}">sendInitialEvents + +- **timeoutSeconds** (**查询参数**): integer + + }}">timeoutSeconds + + +#### 响应 + +200 (}}">Status): OK + +401: Unauthorized