confutil

Documentation

Index

• Constants
• func ConfigDir(dockerCli command.Cli) string
• func DefaultConfigFile(dockerCli command.Cli) (string, bool)
• func IsExperimental() bool
• func LoadConfigFiles(bkconfig string) (map[string][]byte, error)
• func MetadataWarningsEnabled() bool
• func TryNodeIdentifier(configDir string) (out string)
• type MetadataProvenanceMode
  • func MetadataProvenance() MetadataProvenanceMode
  • func ParseMetadataProvenance(inp string) MetadataProvenanceMode

Constants

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"
)

Functions

func ConfigDir

func ConfigDir(dockerCli command.Cli) string

ConfigDir 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 DefaultConfigFile

func DefaultConfigFile(dockerCli command.Cli) (string, bool)

DefaultConfigFile returns the default BuildKit configuration file path

func IsExperimental

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

func MetadataWarningsEnabled() bool

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

func TryNodeIdentifier

func TryNodeIdentifier(configDir string) (out string)

Types

type MetadataProvenanceMode

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

func MetadataProvenance() MetadataProvenanceMode

MetadataProvenance returns the metadata provenance mode from BUILDX_METADATA_PROVENANCE environment variable

func ParseMetadataProvenance

func ParseMetadataProvenance(inp string) MetadataProvenanceMode

ParseMetadataProvenance parses the metadata provenance mode from a string