types

Documentation

Index

• Constants
• Variables
• type Config
• type Disk
  • func (n Disk) Validate() report.Report
• type File
• type FileMode
  • func (m FileMode) Validate() report.Report
• type Filesystem
• type FilesystemCreate
• type FilesystemFormat
  • func (f FilesystemFormat) Validate() report.Report
• type Group
• type MkfsOptions
• type Networkd
• type NetworkdUnit
• type NetworkdUnitName
  • func (n NetworkdUnitName) Validate() report.Report
• type Partition
• type PartitionDimension
• type PartitionLabel
  • func (n PartitionLabel) Validate() report.Report
• type PartitionTypeGUID
  • func (d PartitionTypeGUID) Validate() report.Report
• type Passwd
• type Path
  • func (d Path) Validate() report.Report
• type Raid
  • func (n Raid) Validate() report.Report
• type Storage
• type Systemd
• type SystemdUnit
• type SystemdUnitDropIn
• type SystemdUnitDropInName
  • func (n SystemdUnitDropInName) Validate() report.Report
• type SystemdUnitName
  • func (n SystemdUnitName) Validate() report.Report
• type User
• type UserCreate

Constants

const (
	Version = 1
)

Variables

var (
	MaxVersion = semver.Version{
		Major: Version,
	}
)

Types

type Config

type Config struct {
	Version  int      `json:"ignitionVersion"`
	Storage  Storage  `json:"storage,omitempty"`
	Systemd  Systemd  `json:"systemd,omitempty"`
	Networkd Networkd `json:"networkd,omitempty"`
	Passwd   Passwd   `json:"passwd,omitempty"`
}

type Disk

type Disk struct {
	Device     Path        `json:"device,omitempty"`
	WipeTable  bool        `json:"wipeTable,omitempty"`
	Partitions []Partition `json:"partitions,omitempty"`
}

func (Disk) Validate

func (n Disk) Validate() report.Report

type File

type File struct {
	Path     Path     `json:"path,omitempty"`
	Contents string   `json:"contents,omitempty"`
	Mode     FileMode `json:"mode,omitempty"`
	Uid      int      `json:"uid,omitempty"`
	Gid      int      `json:"gid,omitempty"`
}

type FileMode

type FileMode os.FileMode

func (FileMode) Validate

func (m FileMode) Validate() report.Report

type Filesystem

type Filesystem struct {
	Device Path              `json:"device,omitempty"`
	Format FilesystemFormat  `json:"format,omitempty"`
	Create *FilesystemCreate `json:"create,omitempty"`
	Files  []File            `json:"files,omitempty"`
}

type FilesystemCreate

type FilesystemCreate struct {
	Force   bool        `json:"force,omitempty"`
	Options MkfsOptions `json:"options,omitempty"`
}

type FilesystemFormat

type FilesystemFormat string

func (FilesystemFormat) Validate

func (f FilesystemFormat) Validate() report.Report

type Group

type Group struct {
	Name         string `json:"name,omitempty"`
	Gid          *uint  `json:"gid,omitempty"`
	PasswordHash string `json:"passwordHash,omitempty"`
	System       bool   `json:"system,omitempty"`
}

type MkfsOptions

type MkfsOptions []string

type Networkd

type Networkd struct {
	Units []NetworkdUnit `json:"units,omitempty"`
}

type NetworkdUnit

type NetworkdUnit struct {
	Name     NetworkdUnitName `json:"name,omitempty"`
	Contents string           `json:"contents,omitempty"`
}

type NetworkdUnitName

type NetworkdUnitName string

func (NetworkdUnitName) Validate

func (n NetworkdUnitName) Validate() report.Report

type Partition

type Partition struct {
	Label    PartitionLabel     `json:"label,omitempty"`
	Number   int                `json:"number"`
	Size     PartitionDimension `json:"size"`
	Start    PartitionDimension `json:"start"`
	TypeGUID PartitionTypeGUID  `json:"typeGuid,omitempty"`
}

type PartitionDimension

type PartitionDimension uint64

type PartitionLabel

type PartitionLabel string

func (PartitionLabel) Validate

func (n PartitionLabel) Validate() report.Report

type PartitionTypeGUID

type PartitionTypeGUID string

func (PartitionTypeGUID) Validate

func (d PartitionTypeGUID) Validate() report.Report

type Passwd

type Passwd struct {
	Users  []User  `json:"users,omitempty"`
	Groups []Group `json:"groups,omitempty"`
}

type Path

type Path string

func (Path) Validate

func (d Path) Validate() report.Report

type Raid

type Raid struct {
	Name    string `json:"name"`
	Level   string `json:"level"`
	Devices []Path `json:"devices,omitempty"`
	Spares  int    `json:"spares,omitempty"`
}

func (Raid) Validate

func (n Raid) Validate() report.Report

type Storage

type Storage struct {
	Disks       []Disk       `json:"disks,omitempty"`
	Arrays      []Raid       `json:"raid,omitempty"`
	Filesystems []Filesystem `json:"filesystems,omitempty"`
}

type Systemd

type Systemd struct {
	Units []SystemdUnit `json:"units,omitempty"`
}

type SystemdUnit

type SystemdUnit struct {
	Name     SystemdUnitName     `json:"name,omitempty"`
	Enable   bool                `json:"enable,omitempty"`
	Mask     bool                `json:"mask,omitempty"`
	Contents string              `json:"contents,omitempty"`
	DropIns  []SystemdUnitDropIn `json:"dropins,omitempty"`
}

type SystemdUnitDropIn

type SystemdUnitDropIn struct {
	Name     SystemdUnitDropInName `json:"name,omitempty"`
	Contents string                `json:"contents,omitempty"`
}

type SystemdUnitDropInName

type SystemdUnitDropInName string

func (SystemdUnitDropInName) Validate

func (n SystemdUnitDropInName) Validate() report.Report

type SystemdUnitName

type SystemdUnitName string

func (SystemdUnitName) Validate

func (n SystemdUnitName) Validate() report.Report

type User

type User struct {
	Name              string      `json:"name,omitempty"`
	PasswordHash      string      `json:"passwordHash,omitempty"`
	SSHAuthorizedKeys []string    `json:"sshAuthorizedKeys,omitempty"`
	Create            *UserCreate `json:"create,omitempty"`
}

type UserCreate

type UserCreate struct {
	Uid          *uint    `json:"uid,omitempty"`
	GECOS        string   `json:"gecos,omitempty"`
	Homedir      string   `json:"homeDir,omitempty"`
	NoCreateHome bool     `json:"noCreateHome,omitempty"`
	PrimaryGroup string   `json:"primaryGroup,omitempty"`
	Groups       []string `json:"groups,omitempty"`
	NoUserGroup  bool     `json:"noUserGroup,omitempty"`
	System       bool     `json:"system,omitempty"`
	NoLogInit    bool     `json:"noLogInit,omitempty"`
	Shell        string   `json:"shell,omitempty"`
}