@hashgraph/solo
    Preparing search index...

    Interface HelmClient

    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.

    interface HelmClient {
        addRepository(repository: Repository): Promise<void>;
        dependencyUpdate(chartName: string): Promise<void>;
        installChart(
            releaseName: string,
            chart: Chart,
            options: InstallChartOptions,
        ): Promise<Release>;
        listReleases(
            allNamespaces: boolean,
            namespace?: string,
            kubeContext?: string,
        ): Promise<ReleaseItem[]>;
        listRepositories(): Promise<Repository[]>;
        removeRepository(repository: Repository): Promise<void>;
        testChart(releaseName: string, options: TestChartOptions): Promise<void>;
        uninstallChart(
            releaseName: string,
            options: UnInstallChartOptions,
        ): Promise<void>;
        upgradeChart(
            releaseName: string,
            chart: Chart,
            options: UpgradeChartOptions,
        ): Promise<Release>;
        version(): Promise<SemanticVersion>;
    }

    Implemented by

    Index

    Methods

    addRepository dependencyUpdate installChart listReleases listRepositories removeRepository testChart uninstallChart upgradeChart version

    Methods

    • Executes the Helm CLI repo add sub-command and adds a new repository.

      Parameters

      Returns Promise<void>

      Error if name or url is null or blank.

      HelmExecutionException if the Helm CLI command fails.

      HelmParserException if the output of the Helm CLI command cannot be parsed.

    • 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>

    • 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.

    Settings

    Member Visibility

    On This Page

    Methods