config

Documentation

Index

• Constants
• func DefaultConfigPath() (string, error)
• func DefaultVolumeKeysPath() (string, error)
• func FormatUndecodedKeys(undecodedKeys []toml.Key) string
• func MkdirAll(path string) error
• func PackHome() (string, error)
• func Write(cfg interface{}, path string) error
• type Config
  • func Read(path string) (Config, error)
  • func SetRunImageMirrors(cfg Config, image string, mirrors []string) Config
• type Registry
  • func DefaultRegistry() Registry
  • func GetRegistries(cfg Config) []Registry
  • func GetRegistry(cfg Config, registryName string) (Registry, error)
• type RunImage
• type TrustedBuilder
• type VolumeConfig
  • func ReadVolumeKeys(path string) (VolumeConfig, error)

Constants

const DefaultLifecycleImageRepo = "docker.io/buildpacksio/lifecycle"

const OfficialRegistryName = "official"

Functions

func DefaultConfigPath

func DefaultConfigPath() (string, error)

func DefaultVolumeKeysPath

func DefaultVolumeKeysPath() (string, error)

func FormatUndecodedKeys

func FormatUndecodedKeys(undecodedKeys []toml.Key) string

func MkdirAll

func MkdirAll(path string) error

func PackHome

func PackHome() (string, error)

func Write

func Write(cfg interface{}, path string) error

Types

type Config

type Config struct {
	// Deprecated: Use DefaultRegistryName instead. See https://github.com/buildpacks/pack/issues/747.
	DefaultRegistry     string            `toml:"default-registry-url,omitempty"`
	DefaultRegistryName string            `toml:"default-registry,omitempty"`
	DefaultBuilder      string            `toml:"default-builder-image,omitempty"`
	PullPolicy          string            `toml:"pull-policy,omitempty"`
	Experimental        bool              `toml:"experimental,omitempty"`
	RunImages           []RunImage        `toml:"run-images"`
	TrustedBuilders     []TrustedBuilder  `toml:"trusted-builders,omitempty"`
	Registries          []Registry        `toml:"registries,omitempty"`
	LifecycleImage      string            `toml:"lifecycle-image,omitempty"`
	RegistryMirrors     map[string]string `toml:"registry-mirrors,omitempty"`
	LayoutRepositoryDir string            `toml:"layout-repo-dir,omitempty"`
}

func Read

func Read(path string) (Config, error)

func SetRunImageMirrors

func SetRunImageMirrors(cfg Config, image string, mirrors []string) Config

type Registry

type Registry struct {
	Name string `toml:"name"`
	Type string `toml:"type"`
	URL  string `toml:"url"`
}

func DefaultRegistry

func DefaultRegistry() Registry

func GetRegistries

func GetRegistries(cfg Config) []Registry

func GetRegistry

func GetRegistry(cfg Config, registryName string) (Registry, error)

type RunImage

type RunImage struct {
	Image   string   `toml:"image"`
	Mirrors []string `toml:"mirrors"`
}

type TrustedBuilder

type TrustedBuilder struct {
	Name string `toml:"name"`
}

type VolumeConfig

type VolumeConfig struct {
	VolumeKeys map[string]string `toml:"volume-keys,omitempty"`
}

func ReadVolumeKeys

func ReadVolumeKeys(path string) (VolumeConfig, error)