Class Templates

Constructors

constructor

Methods

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

Constructors

constructor

Methods

StaticinstallationPath

  • installationPath(
        dep: string,
        osPlatform?: string,
        installationDir?: string,
    ): string

    Parameters

    • dep: string
    • osPlatform: string = ...
    • installationDir: string = ...

    Returns string

StaticnodeIdFromNodeAlias

  • nodeIdFromNodeAlias(nodeAlias: `node${number}`): number

    Parameters

    • nodeAlias: `node${number}`

    Returns number

StaticparseNodeAliasToIpMapping

  • parseNodeAliasToIpMapping(unparsed: string): Record<`node${number}`, string>

    Parameters

    • unparsed: string

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

StaticprepareReleasePrefix

StaticrenderAccountKeySecretLabelObject

  • 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

StaticrenderAccountKeySecretLabelSelector

  • 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

StaticrenderAccountKeySecretName

  • 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

StaticrenderConsensusNodeFullyQualifiedDomainName

  • 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

StaticrenderDistinguishedName

  • 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

StaticrenderEnvoyProxyName

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

    Parameters

    • nodeAlias: `node${number}`

    Returns string

StaticrenderFullyQualifiedHaProxyName

StaticrenderFullyQualifiedNetworkPodName

StaticrenderFullyQualifiedNetworkSvcName

StaticrenderGossipKeySecretLabelObject

  • renderGossipKeySecretLabelObject(
        nodeAlias: `node${number}`,
    ): { "solo.hedera.com/node-name": string }

    Parameters

    • nodeAlias: `node${number}`

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

StaticrenderGossipKeySecretName

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

    Parameters

    • nodeAlias: `node${number}`

    Returns string

StaticrenderGossipPemPrivateKeyFile

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

    Parameters

    • nodeAlias: `node${number}`

    Returns string

StaticrenderGossipPemPublicKeyFile

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

    Parameters

    • nodeAlias: `node${number}`

    Returns string

StaticrenderGrpcTlsCertificatesSecretLabelObject

  • 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

StaticrenderGrpcTlsCertificatesSecretName

  • 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

StaticrenderHaProxyName

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

    Parameters

    • nodeAlias: `node${number}`

    Returns string

StaticrenderNetworkHeadlessSvcName

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

    Parameters

    • nodeAlias: `node${number}`

    Returns string

StaticrenderNetworkPodName

StaticrenderNodeAdminKeyName

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

    Parameters

    • nodeAlias: `node${number}`

    Returns string

StaticrenderNodeFriendlyName

  • renderNodeFriendlyName(
        prefix: string,
        nodeAlias: `node${number}`,
        suffix?: string,
    ): string

    Parameters

    • prefix: string
    • nodeAlias: `node${number}`
    • suffix: string = ''

    Returns string

StaticrenderStagingDir

  • renderStagingDir(cacheDir: string, releaseTagOverride: string): string

    Parameters

    • cacheDir: string
    • releaseTagOverride: string

    Returns string

StaticrenderTLSPemPrivateKeyFile

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

    Parameters

    • nodeAlias: `node${number}`

    Returns string

StaticrenderTLSPemPublicKeyFile

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

    Parameters

    • nodeAlias: `node${number}`

    Returns string

Settings

Member Visibility

On This Page

Constructors
Methods