Class PlatformInstaller

PlatformInstaller install platform code in the root-container of a network pod

Index

Constructors

Methods

copyFiles copyGossipKeys copyNodeKeys copyTLSKeys fetchPlatform setPathPermission setPlatformDirPermissions taskSetup validatePlatformReleaseDir

Constructors

constructor

new PlatformInstaller(
    logger?: SoloLogger,
    k8Factory?: K8Factory,
    configManager?: ConfigManager,
): PlatformInstaller
Parameters
- Optionallogger: SoloLogger
- Optionalk8Factory: K8Factory
- OptionalconfigManager: ConfigManager
Returns PlatformInstaller
- Defined in src/core/platform-installer.ts:34

Methods

copyFiles

copyFiles(
    podReference: PodReference,
    sourceFiles: string[],
    destinationDirectory: string,
    container?: ContainerName,
    context?: string,
): Promise<string[]>
Copy a list of files to a directory in the container
Parameters
- podReference: PodReference
  pod reference
- sourceFiles: string[]
  list of source files
- destinationDirectory: string
  destination directory
- Optionalcontainer: ContainerName = constants.ROOT_CONTAINER
  name of the container
- Optionalcontext: string
Returns Promise<string[]>
a list of paths of the copied files insider the container
- Defined in src/core/platform-installer.ts:142

copyGossipKeys

copyGossipKeys(
    consensusNode: ConsensusNode,
    stagingDirectory: string,
    consensusNodes: ConsensusNode[],
): Promise<void>
Parameters
- consensusNode: ConsensusNode
- stagingDirectory: string
- consensusNodes: ConsensusNode[]
Returns Promise<void>
- Defined in src/core/platform-installer.ts:178

copyNodeKeys

copyNodeKeys(
    stagingDirectory: string,
    consensusNodes: ConsensusNode[],
    contexts: string[],
): any[]
Return a list of task to copy the node keys to the staging directory

It assumes the staging directory has the following files and resources:
${staging}/keys/s-public-.pem: private signing key for a node
${staging}/keys/s-private-.pem: public signing key for a node
${staging}/keys/a-public-.pem: private agreement key for a node
${staging}/keys/a-private-.pem: public agreement key for a node
${staging}/keys/hedera-.key: gRPC TLS key for a node
${staging}/keys/hedera-.crt: gRPC TLS cert for a node

Parameters

stagingDirectory: string
staging directory path
consensusNodes: ConsensusNode[]
list of consensus nodes
contexts: string[]
list of k8s contexts

Returns any[]

copyTLSKeys

copyTLSKeys(
    consensusNodes: ConsensusNode[],
    stagingDirectory: string,
    contexts: string[],
): Promise<void>
Parameters
- consensusNodes: ConsensusNode[]
- stagingDirectory: string
- contexts: string[]
Returns Promise<void>
- Defined in src/core/platform-installer.ts:240

fetchPlatform

fetchPlatform(
    podReference: PodReference,
    tag: string,
    context?: string,
): Promise<boolean>
Fetch and extract platform code into the container
Parameters
- podReference: PodReference
- tag: string
- Optionalcontext: string
Returns Promise<boolean>
- Defined in src/core/platform-installer.ts:100

setPathPermission

setPathPermission(
    podReference: PodReference,
    destinationPath: string,
    mode?: string,
    recursive?: boolean,
    container?: ContainerName,
    context?: string,
): Promise<boolean>
Parameters
- podReference: PodReference
- destinationPath: string
- mode: string = '0755'
- recursive: boolean = true
- container: ContainerName = constants.ROOT_CONTAINER
- Optionalcontext: string
Returns Promise<boolean>
- Defined in src/core/platform-installer.ts:291

setPlatformDirPermissions

setPlatformDirPermissions(
podReference: PodReference,
context?: string,
): Promise<boolean>
Parameters
- podReference: PodReference
- Optionalcontext: string
Returns Promise<boolean>
- Defined in src/core/platform-installer.ts:321

taskSetup

taskSetup(
    podReference: PodReference,
    stagingDirectory: string,
    isGenesis: boolean,
    context?: string,
): Listr<any, "default", "simple">
Return a list of task to perform node directory setup
Parameters
- podReference: PodReference
- stagingDirectory: string
- isGenesis: boolean
- Optionalcontext: string
Returns Listr<any, "default", "simple">
- Defined in src/core/platform-installer.ts:341

validatePlatformReleaseDir

validatePlatformReleaseDir(releaseDirectory: string): void
Parameters
- releaseDirectory: string
Returns void
- Defined in src/core/platform-installer.ts:52