build
packageThis package is not in the latest version of its module.
Details
Valid go.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Index¶
Constants¶
This section is empty.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeBuilderVersion¶
type BuilderVersionstring
BuilderVersion sets the version of underlying builder to use
const (// BuilderV1 is the first generation builder in docker daemonBuilderV1BuilderVersion = "1"// BuilderBuildKit is builder based on moby/buildkit projectBuilderBuildKitBuilderVersion = "2")
typeCacheDiskUsagedeprecated
type CacheDiskUsage struct {TotalSizeint64Reclaimableint64Items []*CacheRecord}CacheDiskUsage contains disk usage for the build cache.
Deprecated: this type is no longer used and will be removed in the next release.
typeCachePruneOptions¶
type CachePruneOptions struct {AllboolReservedSpaceint64MaxUsedSpaceint64MinFreeSpaceint64Filtersfilters.ArgsKeepStorageint64// Deprecated: deprecated in API 1.48.}CachePruneOptions hold parameters to prune the build cache.
typeCachePruneReport¶
CachePruneReport contains the response for Engine API:POST "/build/prune"
typeCacheRecord¶
type CacheRecord struct {// ID is the unique ID of the build cache record.IDstring// Parent is the ID of the parent build cache record.//// Deprecated: deprecated in API v1.42 and up, as it was deprecated in BuildKit; use Parents instead.Parentstring `json:"Parent,omitempty"`// Parents is the list of parent build cache record IDs.Parents []string `json:" Parents,omitempty"`// Type is the cache record type.Typestring// Description is a description of the build-step that produced the build cache.Descriptionstring// InUse indicates if the build cache is in use.InUsebool// Shared indicates if the build cache is shared.Sharedbool// Size is the amount of disk space used by the build cache (in bytes).Sizeint64// CreatedAt is the date and time at which the build cache was created.CreatedAttime.Time// LastUsedAt is the date and time at which the build cache was last used.LastUsedAt *time.TimeUsageCountint}CacheRecord contains information about a build cache record.
typeImageBuildOptions¶
type ImageBuildOptions struct {Tags []stringSuppressOutputboolRemoteContextstringNoCacheboolRemoveboolForceRemoveboolPullParentboolIsolationcontainer.IsolationCPUSetCPUsstringCPUSetMemsstringCPUSharesint64CPUQuotaint64CPUPeriodint64Memoryint64MemorySwapint64CgroupParentstringNetworkModestringShmSizeint64DockerfilestringUlimits []*container.Ulimit// BuildArgs needs to be a *string instead of just a string so that// we can tell the difference between "" (empty string) and no value// at all (nil). See the parsing of buildArgs in// api/server/router/build/build_routes.go for even more info.BuildArgs map[string]*stringAuthConfigs map[string]registry.AuthConfigContextio.ReaderLabels map[string]string// squash the resulting image's layers to the parent// preserves the original image and creates a new one from the parent with all// the changes applied to a single layerSquashbool// CacheFrom specifies images that are used for matching cache. Images// specified here do not need to have a valid parent chain to match cache.CacheFrom []stringSecurityOpt []stringExtraHosts []string// List of extra hostsTargetstringSessionIDstringPlatformstring// Version specifies the version of the underlying builder to useVersionBuilderVersion// BuildID is an optional identifier that can be passed together with the// build request. The same identifier can be used to gracefully cancel the// build with the cancel request.BuildIDstring// Outputs defines configurations for exporting build results. Only supported// in BuildKit modeOutputs []ImageBuildOutput}ImageBuildOptions holds the informationnecessary to build images.
typeImageBuildOutput¶
ImageBuildOutput defines configuration for exporting a build result
typeImageBuildResponse¶
type ImageBuildResponse struct {Bodyio.ReadCloserOSTypestring}ImageBuildResponse holds informationreturned by a server after buildingan image.