DockerImageBuildSettings Class

Summary

Settings for docker build [OPTIONS] PATH | URL | -. Build an image from a Dockerfile
Assembly
Cake.Docker.dll
Namespace
Cake.Docker
Base Types
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Docker/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["DockerImageBuildSettings"] class Type type-node

Syntax

public sealed class DockerImageBuildSettings : AutoToolSettings

Constructors

Name Summary
DockerImageBuildSettings()

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)
BuildArg string[]
--build-arg Set build-time variables
CacheFrom string[]
--cache-from default: Images to consider as cache sources
CgroupParent string
--cgroup-parent Optional parent cgroup for the container
Compress Nullable<bool>
--compress default: false Compress the build context using gzip
CpuPeriod Nullable<long>
--cpu-period default: 0 Limit the CPU CFS (Completely Fair Scheduler) period
CpuQuota Nullable<long>
--cpu-quota default: 0 Limit the CPU CFS (Completely Fair Scheduler) quota
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)
DisableContentTrust Nullable<bool>
--disable-content-trust default: true Skip image verification
File string
--file, -f Name of the Dockerfile (Default is 'PATH/Dockerfile')
ForceRm Nullable<bool>
--force-rm default: false Always remove intermediate containers
Iidfile string
--iidfile Write the image ID to the file
Isolation string
--isolation Container isolation technology
Label string[]
--label Set metadata for an image
Memory string
--memory, -m Memory limit
MemorySwap string
--memory-swap Swap limit equal to memory plus swap: '-1' to enable unlimited swap
Network string
--network default: default Set the networking mode for the RUN instructions during build
NoCache Nullable<bool>
--no-cache default: false Do not use cache when building the image
Platform string
--platform Set platform if server is multi-platform capable
Progress string
Set type of progress output ("auto", "plain", "tty"). Use plain to show container output (default "auto")
Pull Nullable<bool>
--pull default: false Always attempt to pull a newer version of the image
Quiet Nullable<bool>
--quiet, -q default: false Suppress the build output and print image ID on success
Rm Nullable<bool>
--rm default: true Remove intermediate containers after a successful build
SecurityOpt string[]
--security-opt default: Security options
ShmSize string
--shm-size Size of /dev/shm
Squash Nullable<bool>
--squash default: false Squash newly built layers into a single new layer
Stream Nullable<bool>
--stream default: false Stream attaches to server to negotiate build context
Tag string[]
--tag, -t Name and optionally a tag in the 'name:tag' format
Target string
--target Set the target build stage to build.
Ulimit string[]
--ulimit Ulimit options

Methods

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

Extension Methods

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