Class BaseCommand`Abstract`

Hierarchy (View Summary)

ShellRunner
- BaseCommand

Constructors

constructor

new BaseCommand(
    helm?: HelmClient,
    k8Factory?: K8Factory,
    chartManager?: ChartManager,
    configManager?: ConfigManager,
    depManager?: DependencyManager,
    leaseManager?: LockManager,
    localConfig?: LocalConfigRuntimeState,
    remoteConfig?: RemoteConfigRuntimeStateApi,
    taskList?: TaskList<any, ListrRendererValue, ListrRendererValue>,
    componentFactory?: ComponentFactoryApi,
): BaseCommand
Parameters
- Optionalhelm: HelmClient
- Optionalk8Factory: K8Factory
- OptionalchartManager: ChartManager
- OptionalconfigManager: ConfigManager
- OptionaldepManager: DependencyManager
- OptionalleaseManager: LockManager
- OptionallocalConfig: LocalConfigRuntimeState
- OptionalremoteConfig: RemoteConfigRuntimeStateApi
- OptionaltaskList: TaskList<any, ListrRendererValue, ListrRendererValue>
- OptionalcomponentFactory: ComponentFactoryApi
Returns BaseCommand
Overrides ShellRunner.constructor
- Defined in src/commands/base.ts:40

Properties

`Protected` `Optional` `Readonly`chartManager

chartManager?: ChartManager

`Protected` `Optional` `Readonly`componentFactory

componentFactory?: ComponentFactoryApi

`Optional` `Readonly`configManager

configManager?: ConfigManager

`Protected` `Optional` `Readonly`depManager

depManager?: DependencyManager

`Protected` `Optional` `Readonly`helm

helm?: HelmClient

`Protected` `Optional` `Readonly`k8Factory

k8Factory?: K8Factory

`Protected` `Optional` `Readonly`leaseManager

leaseManager?: LockManager

`Protected` `Optional` `Readonly`taskList

taskList?: TaskList<any, ListrRendererValue, ListrRendererValue>

Methods

`Abstract`close

close(): Promise<void>
Returns Promise<void>
- Defined in src/commands/base.ts:219

`Protected`getClusterContext

getClusterContext(clusterReference: string): string
Parameters
- clusterReference: string
Returns string
- Defined in src/commands/base.ts:254

`Protected`getClusterReference

getClusterReference(): string
Returns string
- Defined in src/commands/base.ts:250

`Protected`getNamespace

getNamespace(task: SoloListrTaskWrapper<any>): Promise<NamespaceName>
Parameters
- task: SoloListrTaskWrapper<any>
Returns Promise<NamespaceName>
- Defined in src/commands/base.ts:260

`Protected`inferMirrorNodeData

inferMirrorNodeData(
    namespace: NamespaceName,
    context: string,
): Promise<
    {
        mirrorNamespace: string;
        mirrorNodeId: number;
        mirrorNodeReleaseName: string;
    },
>
Parameters
- namespace: NamespaceName
- context: string
Returns Promise<
    {
        mirrorNamespace: string;
        mirrorNodeId: number;
        mirrorNodeReleaseName: string;
    },
>
- Defined in src/commands/base.ts:291

`Protected`resolveNamespaceFromDeployment

resolveNamespaceFromDeployment(
task?: SoloListrTaskWrapper<any>,
): Promise<NamespaceName>
Parameters
- Optionaltask: SoloListrTaskWrapper<any>
Returns Promise<NamespaceName>
- Defined in src/commands/base.ts:338

run

run(
    cmd: string,
    arguments_?: string[],
    verbose?: boolean,
    detached?: boolean,
): Promise<string[]>
Returns a promise that invokes the shell command
Parameters
- cmd: string
- arguments_: string[] = []
- verbose: boolean = false
- detached: boolean = false
Returns Promise<string[]>
Inherited from ShellRunner.run
- Defined in src/core/shell-runner.ts:17

setupHomeDirectory

setupHomeDirectory(directories?: string[]): string[]
Setup home directories
Parameters
- directories: string[] = []
Returns string[]
- Defined in src/commands/base.ts:225

`Protected`throwIfNamespaceIsMissing

throwIfNamespaceIsMissing(
context: string,
namespace: NamespaceName,
): Promise<void>
Parameters
- context: string
- namespace: NamespaceName
Returns Promise<void>
- Defined in src/commands/base.ts:264

`Static`prepareValuesFilesMap

prepareValuesFilesMap(
    clusterReferences: ClusterReferences,
    chartDirectory?: string,
    profileValuesFile?: string,
    valuesFileInput?: string,
): Record<ClusterReferenceName, string>
Prepare the values files map for each cluster

Order of precedence:
1. Chart's default values file (if chartDirectory is set)
2. Profile values file
3. User's values file
Parameters
- clusterReferences: ClusterReferences
- OptionalchartDirectory: string
  the chart directory
- OptionalprofileValuesFile: string
  the profile values file full path
- OptionalvaluesFileInput: string
  the values file input string
Returns Record<ClusterReferenceName, string>
- Defined in src/commands/base.ts:152

`Static`prepareValuesFilesMapMultipleCluster

prepareValuesFilesMapMultipleCluster(
    clusterReferences: ClusterReferences,
    chartDirectory?: string,
    profileValuesFile?: Record<ClusterReferenceName, string>,
    valuesFileInput?: string,
): Record<ClusterReferenceName, string>
Prepare the values files map for each cluster

Order of precedence:
1. Chart's default values file (if chartDirectory is set)
2. Profile values file
3. User's values file
Parameters
- clusterReferences: ClusterReferences
- OptionalchartDirectory: string
  the chart directory
- OptionalprofileValuesFile: Record<ClusterReferenceName, string>
  mapping of clusterRef to the profile values file full path
- OptionalvaluesFileInput: string
  the values file input string
Returns Record<ClusterReferenceName, string>
- Defined in src/commands/base.ts:79

Class BaseCommandAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BaseCommand

Properties

Protected Optional ReadonlychartManager

Protected Optional ReadonlycomponentFactory

Optional ReadonlyconfigManager

Protected Optional ReadonlydepManager

Protected Optional Readonlyhelm

Protected Optional Readonlyk8Factory

Protected Optional ReadonlyleaseManager

Optional ReadonlylocalConfig

Optionallogger

Protected Optional ReadonlyremoteConfig

Protected Optional ReadonlytaskList

Methods

Abstractclose

Returns Promise<void>

ProtectedgetClusterContext

Parameters

Returns string

ProtectedgetClusterReference

Returns string

ProtectedgetNamespace

Parameters

Returns Promise<NamespaceName>

ProtectedinferMirrorNodeData

Parameters

Returns Promise< { mirrorNamespace: string; mirrorNodeId: number; mirrorNodeReleaseName: string; },>

ProtectedresolveNamespaceFromDeployment

Parameters

Returns Promise<NamespaceName>

run

Parameters

Returns Promise<string[]>

setupHomeDirectory

Parameters

Returns string[]

ProtectedthrowIfNamespaceIsMissing

Parameters

Returns Promise<void>

StaticprepareValuesFilesMap

Parameters

Returns Record<ClusterReferenceName, string>

StaticprepareValuesFilesMapMultipleCluster

Parameters

Returns Record<ClusterReferenceName, string>

Settings

On This Page

Class BaseCommand`Abstract`

`Protected` `Optional` `Readonly`chartManager

`Protected` `Optional` `Readonly`componentFactory

`Optional` `Readonly`configManager

`Protected` `Optional` `Readonly`depManager

`Protected` `Optional` `Readonly`helm

`Protected` `Optional` `Readonly`k8Factory

`Protected` `Optional` `Readonly`leaseManager

`Optional` `Readonly`localConfig

`Optional`logger

`Protected` `Optional` `Readonly`remoteConfig

`Protected` `Optional` `Readonly`taskList

`Abstract`close

`Protected`getClusterContext

`Protected`getClusterReference

`Protected`getNamespace

`Protected`inferMirrorNodeData

Returns Promise<
{
mirrorNamespace: string;
mirrorNodeId: number;
mirrorNodeReleaseName: string;
},
>

`Protected`resolveNamespaceFromDeployment

`Protected`throwIfNamespaceIsMissing

`Static`prepareValuesFilesMap

`Static`prepareValuesFilesMapMultipleCluster