Class BaseCommand`Abstract`

Hierarchy (View Summary)

ShellRunner
- BaseCommand

Constructors

constructor

new BaseCommand(opts: Opts): BaseCommand
Parameters
- opts: Opts
Returns BaseCommand
Overrides ShellRunner.constructor
- Defined in solo/solo/src/commands/base.ts:53

Properties

`Protected` `Readonly`_configMaps

_configMaps: Map<string, any> = ...

`Protected` `Readonly`chartManager

chartManager: ChartManager

`Protected` `Readonly`configManager

configManager: ConfigManager

`Protected` `Readonly`depManager

depManager: DependencyManager

`Protected` `Readonly`helm

helm: Helm

`Protected` `Readonly`k8

k8: K8

`Protected` `Readonly`leaseManager

leaseManager: LeaseManager

`Protected` `Readonly`localConfig

localConfig: LocalConfig

`Optional`logger

logger?: SoloLogger

`Protected` `Readonly`remoteConfigManager

remoteConfigManager: RemoteConfigManager

Methods

`Abstract`close

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

commandActionBuilder

commandActionBuilder(
    actionTasks: any,
    options: any,
    errorString: string,
    lease: Lease,
): (argv: any, commandDef: CommandHandlers) => Promise<void>
Parameters
- actionTasks: any
- options: any
- errorString: string
- lease: Lease
Returns (argv: any, commandDef: CommandHandlers) => Promise<void>
- Defined in solo/solo/src/commands/base.ts:207

getChartManager

getChartManager(): ChartManager
Returns ChartManager
- Defined in solo/solo/src/commands/base.ts:104

getConfig

getConfig(
    configName: string,
    flags: CommandFlag[],
    extraProperties?: string[],
): object
Dynamically builds a class with properties from the provided list of flags and extra properties, will keep track of which properties are used. Call getUnusedConfigs() to get an array of unused properties.
Parameters
- configName: string
- flags: CommandFlag[]
- extraProperties: string[] = []
Returns object
- Defined in solo/solo/src/commands/base.ts:113

getConfigManager

getConfigManager(): ConfigManager
Returns ConfigManager
- Defined in solo/solo/src/commands/base.ts:100

getK8

getK8(): K8
Returns K8
- Defined in solo/solo/src/commands/base.ts:193

getLeaseManager

getLeaseManager(): LeaseManager
Returns LeaseManager
- Defined in solo/solo/src/commands/base.ts:181

getLocalConfig

getLocalConfig(): LocalConfig
Returns LocalConfig
- Defined in solo/solo/src/commands/base.ts:197

getRemoteConfigManager

getRemoteConfigManager(): RemoteConfigManager
Returns RemoteConfigManager
- Defined in solo/solo/src/commands/base.ts:201

getUnusedConfigs

getUnusedConfigs(configName: string): string[]
Get the list of unused configurations that were not accessed
Parameters
- configName: string
Returns string[]
an array of unused configurations
- Defined in solo/solo/src/commands/base.ts:189

prepareChartPath

prepareChartPath(
    chartDir: string,
    chartRepo: string,
    chartReleaseName: string,
): Promise<string>
Parameters
- chartDir: string
- chartRepo: string
- chartReleaseName: string
Returns Promise<string>
- Defined in solo/solo/src/commands/base.ts:74

prepareValuesFiles

prepareValuesFiles(valuesFile: string): string
Parameters
- valuesFile: string
Returns string
- Defined in solo/solo/src/commands/base.ts:87

run

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

setupHomeDirectory

setupHomeDirectory(dirs?: string[]): string[]
Setup home directories
Parameters
- dirs: string[] = ...
  a list of directories that need to be created in sequence
Returns string[]
- Defined in solo/solo/src/commands/base.ts:231

setupHomeDirectoryTask

setupHomeDirectoryTask(): Task
Returns Task
- Defined in solo/solo/src/commands/base.ts:256