config

Documentation

Index

• Constants
• func BuildTypes() []string
• type Args
• type Build
• type BuildFactory
  • func (f BuildFactory) Config(args Args) Build
• type Drop
• type DropFactory
  • func (f *DropFactory) Config() Drop
• type Filter
• type FilterFactory
  • func (f *FilterFactory) Config(args Args) Filter
• type Format
• type FormatFactory
  • func (f *FormatFactory) Config() Format
• type Mount
• type MountFactory
  • func (f *MountFactory) Config(args Args) Mount
• type Start
• type StartFactory
  • func (f *StartFactory) Config() Start
• type Stop
• type StopFactory
  • func (f *StopFactory) Config() Stop
• type Storage
• type StorageFactory
  • func (f *StorageFactory) Config() Storage
• type Tag
• type TagFactory
  • func (f *TagFactory) Config() Tag

Constants

const (
	// BuildTypeImage represents image build
	BuildTypeImage = "image"

	// BuildTypeMount represents mount build
	BuildTypeMount = "mount"

	// BuildTypeBoot represents boot build
	BuildTypeBoot = "boot"

	// BuildTypeVM represents vm build
	BuildTypeVM = "vm"
)

Functions

func BuildTypes

func BuildTypes() []string

BuildTypes returns valid build types

Types

type Args

type Args []string

Args is the list of positional CLI arguments passed to application

type Build

type Build struct {
	// SpecFiles is the list of specfiles to build
	SpecFiles []string

	// Names is the list of names for corresponding specfiles
	Names []string

	// Tags are used to tag the build
	Tags types.Tags

	// Rebuild forces rebuild of all parent images even if they exist
	Rebuild bool
}

Build stores configuration for build command

type BuildFactory

type BuildFactory struct {
	// Names is the list of names for corresponding specfiles
	Names []string

	// Tags are used to tag the build
	Tags []string

	// Rebuild forces rebuild of all parent images even if they exist
	Rebuild bool
}

BuildFactory collects data for build config

func (BuildFactory) Config

func (f BuildFactory) Config(args Args) Build

Config creates build config

type Drop

type Drop struct {
	// If no filter is provided it is required to set this flag to drop builds
	All bool

	// LibvirtAddr is the address libvirt listens on
	LibvirtAddr string
}

Drop stores configuration related to drop operation

type DropFactory

type DropFactory struct {
	// If no filter is provided it is required to set this flag to drop builds
	All bool

	// LibvirtAddr is the address libvirt listens on
	LibvirtAddr string
}

DropFactory collects data for drop config

func (*DropFactory) Config

func (f *DropFactory) Config() Drop

Config returns new drop config

type Filter

type Filter struct {
	// Untagged filters untagged builds only
	Untagged bool

	// Types is the list of build types to return
	Types []types.BuildType

	// BuildIDs is the list of builds to return
	BuildIDs []types.BuildID

	// BuildKeys is the list of build keys to return
	BuildKeys []types.BuildKey
}

Filter stores configuration of filtering criteria

type FilterFactory

type FilterFactory struct {
	// Untagged filters untagged builds only
	Untagged bool

	// Types is the list of build types to return
	Types []string
}

FilterFactory collects data for filter config

func (*FilterFactory) Config

func (f *FilterFactory) Config(args Args) Filter

Config returns new filter config

type Format

type Format struct {
	// Formatter is the name of formatter to use to convert list into string
	Formatter string
}

Format stores configuration specific to formatting

type FormatFactory

type FormatFactory struct {
	// Formatter is the name of formatter to use to convert list into string
	Formatter string
}

FormatFactory collects data for format config

func (*FormatFactory) Config

func (f *FormatFactory) Config() Format

Config returns new format config

type Mount

type Mount struct {
	// Type is the type of mount
	Type types.BuildType

	// Tags are the tags applied to mounts
	Tags types.Tags
}

Mount stores configuration for mount command

type MountFactory

type MountFactory struct {
	// Tags are the tags applied to mounts
	Tags []string

	// Boot means that the mount is created for booting host machine
	Boot bool
}

MountFactory collects data for mount config

func (*MountFactory) Config

func (f *MountFactory) Config(args Args) Mount

Config returns new mount config

type Start

type Start struct {
	// Tag is the tag applied to started VMs
	Tag types.Tag

	// XMLDir is a directory where VM definition is taken from if xml file is not provided explicitly
	XMLDir string

	// VolumeDir is a directory where vm-specific folder exists containing subfolders to be mounted as filesystems in the VM
	VolumeDir string

	// LibvirtAddr is the address libvirt listens on
	LibvirtAddr string
}

Start stores configuration for start command

type StartFactory

type StartFactory struct {
	// Tag is the tag applied to started VMs
	Tag string

	// XMLDir is a directory where VM definition is taken from if xml file is not provided explicitly
	XMLDir string

	// VolumeDir is a directory where vm-specific folder exists containing subfolders to be mounted as filesystems in the VM
	VolumeDir string

	// LibvirtAddr is the address libvirt listens on
	LibvirtAddr string
}

StartFactory collects data for start config

func (*StartFactory) Config

func (f *StartFactory) Config() Start

Config returns new start config

type Stop

type Stop struct {
	// If no filter is provided it is required to set this flag to stop builds
	All bool

	// LibvirtAddr is the address libvirt listens on
	LibvirtAddr string
}

Stop stores configuration for stop command

type StopFactory

type StopFactory struct {
	// If no filter is provided it is required to set this flag to stop builds
	All bool

	// LibvirtAddr is the address libvirt listens on
	LibvirtAddr string
}

StopFactory collects data for stop config

func (*StopFactory) Config

func (f *StopFactory) Config() Stop

Config returns new stop config

type Storage

type Storage struct {
	// Root is the root location for images
	Root string

	// Driver specifies storage driver to use
	Driver string
}

Storage stores configuration related to storage drivers

type StorageFactory

type StorageFactory struct {
	// Root is the root location for images
	Root string

	// Driver specifies storage driver to use
	Driver string
}

StorageFactory collects data for storage config

func (*StorageFactory) Config

func (f *StorageFactory) Config() Storage

Config returns new storage config

type Tag

type Tag struct {
	// If no filter is provided it is required to set this flag to tag builds
	All bool

	// Remove is the list of tags to remove
	Remove []types.Tag

	// Add is the list of tags to add
	Add []types.Tag
}

Tag stores configuration related to tag operation

type TagFactory

type TagFactory struct {
	// If no filter is provided it is required to set this flag to tag builds
	All bool

	// Remove is the list of tags to remove
	Remove []string

	// Add is the list of tags to add
	Add []string
}

TagFactory collects data for tag config

func (*TagFactory) Config

func (f *TagFactory) Config() Tag

Config returns new tag config