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

Properties

`Protected` `Optional` `Readonly`chartManager

chartManager?: ChartManager

`Protected` `Optional` `Readonly`componentFactory

componentFactory?: ComponentFactoryApi

`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

`Protected` `Optional` `Readonly`taskList

taskList?: TaskList<any, ListrRendererValue, ListrRendererValue>

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

`Protected`getClusterContext

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

`Protected`getClusterReference

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

`Protected`getNamespace

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

getUnusedConfigs

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

`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;
    },
>
Inherited from BaseCommand.inferMirrorNodeData
- Defined in src/commands/base.ts:291

`Protected`resolveNamespaceFromDeployment

resolveNamespaceFromDeployment(
task?: SoloListrTaskWrapper<any>,
): Promise<NamespaceName>
Parameters
- Optionaltask: SoloListrTaskWrapper<any>
Returns Promise<NamespaceName>
Inherited from BaseCommand.resolveNamespaceFromDeployment
- 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 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:225

`Protected`throwIfNamespaceIsMissing

throwIfNamespaceIsMissing(
context: string,
namespace: NamespaceName,
): Promise<void>
Parameters
- context: string
- namespace: NamespaceName
Returns Promise<void>
Inherited from BaseCommand.throwIfNamespaceIsMissing
- 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>
Inherited from BaseCommand.prepareValuesFilesMap
- 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>
Inherited from BaseCommand.prepareValuesFilesMapMultipleCluster
- Defined in src/commands/base.ts:79

Class NodeCommand

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns NodeCommand

Properties

Protected Optional ReadonlychartManager

Protected Optional ReadonlycomponentFactory

Optional ReadonlyconfigManager

Protected Optional ReadonlydepManager

Optional Readonlyhandlers

Protected Optional Readonlyhelm

Protected Optional Readonlyk8Factory

Protected Optional ReadonlyleaseManager

Optional ReadonlylocalConfig

Optionallogger

Protected Optional ReadonlyremoteConfig

Protected Optional ReadonlytaskList

Methods

close

Returns Promise<void>

ProtectedgetClusterContext

Parameters

Returns string

ProtectedgetClusterReference

Returns string

ProtectedgetNamespace

Parameters

Returns Promise<NamespaceName>

getUnusedConfigs

Parameters

Returns string[]

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

`Protected` `Optional` `Readonly`chartManager

`Protected` `Optional` `Readonly`componentFactory

`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

`Protected` `Optional` `Readonly`taskList

`Protected`getClusterContext

`Protected`getClusterReference

`Protected`getNamespace

`Protected`inferMirrorNodeData

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

`Protected`resolveNamespaceFromDeployment

`Protected`throwIfNamespaceIsMissing

`Static`prepareValuesFilesMap

`Static`prepareValuesFilesMapMultipleCluster