Function brane_ctl::lifetime::start

source · 
pub async fn start(
    exe: impl AsRef<str>,
    file: Option<PathBuf>,
    node_config_path: impl Into<PathBuf>,
    docker_opts: DockerOptions,
    opts: StartOpts,
    command: StartSubcommand,
) -> Result<(), Error>
Expand description

Starts the local node by running the given docker-compose file.

§Arguments

  • exe: The docker-compose executable to run.
  • file: The docker-compose.yml file to launch.
  • node_config_path: The path to the node config file to potentially override.
  • docker_opts: Configuration for connecting to the local Docker daemon. See DockerOptions for more information.
  • opts: Miscellaneous configuration for starting the images. See StartOpts for more information.
  • command: The StartSubcommand that carries additional information, including which of the node types to launch.

§Returns

Nothing, but does change the local Docker daemon to load and then run the given files.

§Errors

This function errors if we failed to run the docker-compose command or if we failed to assert that the given command matches the node kind of the node.yml file on disk.