Globals / "src/main/helm/helm-service" / HelmService
Class: HelmService#
Hierarchy#
- HelmService
Index#
Methods#
- deleteRelease
- excludeDeprecated
- getChart
- getChartValues
- getRelease
- getReleaseHistory
- getReleaseValues
- installChart
- listCharts
- listReleases
- rollback
- updateRelease
Methods#
deleteRelease#
▸ deleteRelease(cluster: Cluster, releaseName: string, namespace: string): Promise\
Defined in src/main/helm/helm-service.ts:68
Parameters:
| Name | Type |
|---|---|
cluster |
Cluster |
releaseName |
string |
namespace |
string |
Returns: Promise\
excludeDeprecated#
▸ ProtectedexcludeDeprecated(entries: any): any
Defined in src/main/helm/helm-service.ts:84
Parameters:
| Name | Type |
|---|---|
entries |
any |
Returns: any
getChart#
▸ getChart(repoName: string, chartName: string, version?: string): Promise\<{ readme: string = ""; versions: {} }>
Defined in src/main/helm/helm-service.ts:29
Parameters:
| Name | Type | Default value |
|---|---|---|
repoName |
string | - |
chartName |
string | - |
version |
string | "" |
Returns: Promise\<{ readme: string = ""; versions: {} }>
getChartValues#
▸ getChartValues(repoName: string, chartName: string, version?: string): Promise\
Defined in src/main/helm/helm-service.ts:42
Parameters:
| Name | Type | Default value |
|---|---|---|
repoName |
string | - |
chartName |
string | - |
version |
string | "" |
Returns: Promise\
getRelease#
▸ getRelease(cluster: Cluster, releaseName: string, namespace: string): Promise\
Defined in src/main/helm/helm-service.ts:53
Parameters:
| Name | Type |
|---|---|
cluster |
Cluster |
releaseName |
string |
namespace |
string |
Returns: Promise\
getReleaseHistory#
▸ getReleaseHistory(cluster: Cluster, releaseName: string, namespace: string): Promise\
Defined in src/main/helm/helm-service.ts:63
Parameters:
| Name | Type |
|---|---|
cluster |
Cluster |
releaseName |
string |
namespace |
string |
Returns: Promise\
getReleaseValues#
▸ getReleaseValues(cluster: Cluster, releaseName: string, namespace: string): Promise\
Defined in src/main/helm/helm-service.ts:58
Parameters:
| Name | Type |
|---|---|
cluster |
Cluster |
releaseName |
string |
namespace |
string |
Returns: Promise\
installChart#
▸ installChart(cluster: Cluster, data: { chart: string ; name: string ; namespace: string ; values: {} ; version: string }): Promise\<{ log: string = stdout; release: { name: string = releaseName; namespace: string = namespace } }>
Defined in src/main/helm/helm-service.ts:8
Parameters:
| Name | Type |
|---|---|
cluster |
Cluster |
data |
{ chart: string ; name: string ; namespace: string ; values: {} ; version: string } |
Returns: Promise\<{ log: string = stdout; release: { name: string = releaseName; namespace: string = namespace } }>
listCharts#
▸ listCharts(): Promise\
Defined in src/main/helm/helm-service.ts:12
Returns: Promise\
listReleases#
▸ listReleases(cluster: Cluster, namespace?: string): Promise\
Defined in src/main/helm/helm-service.ts:48
Parameters:
| Name | Type | Default value |
|---|---|---|
cluster |
Cluster | - |
namespace |
string | null |
Returns: Promise\
rollback#
▸ rollback(cluster: Cluster, releaseName: string, namespace: string, revision: number): Promise\<{ message: string = output }>
Defined in src/main/helm/helm-service.ts:78
Parameters:
| Name | Type |
|---|---|
cluster |
Cluster |
releaseName |
string |
namespace |
string |
revision |
number |
Returns: Promise\<{ message: string = output }>
updateRelease#
▸ updateRelease(cluster: Cluster, releaseName: string, namespace: string, data: { chart: string ; values: {} ; version: string }): Promise\<{ log: string = stdout; release: Promise\
Defined in src/main/helm/helm-service.ts:73
Parameters:
| Name | Type |
|---|---|
cluster |
Cluster |
releaseName |
string |
namespace |
string |
data |
{ chart: string ; values: {} ; version: string } |
Returns: Promise\<{ log: string = stdout; release: Promise\