Class NetworkCommand

Hierarchy (View Summary)

BaseCommand
- NetworkCommand

Constructors

constructor

new NetworkCommand(opts: Opts): NetworkCommand
Parameters
- opts: Opts
Returns NetworkCommand
Overrides BaseCommand.constructor
- Defined in solo/solo/src/commands/network.ts:92

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

Accessors

`Static`DEPLOY_CONFIGS_NAME

get DEPLOY_CONFIGS_NAME(): string
Returns string
- Defined in solo/solo/src/commands/network.ts:111

`Static`DEPLOY_FLAGS_LIST

get DEPLOY_FLAGS_LIST(): CommandFlag[]
Returns CommandFlag[]
- Defined in solo/solo/src/commands/network.ts:115

Methods

addNodesAndProxies

addNodesAndProxies(): SoloListrTask<
{ config: { namespace: string; nodeAliases: NodeAliases } },
>
Adds the consensus node, envoy and haproxy components to remote config.

Returns SoloListrTask<{ config: { namespace: string; nodeAliases: NodeAliases } }>
- Defined in solo/solo/src/commands/network.ts:956

close

close(): Promise<void>
Returns Promise<void>
Overrides BaseCommand.close
- Defined in solo/solo/src/commands/network.ts:988

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>
Inherited from BaseCommand.commandActionBuilder
- Defined in solo/solo/src/commands/base.ts:207

deploy

deploy(argv: any): Promise<boolean>
Run helm install and deploy network components
Parameters
- argv: any
Returns Promise<boolean>
- Defined in solo/solo/src/commands/network.ts:495

destroy

destroy(argv: any): Promise<boolean>
Parameters
- argv: any
Returns Promise<boolean>
- Defined in solo/solo/src/commands/network.ts:720

destroyTask

destroyTask(ctx: any, task: any): Promise<void>
Parameters
- ctx: any
- task: any
Returns Promise<void>
- Defined in solo/solo/src/commands/network.ts:467

getChartManager

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

getCommandDefinition

getCommandDefinition(): {
    builder: CommandBuilder;
    command: string;
    desc: string;
}
Returns { builder: CommandBuilder; command: string; desc: string }
- Defined in solo/solo/src/commands/network.ts:871

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
Inherited from BaseCommand.getConfig
- Defined in solo/solo/src/commands/base.ts:113

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
Inherited from BaseCommand.getUnusedConfigs
- 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>
Inherited from BaseCommand.prepareChartPath
- Defined in solo/solo/src/commands/base.ts:74

prepareConfig

prepareConfig(task: any, argv: any): Promise<NetworkDeployConfigClass>
Parameters
- task: any
- argv: any
Returns Promise<NetworkDeployConfigClass>
- Defined in solo/solo/src/commands/network.ts:358

prepareStorageSecrets

prepareStorageSecrets(config: NetworkDeployConfigClass): Promise<void>
Parameters
- config: NetworkDeployConfigClass
Returns Promise<void>
- Defined in solo/solo/src/commands/network.ts:156

prepareValuesArg

prepareValuesArg(
    config: {
        app?: string;
        backupBucket: string;
        chartDirectory?: string;
        debugNodeAlias?: `node${number}`;
        enablePrometheusSvcMonitor?: boolean;
        envoyIpsParsed?: Record<`node${number}`, string>;
        googleCredential: string;
        haproxyIpsParsed?: Record<`node${number}`, string>;
        loadBalancerEnabled: boolean;
        nodeAliases: string[];
        persistentVolumeClaims?: string;
        releaseTag?: string;
        resolvedThrottlesFile: string;
        storageAccessKey: string;
        storageBucket: string;
        storageEndpoint: string;
        storageSecrets: string;
        storageType: StorageType;
        valuesFile?: string;
    },
): Promise<string>
Parameters
- config: {
      app?: string;
      backupBucket: string;
      chartDirectory?: string;
      debugNodeAlias?: `node${number}`;
      enablePrometheusSvcMonitor?: boolean;
      envoyIpsParsed?: Record<`node${number}`, string>;
      googleCredential: string;
      haproxyIpsParsed?: Record<`node${number}`, string>;
      loadBalancerEnabled: boolean;
      nodeAliases: string[];
      persistentVolumeClaims?: string;
      releaseTag?: string;
      resolvedThrottlesFile: string;
      storageAccessKey: string;
      storageBucket: string;
      storageEndpoint: string;
      storageSecrets: string;
      storageType: StorageType;
      valuesFile?: string;
  }
Returns Promise<string>
- Defined in solo/solo/src/commands/network.ts:240

prepareValuesFiles

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

refresh

refresh(argv: any): Promise<boolean>
Run helm upgrade to refresh network components with new settings
Parameters
- argv: any
Returns Promise<boolean>
- Defined in solo/solo/src/commands/network.ts:813

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 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[]
Inherited from BaseCommand.setupHomeDirectory
- Defined in solo/solo/src/commands/base.ts:231

setupHomeDirectoryTask

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

Class NetworkCommand

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NetworkCommand

Properties

Protected Readonly_configMaps

Protected ReadonlychartManager

Protected ReadonlyconfigManager

Protected ReadonlydepManager

Protected Readonlyhelm

Protected Readonlyk8

Protected ReadonlyleaseManager

Protected ReadonlylocalConfig

Optionallogger

Protected ReadonlyremoteConfigManager

Accessors

StaticDEPLOY_CONFIGS_NAME

Returns string

StaticDEPLOY_FLAGS_LIST

Returns CommandFlag[]

Methods

addNodesAndProxies

Returns SoloListrTask<{ config: { namespace: string; nodeAliases: NodeAliases } }>

close

Returns Promise<void>

commandActionBuilder

Parameters

Returns (argv: any, commandDef: CommandHandlers) => Promise<void>

deploy

Parameters

Returns Promise<boolean>

destroy

Parameters

Returns Promise<boolean>

destroyTask

Parameters

Returns Promise<void>

getChartManager

Returns ChartManager

getCommandDefinition

Returns { builder: CommandBuilder; command: string; desc: string }

getConfig

Parameters

Returns object

getConfigManager

Returns ConfigManager

getK8

Returns K8

getLeaseManager

Returns LeaseManager

getLocalConfig

Returns LocalConfig

getRemoteConfigManager

Returns RemoteConfigManager

getUnusedConfigs

Parameters

Returns string[]

prepareChartPath

Parameters

Returns Promise<string>

prepareConfig

Parameters

Returns Promise<NetworkDeployConfigClass>

prepareStorageSecrets

Parameters

Returns Promise<void>

prepareValuesArg

Parameters

Returns Promise<string>

prepareValuesFiles

Parameters

Returns string

refresh

`Protected` `Readonly`_configMaps

`Protected` `Readonly`chartManager

`Protected` `Readonly`configManager

`Protected` `Readonly`depManager

`Protected` `Readonly`helm

`Protected` `Readonly`k8

`Protected` `Readonly`leaseManager

`Protected` `Readonly`localConfig

`Optional`logger

`Protected` `Readonly`remoteConfigManager

`Static`DEPLOY_CONFIGS_NAME

`Static`DEPLOY_FLAGS_LIST