搜索

1.20. ManagedClusterAddOn API (v1alpha1)

download PDF

1.20.1. 概述

本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 ManagedClusterAddOn 资源相关的 API 信息。ManagedClusterAddOn 资源有 4 个可用的请求:create、query、delete 和 update。ManagedClusterAddOn 是包含附加组件当前状态的自定义资源对象。此资源应该在 ManagedCluster 命名空间中创建。

1.20.1.1. 版本信息

版本 : 2.10.0

1.20.1.2. URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

1.20.1.3. Tags

  • addon.open-cluster-management.io:创建和管理 ManagedClusterAddOns

1.20.2. 路径

1.20.2.1. 查询所有 ManagedClusterAddOns

GET /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons
1.20.2.1.1. 描述

查询 ManagedClusterAddOns 获取更多详细信息。

1.20.2.1.2. 参数
类型Name描述模式

标头

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

1.20.2.1.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.20.2.1.4. 使用
  • managedclusteraddon/yaml
1.20.2.1.5. Tags
  • addon.open-cluster-management.io

1.20.2.2. 创建 ManagedClusterAddOn

POST /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons
1.20.2.2.1. 描述

创建 ManagedClusterAddOn。

1.20.2.2.2. 参数
类型Name描述模式

标头

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

Body

body
必需

描述要创建的 ManagedClusterAddOn 绑定的参数。

ManagedClusterAddOn

1.20.2.2.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.20.2.2.4. 使用
  • managedclusteraddon/yaml
1.20.2.2.5. Tags
  • addon.open-cluster-management.io
1.20.2.2.6. HTTP 请求示例
1.20.2.2.6.1. 请求正文
{
  "apiVersion": "addon.open-cluster-management.io/v1alpha1",
  "kind": "ManagedClusterAddOn",
  "metadata": {
    "name": "helloworld",
    "namespace": "cluster1"
  },
  "spec": {
    "configs": [
      {
        "group": "addon.open-cluster-management.io",
        "name": "cluster-deploy-config",
        "namespace": "open-cluster-management-hub",
        "resource": "addondeploymentconfigs"
      }
    ],
    "installNamespace": "default"
  },
 "status" : { }
}

1.20.2.3. 查询单个 ManagedClusterAddOn

GET /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons/{managedclusteraddon_name}
1.20.2.3.1. 描述

查询单个 ManagedClusterAddOn 获取更多详细信息。

1.20.2.3.2. 参数
类型Name描述模式

标头

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

managedclusteraddon_name
必需

要查询的 ManagedClusterAddOn 的名称。

字符串

1.20.2.3.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.20.2.3.4. Tags
  • addon.open-cluster-management.io

1.20.2.4. 删除 ManagedClusterAddOn

DELETE /addon.open-cluster-management.io/v1alpha1/namespaces/{namespace}/managedclusteraddons/{managedclusteraddon_name}
1.20.2.4.1. 描述

删除单个 ManagedClusterAddOn。

1.20.2.4.2. 参数
类型Name描述模式

标头

COOKIE
必需

身份验证:Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。

字符串

路径

managedclusteraddon_name
必需

要删除的 ManagedClusterAddOn 的名称。

字符串

1.20.2.4.3. 响应
HTTP 代码描述模式

200

成功

无内容

403

禁止访问

无内容

404

未找到资源

无内容

500

内部服务错误

无内容

503

服务不可用

无内容

1.20.2.4.4. Tags
  • addon.open-cluster-management.io

1.20.3. 定义

1.20.3.1. ManagedClusterAddOn

Name描述模式

apiVersion
必需

ManagedClusterAddOn 的版本化模式。

字符串

kind
必需

代表 REST 资源的字符串值。

字符串

metadata
必需

ManagedClusterAddOn 的元数据。

object

spec
必需

ManagedClusterAddOn 的规格。

spec

spec

Name描述模式

installNamespace
可选

受管集群上的命名空间,用于安装附加组件代理。如果没有设置,则使用 open-cluster-management-agent-addon 命名空间来安装附加组件代理。

字符串

configs
可选

当前附加组件有其自身配置的附加组件配置列表。

addOnConfig 数组

addOnConfig

Name描述模式

group
可选

附加组件配置的组。

字符串

resource
必需

附加组件配置的资源。

字符串

namespace
可选

附加组件配置的命名空间。如果没有设置此字段,则配置是 cluster-scope。

字符串

name
必需

附加组件配置的名称。

字符串

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.