@hashgraph/solo/src/commands/command-definitions/backup-restore-command-definition.ts

An opinionated CLI tool to deploy and manage private Hedera Networks.

// SPDX-License-Identifier: Apache-2.0

import {inject, injectable} from 'tsyringe-neo';
import {InjectTokens} from '../../core/dependency-injection/inject-tokens.js';
import {patchInject} from '../../core/dependency-injection/container-helper.js';
import {BaseCommandDefinition} from './base-command-definition.js';
import {CommandBuilder, CommandGroup, Subcommand} from '../../core/command-path-builders/command-builder.js';
import {BackupRestoreCommand} from '../backup-restore.js';
import {type CommandDefinition} from '../../types/index.js';
import {type SoloLogger} from '../../core/logging/solo-logger.js';

@injectable()
export class BackupRestoreCommandDefinition extends BaseCommandDefinition {
  public constructor(
    @inject(InjectTokens.SoloLogger) private readonly logger?: SoloLogger,
    @inject(InjectTokens.BackupRestoreCommand) public readonly backupRestoreCommand?: BackupRestoreCommand,
  ) {
    super();
    this.backupRestoreCommand = patchInject(
      backupRestoreCommand,
      InjectTokens.BackupRestoreCommand,
      this.constructor.name,
    );
    this.logger = patchInject(logger, InjectTokens.SoloLogger, this.constructor.name);
  }

  public static override readonly COMMAND_NAME = 'config';
  protected static override readonly DESCRIPTION =
    'Backup and restore component configurations for Solo deployments. ' +
    'These commands display what would be backed up or restored without performing actual operations.';

  public static readonly SUBCOMMAND_NAME = 'ops';
  private static readonly SUBCOMMAND_DESCRIPTION = 'Configuration backup and restore operations';

  public static readonly BACKUP_COMMAND = 'backup';
  public static readonly RESTORE_CONFIG_COMMAND = 'restore-config';
  public static readonly RESTORE_CLUSTERS_COMMAND = 'restore-clusters';
  public static readonly RESTORE_NETWORK_COMMAND = 'restore-network';

  public getCommandDefinition(): CommandDefinition {
    return new CommandBuilder(
      BackupRestoreCommandDefinition.COMMAND_NAME,
      BackupRestoreCommandDefinition.DESCRIPTION,
      this.logger,
    )
      .addCommandGroup(
        new CommandGroup(
          BackupRestoreCommandDefinition.SUBCOMMAND_NAME,
          BackupRestoreCommandDefinition.SUBCOMMAND_DESCRIPTION,
        )
          .addSubcommand(
            new Subcommand(
              BackupRestoreCommandDefinition.BACKUP_COMMAND,
              'Display backup plan for all component configurations of a deployment. ' +
                'Shows what files and configurations would be backed up without performing the actual backup.',
              this.backupRestoreCommand,
              this.backupRestoreCommand.backup,
              BackupRestoreCommand.BACKUP_FLAGS_LIST,
              [],
            ),
          )
          .addSubcommand(
            new Subcommand(
              BackupRestoreCommandDefinition.RESTORE_CONFIG_COMMAND,
              'Restore component configurations from backup. ' +
                'Imports ConfigMaps, Secrets, logs, and state files for a running deployment.',
              this.backupRestoreCommand,
              this.backupRestoreCommand.restoreConfig,
              BackupRestoreCommand.RESTORE_CONFIG_FLAGS_LIST,
              [],
            ),
          )
          .addSubcommand(
            new Subcommand(
              BackupRestoreCommandDefinition.RESTORE_CLUSTERS_COMMAND,
              'Restore Kind clusters from backup directory structure. ' +
                'Creates clusters, sets up Docker network, installs MetalLB, and initializes cluster configurations. ' +
                'Does not deploy network components.',
              this.backupRestoreCommand,
              this.backupRestoreCommand.restoreClusters,
              BackupRestoreCommand.RESTORE_CLUSTERS_FLAGS_LIST,
              [],
            ),
          )
          .addSubcommand(
            new Subcommand(
              BackupRestoreCommandDefinition.RESTORE_NETWORK_COMMAND,
              'Deploy network components to existing clusters from backup. ' +
                'Deploys consensus nodes, block nodes, mirror nodes, explorers, and relay nodes. ' +
                'Requires clusters to be already created (use restore-clusters first).',
              this.backupRestoreCommand,
              this.backupRestoreCommand.restoreNetwork,
              BackupRestoreCommand.RESTORE_NETWORK_FLAGS_LIST,
              [],
            ),
          ),
      )
      .build();
  }
}