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["DockerComposeDownSettings"]
class Type type-node
Syntax
public sealed class DockerComposeDownSettings : DockerComposeSettingsConstructors
| 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 |
|---|---|---|
| Files | string[] |
Configuration files.
Inherited from Docker
|
| Host | string |
Daemon socket to connect to
Inherited from Docker
|
| 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
|
| Rmi | string |
Remove images. Type must be one of:
'all': Remove all images used by any service.
'local': Remove only images that don't have a custom tag
set by the `image` field.
|
| 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
|
| 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
|
| Volumes | bool |
Remove named volumes declared in the `volumes` section
of the Compose file and anonymous volumes
attached to containers.
|
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
|
| To |
string |
Returns the string value or a
Not set> markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|