Class BaseCommand`Abstract`

Hierarchy (View Summary)

ShellRunner
- BaseCommand

Index

Constructors

Properties

chartManager? configManager? depManager? helm? k8Factory? leaseManager? localConfig? logger? remoteConfig? taskList?

Methods

close run setupHomeDirectory setupHomeDirectoryTask prepareValuesFilesMap prepareValuesFilesMapMultipleCluster

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>,
): BaseCommand
Parameters
- Optionalhelm: HelmClient
- Optionalk8Factory: K8Factory
- OptionalchartManager: ChartManager
- OptionalconfigManager: ConfigManager
- OptionaldepManager: DependencyManager
- OptionalleaseManager: LockManager
- OptionallocalConfig: LocalConfigRuntimeState
- OptionalremoteConfig: RemoteConfigRuntimeStateApi
- OptionaltaskList: TaskList<any, ListrRendererValue, ListrRendererValue>
Returns BaseCommand
Overrides ShellRunner.constructor
- Defined in src/commands/base.ts:25

Properties

`Protected` `Optional` `Readonly`chartManager

chartManager?: ChartManager

`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

`Optional` `Readonly`localConfig

localConfig?: LocalConfigRuntimeState

`Optional`logger

logger?: SoloLogger

`Protected` `Optional` `Readonly`remoteConfig

remoteConfig?: RemoteConfigRuntimeStateApi

`Protected` `Optional` `Readonly`taskList

taskList?: TaskList<any, ListrRendererValue, ListrRendererValue>

Methods

`Abstract`close

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

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:208

setupHomeDirectoryTask

setupHomeDirectoryTask(): { task: () => Promise<void>; tile: string }
Returns { task: () => Promise<void>; tile: string }
- Defined in src/commands/base.ts:233

`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:135

`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:62