Struct StackConfigBuilder

pub struct StackConfigBuilder { /* private fields */ }

Builder for StackConfig.

Implementations

impl StackConfigBuilder

pub fn server_id(&mut self, value: String) -> &mut Self

The server to deploy the stack on.

pub fn project_name(&mut self, value: String) -> &mut Self

Optionally specify a custom project name for the stack. If this is empty string, it will default to the stack name. Used with docker compose -p {project_name}.

Note. Can be used to import pre-existing stacks.

pub fn run_directory(&mut self, value: String) -> &mut Self

Directory to change to (cd) before running docker compose up -d. Default: ./ (the repo root)

pub fn file_paths(&mut self, value: Vec<String>) -> &mut Self

Add paths to compose files, relative to the run path. If this is empty, will use file compose.yaml.

pub fn files_on_host(&mut self, value: bool) -> &mut Self

If this is checked, the stack will source the files on the host. Use run_directory and file_paths to specify the path on the host. This is useful for those who wish to setup their files on the host using SSH or similar, rather than defining the contents in UI or in a git repo.

pub fn registry_provider(&mut self, value: String) -> &mut Self

Used with registry_account to login to a registry before docker compose up.

pub fn registry_account(&mut self, value: String) -> &mut Self

Used with registry_provider to login to a registry before docker compose up.

pub fn extra_args(&mut self, value: Vec<String>) -> &mut Self

The extra arguments to pass after docker compose up -d. If empty, no extra arguments will be passed.

pub fn environment(&mut self, value: Vec<EnvironmentVar>) -> &mut Self

The environment variables passed to the compose file. They will be written to path defined in env_file_path, which is given relative to the run directory.

If it is empty, no file will be written.

pub fn env_file_path(&mut self, value: String) -> &mut Self

The name of the written environment file before docker compose up. Relative to the repo root. Default: .env

pub fn skip_secret_interp(&mut self, value: bool) -> &mut Self

Whether to skip secret interpolation into the stack environment variables.

pub fn file_contents(&mut self, value: String) -> &mut Self

The contents of the file directly, for management in the UI. If this is empty, it will fall back to checking git config for repo based compose file.

pub fn ignore_services(&mut self, value: Vec<String>) -> &mut Self

Ignore certain services declared in the compose file when checking the stack status. For example, an init service might be exited, but the stack should be healthy. This init service should be in ignore_services

pub fn git_provider(&mut self, value: String) -> &mut Self

The git provider domain. Default: github.com

pub fn git_https(&mut self, value: bool) -> &mut Self

Whether to use https to clone the repo (versus http). Default: true

Note. Monitor does not currently support cloning repos via ssh.

pub fn git_account(&mut self, value: String) -> &mut Self

The git account used to access private repos. Passing empty string can only clone public repos.

Note. A token for the account must be available in the core config or the builder server’s periphery config for the configured git provider.

pub fn repo(&mut self, value: String) -> &mut Self

The Github repo used as the source of the build.

pub fn branch(&mut self, value: String) -> &mut Self

The branch of the repo.

pub fn commit(&mut self, value: String) -> &mut Self

Optionally set a specific commit hash.

pub fn webhook_enabled(&mut self, value: bool) -> &mut Self

Whether incoming webhooks actually trigger action.

pub fn webhook_secret(&mut self, value: String) -> &mut Self

Optionally provide an alternate webhook secret for this stack. If its an empty string, use the default secret from the config.

pub fn send_alerts(&mut self, value: bool) -> &mut Self

Whether to send StackStateChange alerts for this stack.

pub fn build(&self) -> Result<StackConfig, StackConfigBuilderError>

Builds a new StackConfig.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for StackConfigBuilder

fn clone(&self) -> StackConfigBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for StackConfigBuilder

fn default() -> Self

Returns the “default value” for a type.