Function brane_ctl::generate::backend

source ·
pub fn backend(
    fix_dirs: bool,
    path: impl Into<PathBuf>,
    capabilities: Vec<Capability>,
    hash_containers: bool,
    command: GenerateBackendSubcommand,
) -> Result<(), Error>
Expand description

Handles generating a new creds.yml config file.

§Arguments

  • fix_dirs: if true, will generate missing directories instead of complaining.
  • path: The path to write the creds.yml to.
  • capabilities: A list of Capabilities to advertise for this domain.
  • hash_container: Whether the hashing-containers feature should be enabled or not.
  • command: The command with the type of backend (and associated properties) encoded in it.

§Returns

Nothing, but does write a new file to the given path and updates the user on stdout on success.

§Errors

This function may error if I/O errors occur while writing the file.