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
Generic docker-compose settings.
- Assembly
- Cake
.Docker .dll - Namespace
- Cake
.Docker - Base Types
-
- ToolSettings
- AutoToolSettings
- Derived Types
-
- Docker
Compose Restart Settings - Docker
Compose Port Settings - Docker
Compose Push Settings - Docker
Compose Exec Settings - Docker
Compose Run Settings - Docker
Compose Ps Settings - Docker
Compose Rm Settings - Docker
Compose Build Settings - Docker
Compose Logs Settings - Docker
Compose Stop Settings - Docker
Compose Up Settings - Docker
Compose Create Settings - Docker
Compose Kill Settings - Docker
Compose Down Settings - Docker
Compose Pull Settings
- Docker
graph BT
Type-->Base0["AutoToolSettings"]
click Base0 "/api/Cake.Docker/AutoToolSettings"
Base0-->Base1["ToolSettings"]
Type["DockerComposeSettings"]
class Type type-node
Derived0["DockerComposeRestartSettings"]-->Type
click Derived0 "/api/Cake.Docker/DockerComposeRestartSettings"
Derived1["DockerComposePortSettings"]-->Type
click Derived1 "/api/Cake.Docker/DockerComposePortSettings"
Derived2["DockerComposePushSettings"]-->Type
click Derived2 "/api/Cake.Docker/DockerComposePushSettings"
Derived3["DockerComposeExecSettings"]-->Type
click Derived3 "/api/Cake.Docker/DockerComposeExecSettings"
Derived4["DockerComposeRunSettings"]-->Type
click Derived4 "/api/Cake.Docker/DockerComposeRunSettings"
Derived5["DockerComposePsSettings"]-->Type
click Derived5 "/api/Cake.Docker/DockerComposePsSettings"
Derived6["DockerComposeRmSettings"]-->Type
click Derived6 "/api/Cake.Docker/DockerComposeRmSettings"
Derived7["DockerComposeBuildSettings"]-->Type
click Derived7 "/api/Cake.Docker/DockerComposeBuildSettings"
Derived8["DockerComposeLogsSettings"]-->Type
click Derived8 "/api/Cake.Docker/DockerComposeLogsSettings"
Derived9["DockerComposeStopSettings"]-->Type
click Derived9 "/api/Cake.Docker/DockerComposeStopSettings"
Derived10["DockerComposeUpSettings"]-->Type
click Derived10 "/api/Cake.Docker/DockerComposeUpSettings"
Derived11["DockerComposeCreateSettings"]-->Type
click Derived11 "/api/Cake.Docker/DockerComposeCreateSettings"
Derived12["DockerComposeKillSettings"]-->Type
click Derived12 "/api/Cake.Docker/DockerComposeKillSettings"
Derived13["DockerComposeDownSettings"]-->Type
click Derived13 "/api/Cake.Docker/DockerComposeDownSettings"
Derived14["DockerComposePullSettings"]-->Type
click Derived14 "/api/Cake.Docker/DockerComposePullSettings"
Syntax
public class DockerComposeSettings : AutoToolSettingsConstructors
| 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.
|
| Host | string |
Daemon socket to connect to
|
| ProjectDirectory | string |
Specify an alternate working directory
(default: the path of the Compose file)
|
| ProjectName | string |
Specify an alternate project name (default: directory name)
|
| 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)
|
| Tls | bool |
Use TLS; implied by --tlsverify
|
| Tlscacert | string |
Trust certs signed only by this CA
|
| Tlscert | string |
Path to TLS certificate file
|
| Tlskey | string |
Path to TLS key file
|
| Tlsverify | bool |
Use TLS and verify the remote
|
| Verbose | bool |
Show more output
|
| Version | bool |
Print version and exit
|
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
|