Class BackupRestoreCommand

Hierarchy (View Summary)

BaseCommand
- BackupRestoreCommand

Constructors

constructor

new BackupRestoreCommand(
kindBuilder: DefaultKindClientBuilder,
): BackupRestoreCommand
Parameters
- kindBuilder: DefaultKindClientBuilder
Returns BackupRestoreCommand
Overrides BaseCommand.constructor
- Defined in src/commands/backup-restore.ts:55

Properties

`Protected` `Optional` `Readonly`chartManager

chartManager?: ChartManager

`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

`Protected` `Optional` `Readonly`taskList

taskList?: TaskList<any, ListrRendererValue, ListrRendererValue>

`Static`BACKUP_FLAGS_LIST

BACKUP_FLAGS_LIST: CommandFlags = ...

`Static`RESTORE_CLUSTERS_FLAGS_LIST

RESTORE_CLUSTERS_FLAGS_LIST: CommandFlags = ...

`Static`RESTORE_CONFIG_FLAGS_LIST

RESTORE_CONFIG_FLAGS_LIST: CommandFlags = ...

`Static`RESTORE_NETWORK_FLAGS_LIST

RESTORE_NETWORK_FLAGS_LIST: CommandFlags = ...

Methods

backup

backup(argv: ArgvStruct): Promise<boolean>
Backup all component configurations
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/backup-restore.ts:212

close

close(): Promise<void>
Returns Promise<void>
Overrides BaseCommand.close
- Defined in src/commands/backup-restore.ts:61

`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

`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

`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

restoreClusters

restoreClusters(argv: ArgvStruct): Promise<boolean>
Restore Kind clusters from backup directory structure Command: solo config ops restore-clusters
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/backup-restore.ts:1536

restoreConfig

restoreConfig(argv: ArgvStruct): Promise<boolean>
Restore all component configurations Command: solo config ops restore-config
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/backup-restore.ts:501

restoreNetwork

restoreNetwork(argv: ArgvStruct): Promise<boolean>
Deploy network components to existing clusters from backup Command: solo config ops restore-network
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/backup-restore.ts:1613

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

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 BackupRestoreCommand

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BackupRestoreCommand

Properties

Protected Optional ReadonlychartManager

Protected Optional ReadonlycomponentFactory

Optional ReadonlyconfigManager

Protected Optional ReadonlydepManager

Protected Optional Readonlyhelm

Protected Optional Readonlyk8Factory

Protected ReadonlykindBuilder

Protected Optional ReadonlyleaseManager

Optional ReadonlylocalConfig

Optionallogger

Protected Optional ReadonlyremoteConfig

Protected Optional ReadonlytaskList

StaticBACKUP_FLAGS_LIST

StaticRESTORE_CLUSTERS_FLAGS_LIST

StaticRESTORE_CONFIG_FLAGS_LIST

StaticRESTORE_NETWORK_FLAGS_LIST

Methods

backup

Parameters

Returns Promise<boolean>

close

Returns Promise<void>

ProtectedgetClusterContext

Parameters

Returns string

ProtectedgetClusterReference

Returns string

ProtectedgetNamespace

Parameters

Returns Promise<NamespaceName>

ProtectedinferMirrorNodeData

Parameters

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

ProtectedresolveNamespaceFromDeployment

Parameters

Returns Promise<NamespaceName>

restoreClusters

Parameters

Returns Promise<boolean>

restoreConfig

Parameters

Returns Promise<boolean>

restoreNetwork

Parameters

Returns Promise<boolean>

run

Parameters

Returns Promise<string[]>

setupHomeDirectory

Parameters

Returns string[]

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` `Optional` `Readonly`chartManager

`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` `Optional` `Readonly`remoteConfig

`Protected` `Optional` `Readonly`taskList

`Static`BACKUP_FLAGS_LIST

`Static`RESTORE_CLUSTERS_FLAGS_LIST

`Static`RESTORE_CONFIG_FLAGS_LIST

`Static`RESTORE_NETWORK_FLAGS_LIST

`Protected`getClusterContext

`Protected`getClusterReference

`Protected`getNamespace

`Protected`inferMirrorNodeData

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

`Protected`resolveNamespaceFromDeployment

`Protected`throwIfNamespaceIsMissing

`Static`prepareValuesFilesMap

`Static`prepareValuesFilesMapMultipleCluster