Class RemoteConfigRuntimeState

constructor

• new RemoteConfigRuntimeState(
      k8Factory?: K8Factory,
      logger?: SoloLogger,
      localConfig?: LocalConfigRuntimeState,
      configManager?: ConfigManager,
      remoteConfigValidator?: RemoteConfigValidatorApi,
      objectMapper?: ObjectMapper,
  ): RemoteConfigRuntimeState

  Parameters

  • Optionalk8Factory: K8Factory
  • Optionallogger: SoloLogger
  • OptionallocalConfig: LocalConfigRuntimeState
  • OptionalconfigManager: ConfigManager
  • OptionalremoteConfigValidator: RemoteConfigValidatorApi
  • OptionalobjectMapper: ObjectMapper

  Returns RemoteConfigRuntimeState

clusterReferences

components

• get components(): Readonly<ComponentsDataWrapperApi>

  Returns Readonly<ComponentsDataWrapperApi>

configuration

• get configuration(): RemoteConfig

  Returns RemoteConfig

currentCluster

• get currentCluster(): string

  Returns string

addCommandToHistory

• addCommandToHistory(command: string): void

  Parameters

  • command: string

  Returns void

create

• create(
      argv: ArgvStruct,
      ledgerPhase: LedgerPhase,
      nodeAliases: NodeAliases,
      namespace: NamespaceName,
      deploymentName: string,
      clusterReference: string,
      context: string,
      dnsBaseDomain: string,
      dnsConsensusNodePattern: string,
  ): Promise<void>

  Parameters

  • argv: ArgvStruct
  • ledgerPhase: LedgerPhase
  • nodeAliases: NodeAliases
  • namespace: NamespaceName
  • deploymentName: string
  • clusterReference: string
  • context: string
  • dnsBaseDomain: string
  • dnsConsensusNodePattern: string

  Returns Promise<void>

createConfigMap

• createConfigMap(namespace: NamespaceName, context: string): Promise<ConfigMap>

  Parameters

  • namespace: NamespaceName
  • context: string

  Returns Promise<ConfigMap>

createFromExisting

• createFromExisting(
      namespace: NamespaceName,
      clusterReference: string,
      deploymentName: string,
      componentFactory: ComponentFactoryApi,
      dnsBaseDomain: string,
      dnsConsensusNodePattern: string,
      existingClusterContext: string,
      argv: ArgvStruct,
      nodeAliases: NodeAliases,
  ): Promise<void>

  Parameters

  • namespace: NamespaceName
  • clusterReference: string
  • deploymentName: string
  • componentFactory: ComponentFactoryApi
  • dnsBaseDomain: string
  • dnsConsensusNodePattern: string
  • existingClusterContext: string
  • argv: ArgvStruct
  • nodeAliases: NodeAliases

  Returns Promise<void>

deleteComponents

• deleteComponents(): Promise<void>

  Returns Promise<void>

extractContextFromConsensusNodes

• extractContextFromConsensusNodes(nodeAlias: `node${number}`): string

  Parameters

  • nodeAlias: `node${number}`

  Returns string

getClusterRefs

• getClusterRefs(): ClusterReferences

  Gets a list of distinct cluster references from the consensus nodes.

  Returns ClusterReferences

  an object of cluster references.

getComponentVersion

• getComponentVersion(type: ComponentTypes): SemVer

  Parameters

  • type: ComponentTypes

  Returns SemVer

getConsensusNodes

• getConsensusNodes(): ConsensusNode[]

  Get the consensus nodes from the remoteConfig 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.

getNamespace

• getNamespace(): NamespaceName

  Returns NamespaceName

isLoaded

• isLoaded(): boolean

  Returns boolean

load

• load(namespace?: NamespaceName, context?: string): Promise<void>

  Parameters

  • Optionalnamespace: NamespaceName
  • Optionalcontext: string

  Returns Promise<void>

loadAndValidate

• loadAndValidate(
      argv: { _: string[] } & AnyObject,
      validate?: boolean,
      skipConsensusNodesValidation?: boolean,
  ): Promise<void>

  Performs the loading of the remote configuration. Checks if the configuration is already loaded, otherwise loads and adds the command to history.

  Parameters

  • argv: { _: string[] } & AnyObject

    arguments containing command input for historical reference.

  • validate: boolean = true

    whether to validate the remote configuration.

  • OptionalskipConsensusNodesValidation: boolean = true

    whether or not to validate the consensusNodes

  Returns Promise<void>

persist

• persist(): Promise<void>

  Returns Promise<void>

populateClusterReferences

• populateClusterReferences(deploymentName: string): string

  Parameters

  • deploymentName: string

  Returns string

populateFromExisting

• populateFromExisting(namespace: NamespaceName, context: string): Promise<void>

  Parameters

  • namespace: NamespaceName
  • context: string

  Returns Promise<void>

remoteConfigExists

• remoteConfigExists(namespace: NamespaceName, context: string): Promise<boolean>

  Parameters

  • namespace: NamespaceName
  • context: string

  Returns Promise<boolean>

updateComponentVersion

• updateComponentVersion(type: ComponentTypes, version: SemVer): void

  Parameters

  • type: ComponentTypes
  • version: SemVer

  Returns void