DockerContainerRunSettings Class

Summary

Settings for docker run [OPTIONS] IMAGE [COMMAND] [ARG...]. Run a command in a new container
Assembly
Cake.Docker.dll
Namespace
Cake.Docker
Base Types
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Docker/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["DockerContainerRunSettings"] class Type type-node

Syntax

public sealed class DockerContainerRunSettings : AutoToolSettings

Constructors

Name Summary
DockerContainerRunSettings()

Fields

Name Constant Value Summary
SecretProperties
Values of these properties shouldn't be displayed in the output.
Inherited from AutoToolSettings

Properties

Name Value Summary
AddHost string[]
--add-host Add a custom host-to-IP mapping (host:ip)
Attach string[]
--attach, -a Attach to STDIN, STDOUT or STDERR
BlkioWeightDevice Nullable<ulong>
--blkio-weight-device Block IO weight (relative device weight)
CapAdd string[]
--cap-add Add Linux capabilities
CapDrop string[]
--cap-drop Drop Linux capabilities
CgroupParent string
--cgroup-parent Optional parent cgroup for the container
Cidfile string
--cidfile Write the container ID to the file
CpuCount Nullable<long>
--cpu-count default: 0 CPU count (Windows only)
CpuPercent Nullable<long>
--cpu-percent default: 0 CPU percent (Windows only)
CpuPeriod Nullable<long>
--cpu-period default: 0 Limit CPU CFS (Completely Fair Scheduler) period
CpuQuota Nullable<long>
--cpu-quota default: 0 Limit CPU CFS (Completely Fair Scheduler) quota
CpuRtPeriod Nullable<long>
--cpu-rt-period default: 0 Limit CPU real-time period in microseconds
CpuRtRuntime Nullable<long>
--cpu-rt-runtime default: 0 Limit CPU real-time runtime in microseconds
Cpus Nullable<ulong>
--cpus Number of CPUs
CpusetCpus string
--cpuset-cpus CPUs in which to allow execution (0-3, 0,1)
CpusetMems string
--cpuset-mems MEMs in which to allow execution (0-3, 0,1)
CpuShares Nullable<long>
--cpu-shares, -c default: 0 CPU shares (relative weight)
Detach Nullable<bool>
--detach, -d default: false Run container in background and print container ID
DetachKeys string
--detach-keys Override the key sequence for detaching a container
Device string[]
--device Add a host device to the container
DeviceCgroupRule string[]
--device-cgroup-rule Add a rule to the cgroup allowed devices list
DeviceReadBps Nullable<ulong>
--device-read-bps Limit read rate (bytes per second) from a device
DeviceReadIops Nullable<ulong>
--device-read-iops Limit read rate (IO per second) from a device
DeviceWriteBps Nullable<ulong>
--device-write-bps Limit write rate (bytes per second) to a device
DeviceWriteIops Nullable<ulong>
--device-write-iops Limit write rate (IO per second) to a device
DisableContentTrust Nullable<bool>
--disable-content-trust default: true Skip image verification
Dns string[]
--dns Set custom DNS servers
DnsOption string[]
--dns-option Set DNS options
DnsSearch string[]
--dns-search Set custom DNS search domains
Entrypoint string
--entrypoint Overwrite the default ENTRYPOINT of the image
Env string[]
--env, -e Set environment variables
EnvFile string[]
--env-file Read in a file of environment variables
Expose string[]
--expose Expose a port or a range of ports
GroupAdd string[]
--group-add Add additional groups to join
HealthCmd string
--health-cmd Command to run to check health
HealthInterval string
--health-interval default: 0 Time between running the check (ms|s|m|h) (default 0s)
HealthRetries Nullable<int>
--health-retries default: 0 Consecutive failures needed to report unhealthy
HealthStartPeriod string
--health-start-period default: 0 Start period for the container to initialize before starting health-retries countdown (ms|s|m|h) (default 0s)
HealthTimeout string
--health-timeout default: 0 Maximum time to allow one check to run (ms|s|m|h) (default 0s)
Hostname string
--hostname, -h Container host name
Init Nullable<bool>
--init default: false Run an init inside the container that forwards signals and reaps processes
Interactive Nullable<bool>
--interactive, -i default: false Keep STDIN open even if not attached
IoMaxbandwidth string
--io-maxbandwidth Maximum IO bandwidth limit for the system drive (Windows only)
IoMaxiops string
--io-maxiops
Ip string
--ip IPv4 address (e.g., 172.30.100.104)
Ip6 string
--ip6 IPv6 address (e.g., 2001:db8::33)
Ipc string
--ipc IPC mode to use
Isolation string
--isolation Container isolation technology
KernelMemory string
--kernel-memory Kernel memory limit
Label string[]
--label, -l Set meta data on a container
LabelFile string[]
--label-file Read in a line delimited file of labels
Link string[]
--link Add link to another container
LinkLocalIp string[]
--link-local-ip Container IPv4/IPv6 link-local addresses
LogDriver string
--log-driver Logging driver for the container
LogOpt string[]
--log-opt Log driver options
MacAddress string
--mac-address Container MAC address (e.g., 92:d0:c6:0a:29:33)
Memory string
--memory, -m Memory limit
MemoryReservation string
--memory-reservation Memory soft limit
MemorySwap string
--memory-swap Swap limit equal to memory plus swap: '-1' to enable unlimited swap
MemorySwappiness Nullable<long>
--memory-swappiness default: -1 Tune container memory swappiness (0 to 100)
Mount string[]
--mount Attach a filesystem mount to the container
Name string
--name Assign a name to the container
Network string
--network default: default Connect a container to a network
NetworkAlias string[]
--network-alias Add network-scoped alias for the container
NoHealthcheck Nullable<bool>
--no-healthcheck default: false Disable any container-specified HEALTHCHECK
OomKillDisable Nullable<bool>
--oom-kill-disable default: false Disable OOM Killer
OomScoreAdj Nullable<int>
--oom-score-adj default: 0 Tune host's OOM preferences (-1000 to 1000)
Pid string
--pid PID namespace to use
PidsLimit Nullable<long>
--pids-limit default: 0 Tune container pids limit (set -1 for unlimited)
Platform string
--platform Set platform if server is multi-platform capable
Privileged Nullable<bool>
--privileged default: false Give extended privileges to this container
Publish string[]
--publish, -p Publish a container's port(s) to the host
PublishAll Nullable<bool>
--publish-all, -P default: false Publish all exposed ports to random ports
ReadOnly Nullable<bool>
--read-only default: false Mount the container's root filesystem as read only
Restart string
--restart default: no Restart policy to apply when a container exits
Rm Nullable<bool>
--rm default: false Automatically remove the container when it exits
Runtime string
--runtime Runtime to use for this container
SecurityOpt string[]
--security-opt Security Options
ShmSize string
--shm-size Size of /dev/shm
SigProxy Nullable<bool>
--sig-proxy default: true Proxy received signals to the process
StopSignal string
--stop-signal default: signal.DefaultStopSignal Signal to stop a container
StopTimeout Nullable<int>
--stop-timeout default: 0 Timeout (in seconds) to stop a container
StorageOpt string[]
--storage-opt Storage driver options for the container
Sysctl string[]
--sysctl Sysctl options
Tmpfs string[]
--tmpfs Mount a tmpfs directory
Tty Nullable<bool>
--tty, -t default: false Allocate a pseudo-TTY
Ulimit string[]
--ulimit Ulimit options
User string
--user, -u Username or UID (format: <name|uid>[:<group|gid>])
Userns string
--userns User namespace to use
Uts string
--uts UTS namespace to use
Volume string[]
--volume, -v Bind mount a volume
VolumeDriver string
--volume-driver Optional volume driver for the container
VolumesFrom string[]
--volumes-from Mount volumes from the specified container(s)
Workdir string
--workdir, -w Working directory inside the container

Methods

Name Value Summary
CollectSecretProperties() string[]
Collects secret properties.
Inherited from AutoToolSettings

Extension Methods

Name Value Summary
Dump<DockerContainerRunSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<DockerContainerRunSettings>(DockerContainerRunSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<DockerContainerRunSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<DockerContainerRunSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<DockerContainerRunSettings>(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<DockerContainerRunSettings>(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