From f97f92c92bba8513436bb2026505649c15ae6da3 Mon Sep 17 00:00:00 2001 From: windsonsea Date: Tue, 31 Dec 2024 09:19:57 +0800 Subject: [PATCH] [zh] Add resource-claim-template-v1beta1.md --- .../resource-claim-template-v1beta1.md | 868 ++++++++++++++++++ 1 file changed, 868 insertions(+) create mode 100644 content/zh-cn/docs/reference/kubernetes-api/workload-resources/resource-claim-template-v1beta1.md diff --git a/content/zh-cn/docs/reference/kubernetes-api/workload-resources/resource-claim-template-v1beta1.md b/content/zh-cn/docs/reference/kubernetes-api/workload-resources/resource-claim-template-v1beta1.md new file mode 100644 index 0000000000000..f12ea8fa4b156 --- /dev/null +++ b/content/zh-cn/docs/reference/kubernetes-api/workload-resources/resource-claim-template-v1beta1.md @@ -0,0 +1,868 @@ +--- +api_metadata: + apiVersion: "resource.k8s.io/v1beta1" + import: "k8s.io/api/resource/v1beta1" + kind: "ResourceClaimTemplate" +content_type: "api_reference" +description: "ResourceClaimTemplate 用于生成 ResourceClaim 对象。" +title: "ResourceClaimTemplate v1beta1" +weight: 17 +--- + + + + +`apiVersion: resource.k8s.io/v1beta1` + +`import "k8s.io/api/resource/v1beta1"` + +## ResourceClaimTemplate {#ResourceClaimTemplate} + + +ResourceClaimTemplate 用于生成 ResourceClaim 对象。 + +这是一个 Alpha 类型的特性，需要启用 DynamicResourceAllocation 特性门控。 + +
+ +- **apiVersion**: resource.k8s.io/v1beta1 + +- **kind**: ResourceClaimTemplate + +- **metadata** (}}">ObjectMeta) + + + 标准的对象元数据。 + + +- **spec** (}}">ResourceClaimTemplateSpec)，必需 + + 描述要生成的 ResourceClaim。 + + 该字段是不可变的。当需要时，控制平面将为 Pod 创建一个 ResourceClaim，然后不再对其进行更新。 + +## ResourceClaimTemplateSpec {#ResourceClaimTemplateSpec} + + +ResourceClaimTemplateSpec 包含针对 ResourceClaim 的元数据和字段。 + +
+ + +- **spec** (}}">ResourceClaimSpec)，必需 + + ResourceClaim 的规约。整个内容将不加修改地复制到从模板创建的 ResourceClaim 中。 + 与 ResourceClaim 中相同的字段在此处也是有效的。 + + +- **metadata** (}}">ObjectMeta) + + ObjectMeta 可以包含创建 PVC 时将要复制到其中的标签和注解。 + 不允许设置其他字段，并且即便设置了也会在验证期间被拒绝。 + +## ResourceClaimTemplateList {#ResourceClaimTemplateList} + + +ResourceClaimTemplateList 是申领模板的集合。 + +
+ +- **apiVersion**: resource.k8s.io/v1beta1 + +- **kind**: ResourceClaimTemplateList + +- **metadata** (}}">ListMeta) + + + 标准的列表元数据。 + + +- **items** ([]}}">ResourceClaimTemplate)，必需 + + items 是资源申领模板的列表。 + + +## 操作 {#Operations} + +
+ +### `get` 读取指定的 ResourceClaimTemplate + +#### HTTP 请求 + +GET /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} + + +#### 参数 + +- **name** (**路径参数**): string，必需 + + ResourceClaimTemplate 的名称。 + +- **namespace** (**路径参数**): string，必需 + + }}">namespace + +- **pretty** (**查询参数**): string + + }}">pretty + + +#### 响应 + +200 (}}">ResourceClaimTemplate): OK + +401: Unauthorized + + +### `list` 列出或监视 ResourceClaimTemplate 类别的对象 + +#### HTTP 请求 + +GET /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates + + +#### 参数 + +- **namespace** (**路径参数**): string，必需 + + }}">namespace + +- **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 (}}">ResourceClaimTemplateList): OK + +401: Unauthorized + + +### `list` 列出或监视 ResourceClaimTemplate 类别的对象 + +#### HTTP 请求 + +GET /apis/resource.k8s.io/v1beta1/resourceclaimtemplates + + +#### 参数 + +- **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 (}}">ResourceClaimTemplateList): OK + +401: Unauthorized + + +### `create` 创建 ResourceClaimTemplate + +#### HTTP 请求 + +POST /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates + + +#### 参数 + +- **namespace** (**路径参数**): string，必需 + + }}">namespace + +- **body**: }}">ResourceClaimTemplate，必需 + +- **dryRun** (**查询参数**): string + + }}">dryRun + +- **fieldManager** (**查询参数**): string + + }}">fieldManager + +- **fieldValidation** (**查询参数**): string + + }}">fieldValidation + +- **pretty** (**查询参数**): string + + }}">pretty + + +#### 响应 + +200 (}}">ResourceClaimTemplate): OK + +201 (}}">ResourceClaimTemplate): Created + +202 (}}">ResourceClaimTemplate): Accepted + +401: Unauthorized + + +### `update` 替换指定的 ResourceClaimTemplate + +#### HTTP 请求 + +PUT /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} + + +#### 参数 + +- **name** (**路径参数**): string，必需 + + ResourceClaimTemplate 的名称。 + +- **namespace** (**路径参数**): string，必需 + + }}">namespace + +- **body**: }}">ResourceClaimTemplate，必需 + +- **dryRun** (**查询参数**): string + + }}">dryRun + +- **fieldManager** (**查询参数**): string + + }}">fieldManager + +- **fieldValidation** (**查询参数**): string + + }}">fieldValidation + +- **pretty** (**查询参数**): string + + }}">pretty + + +#### 响应 + +200 (}}">ResourceClaimTemplate): OK + +201 (}}">ResourceClaimTemplate): Created + +401: Unauthorized + + +### `patch` 部分更新指定的 ResourceClaimTemplate + +#### HTTP 请求 + +PATCH /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} + + +#### 参数 + +- **name** (**路径参数**): string，必需 + + ResourceClaimTemplate 的名称。 + +- **namespace** (**路径参数**): string，必需 + + }}">namespace + +- **body**: }}">Patch，必需 + +- **dryRun** (**查询参数**): string + + }}">dryRun + +- **fieldManager** (**查询参数**): string + + }}">fieldManager + +- **fieldValidation** (**查询参数**): string + + }}">fieldValidation + +- **force** (**查询参数**): boolean + + }}">force + +- **pretty** (**查询参数**): string + + }}">pretty + + +#### 响应 + +200 (}}">ResourceClaimTemplate): OK + +201 (}}">ResourceClaimTemplate): Created + +401: Unauthorized + + +### `delete` 删除 ResourceClaimTemplate + +#### HTTP 请求 + +DELETE /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates/{name} + + +#### 参数 + +- **name** (**路径参数**): string，必需 + + ResourceClaimTemplate 的名称。 + +- **namespace** (**路径参数**): string，必需 + + }}">namespace + +- **body**: }}">DeleteOptions + +- **dryRun** (**查询参数**): string + + }}">dryRun + +- **gracePeriodSeconds** (**查询参数**): integer + + }}">gracePeriodSeconds + +- **pretty** (**查询参数**): string + + }}">pretty + +- **propagationPolicy** (**查询参数**): string + + }}">propagationPolicy + + +#### 响应 + +200 (}}">ResourceClaimTemplate): OK + +202 (}}">ResourceClaimTemplate): Accepted + +401: Unauthorized + + +### `deletecollection` 删除 ResourceClaimTemplate 的集合 + +#### HTTP 请求 + +DELETE /apis/resource.k8s.io/v1beta1/namespaces/{namespace}/resourceclaimtemplates + + +#### 参数 + +- **namespace** (**路径参数**): string，必需 + + }}">namespace + +- **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