Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

platform

package

Go to main page

Versions in this module

v0

v0.17.0

Apr 30, 2024

Changes in this version

type Disk

+ Wwn uint64

type QemuMachineOptions

+ Firmware string

+ Nvme bool

v0.16.0

Nov 9, 2023

Changes in this version

+ var ErrInitramfsEmergency = errors.New("entered emergency.target in initramfs")

+ func CheckMachine(ctx context.Context, m Machine) error

+ func CopyDirToMachine(inputdir string, m Machine, destdir string) error

+ func GenerateFakeKey() (string, error)

+ func GetMachineBootId(m Machine) (string, error)

+ func InstallFile(in io.Reader, m Machine, to string) error

+ func Manhole(m Machine) (err error)

+ func ReadFile(m Machine, path string) (io.ReadCloser, error)

+ func RebootMachine(m Machine, j *Journal) error

+ func StartMachine(m Machine, j *Journal) error

+ func StartMachineAfterReboot(m Machine, j *Journal, oldBootId string) error

+ func StartReboot(m Machine) error

+ func TransferFile(src Machine, srcPath string, dst Machine, dstPath string) error

+ func WaitForMachineReboot(m Machine, j *Journal, timeout time.Duration, oldBootId string) error

+ func WriteJSONInfo(m Machine, w io.Writer) error

+ type BaseCluster struct

+ func NewBaseCluster(bf *BaseFlight, rconf *RuntimeConfig) (*BaseCluster, error)

+ func (bc *BaseCluster) AddMach(m Machine)

+ func (bc *BaseCluster) AllocateMachineSerial() uint

+ func (bc *BaseCluster) ConsoleOutput() map[string]string

+ func (bc *BaseCluster) DelMach(m Machine)

+ func (bc *BaseCluster) Destroy()

+ func (bc *BaseCluster) Distribution() string

+ func (bc *BaseCluster) EarlyRelease()

+ func (bc *BaseCluster) JournalOutput() map[string]string

+ func (bc *BaseCluster) Keys() ([]*agent.Key, error)

+ func (bc *BaseCluster) Machines() []Machine

+ func (bc *BaseCluster) Name() string

+ func (bc *BaseCluster) PasswordSSHClient(ip string, user string, password string) (*ssh.Client, error)

+ func (bc *BaseCluster) Platform() Name

+ func (bc *BaseCluster) RenderUserData(userdata *platformConf.UserData, ignitionVars map[string]string) (*platformConf.Conf, error)

+ func (bc *BaseCluster) RuntimeConf() RuntimeConfig

+ func (bc *BaseCluster) SSH(m Machine, cmd string) ([]byte, []byte, error)

+ func (bc *BaseCluster) SSHClient(ip string) (*ssh.Client, error)

+ func (bc *BaseCluster) SSHOnTestFailure() bool

+ func (bc *BaseCluster) UserSSHClient(ip, user string) (*ssh.Client, error)

+ type BaseFlight struct

+ func NewBaseFlight(opts *Options, platform Name) (*BaseFlight, error)

+ func NewBaseFlightWithDialer(opts *Options, platform Name, dialer network.Dialer) (*BaseFlight, error)

+ func (bf *BaseFlight) AddCluster(c Cluster)

+ func (bf *BaseFlight) Clusters() []Cluster

+ func (bf *BaseFlight) DelCluster(c Cluster)

+ func (bf *BaseFlight) Destroy()

+ func (bf *BaseFlight) Keys() ([]*agent.Key, error)

+ func (bf *BaseFlight) Name() string

+ func (bf *BaseFlight) Platform() Name

+ type Cluster interface

+ ConsoleOutput func() map[string]string

+ Destroy func()

+ Distribution func() string

+ JournalOutput func() map[string]string

+ Machines func() []Machine

+ Name func() string

+ NewMachine func(userdata *conf.UserData) (Machine, error)

+ NewMachineWithOptions func(userdata *conf.UserData, options MachineOptions) (Machine, error)

+ Platform func() Name

+ SSHOnTestFailure func() bool

+ type Disk struct

+ BackingFile string

+ BackingFormat string

+ Channel string

+ DeviceOpts []string

+ DriveOpts []string

+ MultiPathDisk bool

+ NbdDisk bool

+ SectorSize int

+ Size string

+ func ParseDisk(spec string) (*Disk, error)

+ type Flight interface

+ Clusters func() []Cluster

+ ConfigTooLarge func(ud conf.UserData) bool

+ Destroy func()

+ Name func() string

+ NewCluster func(rconf *RuntimeConfig) (Cluster, error)

+ Platform func() Name

+ type HostForwardPort struct

+ GuestPort int

+ HostPort int

+ Service string

+ type HostMount struct

+ type Install struct

+ Builder *QemuBuilder

+ CosaBuild *util.LocalBuild

+ Insecure bool

+ MultiPathDisk bool

+ Native4k bool

+ NmKeyfiles map[string]string

+ PxeAppendRootfs bool

+ func (inst *Install) InstallViaISOEmbed(kargs []string, liveIgnition, targetIgnition conf.Conf, outdir string, ...) (*InstalledMachine, error)

+ func (inst *Install) PXE(kargs []string, liveIgnition, ignition conf.Conf, offline bool) (*InstalledMachine, error)

+ type InstalledMachine struct

+ BootStartedErrorChannel chan error

+ QemuInst *QemuInstance

+ Tempdir string

+ func (inst *InstalledMachine) Destroy() error

+ type Journal struct

+ func NewJournal(dir string) (*Journal, error)

+ func (j *Journal) Destroy()

+ func (j *Journal) Read() ([]byte, error)

+ func (j *Journal) Start(ctx context.Context, m Machine, oldBootId string) error

+ type Machine interface

+ ConsoleOutput func() string

+ Destroy func()

+ ID func() string

+ IP func() string

+ IgnitionError func() error

+ JournalOutput func() string

+ PasswordSSHClient func(user string, password string) (*ssh.Client, error)

+ PrivateIP func() string

+ Reboot func() error

+ RuntimeConf func() RuntimeConfig

+ SSH func(cmd string) ([]byte, []byte, error)

+ SSHClient func() (*ssh.Client, error)

+ Start func() error

+ WaitForReboot func(time.Duration, string) error

+ func NewMachines(c Cluster, userdata *conf.UserData, n int, options MachineOptions) ([]Machine, error)

+ type MachineOptions struct

+ AdditionalDisks []string

+ AdditionalNics int

+ AppendFirstbootKernelArgs string

+ AppendKernelArgs string

+ MinDiskSize int

+ MinMemory int

+ MultiPathDisk bool

+ SkipStartMachine bool

+ type Name string

+ type Options struct

+ AppendButane string

+ AppendIgnition string

+ BaseName string

+ CosaBuildArch string

+ CosaBuildId string

+ CosaWorkdir string

+ Distribution string

+ ExtendTimeoutPercent uint

+ OSContainer string

+ SSHOnTestFailure bool

+ Stream string

+ SystemdDropins []SystemdDropin

+ UseWarnExitCode77 bool

+ type QEMUMachine interface

+ RemovePrimaryBlockDevice func() error

+ type QOMBlkDev struct

+ Return []struct{ ... }

+ type QOMDev struct

+ Return []struct{ ... }

+ type QemuBuilder struct

+ AppendFirstbootKernelArgs string

+ AppendKernelArgs string

+ Argv []string

+ ConfigFile string

+ ConsoleFile string

+ Firmware string

+ ForceConfigInjection bool

+ Hostname string

+ InheritConsole bool

+ MemoryMiB int

+ Pdeathsig bool

+ Processors int

+ RestrictNetworking bool

+ Swtpm bool

+ UUID string

+ UsermodeNetworking bool

+ func NewMetalQemuBuilderDefault() *QemuBuilder

+ func NewQemuBuilder() *QemuBuilder

+ func (builder *QemuBuilder) AddAdditionalNics(additionalNics int)

+ func (builder *QemuBuilder) AddBootDisk(disk *Disk) error

+ func (builder *QemuBuilder) AddDisk(disk *Disk) error

+ func (builder *QemuBuilder) AddDisksFromSpecs(specs []string) error

+ func (builder *QemuBuilder) AddFd(fd *os.File) string

+ func (builder *QemuBuilder) AddIso(path string, bootindexStr string, asDisk bool) error

+ func (builder *QemuBuilder) AddPrimaryDisk(disk *Disk) error

+ func (builder *QemuBuilder) Append(args ...string)

+ func (builder *QemuBuilder) Close()

+ func (builder *QemuBuilder) EnableUsermodeNetworking(h []HostForwardPort, usernetAddr string)

+ func (builder *QemuBuilder) Exec() (*QemuInstance, error)

+ func (builder *QemuBuilder) MountHost(source, dest string, readonly bool)

+ func (builder *QemuBuilder) SerialPipe() (*os.File, error)

+ func (builder *QemuBuilder) SetArchitecture(arch string) error

+ func (builder *QemuBuilder) SetConfig(config *conf.Conf)

+ func (builder *QemuBuilder) SetNetbootP(filename, dir string)

+ func (builder *QemuBuilder) SetSecureExecution(gpgkey string, hostkey string, config *conf.Conf) error

+ func (builder *QemuBuilder) TempFile(pattern string) (*os.File, error)

+ func (builder *QemuBuilder) VirtioChannelRead(name string) (*os.File, error)

+ func (builder *QemuBuilder) VirtioJournal(config *conf.Conf, queryArguments string) (*os.File, error)

+ type QemuInstance struct

+ func (inst *QemuInstance) Destroy()

+ func (inst *QemuInstance) Kill() error

+ func (inst *QemuInstance) Pid() int

+ func (inst *QemuInstance) RemovePrimaryBlockDevice() (err2 error)

+ func (inst *QemuInstance) SSHAddress() (string, error)

+ func (inst *QemuInstance) Signaled() bool

+ func (inst *QemuInstance) SwitchBootOrder() (err2 error)

+ func (inst *QemuInstance) Wait() error

+ func (inst *QemuInstance) WaitAll(ctx context.Context) error

+ func (inst *QemuInstance) WaitIgnitionError(ctx context.Context) (string, error)

+ type QemuMachineOptions struct

+ DisablePDeathSig bool

+ HostForwardPorts []HostForwardPort

+ OverrideBackingFile string

+ type RuntimeConfig struct

+ AllowFailedUnits bool

+ EarlyRelease func()

+ InternetAccess bool

+ NoInstanceCreds bool

+ NoSSHKeyInMetadata bool

+ NoSSHKeyInUserData bool

+ OutputDir string

+ SSHOnTestFailure bool

+ WarningsAction conf.WarningsAction

+ type SystemdDropin struct

+ Contents string

+ Name string

+ Unit string