DockerComposeUpSettings Class

Summary

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

Syntax

public sealed class DockerComposeUpSettings : DockerComposeSettings

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 bool
Stops all containers if any container was stopped. Incompatible with -d
AlwaysRecreateDeps bool
Recreate dependent containers. Incompatible with --no-recreate.
Attach string[]
Attach to service output.
AttachDependencies bool
Attach to dependent containers.
Build bool
Build images before starting containers.
Detach bool
Detached mode: Run containers in the background
DryRun bool
Execute command in dry run mode
ExitCodeFrom string
Return the exit code of the selected service container. Implies --abort-on-container-exit
Files string[]
Configuration files.
Inherited from DockerComposeSettings
ForceRecreate bool
Recreate containers even if their configuration and image haven't changed.
Host string
Daemon socket to connect to
Inherited from DockerComposeSettings
NoAttach string[]
Don't attach to specified service.
NoBuild bool
Don't build an image, even if it's missing.
NoColor bool
Produce monochrome output.
NoDeps bool
Don't start linked services.
NoLogPrefix bool
Don't print prefix in logs.
NoRecreate bool
If containers already exist, don't recreate them. Incompatible with --force-recreate.
NoStart bool
Don't start the services after creating them.
ProjectDirectory string
Specify an alternate working directory (default: the path of the Compose file)
Inherited from DockerComposeSettings
ProjectName string
Specify an alternate project name (default: directory name)
Inherited from DockerComposeSettings
Pull string
Pull image before running ("always"|"missing"|"never") (default "missing")
QuietPull bool
Pull without printing progress information.
RemoveOrphans bool
Remove containers for services not defined in the Compose file.
RenewAnonVolumes bool
Recreate anonymous volumes instead of retrieving data from the previous containers.
Scale string
Scale SERVICE to NUM instances. Overrides the scale setting in the Compose file if present.
SkipHostnameCheck bool
Don't check the daemon's hostname against the name specified in the client certificate (for example if your docker host is an IP address)
Inherited from DockerComposeSettings
Timeout int
Use this timeout in seconds for container shutdown when attached or when containers are already running.
Timestamps bool
Show timestamps.
Tls bool
Use TLS; implied by --tlsverify
Inherited from DockerComposeSettings
Tlscacert string
Trust certs signed only by this CA
Inherited from DockerComposeSettings
Tlscert string
Path to TLS certificate file
Inherited from DockerComposeSettings
Tlskey string
Path to TLS key file
Inherited from DockerComposeSettings
Tlsverify bool
Use TLS and verify the remote
Inherited from DockerComposeSettings
Verbose bool
Show more output
Inherited from DockerComposeSettings
Version bool
Print version and exit
Inherited from DockerComposeSettings
Wait bool
Wait for services to be running|healthy. Implies detached mode.
WaitTimeout Nullable<int>
timeout waiting for application 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.Issues addin
NotNull<DockerComposeUpSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp 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