ipxe

Documentation

Overview

Package ipxe provides iPXE functionality.

Package ipxe provides iPXE functionality.

Index

• type BootFromDiskMethod
• type Handler
  • func NewHandler(imageFactoryClient ImageFactoryClient, state state.State, ...) (*Handler, error)
  • func (handler *Handler) ServeHTTP(w http.ResponseWriter, req *http.Request)
• type HandlerOptions
• type ImageFactoryClient

Types

type BootFromDiskMethod

type BootFromDiskMethod string

BootFromDiskMethod defines a way to boot from disk.

const (
	// BootIPXEExit is a method to boot from disk using iPXE script with `exit` command.
	BootIPXEExit BootFromDiskMethod = "ipxe-exit"

	// Boot404 is a method to boot from disk using HTTP 404 response to iPXE.
	Boot404 BootFromDiskMethod = "http-404"

	// BootSANDisk is a method to boot from disk using iPXE script with `sanboot` command.
	BootSANDisk BootFromDiskMethod = "ipxe-sanboot"
)

type Handler

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

Handler represents an iPXE handler.

func NewHandler

func NewHandler(imageFactoryClient ImageFactoryClient, state state.State, options HandlerOptions, logger *zap.Logger) (*Handler, error)

NewHandler creates a new iPXE server.

func (*Handler) ServeHTTP

func (handler *Handler) ServeHTTP(w http.ResponseWriter, req *http.Request)

ServeHTTP serves the iPXE request.

URL pattern: http://ip-of-this-provider:50042/ipxe?uuid=${uuid}&mac=${net${idx}/mac:hexhyp}&domain=${domain}&hostname=${hostname}&serial=${serial}&arch=${buildarch}

Implements http.Handler interface.

type HandlerOptions

type HandlerOptions struct {
	APIAdvertiseAddress string
	BootFromDiskMethod  string
	APIPort             int
	UseLocalBootAssets  bool
	AgentTestMode       bool
}

HandlerOptions represents the options for the iPXE handler.

type ImageFactoryClient

type ImageFactoryClient interface {
	SchematicIPXEURL(ctx context.Context, agentMode bool, talosVersion, arch string, extensions, extraKernelArgs []string) (string, error)
}

ImageFactoryClient represents an image factory client which ensures a schematic exists on image factory, and returns the PXE URL to it.