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.8.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

1.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

1.19.2.2.1. 描述

创建 ClusterManagementAddOn。

1.19.2.2.2. 参数

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
Body	body 必需	描述要创建的 ClusterManagementAddon 绑定的参数。	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. 请求正文

{
  "apiVersion": "addon.open-cluster-management.io/v1alpha1",
  "kind": "ClusterManagementAddOn",
  "metadata": {
    "name": "helloworld"
  },
  "spec": {
    "supportedConfigs": [
      {
        "defaultConfig": {
          "name": "deploy-config",
          "namespace": "open-cluster-management-hub"
        },
        "group": "addon.open-cluster-management.io",
        "resource": "addondeploymentconfigs"
      }
    ]
  },
  "status" : { }
}

1.19.2.3. 查询单个 ClusterManagementAddOn

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 required	要查询的 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}

1.19.2.4.1. 描述

删除单个 ClusterManagementAddOn。

1.19.2.4.2. 参数

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	clustermanagementaddon_name required	要删除的 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 的元数据。	对象
spec 必需	ClusterManagementAddOn 的规格。	spec

spec

Name	描述	模式
addOnMeta optional	AddOnMeta 是对附加组件的元数据信息的引用。	addOnMeta
supportedConfigs 可选	SupportedConfigs 是附加组件支持的配置类型列表。	configMeta 数组

addOnMeta

Name	描述	模式
displayName 可选	表示显示的附加组件名称。	字符串
description 可选	代表附加组件的详细描述。	字符串

configMeta

Name	描述	模式
group 可选	附加组件配置的组。	字符串
resource 必需	附加组件配置的资源。	字符串
defaultConfig 必需	代表默认附加组件配置的命名空间和名称。这是所有附加组件都有相同的配置的位置。	configReferent

configReferent

Name	描述	模式
namespace 可选	附加组件配置的命名空间。如果没有设置此字段，则配置是 cluster-scope。	字符串
name 必需	附加组件配置的名称。	字符串