1.9. Helm API

1.9.1. 概述

本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的 HelmRelease 资源相关的 API 信息。HelmRelease 有 4 个可用的请求：create、query、delete 和 update。

1.9.1.1. 版本信息

版本 : 2.8.0

1.9.1.2. URI scheme

BasePath : /kubernetes/apis
Schemes : HTTPS

1.9.1.3. Tags

helmreleases.apps.open-cluster-management.io : 创建和管理 helmreleases

1.9.2. 路径

1.9.2.1. 创建 helmrelease

POST /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases

1.9.2.1.1. 描述

创建 helmrelease。

1.9.2.1.2. 参数

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串
Body	body 必需	描述要创建的 helmrelease 的参数。	HelmRelease

1.9.2.1.3. 响应

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.9.2.1.4. 使用

application/yaml

1.9.2.1.5. Tags

helmreleases.apps.open-cluster-management.io

1.9.2.1.6. HTTP 请求示例

1.9.2.1.6.1. 请求正文

{
  "apiVersion" : "apps.open-cluster-management.io/v1",
  "kind" : "HelmRelease",
  "metadata" : {
    "name" : "nginx-ingress",
    "namespace" : "default"
  },
  "repo" : {
    "chartName" : "nginx-ingress",
    "source" : {
      "helmRepo" : {
        "urls" : [ "https://kubernetes-charts.storage.googleapis.com/nginx-ingress-1.26.0.tgz" ]
      },
      "type" : "helmrepo"
    },
    "version" : "1.26.0"
  },
  "spec" : {
    "defaultBackend" : {
      "replicaCount" : 3
    }
  }
}

1.9.2.2. 查询所有 helmreleases

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases

1.9.2.2.1. 描述

查询您的 helmreleases 获取更多详细信息。

1.9.2.2.2. 参数

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.9.2.2.3. 响应

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.9.2.2.4. 使用

application/yaml

1.9.2.2.5. Tags

helmreleases.apps.open-cluster-management.io

1.9.2.3. 查询单个 helmrelease

GET /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}

1.9.2.3.1. 描述

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

1.9.2.3.2. 参数

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	helmrelease_name 必需	要查询的 helmrelease 的名称。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.9.2.3.3. 响应

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.9.2.3.4. Tags

helmreleases.apps.open-cluster-management.io

1.9.2.4. 删除 helmrelease

DELETE /apps.open-cluster-management.io/v1/namespaces/{namespace}/helmreleases/{helmrelease_name}

1.9.2.4.1. 参数

类型	Name	描述	模式
标头	COOKIE 必需	身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。	字符串
路径	helmrelease_name 必需	要删除的 helmrelease 的名称。	字符串
路径	namespace 必需	要使用的命名空间，如 default。	字符串

1.9.2.4.2. 响应

HTTP 代码	描述	模式
200	成功	无内容
403	禁止访问	无内容
404	未找到资源	无内容
500	内部服务错误	无内容
503	服务不可用	无内容

1.9.2.4.3. Tags

helmreleases.apps.open-cluster-management.io

1.9.3. 定义

1.9.3.1. HelmRelease

Name	模式
apiVersion 必需	字符串
kind 必需	字符串
metadata 必需	对象
repo 必需	repo
spec 必需	对象
status 必需	status

repo

Name	模式
chartName 可选	字符串
configMapRef 可选	configMapRef
secretRef 可选	secretRef
source 可选	source
version 可选	字符串

configMapRef

Name	模式
apiVersion 可选	字符串
fieldPath 可选	字符串
kind 可选	字符串
name 可选	字符串
namespace 可选	字符串
resourceVersion 可选	字符串
uid 可选	字符串

secretRef

Name	模式
apiVersion 可选	字符串
fieldPath 可选	字符串
kind 可选	字符串
name 可选	字符串
namespace 可选	字符串
resourceVersion 可选	字符串
uid 可选	字符串

source

Name	模式
github 可选	github
helmRepo 可选	helmRepo
type 可选	字符串

github

Name	模式
branch 可选	字符串
chartPath 可选	字符串
urls 可选	字符串数组

helmRepo

Name	模式
urls 可选	字符串数组

status

Name	模式
conditions 必需	conditions 数组
deployedRelease 可选	deployedRelease

conditions

Name	模式
lastTransitionTime 可选	字符串（date-time）
message 可选	字符串
reason 可选	字符串
status 必需	字符串
type 必需	字符串

deployedRelease

Name	模式
manifest 可选	字符串
name 可选	字符串