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 compose run.
- Assembly
- Cake
.Docker .dll - Namespace
- Cake
.Docker - Base Types
-
- ToolSettings
- AutoToolSettings
graph BT
Type-->Base0["AutoToolSettings"]
click Base0 "/api/Cake.Docker/AutoToolSettings"
Base0-->Base1["ToolSettings"]
Type["DockerComposeRunSettings"]
class Type type-node
Syntax
public sealed class DockerComposeRunSettings : AutoToolSettingsAttributes
| Type | Description |
|---|---|
| Nullable |
|
| NullableAttribute |
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 |
|---|---|---|
| Build | Nullable |
Build image before starting container.
|
| CapAdd | Nullable |
Add Linux capabilities
|
| CapDrop | Nullable |
Drop Linux capabilities
|
| Detach | Nullable |
Run container in background and print
container ID
|
| Entrypoint | string |
Override the entrypoint of the image
|
| Env | string[] |
Set environment variables
|
| Interactive | Nullable |
Keep STDIN open even if not attached.
(default true)
|
| Label | string[] |
Add or override a label
|
| Name | string |
Assign a name to the container
|
| NoDeps | Nullable |
Don't start linked services.
|
| NoTTY | Nullable |
Disable pseudo-TTY allocation (default:
auto-detected).
|
| Publish | string[] |
Publish a container's port(s) to the host.
|
| QuietPull | Nullable |
Pull without printing progress information.
|
| RemoveOrphans | Nullable |
Remove containers for services not defined
in the Compose file.
|
| Rm | Nullable |
Automatically remove the container when it exits
|
| ServicePorts | Nullable |
Run command with all service's ports
enabled and mapped to the host.
|
| UseAliases | Nullable |
Use the service's network useAliases in the
network(s) the container connects to.
|
| User | string |
Run as specified username or uid
|
| Volume | string[] |
Bind mount a volume.
|
| Workdir | string |
Working directory inside the container
|
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
|