Class RelayCommand

Hierarchy (View Summary)

BaseCommand
- RelayCommand

Constructors

constructor

new RelayCommand(accountManager: AccountManager): RelayCommand
Parameters
- accountManager: AccountManager
Returns RelayCommand
Overrides BaseCommand.constructor
- Defined in src/commands/relay.ts:155

Properties

`Protected` `Optional` `Readonly`chartManager

chartManager?: ChartManager

`Protected` `Optional` `Readonly`componentFactory

componentFactory?: ComponentFactoryApi

`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`nodeCommandTasks

nodeCommandTasks?: NodeCommandTasks

`Protected` `Optional` `Readonly`oneShotState

oneShotState?: OneShotState

`Protected` `Optional` `Readonly`remoteConfig

remoteConfig?: RemoteConfigRuntimeStateApi

`Protected` `Optional` `Readonly`taskList

taskList?: TaskList<any, ListrRendererValue, ListrRendererValue>

`Static` `Readonly`DEPLOY_FLAGS_LIST

DEPLOY_FLAGS_LIST: CommandFlags = ...

`Static` `Readonly`DESTROY_FLAGS_LIST

DESTROY_FLAGS_LIST: CommandFlags = ...

`Static` `Readonly`UPGRADE_FLAGS_LIST

UPGRADE_FLAGS_LIST: CommandFlags = ...

Methods

add

add(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/relay.ts:510

addRelayComponent

addRelayComponent(): SoloListrTask<RelayDeployContext>
Adds the relay component to remote config.

Returns SoloListrTask<RelayDeployContext>
- Defined in src/commands/relay.ts:839

close

close(): Promise<void>
Returns Promise<void>
Overrides BaseCommand.close
- Defined in src/commands/relay.ts:868

destroy

destroy(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/relay.ts:739

disableRelayComponent

disableRelayComponent(): SoloListrTask<RelayDestroyContext>
Remove the relay component from remote config.

Returns SoloListrTask<RelayDestroyContext>
- Defined in src/commands/relay.ts:856

`Protected`getClusterContext

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

`Protected`getClusterReference

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

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

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

`Protected`loadRemoteConfigOrWarn

loadRemoteConfigOrWarn(
    argv: { _: string[] } & Record<string, unknown>,
    validate?: boolean,
    skipConsensusNodesValidation?: boolean,
): Promise<boolean>
Parameters
- argv: { _: string[] } & Record<string, unknown>
- validate: boolean = true
- skipConsensusNodesValidation: boolean = true
Returns Promise<boolean>
Inherited from BaseCommand.loadRemoteConfigOrWarn
- Defined in src/commands/base.ts:72

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

run

run(
    cmd: string,
    arguments_?: string[],
    verbose?: boolean,
    detached?: boolean,
    environmentVariablesToAppend?: Record<string, string>,
    timeoutMs?: number,
): Promise<string[]>
Returns a promise that invokes the shell command
Parameters
- cmd: string
- arguments_: string[] = []
- verbose: boolean = false
- detached: boolean = false
- environmentVariablesToAppend: Record<string, string> = {}
- OptionaltimeoutMs: number
Returns Promise<string[]>
Inherited from BaseCommand.run
- Defined in src/core/shell-runner.ts:18

setupHomeDirectory

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

sudoRun

sudoRun(
    sudoRequested: (message: string) => void,
    sudoGranted: (message: string) => void,
    cmd: string,
    arguments_?: string[],
    verbose?: boolean,
    detached?: boolean,
    environmentVariablesToAppend?: Record<string, string>,
): Promise<string[]>
Parameters
- sudoRequested: (message: string) => void
- sudoGranted: (message: string) => void
- cmd: string
- arguments_: string[] = []
- verbose: boolean = false
- detached: boolean = false
- environmentVariablesToAppend: Record<string, string> = {}
Returns Promise<string[]>
Inherited from BaseCommand.sudoRun
- Defined in src/core/shell-runner.ts:128

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

upgrade

upgrade(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/relay.ts:634

Class RelayCommand

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RelayCommand

Properties

Protected Optional ReadonlychartManager

Protected Optional ReadonlycomponentFactory

Optional ReadonlyconfigManager

Protected Optional ReadonlydepManager

Protected Optional Readonlyhelm

Protected Optional Readonlyk8Factory

Protected Optional ReadonlyleaseManager

Optional ReadonlylocalConfig

Optionallogger

Protected Optional ReadonlynodeCommandTasks

Protected Optional ReadonlyoneShotState

Protected Optional ReadonlyremoteConfig

Protected Optional ReadonlytaskList

Static ReadonlyDEPLOY_FLAGS_LIST

Static ReadonlyDESTROY_FLAGS_LIST

Static ReadonlyUPGRADE_FLAGS_LIST

Methods

add

Parameters

Returns Promise<boolean>

addRelayComponent

Returns SoloListrTask<RelayDeployContext>

close

Returns Promise<void>

destroy

Parameters

Returns Promise<boolean>

disableRelayComponent

Returns SoloListrTask<RelayDestroyContext>

ProtectedgetClusterContext

Parameters

Returns string

ProtectedgetClusterReference

Returns string

ProtectedgetNamespace

Parameters

Returns Promise<NamespaceName>

ProtectedinferMirrorNodeData

Parameters

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

ProtectedloadRemoteConfigOrWarn

Parameters

Returns Promise<boolean>

ProtectedresolveNamespaceFromDeployment

Parameters

Returns Promise<NamespaceName>

run

Parameters

Returns Promise<string[]>

setupHomeDirectory

Parameters

Returns string[]

sudoRun

Parameters

Returns Promise<string[]>

ProtectedthrowIfNamespaceIsMissing

Parameters

Returns Promise<void>

upgrade

Parameters

Returns Promise<boolean>

Settings

On This Page

`Protected` `Optional` `Readonly`chartManager

`Protected` `Optional` `Readonly`componentFactory

`Optional` `Readonly`configManager

`Protected` `Optional` `Readonly`depManager

`Protected` `Optional` `Readonly`helm

`Protected` `Optional` `Readonly`k8Factory

`Protected` `Optional` `Readonly`leaseManager

`Optional` `Readonly`localConfig

`Optional`logger

`Protected` `Optional` `Readonly`nodeCommandTasks

`Protected` `Optional` `Readonly`oneShotState

`Protected` `Optional` `Readonly`remoteConfig

`Protected` `Optional` `Readonly`taskList

`Static` `Readonly`DEPLOY_FLAGS_LIST

`Static` `Readonly`DESTROY_FLAGS_LIST

`Static` `Readonly`UPGRADE_FLAGS_LIST

`Protected`getClusterContext

`Protected`getClusterReference

`Protected`getNamespace

`Protected`inferMirrorNodeData

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

`Protected`loadRemoteConfigOrWarn

`Protected`resolveNamespaceFromDeployment

`Protected`throwIfNamespaceIsMissing