Enum GenerateSubcommand

pub(crate) enum GenerateSubcommand {
    Node {
        hosts: Vec<Pair<String, ':', IpAddr>>,
        fix_dirs: bool,
        config_path: PathBuf,
        kind: Box<GenerateNodeSubcommand>,
    },
    Certs {
        fix_dirs: bool,
        path: PathBuf,
        temp_dir: PathBuf,
        kind: Box<GenerateCertsSubcommand>,
    },
    Infra {
        locations: Vec<Pair<String, ':', String>>,
        fix_dirs: bool,
        path: PathBuf,
        names: Vec<Pair<String, '=', String>>,
        reg_ports: Vec<Pair<String, '=', u16>>,
        job_ports: Vec<Pair<String, '=', u16>>,
    },
    Backend {
        fix_dirs: bool,
        path: PathBuf,
        capabilities: Vec<Capability>,
        disable_hashing: bool,
        kind: Box<GenerateBackendSubcommand>,
    },
    PolicyDatabase {
        fix_dirs: bool,
        path: PathBuf,
        branch: String,
    },
    PolicySecret {
        fix_dirs: bool,
        path: PathBuf,
        key_id: String,
        jwt_alg: KeyAlgorithm,
    },
    PolicyToken {
        initiator: String,
        system: String,
        exp: Duration,
        fix_dirs: bool,
        path: PathBuf,
        secret_path: PathBuf,
    },
    Proxy {
        fix_dirs: bool,
        path: PathBuf,
        outgoing_range: InclusiveRange<u16>,
        incoming: Vec<Pair<u16, ':', Address>>,
        forward: Option<Address>,
        forward_protocol: ProxyProtocol,
    },
}

Defines generate-related subcommands for the branectl tool.

Variants

Node

Fields

hosts: Vec<Pair<String, ':', IpAddr>>

Defines one or more additional hostnames to define in the nested Docker container.

fix_dirs: bool

If given, will generate missing directories instead of throwing errors.

config_path: PathBuf

Custom config path.

kind: Box<GenerateNodeSubcommand>

Defines the possible nodes to generate a new node.yml file for.

Certs

Fields

fix_dirs: bool

If given, will generate missing directories instead of throwing errors.

path: PathBuf

The directory to write to.

temp_dir: PathBuf

The directory to write temporary scripts to.

kind: Box<GenerateCertsSubcommand>

The type of certificate to generate.

Infra

Fields

locations: Vec<Pair<String, ':', String>>

Defines the list of domains

fix_dirs: bool

If given, will generate missing directories instead of throwing errors.

path: PathBuf

The path to write to.

names: Vec<Pair<String, '=', String>>

Determines the name of the given domain.

reg_ports: Vec<Pair<String, '=', u16>>

Determines the port of the registry node on the given domain.

job_ports: Vec<Pair<String, '=', u16>>

Determines the port of the delegate node on the given domain.

Backend

Fields

fix_dirs: bool

If given, will generate missing directories instead of throwing errors.

path: PathBuf

The path to write to.

capabilities: Vec<Capability>

The list of capabilities to advertise for this domain.

disable_hashing: bool

Whether to hash containers or not (but inverted).

kind: Box<GenerateBackendSubcommand>

Defines the possible backends to generate a new backend.yml file for.

PolicyDatabase

Fields

fix_dirs: bool

If given, will generate missing directories instead of throwing errors.

path: PathBuf

The path to write to.

branch: String

The branch to pull the migrations from.

PolicySecret

Fields

fix_dirs: bool

If given, will generate missing directories instead of throwing errors.

path: PathBuf

The path to write to.

key_id: String

The identifier for this key.

jwt_alg: KeyAlgorithm

The algorithm used to sign JWTs.

PolicyToken

Fields

initiator: String

The name of the user using this token.

system: String

The name of the system through which the access is performed.

exp: Duration

The expiry time.

fix_dirs: bool

If given, will generate missing directories instead of throwing errors.

path: PathBuf

The path to write to.

secret_path: PathBuf

The path of the secret file containing the key.

Proxy

Fields

fix_dirs: bool

If given, will generate missing directories instead of throwing errors.

path: PathBuf

The path to write to.

outgoing_range: InclusiveRange<u16>

Defines the range of ports that we can allocate for outgoing connections.

incoming: Vec<Pair<u16, ':', Address>>

Defines the map of incoming ports.

forward: Option<Address>

Defines if the proxy should be forwarded.

forward_protocol: ProxyProtocol

Defines which protocol to use if forwarding.

Trait Implementations

impl Debug for GenerateSubcommand

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for GenerateSubcommand

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for GenerateSubcommand

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand