types

Documentation

Index

• Variables
• type Architecture
  • func ParseArchitecture(s string) Architecture
  • func ParseArchitectures(in []string) []Architecture
  • func (a Architecture) Compatible(b Architecture) bool
  • func (a Architecture) String() string
  • func (a Architecture) ToAPK() string
  • func (a Architecture) ToOCIPlatform() *v1.Platform
  • func (a Architecture) ToQEmu() string
• type Group
• type ImageConfiguration
  • func (ic *ImageConfiguration) Load(imageConfigPath string) error
  • func (ic *ImageConfiguration) Summarize(logger *log.Logger)
  • func (ic *ImageConfiguration) Validate() error
  • func (ic *ImageConfiguration) ValidateServiceBundle() error
• type User

Variables

var AllArchs = []Architecture{
	_386,
	amd64,
	arm64,
	armv6,
	armv7,
	ppc64le,
	riscv64,
	s390x,
}

AllArchs contains the standard set of supported architectures, which are used by `apko publish` when no architectures are specified.

Types

type Architecture

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

Architecture represents a CPU architecture for the container image.

func ParseArchitecture

func ParseArchitecture(s string) Architecture

ParseArchitecture parses a single architecture in string form, and returns the equivalent Architecture value.

Any apk-style arch string (e.g., "x86_64") is converted to the OCI-style equivalent ("amd64").

func ParseArchitectures

func ParseArchitectures(in []string) []Architecture

ParseArchitectures parses architecture values in string form, and returns the equivalent slice of Architectures.

apk-style arch strings (e.g., "x86_64") are converted to the OCI-style equivalent ("amd64"). Values are deduped, and the resulting slice is sorted for reproducibility.

func (Architecture) Compatible

func (a Architecture) Compatible(b Architecture) bool

func (Architecture) String

func (a Architecture) String() string

func (Architecture) ToAPK

func (a Architecture) ToAPK() string

ToAPK returns the apk-style equivalent string for the Architecture.

func (Architecture) ToOCIPlatform

func (a Architecture) ToOCIPlatform() *v1.Platform

func (Architecture) ToQEmu

func (a Architecture) ToQEmu() string

type Group

type Group struct {
	GroupName string
	GID       uint32
	Members   []string
}

type ImageConfiguration

type ImageConfiguration struct {
	Contents struct {
		Repositories []string
		Keyring      []string
		Packages     []string
	}
	Entrypoint struct {
		Type    string
		Command string

		// TBD: presently a map of service names and the command to run
		Services map[interface{}]interface{}
	}
	Accounts struct {
		RunAs  string `yaml:"run-as"`
		Users  []User
		Groups []Group
	}
	Archs       []Architecture
	Environment map[string]string
}

func (*ImageConfiguration) Load

func (ic *ImageConfiguration) Load(imageConfigPath string) error

Loads an image configuration given a configuration file path.

func (*ImageConfiguration) Summarize

func (ic *ImageConfiguration) Summarize(logger *log.Logger)

func (*ImageConfiguration) Validate

func (ic *ImageConfiguration) Validate() error

Do preflight checks and mutations on an image configuration.

func (*ImageConfiguration) ValidateServiceBundle

func (ic *ImageConfiguration) ValidateServiceBundle() error

Do preflight checks and mutations on an image configured to manage a service bundle.

type User

type User struct {
	UserName string
	UID      uint32
	GID      uint32
}