@hashgraph/solo
Version:
An opinionated CLI tool to deploy and manage private Hedera Networks.
184 lines (183 loc) • 7.61 kB
TypeScript
import { InstallChartOptions } from './install-chart-options.js';
/**
* The builder for the InstallChartOptions.
*/
export declare class InstallChartOptionsBuilder {
private _atomic;
private _createNamespace;
private _dependencyUpdate;
private _description?;
private _enableDNS;
private _force;
private _passCredentials;
private _password?;
private _repo?;
private _set?;
private _skipCrds;
private _timeout?;
private _username?;
private _values?;
private _verify;
private _version?;
private _waitFor;
private _kubeContext?;
private _namespace?;
private _extraArgs?;
private constructor();
/**
* Returns an instance of the InstallChartOptionsBuilder.
* @returns the InstallChartOptionsBuilder.
*/
static builder(): InstallChartOptionsBuilder;
/**
* if set, the installation process deletes the installation on failure. The --wait flag will be set automatically
* if --atomic is used.
*
* @param atomic if set, the installation process deletes the installation on failure. The --wait flag will be set
* automatically if --atomic is used.
* @returns the current InstallChartOptionsBuilder.
*/
atomic(atomic: boolean): InstallChartOptionsBuilder;
/**
* if set, create the release namespace if not present.
*
* @param createNamespace if set, create the release namespace if not present.
* @returns the current InstallChartOptionsBuilder.
*/
createNamespace(createNamespace: boolean): InstallChartOptionsBuilder;
/**
* if set, update dependencies if they are missing before installing the chart.
*
* @param dependencyUpdate if set, update dependencies if they are missing before installing the chart.
* @returns the current InstallChartOptionsBuilder.
*/
dependencyUpdate(dependencyUpdate: boolean): InstallChartOptionsBuilder;
/**
* add a custom description.
*
* @param description add a custom description.
* @returns the current InstallChartOptionsBuilder.
*/
description(description: string): InstallChartOptionsBuilder;
/**
* enable DNS lookups when rendering templates.
*
* @param enableDNS enable DNS lookups when rendering templates.
* @returns the current InstallChartOptionsBuilder.
*/
enableDNS(enableDNS: boolean): InstallChartOptionsBuilder;
/**
* if set, force resource updates through a replacement strategy.
*
* @param force if set, force resource updates through a replacement strategy.
* @returns the current InstallChartOptionsBuilder.
*/
force(force: boolean): InstallChartOptionsBuilder;
/**
* pass credentials to all domains.
*
* @param passCredentials pass credentials to all domains.
* @returns the current InstallChartOptionsBuilder.
*/
passCredentials(passCredentials: boolean): InstallChartOptionsBuilder;
/**
* chart repository password where to locate the requested chart.
*
* @param password chart repository password where to locate the requested chart.
* @returns the current InstallChartOptionsBuilder.
*/
password(password: string): InstallChartOptionsBuilder;
/**
* chart repository url where to locate the requested chart.
*
* @param repo chart repository url where to locate the requested chart.
* @returns the current InstallChartOptionsBuilder.
*/
repo(repo: string): InstallChartOptionsBuilder;
/**
* set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
*
* @param valueOverride set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
* @returns the current InstallChartOptionsBuilder.
*/
set(valueOverride: string[]): InstallChartOptionsBuilder;
/**
* if set, no CRDs will be installed. By default, CRDs are installed if not already present.
*
* @param skipCrds if set, no CRDs will be installed. By default, CRDs are installed if not already present.
* @returns the current InstallChartOptionsBuilder.
*/
skipCrds(skipCrds: boolean): InstallChartOptionsBuilder;
/**
* time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s).
*
* @param timeout time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s).
* @returns the current InstallChartOptionsBuilder.
*/
timeout(timeout: string): InstallChartOptionsBuilder;
/**
* chart repository username where to locate the requested chart.
*
* @param username chart repository username where to locate the requested chart.
* @returns the current InstallChartOptionsBuilder.
*/
username(username: string): InstallChartOptionsBuilder;
/**
* specify values in a YAML file or a URL (can specify multiple).
*
* @param values specify values in a YAML file or a URL (can specify multiple).
* @returns the current InstallChartOptionsBuilder.
*/
values(values: string[]): InstallChartOptionsBuilder;
/**
* verify the package before installing it.
*
* @param verify verify the package before installing it.
* @returns the current InstallChartOptionsBuilder.
*/
verify(verify: boolean): InstallChartOptionsBuilder;
/**
* specify a version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or
* it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used.
*
* @param version specify a version constraint for the chart version to use. This constraint can be a specific tag
* (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest
* version is used.
* @returns the current InstallChartOptionsBuilder.
*/
version(version: string): InstallChartOptionsBuilder;
/**
* if set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or
* ReplicaSet are in a ready state before marking the release as successful. It will wait for as long as --timeout.
*
* @param waitFor if set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment,
* StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. It will
* wait for as long as --timeout.
* @returns the current InstallChartOptionsBuilder.
*/
waitFor(waitFor: boolean): InstallChartOptionsBuilder;
/**
* build the InstallChartOptions.
* @returns the created InstallChartOptions.
*/
/**
* Sets the Kubernetes context to use.
* @param context The Kubernetes context.
* @returns This builder instance.
*/
kubeContext(context: string): InstallChartOptionsBuilder;
/**
* Set the namespace for the installation.
*
* @param namespace the namespace to install the chart in.
* @returns the current InstallChartOptionsBuilder.
*/
namespace(namespace: string): InstallChartOptionsBuilder;
/**
* Sets additional arguments to pass to the helm command.
* @param arguments_ The additional arguments.
* @returns This builder instance.
*/
extraArgs(arguments_: string): InstallChartOptionsBuilder;
build(): InstallChartOptions;
}