Class DeploymentCommand

Hierarchy (View Summary)

BaseCommand
- DeploymentCommand

Constructors

constructor

new DeploymentCommand(
tasks: ClusterCommandTasks,
componentFactory: ComponentFactoryApi,
): DeploymentCommand
Parameters
- tasks: ClusterCommandTasks
- componentFactory: ComponentFactoryApi
Returns DeploymentCommand
Overrides BaseCommand.constructor
- Defined in src/commands/deployment.ts:63

Properties

`Protected` `Optional` `Readonly`chartManager

chartManager?: ChartManager

`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

`Protected` `Optional` `Readonly`taskList

taskList?: TaskList<any, ListrRendererValue, ListrRendererValue>

`Static` `Readonly`ADD_COMMAND

ADD_COMMAND: string = 'deployment add-cluster'

`Static` `Readonly`COMMAND_NAME

COMMAND_NAME: "deployment" = 'deployment'

`Static` `Readonly`CREATE_COMMAND

CREATE_COMMAND: string = 'deployment create'

Methods

addCluster

addCluster(argv: ArgvStruct): Promise<boolean>
Add new cluster for specified deployment, and create or edit the remote config
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/deployment.ts:281

addClusterRefToDeployments

addClusterRefToDeployments(): SoloListrTask<DeploymentAddClusterContext>
Adds the new cluster-ref for the deployment in local config

Returns SoloListrTask<DeploymentAddClusterContext>
- Defined in src/commands/deployment.ts:672

checkNetworkState

checkNetworkState(): SoloListrTask<DeploymentAddClusterContext>
Checks the ledger phase:
- if remote config is found check's the ledgerPhase field to see if it's pre or post genesis.
  - pre genesis:
    
    prompts user if needed.
    
    generates node aliases based on '--number-of-consensus-nodes'
  - post genesis:
    
    throws if '--number-of-consensus-nodes' is passed
- if remote config is not found:
  - prompts user if needed.
  - generates node aliases based on '--number-of-consensus-nodes'.
Returns SoloListrTask<DeploymentAddClusterContext>
- Defined in src/commands/deployment.ts:566

close

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

create

create(argv: ArgvStruct): Promise<boolean>
Create new deployment inside the local config
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/deployment.ts:103

createOrEditRemoteConfigForNewDeployment

createOrEditRemoteConfigForNewDeployment(
argv: ArgvStruct,
): SoloListrTask<DeploymentAddClusterContext>
- if remote config not found, create new remote config for the deployment.
- if remote config is found, add the new data for the deployment.
Parameters
- argv: ArgvStruct
Returns SoloListrTask<DeploymentAddClusterContext>
- Defined in src/commands/deployment.ts:690

delete

delete(argv: ArgvStruct): Promise<boolean>
Delete a deployment from the local config
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/deployment.ts:189

getCommandDefinition

getCommandDefinition(): CommandDefinition
Returns CommandDefinition
- Defined in src/commands/deployment.ts:378

initializeClusterAddConfig

initializeClusterAddConfig(
argv: ArgvStruct,
): SoloListrTask<DeploymentAddClusterContext>
Initializes and populates the config and context for 'deployment add-cluster'
Parameters
- argv: ArgvStruct
Returns SoloListrTask<DeploymentAddClusterContext>
- Defined in src/commands/deployment.ts:491

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

setupHomeDirectoryTask

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

testClusterConnection

testClusterConnection(): SoloListrTask<DeploymentAddClusterContext>
Tries to connect with the cluster using the context from the local config

Returns SoloListrTask<DeploymentAddClusterContext>
- Defined in src/commands/deployment.ts:638

verifyClusterAddArgs

verifyClusterAddArgs(): SoloListrTask<DeploymentAddClusterContext>
Validates:
- cluster ref is present in the local config's cluster-ref => context mapping
- the deployment is created
- the cluster-ref is not already added to the deployment
Returns SoloListrTask<DeploymentAddClusterContext>
- Defined in src/commands/deployment.ts:529

verifyClusterAddPrerequisites

verifyClusterAddPrerequisites(): SoloListrTask<DeploymentAddClusterContext>
Returns SoloListrTask<DeploymentAddClusterContext>
- Defined in src/commands/deployment.ts:660

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

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

Class DeploymentCommand

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DeploymentCommand

Properties

Protected Optional ReadonlychartManager

Optional ReadonlyconfigManager

Protected Optional ReadonlydepManager

Protected Optional Readonlyhelm

Protected Optional Readonlyk8Factory

Protected Optional ReadonlyleaseManager

Optional ReadonlylocalConfig

Optionallogger

Protected Optional ReadonlyremoteConfig

Protected Optional ReadonlytaskList

Static ReadonlyADD_COMMAND

Static ReadonlyCOMMAND_NAME

Static ReadonlyCREATE_COMMAND

Methods

addCluster

Parameters

Returns Promise<boolean>

addClusterRefToDeployments

Returns SoloListrTask<DeploymentAddClusterContext>

checkNetworkState

Returns SoloListrTask<DeploymentAddClusterContext>

close

Returns Promise<void>

create

Parameters

Returns Promise<boolean>

createOrEditRemoteConfigForNewDeployment

Parameters

Returns SoloListrTask<DeploymentAddClusterContext>

delete

Parameters

Returns Promise<boolean>

getCommandDefinition

Returns CommandDefinition

initializeClusterAddConfig

Parameters

Returns SoloListrTask<DeploymentAddClusterContext>

run

Parameters

Returns Promise<string[]>

setupHomeDirectory

Parameters

Returns string[]

setupHomeDirectoryTask

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

testClusterConnection

Returns SoloListrTask<DeploymentAddClusterContext>

verifyClusterAddArgs

Returns SoloListrTask<DeploymentAddClusterContext>

verifyClusterAddPrerequisites

Returns SoloListrTask<DeploymentAddClusterContext>

StaticprepareValuesFilesMap

Parameters

Returns Record<ClusterReferenceName, string>

StaticprepareValuesFilesMapMultipleCluster

Parameters

Returns Record<ClusterReferenceName, string>

Settings

On This Page

`Protected` `Optional` `Readonly`chartManager

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

`Protected` `Optional` `Readonly`taskList

`Static` `Readonly`ADD_COMMAND

`Static` `Readonly`COMMAND_NAME

`Static` `Readonly`CREATE_COMMAND

`Static`prepareValuesFilesMap

`Static`prepareValuesFilesMapMultipleCluster