@hashgraph/solo
    Preparing search index...

    Interface HelmClientBuilder

    HelmClientBuilder is used to construct instances of HelmClient. This interface defines the standard methods which all HelmClient builders must implement.

    The build() method is responsible for extracting the appropriate Helm executable from the package. The Helm executable should be extracted to a temporary directory which is supplied to the HelmClient implementation.

    HelmClient

    interface HelmClientBuilder {
        build(): HelmClient;
        defaultNamespace(namespace: string): HelmClientBuilder;
        kubeApiServer(kubeApiServer: string): HelmClientBuilder;
        kubeCAFile(kubeCAFile: string): HelmClientBuilder;
        kubeConfig(kubeConfig: string): HelmClientBuilder;
        kubeContext(kubeContext: string): HelmClientBuilder;
        kubeSkipTlsVerification(
            kubeSkipTlsVerification: boolean,
        ): HelmClientBuilder;
        kubeTlsServerName(kubeTlsServerName: string): HelmClientBuilder;
        kubeToken(kubeToken: string): HelmClientBuilder;
        workingDirectory(workingDirectory: string): HelmClientBuilder;
    }

    Implemented by

    Index

    Methods

    build defaultNamespace kubeApiServer kubeCAFile kubeConfig kubeContext kubeSkipTlsVerification kubeTlsServerName kubeToken workingDirectory

    Methods

    • Constructs an instance of the HelmClient with the provided configuration.

      Returns HelmClient

      the HelmClient instance.

      HelmConfigurationException if the HelmClient instance cannot be constructed.

      This method is responsible for extracting the appropriate Helm executable from the package to a temporary working directory. The temporary working directory should be supplied to the HelmClient instance.

      HelmClient

    • Sets the default namespace for the HelmClient instance.

      Parameters

      • namespace: string

        the Kubernetes namespace to use by default.

      Returns HelmClientBuilder

      the HelmClientBuilder instance.

      The kubernetes cluster's default namespace is used if the namespace is not explicitly provided.

      This value should be used to set the --namespace flag for all Helm commands unless overridden by a specific HelmClient method.

    • Sets the Kubernetes API server address and port number for the HelmClient instance.

      Parameters

      • kubeApiServer: string

        the Kubernetes API server address and port number.

      Returns HelmClientBuilder

      the HelmClientBuilder instance.

      The Kubernetes API server address and port number are read from the Kubernetes configuration file if not explicitly provided.

      This value should be used to set the --kube-apiserver flag for all Helm commands.

    • Sets the path to the Kubernetes CA certificate file for the HelmClient instance.

      Parameters

      • kubeCAFile: string

        the path to the Kubernetes API server CA certificate file.

      Returns HelmClientBuilder

      the HelmClientBuilder instance.

      The Kubernetes CA certificate file path is read from the Kubernetes configuration file if not explicitly provided.

      This value should be used to set the --kube-ca-file flag for all Helm commands.

    • Sets the path to the Kubernetes configuration file for the HelmClient instance.

      Parameters

      • kubeConfig: string

        the path to the Kubernetes configuration file.

      Returns HelmClientBuilder

      the HelmClientBuilder instance.

      The Kubernetes configuration file is read from the default location if not explicitly provided.

      This value should be used to set the --kubeconfig flag for all Helm commands.

    • Sets the context defined in the kube config file to use for the HelmClient instance. If this value is not provided, the current context is used.

      Parameters

      • kubeContext: string

        the name of the context defined in the kube config file to use.

      Returns HelmClientBuilder

      the HelmClientBuilder instance.

      The Kubernetes context is read from the Kubernetes configuration file if not explicitly provided.

      This value should be used to set the --kube-context flag for all Helm commands.

    • Sets whether to skip TLS verification when communicating with the Kubernetes API server for the HelmClient instance.

      Parameters

      • kubeSkipTlsVerification: boolean

        indicates whether to skip TLS verification when communicating with the Kubernetes API server. This value may be null to indicate that the default value should be used.

      Returns HelmClientBuilder

      the HelmClientBuilder instance.

      The Kubernetes skip TLS verification flag is read from the Kubernetes configuration file if not explicitly provided.

      This value should be used to set the --kube-skip-tls-verification flag for all Helm commands.

    • Sets the server name to use for certificate verification of the Kubernetes API server for the HelmClient instance.

      Parameters

      • kubeTlsServerName: string

        the server name to use for certificate verification of the Kubernetes API server.

      Returns HelmClientBuilder

      the HelmClientBuilder instance.

      The Kubernetes TLS server name is read from the Kubernetes configuration file if not explicitly provided.

      This value should be used to set the --kube-tls-server-name flag for all Helm commands.

    • Sets the kubernetes bearer token for the HelmClient instance.

      Parameters

      • kubeToken: string

        the kubernetes bearer token.

      Returns HelmClientBuilder

      the HelmClientBuilder instance.

      The Kubernetes bearer token is read from the Kubernetes configuration file if not explicitly provided.

      This value should be used to set the --kube-token flag for all Helm commands.

    • Sets the working directory for the HelmClient instance.

      Parameters

      • workingDirectory: string

        the working directory.

      Returns HelmClientBuilder

      the HelmClientBuilder instance.

      The working directory is set to the pwd if not explicitly provided, if that fails it will use the parent folder of the helm executable.

    Settings

    Member Visibility

    On This Page

    Methods