This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.Docker.
Summary
Settings for docker build.
- Assembly
- Cake
.Docker .dll - Namespace
- Cake
.Docker - Base Types
-
- ToolSettings
- AutoToolSettings
- Docker
Compose Settings
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 |
---|---|
Docker |
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.
|
Build | bool |
Build images before starting containers.
|
DetachedMode | bool |
Detached mode: Run container in the background, print new container name.
|
ExitCodeFrom | string |
Return the exit code of the selected service container.
Implies --abort-on-container-exit.
|
Files | string[] |
Configuration files.
Inherited from Docker
|
ForceRecreate | bool |
Recreate containers even if their configuration
and image haven't changed.
Incompatible with --no-recreate.
|
Host | string |
Daemon socket to connect to
Inherited from Docker
|
NoBuild | bool |
Don't build an image, even if it's missing.
|
NoColor | bool |
Produce monochrome output.
|
NoDeps | bool |
Don't start linked services.
|
NoRecreate | bool |
If containers already exist, don't recreate them.
Incompatible with --force-recreate.
|
ProjectDirectory | string |
Specify an alternate working directory
(default: the path of the Compose file)
Inherited from Docker
|
ProjectName | string |
Specify an alternate project name (default: directory name)
Inherited from Docker
|
RemoveOrphans | bool |
Remove containers for services not defined in
the Compose file
|
Scale | string |
SERVICE=NUM 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 Docker
|
Timeout | bool |
Use this timeout in seconds for container shutdown
when attached or when containers are already
running. (default: 10)
|
Tls | bool |
Use TLS; implied by --tlsverify
Inherited from Docker
|
Tlscacert | string |
Trust certs signed only by this CA
Inherited from Docker
|
Tlscert | string |
Path to TLS certificate file
Inherited from Docker
|
Tlskey | string |
Path to TLS key file
Inherited from Docker
|
Tlsverify | bool |
Use TLS and verify the remote
Inherited from Docker
|
Verbose | bool |
Show more output
Inherited from Docker
|
Version | bool |
Print version and exit
Inherited from Docker
|
Methods
Name | Value | Summary |
---|---|---|
Collect |
string[] |
Collects secret properties.
Inherited from AutoToolSettings
|
Extension Methods
Name | Value | Summary |
---|---|---|
Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|