HelmChartRepository [helm.openshift.io/v1beta1] - 配置 API | API 参考 | OpenShift Container Platform 4.17

规格
API 端点

描述

HelmChartRepository 保存集群范围内的代理 Helm 图表存储库配置兼容性级别 2：在主要版本中至少稳定 9 个月或 3 个次要版本（以较长者为准）。

类型

对象

必需

spec

规格

属性类型描述

属性	类型	描述
`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`	`对象`	集群中存储库的观察到的状态。

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 可用于显示目的

connectionConfig

对象

连接到图表存储库所需的配置

description

字符串

可选的人类可读存储库描述，UI 可用于显示目的

disabled

布尔值

如果设置为 true，则禁用集群/命名空间中的存储库使用

name

字符串

可选的关联人类可读存储库名称，UI 可用于显示目的

.spec.connectionConfig

描述: 连接到图表存储库所需的配置
类型: 对象

属性类型描述

属性	类型	描述
`ca`	`对象`	ca 是对包含 PEM 编码的 CA 捆绑包的 ConfigMap 的可选引用，名称为。它用作信任锚点，以验证远程服务器提供的 TLS 证书。“ca-bundle.crt”键用于查找数据。如果为空，则使用默认系统根。此 ConfigMap 的命名空间为 openshift-config。
`tlsClientConfig`	`对象`	tlsClientConfig 是对包含 PEM 编码的 TLS 客户端证书和私钥的 Secret 的可选引用，在连接到服务器时将呈现这些证书和私钥。“tls.crt”键用于查找客户端证书。“tls.key”键用于查找私钥。此 Secret 的命名空间为 openshift-config。
`url`	`字符串`	图表存储库 URL

ca

对象

ca 是对包含 PEM 编码的 CA 捆绑包的 ConfigMap 的可选引用，名称为。它用作信任锚点，以验证远程服务器提供的 TLS 证书。“ca-bundle.crt”键用于查找数据。如果为空，则使用默认系统根。此 ConfigMap 的命名空间为 openshift-config。

tlsClientConfig

对象

tlsClientConfig 是对包含 PEM 编码的 TLS 客户端证书和私钥的 Secret 的可选引用，在连接到服务器时将呈现这些证书和私钥。“tls.crt”键用于查找客户端证书。“tls.key”键用于查找私钥。此 Secret 的命名空间为 openshift-config。

url

字符串

图表存储库 URL

.spec.connectionConfig.ca

描述

类型

对象

必需

name

属性类型描述

属性	类型	描述
`name`	`字符串`	name 是引用的 ConfigMap 的 metadata.name

name

字符串

name 是引用的 ConfigMap 的 metadata.name

.spec.connectionConfig.tlsClientConfig

描述

类型

对象

必需

name

属性类型描述

属性	类型	描述
`name`	`字符串`	name 是引用的 Secret 的 metadata.name

name

字符串

name 是引用的 Secret 的 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"` // 其他字段 }

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[]

描述

类型

对象

必需

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)

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/helmchartrepositories
- DELETE：删除 HelmChartRepository 集合
- GET：列出 HelmChartRepository 对象
- POST：创建一个 HelmChartRepository
/apis/helm.openshift.io/v1beta1/helmchartrepositories/{name}
- DELETE：删除一个 HelmChartRepository
- GET：读取指定的 HelmChartRepository
- PATCH：部分更新指定的 HelmChartRepository
- PUT：替换指定的 HelmChartRepository
/apis/helm.openshift.io/v1beta1/helmchartrepositories/{name}/status
- GET：读取指定的 HelmChartRepository 的状态
- PATCH：部分更新指定的 HelmChartRepository 的状态
- PUT：替换指定的 HelmChartRepository 的状态

/apis/helm.openshift.io/v1beta1/helmchartrepositories

HTTP 方法: DELETE
描述: 删除 HelmChartRepository 集合

表 1. HTTP 响应
HTTP 代码	响应体
200 - OK	`Status` 模式
401 - 未授权	空

HTTP 方法: GET
描述: 列出 HelmChartRepository 对象

表 2. HTTP 响应
HTTP 代码	响应体
200 - OK	`HelmChartRepositoryList` 模式
401 - 未授权	空

HTTP 方法: POST
描述: 创建一个 HelmChartRepository

表 3. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍将成功，并且只会保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict：如果要从对象中删除任何未知字段，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 4. 请求体参数
参数	类型	描述
`body`	`HelmChartRepository` 模式

表 5. HTTP 响应
HTTP 代码	响应体
200 - OK	`HelmChartRepository` 模式
201 - 已创建	`HelmChartRepository` 模式
202 - 已接受	`HelmChartRepository` 模式
401 - 未授权	空

/apis/helm.openshift.io/v1beta1/helmchartrepositories/{name}

表 6. 全局路径参数
参数	类型	描述
`name`	`字符串`	HelmChartRepository 的名称

HTTP 方法: DELETE
描述: 删除一个 HelmChartRepository

表 7. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

表 8. HTTP 响应
HTTP 代码	响应体
200 - OK	`Status` 模式
202 - 已接受	`Status` 模式
401 - 未授权	空

HTTP 方法: GET
描述: 读取指定的 HelmChartRepository

表 9. HTTP 响应
HTTP 代码	响应体
200 - OK	`HelmChartRepository` 模式
401 - 未授权	空

HTTP 方法: PATCH
描述: 部分更新指定的 HelmChartRepository

表 10. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍将成功，并且只会保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict：如果要从对象中删除任何未知字段，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 11. HTTP 响应
HTTP 代码	响应体
200 - OK	`HelmChartRepository` 模式
401 - 未授权	空

HTTP 方法: PUT
描述: 替换指定的 HelmChartRepository

表 12. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍将成功，并且只会保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict：如果要从对象中删除任何未知字段，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 13. 请求体参数
参数	类型	描述
`body`	`HelmChartRepository` 模式

表 14. HTTP 响应
HTTP 代码	响应体
200 - OK	`HelmChartRepository` 模式
201 - 已创建	`HelmChartRepository` 模式
401 - 未授权	空

/apis/helm.openshift.io/v1beta1/helmchartrepositories/{name}/status

表 15. 全局路径参数
参数	类型	描述
`name`	`字符串`	HelmChartRepository 的名称

HTTP 方法: GET
描述: 读取指定的 HelmChartRepository 的状态

表 16. HTTP 响应
HTTP 代码	响应体
200 - OK	`HelmChartRepository` 模式
401 - 未授权	空

HTTP 方法: PATCH
描述: 部分更新指定的 HelmChartRepository 的状态

表 17. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍将成功，并且只会保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict：如果要从对象中删除任何未知字段，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 18. HTTP 响应
HTTP 代码	响应体
200 - OK	`HelmChartRepository` 模式
401 - 未授权	空

HTTP 方法: PUT
描述: 替换指定的 HelmChartRepository 的状态

表 19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略从对象中静默删除的任何未知字段，并将忽略解码器遇到的最后一个重复字段以外的所有重复字段。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍将成功，并且只会保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict：如果要从对象中删除任何未知字段，或者存在任何重复字段，这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 20. 请求体参数
参数	类型	描述
`body`	`HelmChartRepository` 模式

表 21. HTTP 响应
HTTP 代码	响应体
200 - OK	`HelmChartRepository` 模式
201 - 已创建	`HelmChartRepository` 模式
401 - 未授权	空