Class ClusterCommand

ReadonlylocalConfig

Optionallogger

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>

getChartManager

• getChartManager(): ChartManager

  Returns ChartManager

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

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

getConfigManager

• getConfigManager(): ConfigManager

  Returns ConfigManager

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

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

getK8Factory

• getK8Factory(): K8Factory

  Returns K8Factory

getLeaseManager

• getLeaseManager(): LeaseManager

  Returns LeaseManager

getLocalConfig

• getLocalConfig(): LocalConfig

  Returns LocalConfig

getRemoteConfigManager

• getRemoteConfigManager(): RemoteConfigManager

  Returns RemoteConfigManager

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

prepareChartPath

• prepareChartPath(
      chartDir: string,
      chartRepo: string,
      chartReleaseName: string,
  ): Promise<string>

  Parameters

  • chartDir: string
  • chartRepo: string
  • chartReleaseName: string

  Returns Promise<string>

prepareValuesFiles

• prepareValuesFiles(valuesFile: string): string

  Parameters

  • valuesFile: string

  Returns string

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[]>

setupHomeDirectory

• setupHomeDirectory(dirs?: string[]): string[]

  Setup home directories

  Parameters

  • dirs: string[] = []

    a list of directories that need to be created in sequence

  Returns string[]

setupHomeDirectoryTask

• setupHomeDirectoryTask(): Task

  Returns Task

StaticprepareValuesFilesMap

• 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>