Documentation
¶
Index ¶
- Variables
- type Compression
- type Config
- type ConfigReference
- type Disk
- type File
- type FileContents
- type FileGroup
- type FileMode
- type FileUser
- type Filesystem
- type FilesystemCreate
- type FilesystemFormat
- type FilesystemMount
- type Group
- type Hash
- type Ignition
- type IgnitionConfig
- type IgnitionVersion
- type MkfsOptions
- type Networkd
- type NetworkdUnit
- type NetworkdUnitName
- type Partition
- type PartitionDimension
- type PartitionLabel
- type PartitionTypeGUID
- type Passwd
- type Path
- type Raid
- type Storage
- type Systemd
- type SystemdUnit
- type SystemdUnitDropIn
- type SystemdUnitDropInName
- type SystemdUnitName
- type Url
- type User
- type UserCreate
- type Verification
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrFilesystemInvalidFormat = errors.New("invalid filesystem format") ErrFilesystemNoMountPath = errors.New("filesystem is missing mount or path") ErrFilesystemMountAndPath = errors.New("filesystem has both mount and path defined") )
View Source
var ( ErrHashMalformed = errors.New("malformed hash specifier") ErrHashWrongSize = errors.New("incorrect size for hash sum") ErrHashUnrecognized = errors.New("unrecognized hash function") )
View Source
var ( ErrOldVersion = errors.New("incorrect config version (too old)") ErrNewVersion = errors.New("incorrect config version (too new)") )
View Source
var (
ErrCompressionInvalid = errors.New("invalid compression method")
)
View Source
var (
ErrFileIllegalMode = errors.New("illegal file mode")
)
View Source
var (
ErrPathRelative = errors.New("path not absolute")
)
View Source
var (
MaxVersion = semver.Version{
Major: 2,
Minor: 0,
}
)
Functions ¶
This section is empty.
Types ¶
type Compression ¶
type Compression string
func (*Compression) UnmarshalJSON ¶
func (c *Compression) UnmarshalJSON(data []byte) error
func (*Compression) UnmarshalYAML ¶
func (c *Compression) UnmarshalYAML(unmarshal func(interface{}) error) error
type Config ¶
type Config struct {
Ignition Ignition `json:"ignition" yaml:"ignition"`
Storage Storage `json:"storage,omitempty" yaml:"storage"`
Systemd Systemd `json:"systemd,omitempty" yaml:"systemd"`
Networkd Networkd `json:"networkd,omitempty" yaml:"networkd"`
Passwd Passwd `json:"passwd,omitempty" yaml:"passwd"`
}
type ConfigReference ¶
type ConfigReference struct {
Source Url `json:"source,omitempty" yaml:"source"`
Verification Verification `json:"verification,omitempty" yaml:"verification"`
}
type Disk ¶
type Disk struct {
Device Path `json:"device,omitempty" yaml:"device"`
WipeTable bool `json:"wipeTable,omitempty" yaml:"wipe_table"`
Partitions []Partition `json:"partitions,omitempty" yaml:"partitions"`
}
func (*Disk) UnmarshalJSON ¶
func (*Disk) UnmarshalYAML ¶
type File ¶
type File struct {
Filesystem string `json:"filesystem,omitempty" yaml:"filesystem"`
Path Path `json:"path,omitempty" yaml:"path"`
Contents FileContents `json:"contents,omitempty" yaml:"contents"`
Mode FileMode `json:"mode,omitempty" yaml:"mode"`
User FileUser `json:"user,omitempty" yaml:"uid"`
Group FileGroup `json:"group,omitempty" yaml:"gid"`
}
type FileContents ¶
type FileContents struct {
Compression Compression `json:"compression,omitempty" yaml:"compression"`
Source Url `json:"source,omitempty" yaml:"source"`
Verification Verification `json:"verification,omitempty" yaml:"verification"`
}
type Filesystem ¶
type Filesystem struct {
Name string `json:"name,omitempty" yaml:"name"`
Mount *FilesystemMount `json:"mount,omitempty" yaml:"mount"`
Path Path `json:"path,omitempty" yaml:"path"`
}
func (*Filesystem) UnmarshalJSON ¶
func (f *Filesystem) UnmarshalJSON(data []byte) error
func (*Filesystem) UnmarshalYAML ¶
func (f *Filesystem) UnmarshalYAML(unmarshal func(interface{}) error) error
type FilesystemCreate ¶
type FilesystemCreate struct {
Force bool `json:"force,omitempty" yaml:"force"`
Options MkfsOptions `json:"options,omitempty" yaml:"options"`
}
type FilesystemFormat ¶
type FilesystemFormat string
func (*FilesystemFormat) UnmarshalJSON ¶
func (f *FilesystemFormat) UnmarshalJSON(data []byte) error
func (*FilesystemFormat) UnmarshalYAML ¶
func (f *FilesystemFormat) UnmarshalYAML(unmarshal func(interface{}) error) error
type FilesystemMount ¶
type FilesystemMount struct {
Device Path `json:"device,omitempty" yaml:"device"`
Format FilesystemFormat `json:"format,omitempty" yaml:"format"`
Create *FilesystemCreate `json:"create,omitempty" yaml:"create"`
}
func (*FilesystemMount) UnmarshalJSON ¶
func (f *FilesystemMount) UnmarshalJSON(data []byte) error
func (*FilesystemMount) UnmarshalYAML ¶
func (f *FilesystemMount) UnmarshalYAML(unmarshal func(interface{}) error) error
type Ignition ¶
type Ignition struct {
Version IgnitionVersion `json:"version,omitempty" yaml:"version" merge:"old"`
Config IgnitionConfig `json:"config,omitempty" yaml:"config" merge:"new"`
}
type IgnitionConfig ¶
type IgnitionConfig struct {
Append []ConfigReference `json:"append,omitempty" yaml:"append"`
Replace *ConfigReference `json:"replace,omitempty" yaml:"replace"`
}
type IgnitionVersion ¶
func (IgnitionVersion) AssertValid ¶
func (v IgnitionVersion) AssertValid() error
func (IgnitionVersion) MarshalJSON ¶
func (v IgnitionVersion) MarshalJSON() ([]byte, error)
func (*IgnitionVersion) UnmarshalJSON ¶
func (v *IgnitionVersion) UnmarshalJSON(data []byte) error
func (*IgnitionVersion) UnmarshalYAML ¶
func (v *IgnitionVersion) UnmarshalYAML(unmarshal func(interface{}) error) error
type MkfsOptions ¶
type MkfsOptions []string
func (*MkfsOptions) UnmarshalJSON ¶
func (o *MkfsOptions) UnmarshalJSON(data []byte) error
func (*MkfsOptions) UnmarshalYAML ¶
func (o *MkfsOptions) UnmarshalYAML(unmarshal func(interface{}) error) error
type Networkd ¶
type Networkd struct {
Units []NetworkdUnit `json:"units,omitempty" yaml:"units"`
}
type NetworkdUnit ¶
type NetworkdUnit struct {
Name NetworkdUnitName `json:"name,omitempty" yaml:"name"`
Contents string `json:"contents,omitempty" yaml:"contents"`
}
type NetworkdUnitName ¶
type NetworkdUnitName string
func (*NetworkdUnitName) UnmarshalJSON ¶
func (n *NetworkdUnitName) UnmarshalJSON(data []byte) error
func (*NetworkdUnitName) UnmarshalYAML ¶
func (n *NetworkdUnitName) UnmarshalYAML(unmarshal func(interface{}) error) error
type Partition ¶
type Partition struct {
Label PartitionLabel `json:"label,omitempty" yaml:"label"`
Number int `json:"number" yaml:"number"`
Size PartitionDimension `json:"size" yaml:"size"`
Start PartitionDimension `json:"start" yaml:"start"`
TypeGUID PartitionTypeGUID `json:"typeGuid,omitempty" yaml:"type_guid"`
}
type PartitionDimension ¶
type PartitionDimension uint64
func (*PartitionDimension) UnmarshalJSON ¶
func (n *PartitionDimension) UnmarshalJSON(data []byte) error
func (*PartitionDimension) UnmarshalYAML ¶
func (n *PartitionDimension) UnmarshalYAML(unmarshal func(interface{}) error) error
type PartitionLabel ¶
type PartitionLabel string
func (*PartitionLabel) UnmarshalJSON ¶
func (n *PartitionLabel) UnmarshalJSON(data []byte) error
func (*PartitionLabel) UnmarshalYAML ¶
func (n *PartitionLabel) UnmarshalYAML(unmarshal func(interface{}) error) error
type PartitionTypeGUID ¶
type PartitionTypeGUID string
func (*PartitionTypeGUID) UnmarshalJSON ¶
func (d *PartitionTypeGUID) UnmarshalJSON(data []byte) error
func (*PartitionTypeGUID) UnmarshalYAML ¶
func (d *PartitionTypeGUID) UnmarshalYAML(unmarshal func(interface{}) error) error
type Path ¶
type Path string
func (Path) MarshalJSON ¶
func (*Path) UnmarshalJSON ¶
func (*Path) UnmarshalYAML ¶
type Raid ¶
type Raid struct {
Name string `json:"name" yaml:"name"`
Level string `json:"level" yaml:"level"`
Devices []Path `json:"devices,omitempty" yaml:"devices"`
Spares int `json:"spares,omitempty" yaml:"spares"`
}
func (*Raid) UnmarshalJSON ¶
func (*Raid) UnmarshalYAML ¶
type Storage ¶
type Storage struct {
Disks []Disk `json:"disks,omitempty" yaml:"disks"`
Arrays []Raid `json:"raid,omitempty" yaml:"raid"`
Filesystems []Filesystem `json:"filesystems,omitempty" yaml:"filesystems"`
Files []File `json:"files,omitempty" yaml:"files"`
}
type Systemd ¶
type Systemd struct {
Units []SystemdUnit `json:"units,omitempty" yaml:"units"`
}
type SystemdUnit ¶
type SystemdUnit struct {
Name SystemdUnitName `json:"name,omitempty" yaml:"name"`
Enable bool `json:"enable,omitempty" yaml:"enable"`
Mask bool `json:"mask,omitempty" yaml:"mask"`
Contents string `json:"contents,omitempty" yaml:"contents"`
DropIns []SystemdUnitDropIn `json:"dropins,omitempty" yaml:"dropins"`
}
type SystemdUnitDropIn ¶
type SystemdUnitDropIn struct {
Name SystemdUnitDropInName `json:"name,omitempty" yaml:"name"`
Contents string `json:"contents,omitempty" yaml:"contents"`
}
type SystemdUnitDropInName ¶
type SystemdUnitDropInName string
func (*SystemdUnitDropInName) UnmarshalJSON ¶
func (n *SystemdUnitDropInName) UnmarshalJSON(data []byte) error
func (*SystemdUnitDropInName) UnmarshalYAML ¶
func (n *SystemdUnitDropInName) UnmarshalYAML(unmarshal func(interface{}) error) error
type SystemdUnitName ¶
type SystemdUnitName string
func (*SystemdUnitName) UnmarshalJSON ¶
func (n *SystemdUnitName) UnmarshalJSON(data []byte) error
func (*SystemdUnitName) UnmarshalYAML ¶
func (n *SystemdUnitName) UnmarshalYAML(unmarshal func(interface{}) error) error
type User ¶
type User struct {
Name string `json:"name,omitempty" yaml:"name"`
PasswordHash string `json:"passwordHash,omitempty" yaml:"password_hash"`
SSHAuthorizedKeys []string `json:"sshAuthorizedKeys,omitempty" yaml:"ssh_authorized_keys"`
Create *UserCreate `json:"create,omitempty" yaml:"create"`
}
type UserCreate ¶
type UserCreate struct {
Uid *uint `json:"uid,omitempty" yaml:"uid"`
GECOS string `json:"gecos,omitempty" yaml:"gecos"`
Homedir string `json:"homeDir,omitempty" yaml:"home_dir"`
NoCreateHome bool `json:"noCreateHome,omitempty" yaml:"no_create_home"`
PrimaryGroup string `json:"primaryGroup,omitempty" yaml:"primary_group"`
Groups []string `json:"groups,omitempty" yaml:"groups"`
NoUserGroup bool `json:"noUserGroup,omitempty" yaml:"no_user_group"`
System bool `json:"system,omitempty" yaml:"system"`
NoLogInit bool `json:"noLogInit,omitempty" yaml:"no_log_init"`
Shell string `json:"shell,omitempty" yaml:"shell"`
}
type Verification ¶
type Verification struct {
Hash *Hash `json:"hash,omitempty" yaml:"hash"`
}
Click to show internal directories.
Click to hide internal directories.