Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var CustomScript = `` /* 139-byte string literal not displayed */
CustomScript is the template for the custom script. It will either chain to a URL or execute an iPXE script.
var HookScript = `` /* 1665-byte string literal not displayed */
HookScript is the default iPXE script for loading Hook.
var StaticScript = `` /* 1997-byte string literal not displayed */
StaticScript is the iPXE script used when in the auto-proxy mode. It is built to be generic enough for all hardware to use.
Functions ¶
Types ¶
type Custom ¶
Custom holds either a URL to chain to or a script to execute. There is no validation of the script.
type Handler ¶
type Handler struct {
Logger logr.Logger
Backend handler.BackendReader
OSIEURL string
ExtraKernelParams []string
PublicSyslogFQDN string
TinkServerTLS bool
TinkServerInsecureTLS bool
TinkServerGRPCAddr string
IPXEScriptRetries int
IPXEScriptRetryDelay int
StaticIPXEEnabled bool
}
func (*Handler) HandlerFunc ¶
func (h *Handler) HandlerFunc() http.HandlerFunc
HandlerFunc returns a http.HandlerFunc that serves the ipxe script. It is expected that the request path is /<mac address>/auto.ipxe.
type Hook ¶
type Hook struct {
Arch string // example x86_64
Console string // example ttyS1,115200
DownloadURL string // example https://location:8080/to/kernel/and/initrd
ExtraKernelParams []string // example tink_worker_image=quay.io/tinkerbell/tink-worker:v0.8.0
Facility string
HWAddr string // example 3c:ec:ef:4c:4f:54
SyslogHost string
TinkerbellTLS bool
TinkerbellInsecureTLS bool
TinkGRPCAuthority string // example 192.168.2.111:42113
TraceID string
VLANID string // string number between 1-4095
WorkerID string // example 3c:ec:ef:4c:4f:54 or worker1
Retries int // number of retries to attempt when fetching kernel and initrd files
RetryDelay int // number of seconds to wait between retries
Kernel string // name of the kernel file
Initrd string // name of the initrd file
}
Hook holds the values used to generate the iPXE script that loads the Hook OS.
type OSIE ¶ added in v0.13.0
type OSIE struct {
// BaseURL is the URL where the OSIE parts are located.
BaseURL *url.URL
// Kernel is the name of the kernel file.
Kernel string
// Initrd is the name of the initrd file.
Initrd string
}
OSIE or OS Installation Environment is the data about where the OSIE parts are located.