Class NetworkCommand

Hierarchy (View Summary)

BaseCommand
- NetworkCommand

Constructors

constructor

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

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

k8Factory: K8Factory

`Protected` `Readonly`leaseManager

leaseManager: LeaseManager

`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 src/commands/network.ts:129

`Static`DEPLOY_FLAGS_LIST

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

Methods

addNodesAndProxies

addNodesAndProxies(): SoloListrTask<any>
Adds the consensus node, envoy and haproxy components to remote config.

Returns SoloListrTask<any>
- Defined in src/commands/network.ts:1337

close

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

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 src/commands/base.ts:308

deploy

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

destroy

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

destroyTask

destroyTask(
ctx: NetworkDestroyContext,
task: SoloListrTaskWrapper<NetworkDestroyContext>,
): Promise<void>
Parameters
- ctx: NetworkDestroyContext
- task: SoloListrTaskWrapper<NetworkDestroyContext>
Returns Promise<void>
- Defined in src/commands/network.ts:724

getChartManager

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

getClusterRefs

getClusterRefs(): ClusterRefs
Gets a list of distinct cluster references from the consensus nodes

Returns ClusterRefs
an object of cluster references

Deprecated
use one inside remote config
Inherited from BaseCommand.getClusterRefs
- Defined in src/commands/base.ts:429

getCommandDefinition

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

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 src/commands/base.ts:213

getConfigManager

getConfigManager(): ConfigManager
Returns ConfigManager
Inherited from BaseCommand.getConfigManager
- Defined in src/commands/base.ts:200

getConsensusNodes

getConsensusNodes(): ConsensusNode[]
Get the consensus nodes from the remoteConfigManager and use the localConfig to get the context

Returns ConsensusNode[]
an array of ConsensusNode objects
Inherited from BaseCommand.getConsensusNodes
- Defined in src/commands/base.ts:368

getContexts

getContexts(): string[]
Gets a list of distinct contexts from the consensus nodes

Returns string[]
an array of context strings

Deprecated
use one inside remote config
Inherited from BaseCommand.getContexts
- Defined in src/commands/base.ts:414

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 src/commands/base.ts:290

prepareBackupUploaderSecrets

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

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 src/commands/base.ts:92

prepareConfig

prepareConfig(
    task: any,
    argv: any,
    promptForNodeAliases?: boolean,
): Promise<NetworkDeployConfigClass>
Parameters
- task: any
- argv: any
- promptForNodeAliases: boolean = false
Returns Promise<NetworkDeployConfigClass>
- Defined in src/commands/network.ts:594

prepareMinioSecrets

prepareMinioSecrets(
    config: NetworkDeployConfigClass,
    minioAccessKey: string,
    minioSecretKey: string,
): Promise<void>
Parameters
- config: NetworkDeployConfigClass
- minioAccessKey: string
- minioSecretKey: string
Returns Promise<void>
- Defined in src/commands/network.ts:216

prepareNamespaces

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

prepareStorageSecrets

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

prepareStreamUploaderSecrets

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

prepareValuesArg

prepareValuesArg(
    config: {
        app?: string;
        awsBucket: string;
        awsBucketPrefix: string;
        awsEndpoint: string;
        awsWriteAccessKey: string;
        awsWriteSecrets: string;
        backupBucket: string;
        chartDirectory?: string;
        consensusNodes: ConsensusNode[];
        debugNodeAlias?: `node${number}`;
        enablePrometheusSvcMonitor?: boolean;
        envoyIpsParsed?: Record<`node${number}`, string>;
        gcsBucket: string;
        gcsBucketPrefix: string;
        gcsEndpoint: string;
        gcsWriteAccessKey: string;
        gcsWriteSecrets: string;
        googleCredential: string;
        haproxyIpsParsed?: Record<`node${number}`, string>;
        loadBalancerEnabled: boolean;
        persistentVolumeClaims?: string;
        releaseTag?: string;
        resolvedThrottlesFile: string;
        storageType: StorageType;
        valuesFile?: string;
    },
): Record<string, string>
Prepare the values argument for the helm chart for a given config
Parameters
- config: {
      app?: string;
      awsBucket: string;
      awsBucketPrefix: string;
      awsEndpoint: string;
      awsWriteAccessKey: string;
      awsWriteSecrets: string;
      backupBucket: string;
      chartDirectory?: string;
      consensusNodes: ConsensusNode[];
      debugNodeAlias?: `node${number}`;
      enablePrometheusSvcMonitor?: boolean;
      envoyIpsParsed?: Record<`node${number}`, string>;
      gcsBucket: string;
      gcsBucketPrefix: string;
      gcsEndpoint: string;
      gcsWriteAccessKey: string;
      gcsWriteSecrets: string;
      googleCredential: string;
      haproxyIpsParsed?: Record<`node${number}`, string>;
      loadBalancerEnabled: boolean;
      persistentVolumeClaims?: string;
      releaseTag?: string;
      resolvedThrottlesFile: string;
      storageType: StorageType;
      valuesFile?: string;
  }
Returns Record<string, string>
- Defined in src/commands/network.ts:386

prepareValuesArgMap

prepareValuesArgMap(
    config: {
        app?: string;
        awsBucket: string;
        awsBucketPrefix: string;
        awsEndpoint: string;
        awsWriteAccessKey: string;
        awsWriteSecrets: string;
        backupBucket: string;
        chartDirectory?: string;
        clusterRefs: ClusterRefs;
        consensusNodes: ConsensusNode[];
        debugNodeAlias?: `node${number}`;
        enablePrometheusSvcMonitor?: boolean;
        envoyIpsParsed?: Record<`node${number}`, string>;
        gcsBucket: string;
        gcsBucketPrefix: string;
        gcsEndpoint: string;
        gcsWriteAccessKey: string;
        gcsWriteSecrets: string;
        googleCredential: string;
        haproxyIpsParsed?: Record<`node${number}`, string>;
        loadBalancerEnabled: boolean;
        nodeAliases: string[];
        persistentVolumeClaims?: string;
        releaseTag?: string;
        resolvedThrottlesFile: string;
        storageType: StorageType;
        valuesFile?: string;
    },
): Promise<Record<string, string>>
Prepare values args string for each cluster-ref
Parameters
- config: {
      app?: string;
      awsBucket: string;
      awsBucketPrefix: string;
      awsEndpoint: string;
      awsWriteAccessKey: string;
      awsWriteSecrets: string;
      backupBucket: string;
      chartDirectory?: string;
      clusterRefs: ClusterRefs;
      consensusNodes: ConsensusNode[];
      debugNodeAlias?: `node${number}`;
      enablePrometheusSvcMonitor?: boolean;
      envoyIpsParsed?: Record<`node${number}`, string>;
      gcsBucket: string;
      gcsBucketPrefix: string;
      gcsEndpoint: string;
      gcsWriteAccessKey: string;
      gcsWriteSecrets: string;
      googleCredential: string;
      haproxyIpsParsed?: Record<`node${number}`, string>;
      loadBalancerEnabled: boolean;
      nodeAliases: string[];
      persistentVolumeClaims?: string;
      releaseTag?: string;
      resolvedThrottlesFile: string;
      storageType: StorageType;
      valuesFile?: string;
  }
Returns Promise<Record<string, string>>
- Defined in src/commands/network.ts:332

prepareValuesFiles

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

refresh

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

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

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 src/commands/base.ts:332

setupHomeDirectoryTask

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

`Static`prepareValuesFilesMap

prepareValuesFilesMap(
    clusterRefs: ClusterRefs,
    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
- clusterRefs: ClusterRefs
  the map of cluster references
- OptionalchartDirectory: string
  the chart directory
- OptionalprofileValuesFile: string
  the profile values file
- OptionalvaluesFileInput: string
  the values file input string
Returns Record<string, string>
Inherited from BaseCommand.prepareValuesFilesMap
- Defined in src/commands/base.ts:133

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 Readonlyk8Factory

Protected ReadonlyleaseManager

ReadonlylocalConfig

Optionallogger

Protected ReadonlyremoteConfigManager

Accessors

StaticDEPLOY_CONFIGS_NAME

Returns string

StaticDEPLOY_FLAGS_LIST

Returns CommandFlag[]

Methods

addNodesAndProxies

Returns SoloListrTask<any>

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

getClusterRefs

Returns ClusterRefs

Deprecated

getCommandDefinition

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

getConfig

Parameters

Returns object

getConfigManager

Returns ConfigManager

getConsensusNodes

Returns ConsensusNode[]

getContexts

Returns string[]

Deprecated

getK8Factory

Returns K8Factory

getLeaseManager

Returns LeaseManager

getLocalConfig

Returns LocalConfig

getRemoteConfigManager

Returns RemoteConfigManager

getUnusedConfigs

Parameters

Returns string[]

prepareBackupUploaderSecrets

Parameters

Returns Promise<void>

prepareChartPath

Parameters

Returns Promise<string>

prepareConfig

Parameters

`Protected` `Readonly`_configMaps

`Protected` `Readonly`chartManager

`Protected` `Readonly`configManager

`Protected` `Readonly`depManager

`Protected` `Readonly`helm

`Protected` `Readonly`k8Factory

`Protected` `Readonly`leaseManager

`Readonly`localConfig

`Optional`logger

`Protected` `Readonly`remoteConfigManager

`Static`DEPLOY_CONFIGS_NAME

`Static`DEPLOY_FLAGS_LIST

`Static`prepareValuesFilesMap