common

Documentation

Index

• Variables
• type TranslateBytesOptions
• type TranslateOptions

Variables

var (
	// common field parsing
	ErrNoVariant      = errors.New("error parsing variant; must be specified")
	ErrInvalidVersion = errors.New("error parsing version; must be a valid semver")

	// high-level errors for fatal reports
	ErrInvalidSourceConfig    = errors.New("source config is invalid")
	ErrInvalidGeneratedConfig = errors.New("config generated was invalid")

	// deprecated variant/version
	ErrRhcosVariantDeprecated = errors.New("this variant is deprecated and will be removed in a future release; use openshift variant instead")

	// resources and trees
	ErrTooManyResourceSources = errors.New("only one of the following can be set: inline, local, source")
	ErrFilesDirEscape         = errors.New("local file path traverses outside the files directory")
	ErrFileType               = errors.New("trees may only contain files, directories, and symlinks")
	ErrNodeExists             = errors.New("matching filesystem node has existing contents or different type")
	ErrNoFilesDir             = errors.New("local file paths are relative to a files directory that must be specified with -d/--files-dir")
	ErrTreeNotDirectory       = errors.New("root of tree must be a directory")
	ErrTreeNoLocal            = errors.New("local is required")

	// filesystem nodes
	ErrDecimalMode = errors.New("unreasonable mode would be reasonable if specified in octal; remember to add a leading zero")

	// mount units
	ErrMountUnitNoPath   = errors.New("path is required if with_mount_unit is true and format is not swap")
	ErrMountUnitNoFormat = errors.New("format is required if with_mount_unit is true")

	// boot device
	ErrUnknownBootDeviceLayout = errors.New("layout must be one of: aarch64, ppc64le, x86_64")
	ErrTooFewMirrorDevices     = errors.New("mirroring requires at least two devices")

	// partition
	ErrWrongPartitionNumber = errors.New("incorrect partition number; a new partition will be created using reserved label")

	// MachineConfigs
	ErrFieldElided            = errors.New("field ignored in raw mode")
	ErrNameRequired           = errors.New("metadata.name is required")
	ErrRoleRequired           = errors.New("machineconfiguration.openshift.io/role label is required")
	ErrInvalidKernelType      = errors.New("must be empty, \"default\", or \"realtime\"")
	ErrBtrfsSupport           = errors.New("btrfs is not supported in this spec version")
	ErrFilesystemNoneSupport  = errors.New("format \"none\" is not supported in this spec version")
	ErrDirectorySupport       = errors.New("directories are not supported in this spec version")
	ErrFileSchemeSupport      = errors.New("file contents source must be data URL in this spec version")
	ErrFileAppendSupport      = errors.New("appending to files is not supported in this spec version")
	ErrFileCompressionSupport = errors.New("file compression is not supported in this spec version")
	ErrFileSpecialModeSupport = errors.New("special mode bits are not supported in this spec version")
	ErrLinkSupport            = errors.New("links are not supported in this spec version")
	ErrGroupSupport           = errors.New("groups are not supported in this spec version")
	ErrUserFieldSupport       = errors.New("fields other than \"name\" and \"ssh_authorized_keys\" are not supported in this spec version")
	ErrUserNameSupport        = errors.New("users other than \"core\" are not supported in this spec version")
	ErrKernelArgumentSupport  = errors.New("this field cannot be used for kernel arguments in this spec version; use openshift.kernel_arguments instead")

	// Storage
	ErrClevisSupport = errors.New("clevis is not supported in this spec version")

	// Extensions
	ErrExtensionNameRequired = errors.New("field \"name\" is required")

	// Grub
	ErrGrubUserNameNotSpecified = errors.New("field \"name\" is required")
	ErrGrubPasswordNotSpecified = errors.New("field \"password_hash\" is required")
)

Types

type TranslateBytesOptions

type TranslateBytesOptions struct {
	TranslateOptions
	Pretty bool
	Raw    bool // encode only the Ignition config, not any wrapper
}

type TranslateOptions

type TranslateOptions struct {
	FilesDir                  string // allow embedding local files relative to this directory
	NoResourceAutoCompression bool   // skip automatic compression of inline/local resources
	DebugPrintTranslations    bool   // report translations to stderr
}