Documentation
¶
Index ¶
Constants ¶
const ( ParamCluster = "cluster" ParamNamespace = "namespace" ParamName = "name" )
const (
HelmStorageSecrets = "secrets"
)
Variables ¶
This section is empty.
Functions ¶
func ExportRelease ¶
ExportRelease exports manifests of a named release, in yaml/json format. @ID ExportRelease @Summary export manifests of a release @Description export manifests of a release in yaml/json format @Produce application/x-yaml @Produce application/json @Param cluster path string true "kubernetes cluster where the release is" @Param namespace path string true "kubernetes namespace where the release is" @Param name path string true "name of release" @Success 200 @Failure 404 {object} h.AppErr @Router /api/v1/helm/clusters/{cluster}/namespaces/{namespace}/releases/{name}/export [get]
func GetRelease ¶
GetRelease download all information for a named release @ID GetRelease @Summary get information of a named release @Description get manifest, chart, and values of a named release @Tags helm @Produce application/json @Param cluster path string true "kubernetes cluster where the release is" @Param namespace path string true "kubernetes namespace where the release is" @Param name path string true "name of release" @Success 200 {object} api.HelmRelease @Failure 404 {object} h.AppErr @Router /api/v1/helm/clusters/{cluster}/namespaces/{namespace}/releases/{name} [get]
func InstallRelease ¶
InstallRelease install a helm release from specified chart and values @ID InstallRelease @Summary Install helm release @Description Install a helm release in a cluster from specified chart and values @Tags helm @Produce application/json @Param cluster path string true "cluster to create release in" @Param namespace path string true "kubernetes namespace in that cluster to create release in"s @Success 201 {object} api.HelmRelease @Failure 409 {object} h.AppErr @Failure 400 {object} h.AppErr @Router /api/v1/helm/clusters/{cluster}/namespaces/{namespace}/releases [post]
func ListRelease ¶
ListRelease list all releases in a namespace. @ID ListRelease @Summary list releases @Description list all releases in a namespace @Tags helm @Produce application/json @Param cluster path string true "kubernetes cluster to list releases in" @Param namespace path string true "kubernetes namespace to list release in" @Success 200 {array} api.HelmRelease @Failure 404 {object} h.AppErr @Router /api/v1/helm/clusters/{cluster}/namespaces/{namespace}/releases [get]
func RenderTemplate ¶
RenderTemplate render chart templates locally and display the output. @ID RenderTemplate @Summary render templates in a chart @Description render chart templates locally and display the output @Tags helm @Produce application/x-yaml @Produce application/json @Success 201 @Failure 404 {object} h.AppErr @Failure 400 {object} h.AppErr @Router /api/v1/helm/render [post]
func RollbackRelease ¶
RollbackRelease rollbacks a release to a certain version. @ID RollbackRelease @Summary rollback a release @Description roll back a release to an earlier version @Tags helm @Produce application/json @Param cluster path string true "cluster to rollback release in" @Param namespace path string true "kubernetes namespace in that cluster to rollback release in" @Param name path string true "name of release to rollback" @Success 200 {object} api.SuccessfulOption @Failure 404 {object} h.AppErr @Failure 400 {object} h.AppErr @Router /api/v1/helm/clusters/{cluster}/namespaces/{namespace}/releases/{name}/rollback [put]
func UninstallRelease ¶
UninstallRelease uninstalls a named release. @ID UninstallRelease @Summary uninstall a release @Description uninstall a named release and deleted all resources in kubernetes created for the release @Tags helm @Produce application/json @Param cluster path string true "kubernetes cluster where the release is" @Param namespace path string true "kubernetes namespace where the release is" @Param name path string true "name of release" @Success 204 @Failure 404 {object} h.AppErr @Router /api/v1/helm/clusters/{cluster}/namespaces/{namespace}/releases/{name} [delete]
func UpgradeRelease ¶
UpgradeRelease upgrade a helm release by its name. @ID UpgradeRelease @Summary Upgrade installed release @Description Upgrade an installed release with new chart and/or values @Tags helm @Produce application/json @Param cluster path string true "cluster to upgrade release in" @Param namespace path string true "kubernetes namespace in that cluster to upgrade release in" @Param name path string true "name of release to upgrade" @Success 200 {object} api.HelmRelease @Failure 404 {object} h.AppErr @Failure 400 {object} h.AppErr @Router /api/v1/helm/clusters/{cluster}/namespaces/{namespace}/releases/{name} [put]
Types ¶
This section is empty.
Source Files