canic-cli 0.68.3

Operator CLI for Canic fleet setup, builds, evidence, catalog, backup, and restore workflows
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

//! Module: backup::options::create
//!
//! Responsibility: parse `canic backup create` options.
//! Does not own: backup planning or execution.
//! Boundary: create subcommand argument shape and defaults.

use super::shared::parse_backup_options;
use crate::{
    backup::{BackupCommandError, create_usage},
    cli::{
        clap::{
            flag_arg, path_option, required_string, string_option, string_option_or_else, value_arg,
        },
        defaults::{default_icp, local_network},
        globals::{internal_icp_arg, internal_network_arg},
    },
};
use clap::Command as ClapCommand;
use std::{ffi::OsString, path::PathBuf};

///
/// BackupCreateOptions
///

#[derive(Clone, Debug, Eq, PartialEq)]
pub(in crate::backup) struct BackupCreateOptions {
    pub(in crate::backup) deployment: String,
    pub(in crate::backup) subtree: Option<String>,
    pub(in crate::backup) out: Option<PathBuf>,
    pub(in crate::backup) dry_run: bool,
    pub(in crate::backup) network: String,
    pub(in crate::backup) icp: String,
}

impl BackupCreateOptions {
    pub(in crate::backup) fn parse<I>(args: I) -> Result<Self, BackupCommandError>
    where
        I: IntoIterator<Item = OsString>,
    {
        let matches = parse_backup_options(backup_create_command(), create_usage, args)?;

        Ok(Self {
            deployment: required_string(&matches, "deployment"),
            subtree: string_option(&matches, "subtree"),
            out: path_option(&matches, "out"),
            dry_run: matches.get_flag("dry-run"),
            network: string_option_or_else(&matches, "network", local_network),
            icp: string_option_or_else(&matches, "icp", default_icp),
        })
    }
}

pub(in crate::backup) fn backup_create_command() -> ClapCommand {
    ClapCommand::new("create")
        .bin_name("canic backup create")
        .about("Create a topology-aware deployment backup")
        .disable_help_flag(true)
        .arg(
            value_arg("deployment")
                .value_name("deployment")
                .required(true)
                .help("Installed deployment target name to back up"),
        )
        .arg(
            value_arg("subtree")
                .long("subtree")
                .value_name("role-or-principal")
                .help("Plan only one connected subtree"),
        )
        .arg(
            value_arg("out").long("out").value_name("dir").help(
                "Backup output directory; defaults to backups/deployment-<name>-YYYYMMDD-HHMMSS",
            ),
        )
        .arg(
            flag_arg("dry-run")
                .long("dry-run")
                .help("Write the backup plan and execution journal without running it"),
        )
        .arg(internal_network_arg())
        .arg(internal_icp_arg())
}