红帽全球峰会1.19. ClusterManagementAddOn API (v1alpha1)
1.19.1. 概述
本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 ClusterManagementAddOn 资源相关的 API 信息。ClusterManagementAddOn 资源有 4 个可用的请求：create、query、delete 和 update。
ClusterManagementAddOn 代表集群管理器的附加组件注册。此资源允许用户发现哪些附加组件可用于集群管理器，并提供有关附加组件的元数据信息。此资源还提供对 ManagedClusterAddOn 的引用，即用于命名空间范围的 ManagedClusterAddOn 资源的 ClusterManagementAddOn 资源的名称。ClusterManagementAddOn 是一个集群范围的资源。
1.19.1.1. 版本信息
版本 : 2.9.0
1.19.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.19.1.3. Tags
- addon.open-cluster-management.io：创建和管理 ClusterManagementAddOns
1.19.2. 路径
1.19.2.1. 查询所有 ClusterManagementAddOns
GET /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons
GET /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons1.19.2.1.1. 描述
查询 ClusterManagementAddOns 获取更多详细信息。
1.19.2.1.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
1.19.2.1.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.19.2.1.4. 使用
-
clustermanagementaddon/yaml
1.19.2.1.5. Tags
- addon.open-cluster-management.io
1.19.2.2. 创建 ClusterManagementAddOn
POST /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons
POST /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons1.19.2.2.1. 描述
创建 ClusterManagementAddOn。
1.19.2.2.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| Body |
body | 描述要创建的 ClusterManagementAddon 绑定的参数。 |
1.19.2.2.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.19.2.2.4. 使用
-
clustermanagementaddon/yaml
1.19.2.2.5. Tags
- addon.open-cluster-management.io
1.19.2.2.6. HTTP 请求示例
1.19.2.2.6.1. 请求正文
1.19.2.3. 查询单个 ClusterManagementAddOn
GET /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons/{clustermanagementaddon_name}
GET /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons/{clustermanagementaddon_name}1.19.2.3.1. 描述
查询单个 ClusterManagementAddOn 获取更多详细信息。
1.19.2.3.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
clustermanagementaddon_name | 要查询的 ClusterManagementAddOn 的名称。 | 字符串 |
1.19.2.3.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.19.2.3.4. Tags
- addon.open-cluster-management.io
1.19.2.4. 删除 ClusterManagementAddOn
DELETE /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons/{clustermanagementaddon_name}
DELETE /addon.open-cluster-management.io/v1alpha1/clustermanagementaddons/{clustermanagementaddon_name}1.19.2.4.1. 描述
删除单个 ClusterManagementAddOn。
1.19.2.4.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
clustermanagementaddon_name | 要删除的 ClusterManagementAddOn 的名称。 | 字符串 |
1.19.2.4.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.19.2.4.4. Tags
- addon.open-cluster-management.io
1.19.3. 定义
1.19.3.1. ClusterManagementAddOn
| Name | 描述 | 模式 |
|---|---|---|
|
apiVersion | ClusterManagementAddOn 的版本化模式。 | 字符串 |
|
kind | 代表 REST 资源的字符串值。 | 字符串 |
|
metadata | ClusterManagementAddOn 的元数据。 | object |
|
spec | ClusterManagementAddOn 的规格。 |
spec
| Name | 描述 | 模式 |
|---|---|---|
|
addOnMeta | AddOnMeta 是对附加组件的元数据信息的引用。 | |
|
supportedConfigs | SupportedConfigs 是附加组件支持的配置类型列表。 | configMeta 数组 |
addOnMeta
| Name | 描述 | 模式 |
|---|---|---|
|
displayName | 表示显示的附加组件名称。 | 字符串 |
|
description | 代表附加组件的详细描述。 | 字符串 |
configMeta
| Name | 描述 | 模式 |
|---|---|---|
|
group | 附加组件配置的组。 | 字符串 |
|
resource | 附加组件配置的资源。 | 字符串 |
|
defaultConfig | 代表默认附加组件配置的命名空间和名称。这是所有附加组件都有相同的配置的位置。 |
configReferent
| Name | 描述 | 模式 |
|---|---|---|
|
namespace | 附加组件配置的命名空间。如果没有设置此字段，则配置是 cluster-scope。 | 字符串 |
|
name | 附加组件配置的名称。 | 字符串 |
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}