DockerBuildXBuildSettings Class

Summary

Settings for docker buildx build.
Assembly
Cake.Docker.dll
Namespace
Cake.Docker
Base Types
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Docker/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["DockerBuildXBuildSettings"] class Type type-node

Syntax

public sealed class DockerBuildXBuildSettings : AutoToolSettings

Constructors

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 a custom host-to-IP mapping (format: "host:ip")
Allow string[]
Allow extra privileged entitlement (e.g., "network.host", "security.insecure")
BuildArg string[]
Set build-time variables
BuildContext string[]
Additional build contexts (e.g., name=path)
Builder string
Override the configured builder instance
CacheFrom string[]
External cache sources (e.g., "user/app:cache", "type=local,src=path/to/dir")
CacheTo string[]
Cache export destinations (e.g., "user/app:cache", "type=local,dest=path/to/dir")
CgroupParent string
Optional parent cgroup for the container
Compress Nullable<bool>
Compress the build context using gzip
CpuPeriod Nullable<long>
Limit the CPU CFS (Completely Fair Scheduler) period
CpuQuota Nullable<long>
Limit the CPU CFS (Completely Fair Scheduler) quota
CpusetCpus string
CPUs in which to allow execution (0-3, 0,1)
CpusetMems string
MEMs in which to allow execution (0-3, 0,1)
CpuShares Nullable<long>
CPU shares (relative weight)
DisableContentTrust Nullable<bool>
Skip image verification
File string
Name of the Dockerfile (default: "PATH/Dockerfile")
ForceRm Nullable<bool>
Always remove intermediate containers
Iidfile string
Write the image ID to the file
Isolation string
Container isolation technology
Label string[]
Set metadata for an image
Load bool
Shorthand for "--output=type=docker"
Memory string
Memory limit
MemorySwap string
Swap limit equal to memory plus swap: '-1' to enable unlimited swap
MetadataFile string
Write build result metadata to the file
Network string
Set the networking mode for the "RUN" instructions during build (default "default")
NoCache bool
Do not use cache when building the image
NoCacheFilter string[]
Do not cache specified stages
Output string[]
Output destination (format: "type=local,dest=path")
Platform string[]
Set target platform for build
Progress string
Set type of progress output ("auto", "plain", "tty"). Use plain to show container output (default "auto")
Pull bool
Always attempt to pull all referenced images
Push bool
Shorthand for "--output=type=registry"
Quiet bool
Suppress the build output and print image ID on success
Rm Nullable<bool>
Remove intermediate containers after a successful build
Secret string[]
Secret to expose to the build (format: "id=mysecret[,src=/local/secret]")
SecurityOpt string[]
Security options
ShmSize string
Size of "/dev/shm"
Squash Nullable<bool>
Squash newly built layers into a single new layer
Ssh string[]
SSH agent socket or keys to expose to the build (format: "default|<id>[=<socket>|<key>[,<key>]]")
Tag string[]
Name and optionally a tag (format: "name:tag")
Target string
Set the target build stage to build.
Ulimit string[]
Ulimit options (default [])

Methods

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

Extension Methods

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