Class NodeCommand

Defines the core functionalities of 'node' command

Hierarchy (View Summary)

BaseCommand
- NodeCommand

Constructors

constructor

new NodeCommand(
accountManager?: AccountManager,
handlers?: NodeCommandHandlers,
): NodeCommand
Parameters
- OptionalaccountManager: AccountManager
- Optionalhandlers: NodeCommandHandlers
Returns NodeCommand
Overrides BaseCommand.constructor
- Defined in src/commands/node/index.ts:21

Properties

_portForwards

_portForwards: any

`Protected` `Optional` `Readonly`chartManager

chartManager?: ChartManager

`Optional` `Readonly`configManager

configManager?: ConfigManager

`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

`Static` `Readonly`COMMAND_NAME

COMMAND_NAME: "node" = 'node'

Methods

close

close(): Promise<void>
stops and closes the port forwards
- calls the accountManager.close()
- for all portForwards, calls k8Factory.default().pods().readByReference(null).stopPortForward(srv)
Returns Promise<void>
Overrides BaseCommand.close
- Defined in src/commands/node/index.ts:39

getCommandDefinition

getCommandDefinition(): CommandDefinition
Returns CommandDefinition
- Defined in src/commands/node/index.ts:55

getUnusedConfigs

getUnusedConfigs(configName: string): string[]
Parameters
- configName: string
Returns string[]
- Defined in src/commands/node/index.ts:51

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

setupHomeDirectoryTask

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

`Static`prepareValuesFilesMap

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

`Static`prepareValuesFilesMapMulticluster

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

Class NodeCommand

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns NodeCommand

Properties

_portForwards

Protected Optional ReadonlychartManager

Optional ReadonlyconfigManager

Protected Optional ReadonlydepManager

Optional Readonlyhandlers

Protected Optional Readonlyhelm

Protected Optional Readonlyk8Factory

Protected Optional ReadonlyleaseManager

Optional ReadonlylocalConfig

Optionallogger

Protected Optional ReadonlyremoteConfig

Static ReadonlyCOMMAND_NAME

Methods

close

Returns Promise<void>

getCommandDefinition

Returns CommandDefinition

getUnusedConfigs

Parameters

Returns string[]

run

Parameters

Returns Promise<string[]>

setupHomeDirectory

Parameters

Returns string[]

setupHomeDirectoryTask

Returns { task: () => Promise<void>; tile: string }

StaticprepareValuesFilesMap

Parameters

Returns Record<ClusterReference, string>

StaticprepareValuesFilesMapMulticluster

Parameters

Returns Record<ClusterReference, string>

Settings

On This Page

`Protected` `Optional` `Readonly`chartManager

`Optional` `Readonly`configManager

`Protected` `Optional` `Readonly`depManager

`Optional` `Readonly`handlers

`Protected` `Optional` `Readonly`helm

`Protected` `Optional` `Readonly`k8Factory

`Protected` `Optional` `Readonly`leaseManager

`Optional` `Readonly`localConfig

`Optional`logger

`Protected` `Optional` `Readonly`remoteConfig

`Static` `Readonly`COMMAND_NAME

`Static`prepareValuesFilesMap

`Static`prepareValuesFilesMapMulticluster