主页
产品
Red Hat Advanced Cluster Management for Kubernetes
2.0
APIs
1.6. Helm API

1.6. Helm API

1.6.1. Overview
复制链接

This documentation is for the HelmRelease resource for Red Hat Advanced Cluster Management for Kubernetes. The HelmRelease resource has four possible requests: create, query, delete and update.

1.6.1.1. Version information
复制链接

Version : 2.0.0

1.6.1.2. Contact information
复制链接

Contact Email : apiteam@swagger.io

1.6.1.3. License information
复制链接

License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
Terms of service : http://swagger.io/terms/

1.6.1.4. URI scheme
复制链接

BasePath : /kubernetes/apis
Schemes : HTTPS

1.6.1.5. Tags
复制链接

helmreleases.apps.open-cluster-management.io : Create and manage helmreleases

1.6.1.6. External Docs
复制链接

Description : Find out more about Swagger.
URL : http://swagger.io

1.6.2. Paths
复制链接

1.6.2.1. Create a helmrelease
复制链接

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

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

Copy to Clipboard

Toggle word wrap

1.6.2.1.1. Description
复制链接

Create a helmrelease.

1.6.2.1.2. Parameters
复制链接

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string
Body	body required	Parameters describing the helmrelease to be created.	HelmRelease

1.6.2.1.3. Responses
复制链接

Expand

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

1.6.2.1.4. Consumes
复制链接

application/yaml

1.6.2.1.5. Tags
复制链接

helmreleases.apps.open-cluster-management.io

1.6.2.1.6. Example HTTP request
复制链接

1.6.2.1.6.1. Request body
复制链接

{
  "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
    }
  }
}

{
  "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
    }
  }
}

Copy to Clipboard

Toggle word wrap

1.6.2.2. Query all helmreleases
复制链接

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

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

Copy to Clipboard

Toggle word wrap

1.6.2.2.1. Description
复制链接

Query your helmreleases for more details.

1.6.2.2.2. Parameters
复制链接

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

1.6.2.2.3. Responses
复制链接

Expand

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

1.6.2.2.4. Consumes
复制链接

application/yaml

1.6.2.2.5. Tags
复制链接

helmreleases.apps.open-cluster-management.io

1.6.2.3. Query a single helmrelease
复制链接

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

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

Copy to Clipboard

Toggle word wrap

1.6.2.3.1. Description
复制链接

Query a single helmrelease for more details.

1.6.2.3.2. Parameters
复制链接

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	helmrelease_name required	Name of the helmrelease that you wan to query.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

1.6.2.3.3. Responses
复制链接

Expand

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

1.6.2.3.4. Tags
复制链接

helmreleases.apps.open-cluster-management.io

1.6.2.4. Delete a helmrelease
复制链接

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

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

Copy to Clipboard

Toggle word wrap

1.6.2.4.1. Parameters
复制链接

Expand

Type	Name	Description	Schema
Header	COOKIE required	Authorization: Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN is the user access token.	string
Path	helmrelease_name required	Name of the helmrelease that you want to delete.	string
Path	namespace required	Namespace that you want to use, for example, default.	string

1.6.2.4.2. Responses
复制链接

Expand

HTTP Code	Description	Schema
200	Success	No Content
403	Access forbidden	No Content
404	Resource not found	No Content
500	Internal service error	No Content
503	Service unavailable	No Content

1.6.2.4.3. Tags
复制链接

helmreleases.apps.open-cluster-management.io

1.6.3. Definitions
复制链接

1.6.3.1. HelmRelease
复制链接

Expand

Name	Schema
apiVersion required	string
kind required	string
metadata required	object
repo required	repo
spec required	object
status required	status

repo

Expand

Name	Schema
chartName optional	string
configMapRef optional	configMapRef
secretRef optional	secretRef
source optional	source
version optional	string

configMapRef

Expand

Name	Schema
apiVersion optional	string
fieldPath optional	string
kind optional	string
name optional	string
namespace optional	string
resourceVersion optional	string
uid optional	string

secretRef

Expand

Name	Schema
apiVersion optional	string
fieldPath optional	string
kind optional	string
name optional	string
namespace optional	string
resourceVersion optional	string
uid optional	string

source

Expand

Name	Schema
github optional	github
helmRepo optional	helmRepo
type optional	string

github

Expand

Name	Schema
branch optional	string
chartPath optional	string
urls optional	< string > array

helmRepo

Expand

Name	Schema
urls optional	< string > array

status

Expand

Name	Schema
conditions required	< conditions > array
deployedRelease optional	deployedRelease

conditions

Expand

Name	Schema
lastTransitionTime optional	string (date-time)
message optional	string
reason optional	string
status required	string
type required	string

deployedRelease

Expand

Name	Schema
manifest optional	string
name optional	string

返回顶部

1.6. Helm API

1.6.1. Overview复制链接链接已复制到粘贴板!

1.6.1.1. Version information复制链接链接已复制到粘贴板!

1.6.1.2. Contact information复制链接链接已复制到粘贴板!

1.6.1.3. License information复制链接链接已复制到粘贴板!

1.6.1.4. URI scheme复制链接链接已复制到粘贴板!

1.6.1.5. Tags复制链接链接已复制到粘贴板!

1.6.1.6. External Docs复制链接链接已复制到粘贴板!

1.6.2. Paths复制链接链接已复制到粘贴板!

1.6.2.1. Create a helmrelease复制链接链接已复制到粘贴板!

1.6.2.1.1. Description复制链接链接已复制到粘贴板!

1.6.2.1.2. Parameters复制链接链接已复制到粘贴板!

1.6.2.1.3. Responses复制链接链接已复制到粘贴板!

1.6.2.1.4. Consumes复制链接链接已复制到粘贴板!

1.6.2.1.5. Tags复制链接链接已复制到粘贴板!

1.6.2.1.6. Example HTTP request复制链接链接已复制到粘贴板!

1.6.2.1.6.1. Request body复制链接链接已复制到粘贴板!

1.6.2.2. Query all helmreleases复制链接链接已复制到粘贴板!

1.6.2.2.1. Description复制链接链接已复制到粘贴板!

1.6.2.2.2. Parameters复制链接链接已复制到粘贴板!

1.6.2.2.3. Responses复制链接链接已复制到粘贴板!

1.6.2.2.4. Consumes复制链接链接已复制到粘贴板!

1.6.2.2.5. Tags复制链接链接已复制到粘贴板!

1.6.2.3. Query a single helmrelease复制链接链接已复制到粘贴板!

1.6.2.3.1. Description复制链接链接已复制到粘贴板!

1.6.2.3.2. Parameters复制链接链接已复制到粘贴板!

1.6.2.3.3. Responses复制链接链接已复制到粘贴板!

1.6.2.3.4. Tags复制链接链接已复制到粘贴板!

1.6.2.4. Delete a helmrelease复制链接链接已复制到粘贴板!

1.6.2.4.1. Parameters复制链接链接已复制到粘贴板!

1.6.2.4.2. Responses复制链接链接已复制到粘贴板!

1.6.2.4.3. Tags复制链接链接已复制到粘贴板!

1.6.3. Definitions复制链接链接已复制到粘贴板!

1.6.3.1. HelmRelease复制链接链接已复制到粘贴板!

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

1.6.1. Overview
复制链接

1.6.1.1. Version information
复制链接

1.6.1.2. Contact information
复制链接

1.6.1.3. License information
复制链接

1.6.1.4. URI scheme
复制链接

1.6.1.5. Tags
复制链接

1.6.1.6. External Docs
复制链接

1.6.2. Paths
复制链接

1.6.2.1. Create a helmrelease
复制链接

1.6.2.1.1. Description
复制链接

1.6.2.1.2. Parameters
复制链接

1.6.2.1.3. Responses
复制链接

1.6.2.1.4. Consumes
复制链接

1.6.2.1.5. Tags
复制链接

1.6.2.1.6. Example HTTP request
复制链接

1.6.2.1.6.1. Request body
复制链接

1.6.2.2. Query all helmreleases
复制链接

1.6.2.2.1. Description
复制链接

1.6.2.2.2. Parameters
复制链接

1.6.2.2.3. Responses
复制链接

1.6.2.2.4. Consumes
复制链接

1.6.2.2.5. Tags
复制链接

1.6.2.3. Query a single helmrelease
复制链接

1.6.2.3.1. Description
复制链接

1.6.2.3.2. Parameters
复制链接

1.6.2.3.3. Responses
复制链接

1.6.2.3.4. Tags
复制链接

1.6.2.4. Delete a helmrelease
复制链接

1.6.2.4.1. Parameters
复制链接

1.6.2.4.2. Responses
复制链接

1.6.2.4.3. Tags
复制链接

1.6.3. Definitions
复制链接

1.6.3.1. HelmRelease
复制链接