builder

Documentation

Index

• Constants
• Variables
• func GetResolvingURLs(urls []string) ([]string, error)
• func Script(b Builder, c Config, kr kernelrelease.KernelRelease) (string, error)
• func Targets() []string
• type Build
  • func (b *Build) ClientForRegistry(registry string) *auth.Client
  • func (b *Build) GetBuilderImage() string
  • func (b *Build) HasOutputs() bool
  • func (b *Build) KernelReleaseFromBuildConfig() kernelrelease.KernelRelease
  • func (b *Build) LoadImages()
  • func (b *Build) ToConfig() Config
• type Builder
  • func Factory(target Type) (Builder, error)
• type Config
• type FileImagesLister
  • func NewFileImagesLister(filePath string, build *Build) (*FileImagesLister, error)
  • func (f *FileImagesLister) LoadImages() []Image
• type GCCVersionRequestor
• type Image
• type ImageKey
• type ImagesLister
• type ImagesMap
• type MinimumURLsBuilder
• type RepoImagesLister
  • func NewRepoImagesLister(repo string, build *Build) (*RepoImagesLister, error)
  • func (repo *RepoImagesLister) LoadImages() []Image
• type Type
  • func (t Type) String() string
• type YAMLImage
• type YAMLImagesList

Constants

const DriverDirectory = "/tmp/driver"

DriverDirectory is the directory the processor uses to store the driver.

const ModuleFileName = "module.ko"

ModuleFileName is the standard file name for the kernel module.

const ProbeFileName = "probe.o"

ProbeFileName is the standard file name for the eBPF probe.

Variables

var HeadersNotFoundErr = errors.New("kernel headers not found")

var ModuleFullPath = path.Join(DriverDirectory, ModuleFileName)

ModuleFullPath is the standard path for the kernel module. Builders must place the compiled module at this location.

var ProbeFullPath = path.Join(DriverDirectory, "bpf", ProbeFileName)

ProbeFullPath is the standard path for the eBPF probe. Builders must place the compiled probe at this location.

Functions

func GetResolvingURLs

func GetResolvingURLs(urls []string) ([]string, error)

func Script

func Script(b Builder, c Config, kr kernelrelease.KernelRelease) (string, error)

func Targets

func Targets() []string

Targets returns the list of all the supported targets.

Types

type Build

type Build struct {
	TargetType        Type
	KernelConfigData  string
	KernelRelease     string
	KernelVersion     string
	DriverVersion     string
	Architecture      string
	ModuleFilePath    string
	ProbeFilePath     string
	ModuleDriverName  string
	ModuleDeviceName  string
	BuilderImage      string
	BuilderRepos      []string
	ImagesListers     []ImagesLister
	KernelUrls        []string
	GCCVersion        string
	RepoOrg           string
	RepoName          string
	Images            ImagesMap
	RegistryName      string
	RegistryUser      string
	RegistryPassword  string
	RegistryPlainHTTP bool
}

Build contains the info about the on-going build.

func (*Build) ClientForRegistry

func (b *Build) ClientForRegistry(registry string) *auth.Client

func (*Build) GetBuilderImage

func (b *Build) GetBuilderImage() string

func (*Build) HasOutputs

func (b *Build) HasOutputs() bool

func (*Build) KernelReleaseFromBuildConfig

func (b *Build) KernelReleaseFromBuildConfig() kernelrelease.KernelRelease

func (*Build) LoadImages

func (b *Build) LoadImages()

func (*Build) ToConfig

func (b *Build) ToConfig() Config

type Builder

type Builder interface {
	Name() string
	TemplateScript() string
	URLs(kr kernelrelease.KernelRelease) ([]string, error)
	TemplateData(c Config, kr kernelrelease.KernelRelease, urls []string) interface{} // error return type is managed
}

Builder represents a builder capable of generating a script for a driverkit target.

func Factory

func Factory(target Type) (Builder, error)

Factory returns a builder for the given target.

type Config

type Config struct {
	DriverName      string
	DeviceName      string
	DownloadBaseURL string
	*Build
}

Config contains all the configurations needed to build the kernel module or the eBPF probe.

type FileImagesLister

type FileImagesLister struct {
	FilePath string
	Arch     string
	Tag      string
	Target   string
}

func NewFileImagesLister

func NewFileImagesLister(filePath string, build *Build) (*FileImagesLister, error)

func (*FileImagesLister) LoadImages

func (f *FileImagesLister) LoadImages() []Image

type GCCVersionRequestor

type GCCVersionRequestor interface {
	// GCCVersion returns the GCC version to be used.
	// If the returned value is empty, the default algorithm will be enforced.
	GCCVersion(kr kernelrelease.KernelRelease) semver.Version
}

type Image

type Image struct {
	Target     Type
	GCCVersion semver.Version // we expect images to internally link eg: gcc5 to gcc5.0.0
	Name       string
}

type ImageKey

type ImageKey string

type ImagesLister

type ImagesLister interface {
	LoadImages() []Image
}

type ImagesMap

type ImagesMap map[ImageKey]Image

type MinimumURLsBuilder

type MinimumURLsBuilder interface {
	MinimumURLs() int
}

MinimumURLsBuilder is an optional interface to specify minimum number of requested headers urls

type RepoImagesLister

type RepoImagesLister struct {
	*repository.Repository
}

func NewRepoImagesLister

func NewRepoImagesLister(repo string, build *Build) (*RepoImagesLister, error)

func (*RepoImagesLister) LoadImages

func (repo *RepoImagesLister) LoadImages() []Image

type Type

type Type string

Type is a type representing targets.

const TargetTypeAlinux Type = "alinux"

TargetTypeAlinux identifies the AliyunLinux 2 and 3 target.

const TargetTypeAlma Type = "almalinux"

TargetTypeAlma identifies the AlmaLinux target.

const TargetTypeAmazonLinux Type = "amazonlinux"

TargetTypeAmazonLinux identifies the AmazonLinux target.

const TargetTypeAmazonLinux2 Type = "amazonlinux2"

TargetTypeAmazonLinux2 identifies the AmazonLinux2 target.

const TargetTypeAmazonLinux2022 Type = "amazonlinux2022"

TargetTypeAmazonLinux2022 identifies the AmazonLinux2022 target.

const TargetTypeAmazonLinux2023 Type = "amazonlinux2023"

TargetTypeAmazonLinux2023 identifies the AmazonLinux2023 target.

const TargetTypeArchlinux Type = "arch"

TargetTypeArchlinux identifies the Archlinux target.

const TargetTypeBottlerocket Type = "bottlerocket"

TargetTypeBottlerocket identifies the Bottlerocket target.

const TargetTypeCentos Type = "centos"

TargetTypeCentos identifies the Centos target.

const TargetTypeDebian Type = "debian"

TargetTypeDebian identifies the Debian target.

const TargetTypeFedora Type = "fedora"

TargetTypeFedora identifies the Fedora target.

const TargetTypeFlatcar Type = "flatcar"

TargetTypeFlatcar identifies the Flatcar target.

const TargetTypeMinikube Type = "minikube"

TargetTypeMinikube identifies the Minikube target.

const TargetTypeOpenSUSE Type = "opensuse"

TargetTypeOpenSUSE identifies the OpenSUSE target.

const TargetTypePhoton Type = "photon"

TargetTypePhoton identifies the Photon target.

const TargetTypeRedhat Type = "redhat"

TargetTypeRedhat identifies the redhat target.

const TargetTypeRocky Type = "rocky"

TargetTypeRocky identifies the Rocky target.

const TargetTypeTalos Type = "talos"

TargetTypeTalos identifies the Talos target.

const TargetTypeUbuntu Type = "ubuntu"

TargetTypeUbuntu identifies the Ubuntu target.

const TargetTypeVanilla Type = "vanilla"

TargetTypeVanilla identifies the Vanilla target.

const TargetTypeoracle Type = "ol"

TargetTypeoracle identifies the oracle target ("ol" is the ID from /etc/os-release that Oracle uses)

func (Type) String

func (t Type) String() string

type YAMLImage

type YAMLImage struct {
	Target      string   `yaml:"target"`
	GCCVersions []string `yaml:"gcc_versions"` // we expect images to internally link eg: gcc5 to gcc5.0.0
	Name        string   `yaml:"name"`
	Arch        string   `yaml:"arch"`
	Tag         string   `yaml:"tag"`
}

type YAMLImagesList

type YAMLImagesList struct {
	Images []YAMLImage `yaml:"images"`
}