Class DefaultHelmClient

The HelmClient is a bridge between TypeScript and the Helm CLI. The client is highly dependent on specific features and versions of the Helm CLI tools; therefore, all implementations are expected to provide a packaged Helm executable of the appropriate version for each supported OS and architecture.

Implements

HelmClient

Index

Constructors

constructor

Methods

addRepository dependencyUpdate installChart listReleases listRepositories removeRepository testChart uninstallChart upgradeChart version

Constructors

constructor

new DefaultHelmClient(logger?: SoloLogger): DefaultHelmClient
Parameters
- Optionallogger: SoloLogger
Returns DefaultHelmClient
- Defined in src/integration/helm/impl/default-helm-client.ts:46

Methods

addRepository

addRepository(repository: Repository): Promise<void>
Executes the Helm CLI repo add sub-command and adds a new repository.
Parameters
- repository: Repository
  the repository to add.
Returns Promise<void>
Throws
Error if name or url is null or blank.

Throws
HelmExecutionException if the Helm CLI command fails.

Throws
HelmParserException if the output of the Helm CLI command cannot be parsed.
Implementation of HelmClient.addRepository
- Defined in src/integration/helm/impl/default-helm-client.ts:71

dependencyUpdate

dependencyUpdate(chartName: string): Promise<void>
Executes the Helm CLI dependency update sub-command and updates the dependencies of the specified Helm chart.
Parameters
- chartName: string
  the name of the chart to update.
Returns Promise<void>
Implementation of HelmClient.dependencyUpdate
- Defined in src/integration/helm/impl/default-helm-client.ts:100

installChart

installChart(
    releaseName: string,
    chart: Chart,
    options: InstallChartOptions,
): Promise<Release>
Executes the Helm CLI install sub-command and installs a Helm chart passing the flags and arguments provided.
Parameters
- releaseName: string
  the name of the release.
- chart: Chart
  the Helm chart to install.
- options: InstallChartOptions
  the options to pass to the Helm CLI command.
Returns Promise<Release>
the Release that was installed.
Implementation of HelmClient.installChart
- Defined in src/integration/helm/impl/default-helm-client.ts:79

listReleases

listReleases(
    allNamespaces: boolean,
    namespace?: string,
    kubeContext?: string,
): Promise<ReleaseItem[]>
Executes the Helm CLI list sub-command and returns the list of releases.
Parameters
- allNamespaces: boolean
  if true, list releases across all namespaces.
- Optionalnamespace: string
  the namespace to list releases from. Only used if allNamespaces is false.
- OptionalkubeContext: string
Returns Promise<ReleaseItem[]>
the list of releases.
Implementation of HelmClient.listReleases
- Defined in src/integration/helm/impl/default-helm-client.ts:96

listRepositories

listRepositories(): Promise<Repository[]>
Executes the Helm CLI repo list sub-command and returns the list of repositories.

Returns Promise<Repository[]>
the list of repositories.
Implementation of HelmClient.listRepositories
- Defined in src/integration/helm/impl/default-helm-client.ts:67

removeRepository

removeRepository(repository: Repository): Promise<void>
Executes the Helm CLI repo remove sub-command and removes a repository.
Parameters
- repository: Repository
  the repository to remove.
Returns Promise<void>
Implementation of HelmClient.removeRepository
- Defined in src/integration/helm/impl/default-helm-client.ts:75

testChart

testChart(releaseName: string, options: TestChartOptions): Promise<void>
Executes the Helm CLI test sub-command and tests the specified Helm chart.
Parameters
- releaseName: string
  the name of the release to test.
- options: TestChartOptions
  the options to pass to the Helm CLI command.
Returns Promise<void>
Implementation of HelmClient.testChart
- Defined in src/integration/helm/impl/default-helm-client.ts:92

uninstallChart

uninstallChart(
releaseName: string,
options: UnInstallChartOptions,
): Promise<void>
Executes the Helm CLI uninstall sub-command and uninstalls the specified Helm chart.
Parameters
- releaseName: string
  the name of the release to uninstall.
- options: UnInstallChartOptions
  the options to pass to the Helm CLI command.
Returns Promise<void>
Implementation of HelmClient.uninstallChart
- Defined in src/integration/helm/impl/default-helm-client.ts:88

upgradeChart

upgradeChart(
    releaseName: string,
    chart: Chart,
    options: UpgradeChartOptions,
): Promise<Release>
Executes the Helm CLI upgrade sub-command and upgrades a Helm chart.
Parameters
- releaseName: string
  the name of the release.
- chart: Chart
  the Helm chart to upgrade.
- options: UpgradeChartOptions
  the options to pass to the Helm CLI command.
Returns Promise<Release>
the Release that was upgraded.
Implementation of HelmClient.upgradeChart
- Defined in src/integration/helm/impl/default-helm-client.ts:104

version

version(): Promise<SemanticVersion>
Executes the Helm CLI version sub-command and returns the reported version.

Returns Promise<SemanticVersion>
the version of the Helm CLI that is being used by this client.
Implementation of HelmClient.version
- Defined in src/integration/helm/impl/default-helm-client.ts:50

Class DefaultHelmClient

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns DefaultHelmClient

Methods

addRepository

Parameters

Returns Promise<void>

Throws

Throws

Throws

dependencyUpdate

Parameters

Returns Promise<void>

installChart

Parameters

Returns Promise<Release>

listReleases

Parameters

Returns Promise<ReleaseItem[]>

listRepositories

Returns Promise<Repository[]>

removeRepository

Parameters

Returns Promise<void>

testChart

Parameters

Returns Promise<void>

uninstallChart

Parameters

Returns Promise<void>

upgradeChart

Parameters

Returns Promise<Release>

version

Returns Promise<SemanticVersion>

Settings

On This Page