DockerComposeUpSettings Class

Summary

Settings for docker compose up.
Assembly
Cake.Docker.dll
Namespace
Cake.Docker
Base Types
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Docker/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["DockerComposeUpSettings"] class Type type-node

Syntax

public sealed class DockerComposeUpSettings : AutoToolSettings

Attributes

Type Description
NullableContextAttribute
NullableAttribute

Constructors

Name Summary
DockerComposeUpSettings()

Fields

Name Constant Value Summary
SecretProperties
Values of these properties shouldn't be displayed in the output.
Inherited from AutoToolSettings

Properties

Name Value Summary
AbortOnContainerExit Nullable<bool>
Stops all containers if any container was stopped. Incompatible with -d
AlwaysRecreateDeps Nullable<bool>
Recreate dependent containers. Incompatible with --no-recreate.
Attach string[]
Restrict attaching to the specified services. Incompatible with --attach-dependencies.
AttachDependencies Nullable<bool>
Automatically attach to log output of dependent services.
Build Nullable<bool>
Build images before starting containers.
Detach Nullable<bool>
Detached mode: Run containers in the background
ExitCodeFrom string
Return the exit code of the selected service container. Implies --abort-on-container-exit
ForceRecreate Nullable<bool>
Recreate containers even if their configuration and image haven't changed.
NoAttach string[]
Do not attach (stream logs) to the specified services.
NoBuild Nullable<bool>
Don't build an image, even if it's policy.
NoColor Nullable<bool>
Produce monochrome output.
NoDeps Nullable<bool>
Don't start linked services.
NoLogPrefix Nullable<bool>
Don't print prefix in logs.
NoRecreate Nullable<bool>
If containers already exist, don't recreate them. Incompatible with --force-recreate.
NoStart Nullable<bool>
Don't start the services after creating them.
Pull string
Pull image before running ("always"|"missing"|"never") (default "policy")
QuietPull Nullable<bool>
Pull without printing progress information.
RemoveOrphans Nullable<bool>
Remove containers for services not defined in the Compose file.
RenewAnonVolumes Nullable<bool>
Recreate anonymous volumes instead of retrieving data from the previous containers.
Scale Nullable<bool>
Scale SERVICE to NUM instances. Overrides the scale setting in the Compose file if present.
Timeout Nullable<int>
Use this timeout in seconds for container shutdown when attached or when containers are already running.
Timestamps Nullable<bool>
Show timestamps.
Wait Nullable<bool>
Wait for services to be running|healthy. Implies detached mode.
WaitTimeout Nullable<int>
Maximum duration to wait for the project to be running|healthy.

Methods

Name Value Summary
CollectSecretProperties() string[]
Collects secret properties.
Inherited from AutoToolSettings

Extension Methods

Name Value Summary
Dump<DockerComposeUpSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<DockerComposeUpSettings>(DockerComposeUpSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<DockerComposeUpSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<DockerComposeUpSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<DockerComposeUpSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<DockerComposeUpSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin