Class ProfileManager

Index

Constructors

Methods

_setChartItems _setValue getProfile loadProfiles prepareConfigTxt prepareValuesForMirrorNodeChart prepareValuesForNodeTransaction prepareValuesForRpcRelayChart prepareValuesForSoloChart prepareValuesHederaExplorerChart resourcesForConsensusPod

Constructors

constructor

new ProfileManager(
    logger?: SoloLogger,
    configManager?: ConfigManager,
    cacheDirectory?: string,
    k8Factory?: K8Factory,
    remoteConfigManager?: RemoteConfigManager,
): ProfileManager
Parameters
- Optionallogger: SoloLogger
- OptionalconfigManager: ConfigManager
- OptionalcacheDirectory: string
- Optionalk8Factory: K8Factory
- OptionalremoteConfigManager: RemoteConfigManager
Returns ProfileManager
- Defined in src/core/profile-manager.ts:45

Methods

_setChartItems

_setChartItems(itemPath: string, items: any, yamlRoot: AnyObject): void
Set items for the chart
Parameters
- itemPath: string
  item path in the YAML, if empty then root of the YAML object will be used
- items: any
  the element object
- yamlRoot: AnyObject
  root of the YAML object to update
Returns void
- Defined in src/core/profile-manager.ts:176

_setValue

_setValue(itemPath: string, value: any, yamlRoot: AnyObject): AnyObject
Set value in the YAML object
Parameters
- itemPath: string
  item path in the yaml
- value: any
  value to be set
- yamlRoot: AnyObject
  root of the YAML object
Returns AnyObject
- Defined in src/core/profile-manager.ts:134

getProfile

getProfile(profileName: string): AnyObject
Get profile from the profiles map, loads them on demand if they are not loaded already.
Parameters
- profileName: string
  profile name (key in the map).
Returns AnyObject
the profile.

Throws
if profiles can't be loaded or the profile name is not found in the map.
- Defined in src/core/profile-manager.ts:112

loadProfiles

loadProfiles(forceReload?: boolean): Map<string, AnyObject>
Load profiles from a profile file and populate the profiles map.
Parameters
- OptionalforceReload: boolean = false
  forces the profiles map to override even if it exists.
Returns Map<string, AnyObject>
reference to the populated profiles map.

Throws
if the profile file is not found.
- Defined in src/core/profile-manager.ts:73

prepareConfigTxt

prepareConfigTxt(
    nodeAccountMap: Map<`node${number}`, string>,
    consensusNodes: ConsensusNode[],
    destinationPath: string,
    releaseTagOverride: string,
    domainNamesMapping: Record<`node${number}`, string>,
    appName?: string,
    chainId?: string,
    loadBalancerEnabled?: boolean,
): Promise<string>
Prepares config.txt file for the node
Parameters
- nodeAccountMap: Map<`node${number}`, string>
  the map of node aliases to account IDs
- consensusNodes: ConsensusNode[]
  the list of consensus nodes
- destinationPath: string
- releaseTagOverride: string
  release tag override
- domainNamesMapping: Record<`node${number}`, string>
- OptionalappName: string = constants.HEDERA_APP_NAME
  the app name (default: HederaNode.jar)
- OptionalchainId: string = constants.HEDERA_CHAIN_ID
  chain ID (298 for local network)
- OptionalloadBalancerEnabled: boolean = false
  whether the load balancer is enabled (flag is not set by default)
Returns Promise<string>
the config.txt file path
- Defined in src/core/profile-manager.ts:524

prepareValuesForMirrorNodeChart

prepareValuesForMirrorNodeChart(profileName: string): Promise<string>
Prepare a values file for mirror-node Helm chart
Parameters
- profileName: string
  resource profile name
Returns Promise<string>
the full path to the values file
- Defined in src/core/profile-manager.ts:472

prepareValuesForNodeTransaction

prepareValuesForNodeTransaction(
configTxtPath: string,
applicationPropertiesPath: string,
): Promise<string>
Parameters
- configTxtPath: string
- applicationPropertiesPath: string
Returns Promise<string>
- Defined in src/core/profile-manager.ts:404

prepareValuesForRpcRelayChart

prepareValuesForRpcRelayChart(profileName: string): Promise<string>
Prepare a values file for rpc-relay Helm chart
Parameters
- profileName: string
  resource profile name
Returns Promise<string>
return the full path to the values file
- Defined in src/core/profile-manager.ts:419

prepareValuesForSoloChart

prepareValuesForSoloChart(
    profileName: string,
    consensusNodes: ConsensusNode[],
    domainNamesMapping: Record<`node${number}`, string>,
): Promise<Record<string, string>>
Prepare a values file for Solo Helm chart
Parameters
- profileName: string
  resource profile name
- consensusNodes: ConsensusNode[]
  the list of consensus nodes
- domainNamesMapping: Record<`node${number}`, string>
Returns Promise<Record<string, string>>
mapping of cluster-ref to the full path to the values file
- Defined in src/core/profile-manager.ts:359

prepareValuesHederaExplorerChart

prepareValuesHederaExplorerChart(profileName: string): Promise<string>
Parameters
- profileName: string
Returns Promise<string>
- Defined in src/core/profile-manager.ts:436

resourcesForConsensusPod

resourcesForConsensusPod(
    profile: AnyObject,
    consensusNodes: ConsensusNode[],
    nodeAliases: NodeAliases,
    yamlRoot: AnyObject,
    domainNamesMapping: Record<`node${number}`, string>,
): Promise<AnyObject>
Parameters
- profile: AnyObject
- consensusNodes: ConsensusNode[]
- nodeAliases: NodeAliases
- yamlRoot: AnyObject
- domainNamesMapping: Record<`node${number}`, string>
Returns Promise<AnyObject>
- Defined in src/core/profile-manager.ts:199

Class ProfileManager

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ProfileManager

Methods

_setChartItems

Parameters

Returns void

_setValue

Parameters

Returns AnyObject

getProfile

Parameters

Returns AnyObject

Throws

loadProfiles

Parameters

Returns Map<string, AnyObject>

Throws

prepareConfigTxt

Parameters

Returns Promise<string>

prepareValuesForMirrorNodeChart

Parameters

Returns Promise<string>

prepareValuesForNodeTransaction

Parameters

Returns Promise<string>

prepareValuesForRpcRelayChart

Parameters

Returns Promise<string>

prepareValuesForSoloChart

Parameters

Returns Promise<Record<string, string>>

prepareValuesHederaExplorerChart

Parameters

Returns Promise<string>

resourcesForConsensusPod

Parameters

Returns Promise<AnyObject>

Settings

On This Page