ipxe

Documentation

Overview

Package ipxe aims to implement a trivial IPXE configuration handler.

Index

• Variables
• type Config
  • func NewConfig(configURL *url.URL) (*Config, error)
  • func NewConfigWithSchemes(configURL *url.URL, s pxe.Schemes) (*Config, error)

Variables

var (
	// ErrNotIpxeScript is returned when the config file is not an
	// ipxe script.
	ErrNotIpxeScript = errors.New("config file is not ipxe as it does not start with #!ipxe")
)

Types

type Config

type Config struct {
	BootImage *boot.LinuxImage
	// contains filtered or unexported fields
}

Config encapsulates a parsed ipxe configuration file.

We currently only support kernel and initrd commands.

func NewConfig

func NewConfig(configURL *url.URL) (*Config, error)

NewConfig returns a new IPXE configuration with the file at URL and default schemes.

See NewConfigWithSchemes for more details.

func NewConfigWithSchemes

func NewConfigWithSchemes(configURL *url.URL, s pxe.Schemes) (*Config, error)

NewConfigWithSchemes returns a new IPXE configuration with the file at URL and schemes `s`.

`s` is used to get files referred to by URLs in the configuration.