×

规范

属性 类型 描述

apiVersion

字符串

APIVersion定义此对象表示的版本化模式。服务器应将识别的模式转换为最新的内部值,并可能拒绝无法识别的值。更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

Kind是表示此对象表示的REST资源的字符串值。服务器可以从客户端提交请求的端点推断出这一点。不能更新。使用驼峰式命名法。更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

标准对象的元数据。更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

对象

spec包含用户可设置的配置值

status

对象

命名空间内库的观察状态。

.spec

描述

spec包含用户可设置的配置值

类型

对象

属性 类型 描述

connectionConfig

对象

连接到图表库所需的配置

description

字符串

可选的人类可读存储库描述,UI 可以使用它来显示。

disabled

布尔值

如果设置为true,则禁用命名空间中库的使用

name

字符串

可选的关联人类可读存储库名称,UI 可以使用它来显示。

.spec.connectionConfig

描述

连接到图表库所需的配置

类型

对象

属性 类型 描述

basicAuthConfig

对象

basicAuthConfig 是对名称为密钥的可选引用,其中包含连接到服务器时要提供的基本身份验证凭据。密钥“username”用于查找用户名。“password”密钥用于查找密码。此密钥的命名空间必须与实例化项目 helm 图表库的命名空间相同。

ca

对象

ca 是对名称为 config map 的可选引用,其中包含 PEM 编码的 CA 捆绑包。它用作信任锚点,用于验证远程服务器提供的 TLS 证书。“ca-bundle.crt”密钥用于查找数据。如果为空,则使用默认系统根。此 configmap 的命名空间必须与实例化项目 helm 图表库的命名空间相同。

tlsClientConfig

对象

tlsClientConfig 是一个可选的密钥引用,其名称包含 PEM 编码的 TLS 客户端证书和私钥,用于连接到服务器时进行身份验证。密钥 "tls.crt" 用于定位客户端证书。密钥 "tls.key" 用于定位私钥。此密钥的命名空间必须与项目 Helm Chart 仓库实例化的命名空间相同。

url

字符串

Chart 仓库 URL

.spec.connectionConfig.basicAuthConfig

描述

basicAuthConfig 是对名称为密钥的可选引用,其中包含连接到服务器时要提供的基本身份验证凭据。密钥“username”用于查找用户名。“password”密钥用于查找密码。此密钥的命名空间必须与实例化项目 helm 图表库的命名空间相同。

类型

对象

必需
  • name

属性 类型 描述

name

字符串

name 是引用的密钥的 metadata.name

.spec.connectionConfig.ca

描述

ca 是对名称为 config map 的可选引用,其中包含 PEM 编码的 CA 捆绑包。它用作信任锚点,用于验证远程服务器提供的 TLS 证书。“ca-bundle.crt”密钥用于查找数据。如果为空,则使用默认系统根。此 configmap 的命名空间必须与实例化项目 helm 图表库的命名空间相同。

类型

对象

必需
  • name

属性 类型 描述

name

字符串

name 是引用的 ConfigMap 的 metadata.name

.spec.connectionConfig.tlsClientConfig

描述

tlsClientConfig 是一个可选的密钥引用,其名称包含 PEM 编码的 TLS 客户端证书和私钥,用于连接到服务器时进行身份验证。密钥 "tls.crt" 用于定位客户端证书。密钥 "tls.key" 用于定位私钥。此密钥的命名空间必须与项目 Helm Chart 仓库实例化的命名空间相同。

类型

对象

必需
  • name

属性 类型 描述

name

字符串

name 是引用的密钥的 metadata.name

.status

描述

命名空间内库的观察状态。

类型

对象

属性 类型 描述

conditions

数组

conditions 是一个包含条件及其状态的列表。

conditions[]

对象

Condition 包含此 API 资源当前状态的一个方面的详细信息。--- 此结构旨在直接用作字段路径 .status.conditions 中的数组。例如,类型 FooStatus struct{ // 表示对 foo 的当前状态的观察。 // 已知的 .status.conditions.type 为:“Available”、“Progressing”和“Degraded” // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // 其他字段 }

.status.conditions

描述

conditions 是一个包含条件及其状态的列表。

类型

数组

.status.conditions[]

描述

Condition 包含此 API 资源当前状态的一个方面的详细信息。--- 此结构旨在直接用作字段路径 .status.conditions 中的数组。例如,类型 FooStatus struct{ // 表示对 foo 的当前状态的观察。 // 已知的 .status.conditions.type 为:“Available”、“Progressing”和“Degraded” // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // 其他字段 }

类型

对象

必需
  • lastTransitionTime

  • message

  • reason

  • status

  • type

属性 类型 描述

lastTransitionTime

字符串

lastTransitionTime 是条件从一种状态转换到另一种状态的最后时间。这应该是底层条件发生变化的时间。如果不知道,则使用 API 字段发生变化的时间是可以接受的。

message

字符串

message 是一个易于理解的消息,指示有关转换的详细信息。这可能是空字符串。

observedGeneration

整数

observedGeneration 表示根据其设置条件的 .metadata.generation。例如,如果 .metadata.generation 当前为 12,但 .status.conditions[x].observedGeneration 为 9,则该条件相对于实例的当前状态已过期。

reason

字符串

reason 包含一个程序化标识符,指示条件最后转换的原因。特定条件类型的生产者可以为此字段定义预期的值和含义,以及是否将这些值视为保证的 API。该值应为驼峰式字符串。此字段不能为空。

status

字符串

条件的状态,True、False 或 Unknown 之一。

type

字符串

条件类型,采用驼峰式命名法或 foo.example.com/CamelCase 格式。--- 许多 .condition.type 值在资源(如 Available)之间是一致的,但由于任意条件可能很有用(见 .node.status.conditions),因此消除冲突的能力非常重要。它匹配的正则表达式为 (dns1123SubdomainFmt/)?(qualifiedNameFmt)

API 端点

提供以下 API 端点:

  • /apis/helm.openshift.io/v1beta1/projecthelmchartrepositories

    • GET:列出 ProjectHelmChartRepository 类型的对象

  • /apis/helm.openshift.io/v1beta1/namespaces/{namespace}/projecthelmchartrepositories

    • DELETE:删除 ProjectHelmChartRepository 集合

    • GET:列出 ProjectHelmChartRepository 类型的对象

    • POST:创建一个 ProjectHelmChartRepository

  • /apis/helm.openshift.io/v1beta1/namespaces/{namespace}/projecthelmchartrepositories/{name}

    • DELETE:删除一个 ProjectHelmChartRepository

    • GET:读取指定的 ProjectHelmChartRepository

    • PATCH:部分更新指定的 ProjectHelmChartRepository

    • PUT:替换指定的 ProjectHelmChartRepository

  • /apis/helm.openshift.io/v1beta1/namespaces/{namespace}/projecthelmchartrepositories/{name}/status

    • GET:读取指定的 ProjectHelmChartRepository 的状态

    • PATCH:部分更新指定的 ProjectHelmChartRepository 的状态

    • PUT:替换指定的 ProjectHelmChartRepository 的状态

/apis/helm.openshift.io/v1beta1/projecthelmchartrepositories

HTTP 方法

GET

描述

列出 ProjectHelmChartRepository 类型的对象

表 1. HTTP 响应
HTTP 代码 响应体

200 - OK

ProjectHelmChartRepositoryList 模式

401 - Unauthorized

/apis/helm.openshift.io/v1beta1/namespaces/{namespace}/projecthelmchartrepositories

HTTP 方法

DELETE

描述

删除 ProjectHelmChartRepository 集合

表 2. HTTP 响应
HTTP 代码 响应体

200 - OK

Status 模式

401 - Unauthorized

HTTP 方法

GET

描述

列出 ProjectHelmChartRepository 类型的对象

表 3. HTTP 响应
HTTP 代码 响应体

200 - OK

ProjectHelmChartRepositoryList 模式

401 - Unauthorized

HTTP 方法

POST

描述

创建一个 ProjectHelmChartRepository

表 4. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略从对象中静默删除的任何未知字段,并将忽略解码器遇到的除最后一个重复字段之外的所有重复字段。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍然会成功,并且只会保留任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,这将使请求失败并出现 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 5. 请求体参数
参数 类型 描述

body

ProjectHelmChartRepository 模式

表 6. HTTP 响应
HTTP 代码 响应体

200 - OK

ProjectHelmChartRepository 模式

201 - Created

ProjectHelmChartRepository 模式

202 - Accepted

ProjectHelmChartRepository 模式

401 - Unauthorized

/apis/helm.openshift.io/v1beta1/namespaces/{namespace}/projecthelmchartrepositories/{name}

表 7. 全局路径参数
参数 类型 描述

name

字符串

ProjectHelmChartRepository 的名称

HTTP 方法

DELETE

描述

删除一个 ProjectHelmChartRepository

表 8. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

表 9. HTTP 响应
HTTP 代码 响应体

200 - OK

Status 模式

202 - Accepted

Status 模式

401 - Unauthorized

HTTP 方法

GET

描述

读取指定的 ProjectHelmChartRepository

表 10. HTTP 响应
HTTP 代码 响应体

200 - OK

ProjectHelmChartRepository 模式

401 - Unauthorized

HTTP 方法

PATCH

描述

部分更新指定的 ProjectHelmChartRepository

表 11. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略从对象中静默删除的任何未知字段,并将忽略解码器遇到的除最后一个重复字段之外的所有重复字段。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍然会成功,并且只会保留任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,这将使请求失败并出现 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 12. HTTP 响应
HTTP 代码 响应体

200 - OK

ProjectHelmChartRepository 模式

401 - Unauthorized

HTTP 方法

PUT

描述

替换指定的 ProjectHelmChartRepository

表 13. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略从对象中静默删除的任何未知字段,并将忽略解码器遇到的除最后一个重复字段之外的所有重复字段。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍然会成功,并且只会保留任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,这将使请求失败并出现 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 14. 请求体参数
参数 类型 描述

body

ProjectHelmChartRepository 模式

表 15. HTTP 响应
HTTP 代码 响应体

200 - OK

ProjectHelmChartRepository 模式

201 - Created

ProjectHelmChartRepository 模式

401 - Unauthorized

/apis/helm.openshift.io/v1beta1/namespaces/{namespace}/projecthelmchartrepositories/{name}/status

表 16. 全局路径参数
参数 类型 描述

name

字符串

ProjectHelmChartRepository 的名称

HTTP 方法

GET

描述

读取指定的 ProjectHelmChartRepository 的状态

表 17. HTTP 响应
HTTP 代码 响应体

200 - OK

ProjectHelmChartRepository 模式

401 - Unauthorized

HTTP 方法

PATCH

描述

部分更新指定的 ProjectHelmChartRepository 的状态

表 18. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略从对象中静默删除的任何未知字段,并将忽略解码器遇到的除最后一个重复字段之外的所有重复字段。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍然会成功,并且只会保留任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,这将使请求失败并出现 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 19. HTTP 响应
HTTP 代码 响应体

200 - OK

ProjectHelmChartRepository 模式

401 - Unauthorized

HTTP 方法

PUT

描述

替换指定 ProjectHelmChartRepository 的状态

表 20. 查询参数
参数 类型 描述

dryRun

字符串

如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略从对象中静默删除的任何未知字段,并将忽略解码器遇到的除最后一个重复字段之外的所有重复字段。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍然会成功,并且只会保留任何重复字段中的最后一个。这是 v1.23+ 中的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,这将使请求失败并出现 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 21. 请求体参数
参数 类型 描述

body

ProjectHelmChartRepository 模式

表 22. HTTP 响应
HTTP 代码 响应体

200 - OK

ProjectHelmChartRepository 模式

201 - Created

ProjectHelmChartRepository 模式

401 - Unauthorized