Class Templates

Constructors

constructor

Methods

installationPath nodeIdFromNodeAlias parseContextCluster parseNodeAliasToIpMapping prepareReleasePrefix renderAccountKeySecretLabelObject renderAccountKeySecretLabelSelector renderAccountKeySecretName renderDistinguishedName renderEnvoyProxyName renderFullyQualifiedHaProxyName renderFullyQualifiedNetworkPodName renderFullyQualifiedNetworkSvcName renderGossipKeySecretLabelObject renderGossipKeySecretName renderGossipPemPrivateKeyFile renderGossipPemPublicKeyFile renderGrpcTlsCertificatesSecretLabelObject renderGrpcTlsCertificatesSecretName renderHaProxyName renderNetworkPodName 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

StaticparseContextCluster

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

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

StaticrenderFullyQualifiedHaProxyName

  • renderFullyQualifiedHaProxyName(
        nodeAlias: `node${number}`,
        namespace: string,
    ): string

  • Parameters

    • nodeAlias: `node${number}`
    • namespace: string

    Returns string

StaticrenderFullyQualifiedNetworkPodName

  • renderFullyQualifiedNetworkPodName(
        namespace: string,
        nodeAlias: `node${number}`,
    ): string

  • Parameters

    • namespace: string
    • nodeAlias: `node${number}`

    Returns string

StaticrenderFullyQualifiedNetworkSvcName

  • renderFullyQualifiedNetworkSvcName(
        namespace: string,
        nodeAlias: `node${number}`,
    ): string

  • Parameters

    • namespace: string
    • nodeAlias: `node${number}`

    Returns string

StaticrenderGossipKeySecretLabelObject

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

  • Parameters

    • nodeAlias: `node${number}`

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

StaticrenderGossipKeySecretName

StaticrenderGossipPemPrivateKeyFile

StaticrenderGossipPemPublicKeyFile

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

StaticrenderNetworkPodName

  • renderNetworkPodName(nodeAlias: `node${number}`): `network-node${number}-0`

  • Parameters

    • nodeAlias: `node${number}`

    Returns `network-node${number}-0`

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

StaticrenderTLSPemPublicKeyFile

Settings

Member Visibility

On This Page

Constructors
Methods