Class Templates

Index

Constructors

Methods

extractNodeAliasFromPodName installationPath nodeIdFromNodeAlias parseNodeAliasToDomainNameMapping parseNodeAliasToIpMapping prepareReleasePrefix renderAccountKeySecretLabelObject renderAccountKeySecretLabelSelector renderAccountKeySecretName renderConsensusNodeFullyQualifiedDomainName renderDistinguishedName renderEnvoyProxyName renderFullyQualifiedHaProxyName renderFullyQualifiedNetworkPodName renderFullyQualifiedNetworkSvcName renderGossipKeySecretLabelObject renderGossipKeySecretName renderGossipPemPrivateKeyFile renderGossipPemPublicKeyFile renderGrpcTlsCertificatesSecretLabelObject renderGrpcTlsCertificatesSecretName renderHaProxyName renderNetworkHeadlessSvcName renderNetworkPodName renderNodeAdminKeyName renderNodeAliasesFromCount renderNodeAliasFromNumber renderNodeFriendlyName renderStagingDir renderTLSPemPrivateKeyFile renderTLSPemPublicKeyFile

Constructors

constructor

new Templates(): Templates
Returns Templates

Methods

`Static`extractNodeAliasFromPodName

extractNodeAliasFromPodName(podName: PodName): `node${number}`
Parameters
- podName: PodName
Returns `node${number}`
- Defined in src/core/templates.ts:80

`Static`installationPath

installationPath(
    dep: string,
    osPlatform?: string,
    installationDirectory?: string,
): string
Parameters
- dep: string
- osPlatform: string = ...
- installationDirectory: string = ...
Returns string
- Defined in src/core/templates.ts:159

`Static`nodeIdFromNodeAlias

nodeIdFromNodeAlias(nodeAlias: `node${number}`): number
Parameters
- nodeAlias: `node${number}`
Returns number
- Defined in src/core/templates.ts:192

`Static`parseNodeAliasToDomainNameMapping

parseNodeAliasToDomainNameMapping(
unparsed: string,
): Record<`node${number}`, string>
Parameters
- unparsed: string
Returns Record<`node${number}`, string>
- Defined in src/core/templates.ts:277

`Static`parseNodeAliasToIpMapping

parseNodeAliasToIpMapping(unparsed: string): Record<`node${number}`, string>
Parameters
- unparsed: string
Returns Record<`node${number}`, string>
- Defined in src/core/templates.ts:266

`Static`prepareReleasePrefix

prepareReleasePrefix(tag: string): string
Parameters
- tag: string
Returns string
- Defined in src/core/templates.ts:88

`Static`renderAccountKeySecretLabelObject

renderAccountKeySecretLabelObject(
accountId: string | AccountId,
): { "solo.hedera.com/account-id": string }
renders the label object to be used to store the new account key in the Kubernetes secret
Parameters
- accountId: string | AccountId
Returns { "solo.hedera.com/account-id": string }
the label object to be used to store the new account key in the Kubernetes secret
- Defined in src/core/templates.ts:122

`Static`renderAccountKeySecretLabelSelector

renderAccountKeySecretLabelSelector(accountId: string | AccountId): string
renders the label selector to be used to fetch the new account key from the Kubernetes secret
Parameters
- accountId: string | AccountId
Returns string
the label selector of the Kubernetes secret to retrieve the account key
- Defined in src/core/templates.ts:113

`Static`renderAccountKeySecretName

renderAccountKeySecretName(accountId: string | AccountId): string
renders the name to be used to store the new account key as a Kubernetes secret
Parameters
- accountId: string | AccountId
Returns string
the name of the Kubernetes secret to store the account key
- Defined in src/core/templates.ts:105

`Static`renderConsensusNodeFullyQualifiedDomainName

renderConsensusNodeFullyQualifiedDomainName(
    nodeAlias: string,
    nodeId: number,
    namespace: string,
    cluster: string,
    dnsBaseDomain: string,
    dnsConsensusNodePattern: string,
): string
Renders the fully qualified domain name for a consensus node. We support the following variables for templating in the dnsConsensusNodePattern: {nodeAlias}, {nodeId}, {namespace}, {cluster}

The end result will be ${dnsConsensusNodePattern}.${dnsBaseDomain}. For example, if the dnsConsensusNodePattern is network-{nodeAlias}-svc.{namespace}.svc and the dnsBaseDomain is cluster.local, the fully qualified domain name will be network-{nodeAlias}-svc.{namespace}.svc.cluster.local.
Parameters
- nodeAlias: string
  the alias of the consensus node
- nodeId: number
  the id of the consensus node
- namespace: string
  the namespace of the consensus node
- cluster: string
  the cluster of the consensus node
- dnsBaseDomain: string
  the base domain of the cluster
- dnsConsensusNodePattern: string
  the pattern to use for the consensus node
Returns string
- Defined in src/core/templates.ts:310

`Static`renderDistinguishedName

renderDistinguishedName(
    nodeAlias: `node${number}`,
    state?: string,
    locality?: string,
    org?: string,
    orgUnit?: string,
    country?: string,
): Name
Parameters
- nodeAlias: `node${number}`
- state: string = 'TX'
- locality: string = 'Richardson'
- org: string = 'Hedera'
- orgUnit: string = 'Hedera'
- country: string = 'US'
Returns Name
- Defined in src/core/templates.ts:130

`Static`renderEnvoyProxyName

renderEnvoyProxyName(nodeAlias: `node${number}`): string
Parameters
- nodeAlias: `node${number}`
Returns string
- Defined in src/core/templates.ts:254

`Static`renderFullyQualifiedHaProxyName

renderFullyQualifiedHaProxyName(
nodeAlias: `node${number}`,
namespace: NamespaceName,
): string
Parameters
- nodeAlias: `node${number}`
- namespace: NamespaceName
Returns string
- Defined in src/core/templates.ts:262

`Static`renderFullyQualifiedNetworkPodName

renderFullyQualifiedNetworkPodName(
namespace: NamespaceName,
nodeAlias: `node${number}`,
): string
Parameters
- namespace: NamespaceName
- nodeAlias: `node${number}`
Returns string
- Defined in src/core/templates.ts:179

`Static`renderFullyQualifiedNetworkSvcName

renderFullyQualifiedNetworkSvcName(
namespace: NamespaceName,
nodeAlias: `node${number}`,
): string
Parameters
- namespace: NamespaceName
- nodeAlias: `node${number}`
Returns string
- Defined in src/core/templates.ts:183

`Static`renderGossipKeySecretLabelObject

renderGossipKeySecretLabelObject(
nodeAlias: `node${number}`,
): { "solo.hedera.com/node-name": string }
Parameters
- nodeAlias: `node${number}`
Returns { "solo.hedera.com/node-name": string }
- Defined in src/core/templates.ts:206

`Static`renderGossipKeySecretName

renderGossipKeySecretName(nodeAlias: `node${number}`): string
Parameters
- nodeAlias: `node${number}`
Returns string
- Defined in src/core/templates.ts:202

`Static`renderGossipPemPrivateKeyFile

renderGossipPemPrivateKeyFile(nodeAlias: `node${number}`): string
Parameters
- nodeAlias: `node${number}`
Returns string
- Defined in src/core/templates.ts:52

`Static`renderGossipPemPublicKeyFile

renderGossipPemPublicKeyFile(nodeAlias: `node${number}`): string
Parameters
- nodeAlias: `node${number}`
Returns string
- Defined in src/core/templates.ts:56

`Static`renderGrpcTlsCertificatesSecretLabelObject

renderGrpcTlsCertificatesSecretLabelObject(
    nodeAlias: `node${number}`,
    type: GrpcProxyTlsEnums,
):
    | {
        "envoy-proxy-secret"?: undefined;
        "haproxy-proxy-secret": `node${number}`;
    }
    | {
        "envoy-proxy-secret": `node${number}`;
        "haproxy-proxy-secret"?: undefined;
    }
Creates the secret labels based on the node alias type
Parameters
- nodeAlias: `node${number}`
  node alias
- type: GrpcProxyTlsEnums
  whether is for gRPC or gRPC Web ( Haproxy or Envoy )
Returns
    | {
        "envoy-proxy-secret"?: undefined;
        "haproxy-proxy-secret": `node${number}`;
    }
    | {
        "envoy-proxy-secret": `node${number}`;
        "haproxy-proxy-secret"?: undefined;
    }
the appropriate secret labels
- Defined in src/core/templates.ts:240

`Static`renderGrpcTlsCertificatesSecretName

renderGrpcTlsCertificatesSecretName(
nodeAlias: `node${number}`,
type: GrpcProxyTlsEnums,
): string
Creates the secret name based on the node alias type
Parameters
- nodeAlias: `node${number}`
  node alias
- type: GrpcProxyTlsEnums
  whether is for gRPC or gRPC Web ( Haproxy or Envoy )
Returns string
the appropriate secret name
- Defined in src/core/templates.ts:218

`Static`renderHaProxyName

renderHaProxyName(nodeAlias: `node${number}`): string
Parameters
- nodeAlias: `node${number}`
Returns string
- Defined in src/core/templates.ts:258

`Static`renderNetworkHeadlessSvcName

renderNetworkHeadlessSvcName(nodeAlias: `node${number}`): string
Parameters
- nodeAlias: `node${number}`
Returns string
- Defined in src/core/templates.ts:32

`Static`renderNetworkPodName

renderNetworkPodName(nodeAlias: `node${number}`): PodName
Parameters
- nodeAlias: `node${number}`
Returns PodName
- Defined in src/core/templates.ts:20

`Static`renderNodeAdminKeyName

renderNodeAdminKeyName(nodeAlias: `node${number}`): string
Parameters
- nodeAlias: `node${number}`
Returns string
- Defined in src/core/templates.ts:68

`Static`renderNodeAliasesFromCount

renderNodeAliasesFromCount(
count: number,
existingNodesCount: number,
): NodeAliases
Parameters
- count: number
- existingNodesCount: number
Returns NodeAliases
- Defined in src/core/templates.ts:40

`Static`renderNodeAliasFromNumber

renderNodeAliasFromNumber(number_: number): `node${number}`
Parameters
- number_: number
Returns `node${number}`
- Defined in src/core/templates.ts:36

`Static`renderNodeFriendlyName

renderNodeFriendlyName(
    prefix: string,
    nodeAlias: `node${number}`,
    suffix?: string,
): string
Parameters
- prefix: string
- nodeAlias: `node${number}`
- suffix: string = ''
Returns string
- Defined in src/core/templates.ts:72

`Static`renderStagingDir

renderStagingDir(cacheDirectory: string, releaseTagOverride: string): string
Parameters
- cacheDirectory: string
- releaseTagOverride: string
Returns string
- Defined in src/core/templates.ts:141

`Static`renderTLSPemPrivateKeyFile

renderTLSPemPrivateKeyFile(nodeAlias: `node${number}`): string
Parameters
- nodeAlias: `node${number}`
Returns string
- Defined in src/core/templates.ts:60

`Static`renderTLSPemPublicKeyFile

renderTLSPemPublicKeyFile(nodeAlias: `node${number}`): string
Parameters
- nodeAlias: `node${number}`
Returns string
- Defined in src/core/templates.ts:64

Class Templates

Index

Constructors

Methods

Constructors

constructor

Returns Templates

Methods

StaticextractNodeAliasFromPodName

Parameters

Returns `node${number}`

StaticinstallationPath

Parameters

Returns string

StaticnodeIdFromNodeAlias

Parameters

Returns number

StaticparseNodeAliasToDomainNameMapping

Parameters

Returns Record<`node${number}`, string>

StaticparseNodeAliasToIpMapping

Parameters

Returns Record<`node${number}`, string>

StaticprepareReleasePrefix

Parameters

Returns string

StaticrenderAccountKeySecretLabelObject

Parameters

Returns { "solo.hedera.com/account-id": string }

StaticrenderAccountKeySecretLabelSelector

Parameters

Returns string

StaticrenderAccountKeySecretName

Parameters

Returns string

StaticrenderConsensusNodeFullyQualifiedDomainName

Parameters

Returns string

StaticrenderDistinguishedName

Parameters

Returns Name

StaticrenderEnvoyProxyName

Parameters

Returns string

StaticrenderFullyQualifiedHaProxyName

Parameters

Returns string

StaticrenderFullyQualifiedNetworkPodName

Parameters

Returns string

StaticrenderFullyQualifiedNetworkSvcName

Parameters

Returns string

StaticrenderGossipKeySecretLabelObject

Parameters

Returns { "solo.hedera.com/node-name": string }

StaticrenderGossipKeySecretName

Parameters

Returns string

StaticrenderGossipPemPrivateKeyFile

Parameters

Returns string

StaticrenderGossipPemPublicKeyFile

Parameters

Returns string

StaticrenderGrpcTlsCertificatesSecretLabelObject

Parameters

Returns | { "envoy-proxy-secret"?: undefined; "haproxy-proxy-secret": `node${number}`; } | { "envoy-proxy-secret": `node${number}`; "haproxy-proxy-secret"?: undefined; }

StaticrenderGrpcTlsCertificatesSecretName

Parameters

Returns string

StaticrenderHaProxyName

Parameters

Returns string

StaticrenderNetworkHeadlessSvcName

Parameters

Returns string

StaticrenderNetworkPodName

Parameters

Returns PodName

`Static`extractNodeAliasFromPodName

`Static`installationPath

`Static`nodeIdFromNodeAlias

`Static`parseNodeAliasToDomainNameMapping

`Static`parseNodeAliasToIpMapping

`Static`prepareReleasePrefix

`Static`renderAccountKeySecretLabelObject

`Static`renderAccountKeySecretLabelSelector

`Static`renderAccountKeySecretName

`Static`renderConsensusNodeFullyQualifiedDomainName

`Static`renderDistinguishedName

`Static`renderEnvoyProxyName

`Static`renderFullyQualifiedHaProxyName

`Static`renderFullyQualifiedNetworkPodName

`Static`renderFullyQualifiedNetworkSvcName

`Static`renderGossipKeySecretLabelObject

`Static`renderGossipKeySecretName

`Static`renderGossipPemPrivateKeyFile

`Static`renderGossipPemPublicKeyFile

`Static`renderGrpcTlsCertificatesSecretLabelObject

Returns
| {
"envoy-proxy-secret"?: undefined;
"haproxy-proxy-secret": `node${number}`;
}
| {
"envoy-proxy-secret": `node${number}`;
"haproxy-proxy-secret"?: undefined;
}

`Static`renderGrpcTlsCertificatesSecretName

`Static`renderHaProxyName

`Static`renderNetworkHeadlessSvcName

`Static`renderNetworkPodName

`Static`renderNodeAdminKeyName

`Static`renderNodeAliasesFromCount

`Static`renderNodeAliasFromNumber

`Static`renderNodeFriendlyName

`Static`renderStagingDir

`Static`renderTLSPemPrivateKeyFile

`Static`renderTLSPemPublicKeyFile