Documentation
¶
Overview ¶
Package bbcos provides a builder API for constructing Butane configs.
Index ¶
- Constants
- type Booter
- type Builder
- func (b *Builder) Validate() *Builder
- func (b *Builder) ValidateWithSpec(spec io.Reader) *Builder
- func (b *Builder) Variant(v string) *Builder
- func (b *Builder) Version(v string) *Builder
- func (b *Builder) WithBootDevice(f func(*Booter)) *Builder
- func (b *Builder) WithIgnition(f func(*Igniter)) *Builder
- func (b *Builder) WithKernelArgs(f func(*Kerneler)) *Builder
- func (b *Builder) WithPasswder(f func(*Passwder)) *Builder
- func (b *Builder) WithStorage(f func(*Storager)) *Builder
- func (b *Builder) WithSystemd(f func(*Systemder)) *Builder
- func (b *Builder) WriteTo(w io.Writer) (int64, error)
- type Igniter
- type Kerneler
- type Passwder
- type Storager
- type Systemder
- type User
Constants ¶
const ( STORAGE = "storage" IGNITION = "ignition" SYSTEMD = "systemd" PASSWD = "passwd" KERNEL_ARGS = "kernel_arguments" BOOT_DEVICE = "boot_device" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Builder ¶
type Builder struct {
// contains filtered or unexported fields
}
Builder provides a classic builder pattern for constructing Butane configs.
func (*Builder) Validate ¶
Validate is used to validate your configuration against a particaular spec matching the set variation and version fields.
func (*Builder) ValidateWithSpec ¶
ValidateWithSpec is used to validate your configuration against a provided spec.
The spec should be a JSON schema. For help formatting your spec, please reference the out-of-box supported specs in the spec folder.
func (*Builder) Version ¶
The semantic version of the spec used for validating the constructed config.
func (*Builder) WithBootDevice ¶
func (*Builder) WithIgnition ¶
WithIgnition
func (*Builder) WithKernelArgs ¶
func (*Builder) WithPasswder ¶
func (*Builder) WithSystemd ¶
type Igniter ¶
type Igniter struct {
// contains filtered or unexported fields
}
Igniter provides a classic builder pattern for providing metadata about the config itself.
type Kerneler ¶
type Kerneler struct {
// contains filtered or unexported fields
}
func NewKerneler ¶
type Passwder ¶
type Passwder struct {
// contains filtered or unexported fields
}
func NewPasswder ¶
type Storager ¶
type Storager struct {
// contains filtered or unexported fields
}
Storager provides a classic builder pattern for describing the desired state of the system’s storage devices.
type Systemder ¶
type Systemder struct {
// contains filtered or unexported fields
}
func NewSystemder ¶
type User ¶
type User struct {
// contains filtered or unexported fields
}
Source Files
Directories