Class ClusterCommand

Defines the core functionalities of 'node' command

Hierarchy (View Summary)

BaseCommand
- ClusterCommand

Index

Constructors

Properties

chartManager configManager depManager handlers helm k8Factory leaseManager localConfig logger? remoteConfigManager COMMAND_NAME

Methods

close getCommandDefinition run setupHomeDirectory setupHomeDirectoryTask prepareValuesFilesMap prepareValuesFilesMapMulticluster

Constructors

constructor

new ClusterCommand(options: Options): ClusterCommand
Parameters
- options: Options
Returns ClusterCommand
Overrides BaseCommand.constructor
- Defined in src/commands/cluster/index.ts:17

Properties

`Protected` `Readonly`chartManager

chartManager: ChartManager

`Readonly`configManager

configManager: ConfigManager

`Protected` `Readonly`depManager

depManager: DependencyManager

handlers

handlers: ClusterCommandHandlers

`Protected` `Readonly`helm

helm: HelmClient

`Protected` `Readonly`k8Factory

k8Factory: K8Factory

`Protected` `Readonly`leaseManager

leaseManager: LockManager

`Readonly`localConfig

localConfig: LocalConfig

`Optional`logger

logger?: SoloLogger

`Protected` `Readonly`remoteConfigManager

remoteConfigManager: RemoteConfigManager

`Static` `Readonly`COMMAND_NAME

COMMAND_NAME: "cluster-ref" = 'cluster-ref'

Methods

close

close(): Promise<void>
Returns Promise<void>
Overrides BaseCommand.close
- Defined in src/commands/cluster/index.ts:102

getCommandDefinition

getCommandDefinition(): {
    builder: (yargs: any) => any;
    command: string;
    desc: string;
}
Returns { builder: (yargs: any) => any; command: string; desc: string }
- Defined in src/commands/cluster/index.ts:25

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 BaseCommand.run
- Defined in src/core/shell-runner.ts:17

setupHomeDirectory

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

setupHomeDirectoryTask

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

`Static`prepareValuesFilesMap

prepareValuesFilesMap(
    clusterReferences: ClusterReferences,
    chartDirectory?: string,
    profileValuesFile?: string,
    valuesFileInput?: string,
): Record<string, 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<string, string>
Inherited from BaseCommand.prepareValuesFilesMap
- Defined in src/commands/base.ts:173

`Static`prepareValuesFilesMapMulticluster

prepareValuesFilesMapMulticluster(
    clusterReferences: ClusterReferences,
    chartDirectory?: string,
    profileValuesFile?: Record<string, string>,
    valuesFileInput?: string,
): Record<string, 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<string, string>
  mapping of clusterRef to the profile values file full path
- OptionalvaluesFileInput: string
  the values file input string
Returns Record<string, string>
Inherited from BaseCommand.prepareValuesFilesMapMulticluster
- Defined in src/commands/base.ts:100