http

Documentation

Overview

Package http implements the HTTP frontend.

Index

• Constants
• type Frontend
  • func NewFrontend(logger *zap.Logger, schematicFactory *schematic.Factory, ...) (*Frontend, error)
  • func (f *Frontend) Handler() http.Handler
• type Options
• type WizardParams
  • func WizardParamsFromRequest(r *http.Request) WizardParams
  • func (p WizardParams) URLValues() url.Values

Constants

const (
	TargetMetal = "metal"
	TargetCloud = "cloud"
	TargetSBC   = "sbc"
)

Target constants.

Types

type Frontend

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

Frontend is the HTTP frontend.

func NewFrontend

func NewFrontend(
	logger *zap.Logger,
	schematicFactory *schematic.Factory,
	assetBuilder *asset.Builder,
	artifactsManager *artifacts.Manager,
	secureBootService *secureboot.Service,
	opts Options,
) (*Frontend, error)

NewFrontend creates a new HTTP frontend.

func (*Frontend) Handler

func (f *Frontend) Handler() http.Handler

Handler returns the HTTP handler.

type Options

type Options struct {
	ExternalURL    *url.URL
	ExternalPXEURL *url.URL

	InstallerInternalRepository name.Repository
	InstallerExternalRepository name.Repository

	CacheSigningKey crypto.PrivateKey

	RemoteOptions []remote.Option
}

Options configures the HTTP frontend.

type WizardParams

type WizardParams struct {
	Target         string
	Version        string
	Arch           string
	Platform       string
	Board          string
	SecureBoot     string
	Extensions     []string
	Cmdline        string
	CmdlineSet     bool
	OverlayOptions string

	SelectedTarget         string
	SelectedVersion        string
	SelectedArch           string
	SelectedPlatform       string
	SelectedBoard          string
	SelectedSecureBoot     string
	SelectedExtensions     []string
	SelectedCmdline        string
	SelectedOverlayOptions string

	// Dynamically set fields.
	PlatformMeta metadata.Platform
	BoardMeta    metadata.SBC
}

WizardParams encapsulates the parameters of the wizard.

Some fields might be not set if we haven't reached that step yet.

func WizardParamsFromRequest

func WizardParamsFromRequest(r *http.Request) WizardParams

WizardParamsFromRequest extracts the wizard parameters from the request.

func (WizardParams) URLValues

func (p WizardParams) URLValues() url.Values

URLValues returns the URL values of the wizard parameters.