Class NetworkCommand

Hierarchy (View Summary)

BaseCommand
- NetworkCommand

Constructors

constructor

new NetworkCommand(options: Options): NetworkCommand
Parameters
- options: Options
Returns NetworkCommand
Overrides BaseCommand.constructor
- Defined in src/commands/network.ts:122

Properties

`Protected` `Readonly`chartManager

chartManager: ChartManager

`Readonly`configManager

configManager: ConfigManager

`Protected` `Readonly`depManager

depManager: DependencyManager

`Protected` `Readonly`helm

helm: HelmClient

`Protected` `Readonly`k8Factory

k8Factory: K8Factory

`Protected` `Readonly`leaseManager

leaseManager: LockManager

`Readonly`localConfig

localConfig: LocalConfig

`Optional`logger

logger?: SoloLogger

`Protected` `Readonly`remoteConfigManager

remoteConfigManager: RemoteConfigManager

`Static` `Readonly`COMMAND_NAME

COMMAND_NAME: "network" = 'network'

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

close

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

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

destroy

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

destroyTask

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

getCommandDefinition

getCommandDefinition(): {
    builder: (yargs: any) => any;
    command: string;
    desc: string;
}
Returns { builder: (yargs: any) => any; command: string; desc: string }
- Defined in src/commands/network.ts:1261

prepareBackupUploaderSecrets

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

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

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

prepareNamespaces

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

prepareStorageSecrets

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

prepareStreamUploaderSecrets

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

prepareValuesArg

prepareValuesArg(
    config: {
        app?: string;
        awsBucket: string;
        awsBucketPrefix: string;
        awsEndpoint: string;
        awsWriteAccessKey: string;
        awsWriteSecrets: string;
        backupBucket: string;
        chartDirectory?: string;
        consensusNodes: ConsensusNode[];
        debugNodeAlias?: `node${number}`;
        domainNamesMapping?: Record<`node${number}`, string>;
        enablePrometheusSvcMonitor?: boolean;
        envoyIpsParsed?: Record<`node${number}`, string>;
        gcsBucket: string;
        gcsBucketPrefix: string;
        gcsEndpoint: string;
        gcsWriteAccessKey: string;
        gcsWriteSecrets: 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}`;
      domainNamesMapping?: Record<`node${number}`, string>;
      enablePrometheusSvcMonitor?: boolean;
      envoyIpsParsed?: Record<`node${number}`, string>;
      gcsBucket: string;
      gcsBucketPrefix: string;
      gcsEndpoint: string;
      gcsWriteAccessKey: string;
      gcsWriteSecrets: 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:425

prepareValuesArgMap

prepareValuesArgMap(
    config: {
        app?: string;
        awsBucket: string;
        awsBucketPrefix: string;
        awsEndpoint: string;
        awsWriteAccessKey: string;
        awsWriteSecrets: string;
        backupBucket: string;
        chartDirectory?: string;
        clusterRefs: ClusterReferences;
        consensusNodes: ConsensusNode[];
        debugNodeAlias?: `node${number}`;
        domainNamesMapping?: Record<`node${number}`, string>;
        enablePrometheusSvcMonitor?: boolean;
        envoyIpsParsed?: Record<`node${number}`, string>;
        gcsBucket: string;
        gcsBucketPrefix: string;
        gcsEndpoint: string;
        gcsWriteAccessKey: string;
        gcsWriteSecrets: 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: ClusterReferences;
      consensusNodes: ConsensusNode[];
      debugNodeAlias?: `node${number}`;
      domainNamesMapping?: Record<`node${number}`, string>;
      enablePrometheusSvcMonitor?: boolean;
      envoyIpsParsed?: Record<`node${number}`, string>;
      gcsBucket: string;
      gcsBucketPrefix: string;
      gcsEndpoint: string;
      gcsWriteAccessKey: string;
      gcsWriteSecrets: 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:363

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

setupHomeDirectoryTask

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

`Static`prepareValuesFilesMap

prepareValuesFilesMap(
    clusterReferences: ClusterReferences,
    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
- clusterReferences: ClusterReferences
- OptionalchartDirectory: string
  the chart directory
- OptionalprofileValuesFile: string
  the profile values file full path
- OptionalvaluesFileInput: string
  the values file input string
Returns Record<string, string>
Inherited from BaseCommand.prepareValuesFilesMap
- Defined in src/commands/base.ts:173

`Static`prepareValuesFilesMapMulticluster

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

Class NetworkCommand

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns NetworkCommand

Properties

Protected ReadonlychartManager

ReadonlyconfigManager

Protected ReadonlydepManager

Protected Readonlyhelm

Protected Readonlyk8Factory

Protected ReadonlyleaseManager

ReadonlylocalConfig

Optionallogger

Protected ReadonlyremoteConfigManager

Static ReadonlyCOMMAND_NAME

Methods

addNodesAndProxies

Returns SoloListrTask<any>

close

Returns Promise<void>

deploy

Parameters

Returns Promise<boolean>

destroy

Parameters

Returns Promise<boolean>

destroyTask

Parameters

Returns Promise<void>

getCommandDefinition

Returns { builder: (yargs: any) => any; command: string; desc: string }

prepareBackupUploaderSecrets

Parameters

Returns Promise<void>

prepareConfig

Parameters

Returns Promise<NetworkDeployConfigClass>

prepareMinioSecrets

Parameters

Returns Promise<void>

prepareNamespaces

Parameters

Returns Promise<void>

prepareStorageSecrets

Parameters

Returns Promise<void>

prepareStreamUploaderSecrets

Parameters

Returns Promise<void>

prepareValuesArg

Parameters

Returns Record<string, string>

prepareValuesArgMap

Parameters

Returns Promise<Record<string, string>>

run

Parameters

Returns Promise<string[]>

setupHomeDirectory

Parameters

Returns string[]

setupHomeDirectoryTask

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

StaticprepareValuesFilesMap

Parameters

Returns Record<string, string>

StaticprepareValuesFilesMapMulticluster

Parameters

Returns Record<string, string>

Settings

On This Page

`Protected` `Readonly`chartManager

`Readonly`configManager

`Protected` `Readonly`depManager

`Protected` `Readonly`helm

`Protected` `Readonly`k8Factory

`Protected` `Readonly`leaseManager

`Readonly`localConfig

`Optional`logger

`Protected` `Readonly`remoteConfigManager

`Static` `Readonly`COMMAND_NAME

`Static`prepareValuesFilesMap

`Static`prepareValuesFilesMapMulticluster