Class InitCommand

Defines the core functionalities of 'init' command

Hierarchy (View Summary)

BaseCommand
- InitCommand

Constructors

constructor

new InitCommand(
    kindBuilder: DefaultKindClientBuilder,
    podmanInstallationDirectory: string,
    brewPackageManager: BrewPackageManager,
    osPackageManager: OsPackageManager,
    clusterTaskManager: ClusterTaskManager,
): InitCommand
Parameters
- kindBuilder: DefaultKindClientBuilder
- podmanInstallationDirectory: string
- brewPackageManager: BrewPackageManager
- osPackageManager: OsPackageManager
- clusterTaskManager: ClusterTaskManager
Returns InitCommand
Overrides BaseCommand.constructor
- Defined in src/commands/init/init.ts:30

Properties

`Protected` `Readonly`brewPackageManager

brewPackageManager: BrewPackageManager

`Protected` `Optional` `Readonly`chartManager

chartManager?: ChartManager

`Protected` `Readonly`clusterTaskManager

clusterTaskManager: ClusterTaskManager

`Protected` `Optional` `Readonly`componentFactory

componentFactory?: ComponentFactoryApi

`Optional` `Readonly`configManager

configManager?: ConfigManager

`Protected` `Optional` `Readonly`depManager

depManager?: DependencyManager

`Protected` `Optional` `Readonly`helm

helm?: HelmClient

`Protected` `Optional` `Readonly`k8Factory

k8Factory?: K8Factory

`Protected` `Readonly`kindBuilder

kindBuilder: DefaultKindClientBuilder

`Protected` `Optional` `Readonly`leaseManager

leaseManager?: LockManager

`Optional` `Readonly`localConfig

localConfig?: LocalConfigRuntimeState

`Optional`logger

logger?: SoloLogger

`Protected` `Readonly`osPackageManager

osPackageManager: OsPackageManager

`Protected` `Readonly`podmanInstallationDirectory

podmanInstallationDirectory: string

`Protected` `Optional` `Readonly`remoteConfig

remoteConfig?: RemoteConfigRuntimeStateApi

`Protected` `Optional` `Readonly`taskList

taskList?: TaskList<any, ListrRendererValue, ListrRendererValue>

`Static` `Readonly`COMMAND_NAME

COMMAND_NAME: string = 'init'

`Static` `Readonly`INIT_COMMAND_NAME

INIT_COMMAND_NAME: string = InitCommand.COMMAND_NAME

Methods

close

close(): Promise<void>
Returns Promise<void>
Overrides BaseCommand.close
- Defined in src/commands/init/init.ts:231

`Protected`getClusterContext

getClusterContext(clusterReference: string): string
Parameters
- clusterReference: string
Returns string
Inherited from BaseCommand.getClusterContext
- Defined in src/commands/base.ts:254

`Protected`getClusterReference

getClusterReference(): string
Returns string
Inherited from BaseCommand.getClusterReference
- Defined in src/commands/base.ts:250

getCommandDefinition

getCommandDefinition(): CommandDefinition
Return Yargs command definition for 'init' command

Returns CommandDefinition
A object representing the Yargs command definition
- Defined in src/commands/init/init.ts:207

`Protected`getNamespace

getNamespace(task: SoloListrTaskWrapper<any>): Promise<NamespaceName>
Parameters
- task: SoloListrTaskWrapper<any>
Returns Promise<NamespaceName>
Inherited from BaseCommand.getNamespace
- Defined in src/commands/base.ts:260

`Protected`inferMirrorNodeData

inferMirrorNodeData(
    namespace: NamespaceName,
    context: string,
): Promise<
    {
        mirrorNamespace: string;
        mirrorNodeId: number;
        mirrorNodeReleaseName: string;
    },
>
Parameters
- namespace: NamespaceName
- context: string
Returns Promise<
    {
        mirrorNamespace: string;
        mirrorNodeId: number;
        mirrorNodeReleaseName: string;
    },
>
Inherited from BaseCommand.inferMirrorNodeData
- Defined in src/commands/base.ts:291

init

init(argv: any): Promise<boolean>
Parameters
- argv: any
Returns Promise<boolean>
- Defined in src/commands/init/init.ts:181

initTasks

initTasks(argv: any): Listr<InitContext, ListrRendererValue, ListrRendererValue>
Executes the init CLI command
Parameters
- argv: any
Returns Listr<InitContext, ListrRendererValue, ListrRendererValue>
- Defined in src/commands/init/init.ts:166

installDependenciesTasks

installDependenciesTasks(
options: InitDependenciesOptions,
): SoloListrTask<InitContext>[]
Parameters
- options: InitDependenciesOptions
Returns SoloListrTask<InitContext>[]
- Defined in src/commands/init/init.ts:125

`Protected`resolveNamespaceFromDeployment

resolveNamespaceFromDeployment(
task?: SoloListrTaskWrapper<any>,
): Promise<NamespaceName>
Parameters
- Optionaltask: SoloListrTaskWrapper<any>
Returns Promise<NamespaceName>
Inherited from BaseCommand.resolveNamespaceFromDeployment
- Defined in src/commands/base.ts:338

run

run(
    cmd: string,
    arguments_?: string[],
    verbose?: boolean,
    detached?: boolean,
): Promise<string[]>
Returns a promise that invokes the shell command
Parameters
- cmd: string
- arguments_: string[] = []
- verbose: boolean = false
- detached: boolean = false
Returns Promise<string[]>
Inherited from BaseCommand.run
- Defined in src/core/shell-runner.ts:17

setupHomeDirectory

setupHomeDirectory(directories?: string[]): string[]
Setup home directories
Parameters
- directories: string[] = []
Returns string[]
Inherited from BaseCommand.setupHomeDirectory
- Defined in src/commands/base.ts:225

setupSystemFilesTasks

setupSystemFilesTasks(argv: any): SoloListrTask<InitContext>[]
Parameters
- argv: any
Returns SoloListrTask<InitContext>[]
- Defined in src/commands/init/init.ts:49

sudoRun

sudoRun(
    sudoRequested: (message: string) => void,
    sudoGranted: (message: string) => void,
    cmd: string,
    arguments_?: string[],
    verbose?: boolean,
    detached?: boolean,
): Promise<string[]>
Parameters
- sudoRequested: (message: string) => void
- sudoGranted: (message: string) => void
- cmd: string
- arguments_: string[] = []
- verbose: boolean = false
- detached: boolean = false
Returns Promise<string[]>
Inherited from BaseCommand.sudoRun
- Defined in src/core/shell-runner.ts:99

`Protected`throwIfNamespaceIsMissing

throwIfNamespaceIsMissing(
context: string,
namespace: NamespaceName,
): Promise<void>
Parameters
- context: string
- namespace: NamespaceName
Returns Promise<void>
Inherited from BaseCommand.throwIfNamespaceIsMissing
- Defined in src/commands/base.ts:264

`Static`prepareValuesFilesMap

prepareValuesFilesMap(
    clusterReferences: ClusterReferences,
    chartDirectory?: string,
    profileValuesFile?: string,
    valuesFileInput?: string,
): Record<ClusterReferenceName, string>
Prepare the values files map for each cluster

Order of precedence:
1. Chart's default values file (if chartDirectory is set)
2. Profile values file
3. User's values file
Parameters
- clusterReferences: ClusterReferences
- OptionalchartDirectory: string
  the chart directory
- OptionalprofileValuesFile: string
  the profile values file full path
- OptionalvaluesFileInput: string
  the values file input string
Returns Record<ClusterReferenceName, string>
Inherited from BaseCommand.prepareValuesFilesMap
- Defined in src/commands/base.ts:152

`Static`prepareValuesFilesMapMultipleCluster

prepareValuesFilesMapMultipleCluster(
    clusterReferences: ClusterReferences,
    chartDirectory?: string,
    profileValuesFile?: Record<ClusterReferenceName, string>,
    valuesFileInput?: string,
): Record<ClusterReferenceName, string>
Prepare the values files map for each cluster

Order of precedence:
1. Chart's default values file (if chartDirectory is set)
2. Profile values file
3. User's values file
Parameters
- clusterReferences: ClusterReferences
- OptionalchartDirectory: string
  the chart directory
- OptionalprofileValuesFile: Record<ClusterReferenceName, string>
  mapping of clusterRef to the profile values file full path
- OptionalvaluesFileInput: string
  the values file input string
Returns Record<ClusterReferenceName, string>
Inherited from BaseCommand.prepareValuesFilesMapMultipleCluster
- Defined in src/commands/base.ts:79

Class InitCommand

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns InitCommand

Properties

Protected ReadonlybrewPackageManager

Protected Optional ReadonlychartManager

Protected ReadonlyclusterTaskManager

Protected Optional ReadonlycomponentFactory

Optional ReadonlyconfigManager

Protected Optional ReadonlydepManager

Protected Optional Readonlyhelm

Protected Optional Readonlyk8Factory

Protected ReadonlykindBuilder

Protected Optional ReadonlyleaseManager

Optional ReadonlylocalConfig

Optionallogger

Protected ReadonlyosPackageManager

Protected ReadonlypodmanInstallationDirectory

Protected Optional ReadonlyremoteConfig

Protected Optional ReadonlytaskList

Static ReadonlyCOMMAND_NAME

Static ReadonlyINIT_COMMAND_NAME

Methods

close

Returns Promise<void>

ProtectedgetClusterContext

Parameters

Returns string

ProtectedgetClusterReference

Returns string

getCommandDefinition

Returns CommandDefinition

ProtectedgetNamespace

Parameters

Returns Promise<NamespaceName>

ProtectedinferMirrorNodeData

Parameters

Returns Promise< { mirrorNamespace: string; mirrorNodeId: number; mirrorNodeReleaseName: string; },>

init

Parameters

Returns Promise<boolean>

initTasks

Parameters

Returns Listr<InitContext, ListrRendererValue, ListrRendererValue>

installDependenciesTasks

Parameters

Returns SoloListrTask<InitContext>[]

ProtectedresolveNamespaceFromDeployment

Parameters

Returns Promise<NamespaceName>

run

Parameters

Returns Promise<string[]>

setupHomeDirectory

Parameters

Returns string[]

setupSystemFilesTasks

Parameters

Returns SoloListrTask<InitContext>[]

sudoRun

Parameters

Returns Promise<string[]>

ProtectedthrowIfNamespaceIsMissing

Parameters

Returns Promise<void>

StaticprepareValuesFilesMap

Parameters

Returns Record<ClusterReferenceName, string>

StaticprepareValuesFilesMapMultipleCluster

Parameters

Returns Record<ClusterReferenceName, string>

Settings

On This Page

`Protected` `Readonly`brewPackageManager

`Protected` `Optional` `Readonly`chartManager

`Protected` `Readonly`clusterTaskManager

`Protected` `Optional` `Readonly`componentFactory

`Optional` `Readonly`configManager

`Protected` `Optional` `Readonly`depManager

`Protected` `Optional` `Readonly`helm

`Protected` `Optional` `Readonly`k8Factory

`Protected` `Readonly`kindBuilder

`Protected` `Optional` `Readonly`leaseManager

`Optional` `Readonly`localConfig

`Optional`logger

`Protected` `Readonly`osPackageManager

`Protected` `Readonly`podmanInstallationDirectory

`Protected` `Optional` `Readonly`remoteConfig

`Protected` `Optional` `Readonly`taskList

`Static` `Readonly`COMMAND_NAME

`Static` `Readonly`INIT_COMMAND_NAME

`Protected`getClusterContext

`Protected`getClusterReference

`Protected`getNamespace

`Protected`inferMirrorNodeData

Returns Promise<
{
mirrorNamespace: string;
mirrorNodeId: number;
mirrorNodeReleaseName: string;
},
>

`Protected`resolveNamespaceFromDeployment

`Protected`throwIfNamespaceIsMissing

`Static`prepareValuesFilesMap

`Static`prepareValuesFilesMapMultipleCluster