Class Flags

Index

Constructors

Properties

accountId adminKey adminPublicKeys allFlags allFlagsMap amount apiPermissionProperties app appConfig applicationEnv applicationProperties awsBucket awsBucketPrefix awsBucketRegion awsEndpoint awsWriteAccessKey awsWriteSecrets backupBucket backupEndpoint backupProvider backupRegion backupWriteAccessKey backupWriteSecrets blockNodeChartVersion bootstrapProperties cacheDir chainId chartDirectory clusterRef clusterSetupNamespace context createAmount debugNodeAlias DEFAULT_FLAGS deletePvcs deleteSecrets deployCertManager deployCertManagerCrds deployGrafanaAgent deployJsonRpcRelay deployment deploymentClusters deployMinio deployPrometheusStack devMode dnsBaseDomain dnsConsensusNodePattern domainName domainNames ecdsaPrivateKey ed25519PrivateKey enableCertManager enableExplorerTls enableIngress enableTimeout endpointType envoyIps explorerStaticIp explorerTlsHostName explorerVersion externalDatabaseHost externalDatabaseOwnerPassword externalDatabaseOwnerUsername externalDatabaseReadonlyPassword externalDatabaseReadonlyUsername force forcePortForward gcsBucket gcsBucketPrefix gcsEndpoint gcsWriteAccessKey gcsWriteSecrets generateEcdsaKey generateGossipKeys generateTlsKeys genesisThrottlesFile gossipEndpoints gossipPrivateKey gossipPublicKey grpcEndpoints grpcTlsCertificatePath grpcTlsKeyPath grpcWebTlsCertificatePath grpcWebTlsKeyPath haproxyIps id imageTag ingressControllerValueFile inputDir integerFlags KEY_COMMON loadBalancerEnabled localBuildPath log4j2Xml mirrorNamespace mirrorNodeId mirrorNodeVersion mirrorStaticIp namespace networkDeploymentValuesFile newAccountNumber newAdminKey nodeAlias nodeAliasesUnparsed nodeConfigFileFlags numberOfConsensusNodes operatorId operatorKey outputDir persistentVolumeClaims pinger podLog predefinedAccounts privateKey profileFile profileName quiet realm relayReleaseTag releaseTag replicaCount serviceMonitor setAlias settingTxt shard skipNodeAlias soloChartVersion stakeAmounts stateFile storageBucket storageBucketPrefix storageBucketRegion storageEndpoint storageReadAccessKey storageReadSecrets storageType tlsClusterIssuerType tlsPrivateKey tlsPublicKey updateAccountKeys upgradeVersion upgradeZipFile useExternalDatabase username valuesFile

Methods

disablePrompts parseValuesFilesInput setOptionalCommandFlags setRequiredCommandFlags stringifyArgv

Constructors

constructor

new Flags(): Flags
Returns Flags

Properties

`Static` `Readonly`accountId

accountId: CommandFlag = ...

`Static` `Readonly`adminKey

adminKey: CommandFlag = ...

`Static` `Readonly`adminPublicKeys

adminPublicKeys: CommandFlag = ...

`Static` `Readonly`allFlags

allFlags: CommandFlag[] = ...

`Static` `Readonly`allFlagsMap

allFlagsMap: Map<string, CommandFlag> = ...

`Static` `Readonly`amount

amount: CommandFlag = ...

`Static` `Readonly`apiPermissionProperties

apiPermissionProperties: CommandFlag = ...

`Static` `Readonly`app

app: CommandFlag = ...

`Static` `Readonly`appConfig

appConfig: CommandFlag = ...

`Static` `Readonly`applicationEnv

applicationEnv: CommandFlag = ...

`Static` `Readonly`applicationProperties

applicationProperties: CommandFlag = ...

`Static` `Readonly`awsBucket

awsBucket: CommandFlag = ...

`Static` `Readonly`awsBucketPrefix

awsBucketPrefix: CommandFlag = ...

`Static` `Readonly`awsBucketRegion

awsBucketRegion: CommandFlag = ...

`Static` `Readonly`awsEndpoint

awsEndpoint: CommandFlag = ...

`Static` `Readonly`awsWriteAccessKey

awsWriteAccessKey: CommandFlag = ...

`Static` `Readonly`awsWriteSecrets

awsWriteSecrets: CommandFlag = ...

`Static` `Readonly`backupBucket

backupBucket: CommandFlag = ...

`Static` `Readonly`backupEndpoint

backupEndpoint: CommandFlag = ...

`Static` `Readonly`backupProvider

backupProvider: CommandFlag = ...

`Static` `Readonly`backupRegion

backupRegion: CommandFlag = ...

`Static` `Readonly`backupWriteAccessKey

backupWriteAccessKey: CommandFlag = ...

`Static` `Readonly`backupWriteSecrets

backupWriteSecrets: CommandFlag = ...

`Static` `Readonly`blockNodeChartVersion

blockNodeChartVersion: CommandFlag = ...

`Static` `Readonly`bootstrapProperties

bootstrapProperties: CommandFlag = ...

`Static` `Readonly`cacheDir

cacheDir: CommandFlag = ...

`Static` `Readonly`chainId

chainId: CommandFlag = ...

`Static` `Readonly`chartDirectory

chartDirectory: CommandFlag = ...

`Static` `Readonly`clusterRef

clusterRef: CommandFlag = ...

`Static` `Readonly`clusterSetupNamespace

clusterSetupNamespace: CommandFlag = ...

`Static` `Readonly`context

context: CommandFlag = ...

`Static` `Readonly`createAmount

createAmount: CommandFlag = ...

`Static` `Readonly`debugNodeAlias

debugNodeAlias: CommandFlag = ...

`Static` `Readonly`DEFAULT_FLAGS

DEFAULT_FLAGS: CommandFlags = ...

`Static` `Readonly`deletePvcs

deletePvcs: CommandFlag = ...

`Static` `Readonly`deleteSecrets

deleteSecrets: CommandFlag = ...

`Static` `Readonly`deployCertManager

deployCertManager: CommandFlag = ...

`Static` `Readonly`deployCertManagerCrds

deployCertManagerCrds: CommandFlag = ...

`Static` `Readonly`deployGrafanaAgent

deployGrafanaAgent: CommandFlag = ...

`Static` `Readonly`deployJsonRpcRelay

deployJsonRpcRelay: CommandFlag = ...

`Static` `Readonly`deployment

deployment: CommandFlag = ...

`Static` `Readonly`deploymentClusters

deploymentClusters: CommandFlag = ...

`Static` `Readonly`deployMinio

deployMinio: CommandFlag = ...

`Static` `Readonly`deployPrometheusStack

deployPrometheusStack: CommandFlag = ...

`Static` `Readonly`devMode

devMode: CommandFlag = ...

`Static` `Readonly`dnsBaseDomain

dnsBaseDomain: CommandFlag = ...

`Static` `Readonly`dnsConsensusNodePattern

dnsConsensusNodePattern: CommandFlag = ...

`Static` `Readonly`domainName

domainName: CommandFlag = ...

`Static` `Readonly`domainNames

domainNames: CommandFlag = ...

`Static` `Readonly`ecdsaPrivateKey

ecdsaPrivateKey: CommandFlag = ...

`Static` `Readonly`ed25519PrivateKey

ed25519PrivateKey: CommandFlag = ...

`Static` `Readonly`enableCertManager

enableCertManager: CommandFlag = ...

`Static` `Readonly`enableExplorerTls

enableExplorerTls: CommandFlag = ...

`Static` `Readonly`enableIngress

enableIngress: CommandFlag = ...

`Static` `Readonly`enableTimeout

enableTimeout: CommandFlag = ...

`Static` `Readonly`endpointType

endpointType: CommandFlag = ...

`Static` `Readonly`envoyIps

envoyIps: CommandFlag = ...

`Static` `Readonly`explorerStaticIp

explorerStaticIp: CommandFlag = ...

`Static` `Readonly`explorerTlsHostName

explorerTlsHostName: CommandFlag = ...

`Static` `Readonly`explorerVersion

explorerVersion: CommandFlag = ...

`Static` `Readonly`externalDatabaseHost

externalDatabaseHost: CommandFlag = ...

`Static` `Readonly`externalDatabaseOwnerPassword

externalDatabaseOwnerPassword: CommandFlag = ...

`Static` `Readonly`externalDatabaseOwnerUsername

externalDatabaseOwnerUsername: CommandFlag = ...

`Static` `Readonly`externalDatabaseReadonlyPassword

externalDatabaseReadonlyPassword: CommandFlag = ...

`Static` `Readonly`externalDatabaseReadonlyUsername

externalDatabaseReadonlyUsername: CommandFlag = ...

`Static` `Readonly`force

force: CommandFlag = ...

`Static` `Readonly`forcePortForward

forcePortForward: CommandFlag = ...

`Static` `Readonly`gcsBucket

gcsBucket: CommandFlag = ...

`Static` `Readonly`gcsBucketPrefix

gcsBucketPrefix: CommandFlag = ...

`Static` `Readonly`gcsEndpoint

gcsEndpoint: CommandFlag = ...

`Static` `Readonly`gcsWriteAccessKey

gcsWriteAccessKey: CommandFlag = ...

`Static` `Readonly`gcsWriteSecrets

gcsWriteSecrets: CommandFlag = ...

`Static` `Readonly`generateEcdsaKey

generateEcdsaKey: CommandFlag = ...

`Static` `Readonly`generateGossipKeys

generateGossipKeys: CommandFlag = ...

`Static` `Readonly`generateTlsKeys

generateTlsKeys: CommandFlag = ...

`Static` `Readonly`genesisThrottlesFile

genesisThrottlesFile: CommandFlag = ...

`Static` `Readonly`gossipEndpoints

gossipEndpoints: CommandFlag = ...

`Static` `Readonly`gossipPrivateKey

gossipPrivateKey: CommandFlag = ...

`Static` `Readonly`gossipPublicKey

gossipPublicKey: CommandFlag = ...

`Static` `Readonly`grpcEndpoints

grpcEndpoints: CommandFlag = ...

`Static` `Readonly`grpcTlsCertificatePath

grpcTlsCertificatePath: CommandFlag = ...

`Static` `Readonly`grpcTlsKeyPath

grpcTlsKeyPath: CommandFlag = ...

`Static` `Readonly`grpcWebTlsCertificatePath

grpcWebTlsCertificatePath: CommandFlag = ...

`Static` `Readonly`grpcWebTlsKeyPath

grpcWebTlsKeyPath: CommandFlag = ...

`Static` `Readonly`haproxyIps

haproxyIps: CommandFlag = ...

`Static` `Readonly`id

id: CommandFlag = ...

`Static` `Readonly`imageTag

imageTag: CommandFlag = ...

`Static` `Readonly`ingressControllerValueFile

ingressControllerValueFile: CommandFlag = ...

`Static` `Readonly`inputDir

inputDir: CommandFlag = ...

`Static` `Readonly`integerFlags

integerFlags: Map<string, CommandFlag> = ...

`Static`KEY_COMMON

KEY_COMMON: string = '_COMMON_'

`Static` `Readonly`loadBalancerEnabled

loadBalancerEnabled: CommandFlag = ...

`Static` `Readonly`localBuildPath

localBuildPath: CommandFlag = ...

`Static` `Readonly`log4j2Xml

log4j2Xml: CommandFlag = ...

`Static` `Readonly`mirrorNamespace

mirrorNamespace: CommandFlag = ...

`Static` `Readonly`mirrorNodeId

mirrorNodeId: CommandFlag = ...

`Static` `Readonly`mirrorNodeVersion

mirrorNodeVersion: CommandFlag = ...

`Static` `Readonly`mirrorStaticIp

mirrorStaticIp: CommandFlag = ...

`Static` `Readonly`namespace

namespace: CommandFlag = ...

`Static` `Readonly`networkDeploymentValuesFile

networkDeploymentValuesFile: CommandFlag = ...

`Static` `Readonly`newAccountNumber

newAccountNumber: CommandFlag = ...

`Static` `Readonly`newAdminKey

newAdminKey: CommandFlag = ...

`Static` `Readonly`nodeAlias

nodeAlias: CommandFlag = ...

`Static` `Readonly`nodeAliasesUnparsed

nodeAliasesUnparsed: CommandFlag = ...

`Static` `Readonly`nodeConfigFileFlags

nodeConfigFileFlags: Map<string, CommandFlag> = ...

`Static` `Readonly`numberOfConsensusNodes

numberOfConsensusNodes: CommandFlag = ...

`Static` `Readonly`operatorId

operatorId: CommandFlag = ...

`Static` `Readonly`operatorKey

operatorKey: CommandFlag = ...

`Static` `Readonly`outputDir

outputDir: CommandFlag = ...

`Static` `Readonly`persistentVolumeClaims

persistentVolumeClaims: CommandFlag = ...

`Static` `Readonly`pinger

pinger: CommandFlag = ...

`Static` `Readonly`podLog

podLog: CommandFlag = ...

`Static` `Readonly`predefinedAccounts

predefinedAccounts: CommandFlag = ...

`Static` `Readonly`privateKey

privateKey: CommandFlag = ...

`Static` `Readonly`profileFile

profileFile: CommandFlag = ...

`Static` `Readonly`profileName

profileName: CommandFlag = ...

`Static` `Readonly`quiet

quiet: CommandFlag = ...

`Static` `Readonly`realm

realm: CommandFlag = ...

`Static` `Readonly`relayReleaseTag

relayReleaseTag: CommandFlag = ...

`Static` `Readonly`releaseTag

releaseTag: CommandFlag = ...

`Static` `Readonly`replicaCount

replicaCount: CommandFlag = ...

`Static` `Readonly`serviceMonitor

serviceMonitor: CommandFlag = ...

`Static` `Readonly`setAlias

setAlias: CommandFlag = ...

`Static` `Readonly`settingTxt

settingTxt: CommandFlag = ...

`Static` `Readonly`shard

shard: CommandFlag = ...

`Static` `Readonly`skipNodeAlias

skipNodeAlias: CommandFlag = ...

`Static` `Readonly`soloChartVersion

soloChartVersion: CommandFlag = ...

`Static` `Readonly`stakeAmounts

stakeAmounts: CommandFlag = ...

`Static` `Readonly`stateFile

stateFile: CommandFlag = ...

`Static` `Readonly`storageBucket

storageBucket: CommandFlag = ...

`Static` `Readonly`storageBucketPrefix

storageBucketPrefix: CommandFlag = ...

`Static` `Readonly`storageBucketRegion

storageBucketRegion: CommandFlag = ...

`Static` `Readonly`storageEndpoint

storageEndpoint: CommandFlag = ...

`Static` `Readonly`storageReadAccessKey

storageReadAccessKey: CommandFlag = ...

`Static` `Readonly`storageReadSecrets

storageReadSecrets: CommandFlag = ...

`Static` `Readonly`storageType

storageType: CommandFlag = ...

`Static` `Readonly`tlsClusterIssuerType

tlsClusterIssuerType: CommandFlag = ...

`Static` `Readonly`tlsPrivateKey

tlsPrivateKey: CommandFlag = ...

`Static` `Readonly`tlsPublicKey

tlsPublicKey: CommandFlag = ...

`Static` `Readonly`updateAccountKeys

updateAccountKeys: CommandFlag = ...

`Static` `Readonly`upgradeVersion

upgradeVersion: CommandFlag = ...

`Static` `Readonly`upgradeZipFile

upgradeZipFile: CommandFlag = ...

`Static` `Readonly`useExternalDatabase

useExternalDatabase: CommandFlag = ...

`Static` `Readonly`username

username: CommandFlag = ...

`Static` `Readonly`valuesFile

valuesFile: CommandFlag = ...

Methods

`Static`disablePrompts

disablePrompts(flags: CommandFlag[]): void
Disable prompts for the given set of flags
Parameters
- flags: CommandFlag[]
  list of flags to disable prompts for
Returns void
- Defined in src/commands/flags.ts:103

`Static`parseValuesFilesInput

parseValuesFilesInput(input: string): Record<ClusterReferenceName, string[]>
Parse the values files input string that includes the cluster reference and the values file path

It supports input as below:
--values-file aws-cluster=aws/solo-values.yaml,aws-cluster=aws/solo-values2.yaml,gcp-cluster=gcp/solo-values.yaml,gcp-cluster=gcp/solo-values2.yaml
Parameters
- input: string
Returns Record<ClusterReferenceName, string[]>
- Defined in src/commands/flags.ts:265

`Static`setOptionalCommandFlags

setOptionalCommandFlags(y: any, ...commandFlags: CommandFlag[]): void
Set flag from the flag option
Parameters
- y: any
  instance of yargs
- ...commandFlags: CommandFlag[]
  a set of command flags
Returns void
- Defined in src/commands/flags.ts:133

`Static`setRequiredCommandFlags

setRequiredCommandFlags(y: any, ...commandFlags: CommandFlag[]): void
Set flag from the flag option
Parameters
- y: any
  instance of yargs
- ...commandFlags: CommandFlag[]
  a set of command flags
Returns void
- Defined in src/commands/flags.ts:118

`Static`stringifyArgv

stringifyArgv(argv: AnyObject): string
Processes the Argv arguments and returns them as string, all with full flag names.
- removes flags that match the default value.
- removes flags with undefined and null values.
- removes boolean flags that are false.
- masks all sensitive flags with their dataMask property.
Parameters
- argv: AnyObject
Returns string
- Defined in src/commands/flags.ts:2731

Class Flags

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Flags

Properties

Static ReadonlyaccountId

Static ReadonlyadminKey

Static ReadonlyadminPublicKeys

Static ReadonlyallFlags

Static ReadonlyallFlagsMap

Static Readonlyamount

Static ReadonlyapiPermissionProperties

Static Readonlyapp

Static ReadonlyappConfig

Static ReadonlyapplicationEnv

Static ReadonlyapplicationProperties

Static ReadonlyawsBucket

Static ReadonlyawsBucketPrefix

Static ReadonlyawsBucketRegion

Static ReadonlyawsEndpoint

Static ReadonlyawsWriteAccessKey

Static ReadonlyawsWriteSecrets

Static ReadonlybackupBucket

Static ReadonlybackupEndpoint

Static ReadonlybackupProvider

Static ReadonlybackupRegion

Static ReadonlybackupWriteAccessKey

Static ReadonlybackupWriteSecrets

Static ReadonlyblockNodeChartVersion

Static ReadonlybootstrapProperties

Static ReadonlycacheDir

Static ReadonlychainId

Static ReadonlychartDirectory

Static ReadonlyclusterRef

Static ReadonlyclusterSetupNamespace

Static Readonlycontext

Static ReadonlycreateAmount

Static ReadonlydebugNodeAlias

Static ReadonlyDEFAULT_FLAGS

Static ReadonlydeletePvcs

Static ReadonlydeleteSecrets

Static ReadonlydeployCertManager

Static ReadonlydeployCertManagerCrds

Static ReadonlydeployGrafanaAgent

Static ReadonlydeployJsonRpcRelay

Static Readonlydeployment

Static ReadonlydeploymentClusters

Static ReadonlydeployMinio

Static ReadonlydeployPrometheusStack

Static ReadonlydevMode

Static ReadonlydnsBaseDomain

Static ReadonlydnsConsensusNodePattern

Static ReadonlydomainName

Static ReadonlydomainNames

Static ReadonlyecdsaPrivateKey

Static Readonlyed25519PrivateKey

Static ReadonlyenableCertManager

Static ReadonlyenableExplorerTls

Static ReadonlyenableIngress

Static ReadonlyenableTimeout

Static ReadonlyendpointType

Static ReadonlyenvoyIps

Static ReadonlyexplorerStaticIp

Static ReadonlyexplorerTlsHostName

Static ReadonlyexplorerVersion

Static ReadonlyexternalDatabaseHost

Static ReadonlyexternalDatabaseOwnerPassword

Static ReadonlyexternalDatabaseOwnerUsername

Static ReadonlyexternalDatabaseReadonlyPassword

Static ReadonlyexternalDatabaseReadonlyUsername

Static Readonlyforce

Static ReadonlyforcePortForward

Static ReadonlygcsBucket

Static ReadonlygcsBucketPrefix

Static ReadonlygcsEndpoint

Static ReadonlygcsWriteAccessKey

`Static` `Readonly`accountId

`Static` `Readonly`adminKey

`Static` `Readonly`adminPublicKeys

`Static` `Readonly`allFlags

`Static` `Readonly`allFlagsMap

`Static` `Readonly`amount

`Static` `Readonly`apiPermissionProperties

`Static` `Readonly`app

`Static` `Readonly`appConfig

`Static` `Readonly`applicationEnv

`Static` `Readonly`applicationProperties

`Static` `Readonly`awsBucket

`Static` `Readonly`awsBucketPrefix

`Static` `Readonly`awsBucketRegion

`Static` `Readonly`awsEndpoint

`Static` `Readonly`awsWriteAccessKey

`Static` `Readonly`awsWriteSecrets

`Static` `Readonly`backupBucket

`Static` `Readonly`backupEndpoint

`Static` `Readonly`backupProvider

`Static` `Readonly`backupRegion

`Static` `Readonly`backupWriteAccessKey

`Static` `Readonly`backupWriteSecrets

`Static` `Readonly`blockNodeChartVersion

`Static` `Readonly`bootstrapProperties

`Static` `Readonly`cacheDir

`Static` `Readonly`chainId

`Static` `Readonly`chartDirectory

`Static` `Readonly`clusterRef

`Static` `Readonly`clusterSetupNamespace

`Static` `Readonly`context

`Static` `Readonly`createAmount

`Static` `Readonly`debugNodeAlias

`Static` `Readonly`DEFAULT_FLAGS

`Static` `Readonly`deletePvcs

`Static` `Readonly`deleteSecrets

`Static` `Readonly`deployCertManager

`Static` `Readonly`deployCertManagerCrds

`Static` `Readonly`deployGrafanaAgent

`Static` `Readonly`deployJsonRpcRelay

`Static` `Readonly`deployment

`Static` `Readonly`deploymentClusters

`Static` `Readonly`deployMinio

`Static` `Readonly`deployPrometheusStack

`Static` `Readonly`devMode

`Static` `Readonly`dnsBaseDomain

`Static` `Readonly`dnsConsensusNodePattern

`Static` `Readonly`domainName

`Static` `Readonly`domainNames

`Static` `Readonly`ecdsaPrivateKey

`Static` `Readonly`ed25519PrivateKey

`Static` `Readonly`enableCertManager

`Static` `Readonly`enableExplorerTls

`Static` `Readonly`enableIngress

`Static` `Readonly`enableTimeout

`Static` `Readonly`endpointType

`Static` `Readonly`envoyIps

`Static` `Readonly`explorerStaticIp

`Static` `Readonly`explorerTlsHostName

`Static` `Readonly`explorerVersion

`Static` `Readonly`externalDatabaseHost

`Static` `Readonly`externalDatabaseOwnerPassword

`Static` `Readonly`externalDatabaseOwnerUsername

`Static` `Readonly`externalDatabaseReadonlyPassword

`Static` `Readonly`externalDatabaseReadonlyUsername

`Static` `Readonly`force

`Static` `Readonly`forcePortForward

`Static` `Readonly`gcsBucket

`Static` `Readonly`gcsBucketPrefix

`Static` `Readonly`gcsEndpoint

`Static` `Readonly`gcsWriteAccessKey

`Static` `Readonly`gcsWriteSecrets

`Static` `Readonly`generateEcdsaKey

`Static` `Readonly`generateGossipKeys

`Static` `Readonly`generateTlsKeys

`Static` `Readonly`genesisThrottlesFile

`Static` `Readonly`gossipEndpoints

`Static` `Readonly`gossipPrivateKey

`Static` `Readonly`gossipPublicKey

`Static` `Readonly`grpcEndpoints