Struct StackConfig 

pub struct StackConfig {

    pub server_id: String,
    pub project_name: String,
    pub run_directory: String,
    pub file_paths: Vec<String>,
    pub files_on_host: bool,
    pub registry_provider: String,
    pub registry_account: String,
    pub extra_args: Vec<String>,
    pub environment: Vec<EnvironmentVar>,
    pub env_file_path: String,
    pub skip_secret_interp: bool,
    pub file_contents: String,
    pub ignore_services: Vec<String>,
    pub git_provider: String,
    pub git_https: bool,
    pub git_account: String,
    pub repo: String,
    pub branch: String,
    pub commit: String,
    pub webhook_enabled: bool,
    pub webhook_secret: String,
    pub send_alerts: bool,
}

The compose file configuration.

Fields

server_id: String

The server to deploy the stack on.

project_name: String

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.

run_directory: String

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

file_paths: Vec<String>

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

files_on_host: bool

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.

registry_provider: String

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

registry_account: String

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

extra_args: Vec<String>

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

environment: Vec<EnvironmentVar>

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.

env_file_path: String

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

skip_secret_interp: bool

Whether to skip secret interpolation into the stack environment variables.

file_contents: String

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.

ignore_services: Vec<String>

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

git_provider: String

The git provider domain. Default: github.com

git_https: bool

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

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

git_account: String

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.

repo: String

The Github repo used as the source of the build.

branch: String

The branch of the repo.

commit: String

Optionally set a specific commit hash.

webhook_enabled: bool

Whether incoming webhooks actually trigger action.

webhook_secret: String

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

send_alerts: bool

Whether to send StackStateChange alerts for this stack.

Implementations

impl StackConfig

pub fn builder() -> StackConfigBuilder

Trait Implementations

impl Clone for StackConfig

fn clone(&self) -> StackConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StackConfig

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

Formats the value using the given formatter.

impl Default for StackConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StackConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<PartialStackConfig> for StackConfig

fn from(value: PartialStackConfig) -> StackConfig

Converts to this type from the input type.

impl From<StackConfig> for PartialStackConfig

fn from(value: StackConfig) -> PartialStackConfig

Converts to this type from the input type.

impl HasPartial for StackConfig

type Partial = PartialStackConfig

fn merge_partial(self, partial: Self::Partial) -> StackConfig

impl PartialDiff<PartialStackConfig, StackConfigDiff> for StackConfig

fn partial_diff(&self, partial: PartialStackConfig) -> StackConfigDiff

Diffs a partial against self, returning a partial where all “Some” fields are not equal to the corresponding field on Self.

fn minimize_partial(&self, partial: P) -> P

impl Serialize for StackConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.