Help us shape the future of Go! Take the 2026 Go Developer Survey

confutil

package
v0.38.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 7, 2026 License: Apache-2.0 Imports: 18 Imported by: 6

Documentation

Index

Constants

View Source
const (
	// DefaultBuildKitStateDir and DefaultBuildKitConfigDir are the location
	// where buildkitd inside the container stores its state. Some drivers
	// create a Linux container, so this should match the location for Linux,
	// as defined in: https://github.com/moby/buildkit/blob/v0.9.0/util/appdefaults/appdefaults_unix.go#L11-L15
	DefaultBuildKitStateDir  = "/var/lib/buildkit"
	DefaultBuildKitConfigDir = "/etc/buildkit"
)

Variables

This section is empty.

Functions

func IsExperimental added in v0.13.0

func IsExperimental() bool

IsExperimental checks if the experimental flag has been configured.

func LoadConfigFiles

func LoadConfigFiles(bkconfig string) (map[string][]byte, error)

LoadConfigFiles creates a temp directory with BuildKit config and registry certificates ready to be copied to a container.

func MetadataWarningsEnabled added in v0.16.0

func MetadataWarningsEnabled() bool

MetadataWarningsEnabled returns whether metadata warnings are enabled from BUILDX_METADATA_WARNINGS environment variable (default false)

Types

type Config added in v0.18.0

type Config struct {
	// contains filtered or unexported fields
}

func NewConfig added in v0.18.0

func NewConfig(dockerCli command.Cli, opts ...ConfigOption) *Config

func (*Config) AtomicWriteFile added in v0.18.0

func (c *Config) AtomicWriteFile(filename string, data []byte, perm os.FileMode) error

AtomicWriteFile writes data to a file within the config dir atomically

func (*Config) BuildKitConfigFile added in v0.18.0

func (c *Config) BuildKitConfigFile() (string, bool)

BuildKitConfigFile returns the default BuildKit configuration file path

func (*Config) Dir added in v0.18.0

func (c *Config) Dir() string

Dir will look for correct configuration store path; if `$BUILDX_CONFIG` is set - use it, otherwise use parent directory of Docker config file (i.e. `${DOCKER_CONFIG}/buildx`)

func (*Config) MkdirAll added in v0.18.0

func (c *Config) MkdirAll(dir string, perm os.FileMode) error

MkdirAll creates a directory and all necessary parents within the config dir.

func (*Config) TryNodeIdentifier added in v0.18.0

func (c *Config) TryNodeIdentifier() (out string)

type ConfigOption added in v0.18.0

type ConfigOption func(*configOptions)

func WithDir added in v0.18.0

func WithDir(dir string) ConfigOption

type MetadataProvenanceMode added in v0.14.0

type MetadataProvenanceMode string

MetadataProvenanceMode is the type for setting provenance in the metadata file

const (
	// MetadataProvenanceModeMin sets minimal provenance (default)
	MetadataProvenanceModeMin MetadataProvenanceMode = "min"
	// MetadataProvenanceModeMax sets full provenance
	MetadataProvenanceModeMax MetadataProvenanceMode = "max"
	// MetadataProvenanceModeDisabled doesn't set provenance
	MetadataProvenanceModeDisabled MetadataProvenanceMode = "disabled"
)

func MetadataProvenance added in v0.14.0

func MetadataProvenance() MetadataProvenanceMode

MetadataProvenance returns the metadata provenance mode from BUILDX_METADATA_PROVENANCE environment variable

func ParseMetadataProvenance added in v0.16.0

func ParseMetadataProvenance(inp string) MetadataProvenanceMode

ParseMetadataProvenance parses the metadata provenance mode from a string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL