Class DeploymentCommand

constructor

• new DeploymentCommand(options: Options): DeploymentCommand

  Parameters

  • options: Options

  Returns DeploymentCommand

Readonlytasks

Static ReadonlyCOMMAND_NAME

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>

addClusterRefToDeployments

• addClusterRefToDeployments(): SoloListrTask<DeploymentAddClusterContext>

  Adds the new cluster-ref for the deployment in local config

  Returns SoloListrTask<DeploymentAddClusterContext>

checkNetworkState

• checkNetworkState(): SoloListrTask<DeploymentAddClusterContext>

  Checks the network state:

  • if remote config is found check's the state 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>

close

• close(): Promise<void>

  Returns Promise<void>

create

• create(argv: ArgvStruct): Promise<boolean>

  Create new deployment inside the local config

  Parameters

  • argv: ArgvStruct

  Returns Promise<boolean>

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>

delete

• delete(argv: ArgvStruct): Promise<boolean>

  Delete a deployment from the local config

  Parameters

  • argv: ArgvStruct

  Returns Promise<boolean>

getCommandDefinition

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

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

initializeClusterAddConfig

• initializeClusterAddConfig(
      argv: ArgvStruct,
  ): SoloListrTask<DeploymentAddClusterContext>

  Initializes and populates the config and context for 'deployment add-cluster'

  Parameters

  • argv: ArgvStruct

  Returns SoloListrTask<DeploymentAddClusterContext>

testClusterConnection

• testClusterConnection(): SoloListrTask<DeploymentAddClusterContext>

  Tries to connect with the cluster using the context from the local config

  Returns SoloListrTask<DeploymentAddClusterContext>

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>

verifyClusterAddPrerequisites

• verifyClusterAddPrerequisites(): SoloListrTask<DeploymentAddClusterContext>

  Returns SoloListrTask<DeploymentAddClusterContext>