ibiconfig

Documentation

Index

• Constants
• type IBIPrepareConfig
  • func (c *IBIPrepareConfig) SetDefaultValues()
  • func (c *IBIPrepareConfig) Validate() error
• type ImageBasedInstallConfig
  • func (i *ImageBasedInstallConfig) SetDefaultValues()
  • func (i *ImageBasedInstallConfig) Validate() error
• type ImageDigestSource

Constants

const ImageBasedInstallConfigVersion = "v1beta1"

ImageBasedInstallConfigVersion is the version supported by this package.

Types

type IBIPrepareConfig

type IBIPrepareConfig struct {

	// SeedImage is the seed image to use for the installation.
	// This image will be used to prepare the installation disk.
	SeedImage string `json:"seedImage"`

	// SeedVersion is the version of the seed image.
	// Version will be validated against the seed image.
	SeedVersion string `json:"seedVersion"`

	// InstallationDisk is the disk to install the seed image.
	// Provide the device id like /dev/by-id/ata-xxxxx
	InstallationDisk string `json:"installationDisk"`

	// PrecacheBestEffort is a flag to enable best effort precaching.
	// +optional
	PrecacheBestEffort bool `json:"precacheBestEffort,omitempty"`

	// PrecacheDisabled is a flag to disable precaching.
	// +optional
	PrecacheDisabled bool `json:"precacheDisabled,omitempty"`

	// Shutdown is a flag to shutdown the host after installation.
	// Default is false
	// +optional
	Shutdown bool `json:"shutdown,omitempty"`

	// UseContainersFolder is a flag to use /var/lib/containers as a folder and not extra partition.
	// Default is false
	UseContainersFolder bool `json:"useContainersFolder,omitempty"`

	// ExtraPartitionStart Start of the /var/lib/containers partition. Free space before it will be allocated to system partition.
	// It can be one of the following:
	// - Positive number: partition will start at position 120Gb of the disk and extend to the end of the disk. Example: 120Gb
	// - Negative number: partition will be of that precise size. Example: -40Gb
	// Default is -40G (40GB before the end of the disk)
	// +optional
	ExtraPartitionStart string `json:"extraPartitionStart,omitempty"`

	// ExtraPartitionLabel label of extra partition used for /var/lib/containers.
	// Default is varlibcontainers
	// +optional
	ExtraPartitionLabel string `json:"extraPartitionLabel,omitempty"`

	// ExtraPartitionNumber number of extra partition used for /var/lib/containers.
	// Default is 5
	// +optional
	ExtraPartitionNumber uint `json:"extraPartitionNumber,omitempty"`

	// SkipDiskCleanup is a flag to skip disk cleanup before installation.
	// As part of installation we will try to format the disk this flag will skip that step.
	// Default is false
	SkipDiskCleanup bool `json:"skipDiskCleanup,omitempty"`

	// CoreosInstallerArgs additional arguments for coreos-install command that will be used while writing os to disk
	// Example: in order not to override earlier created installation disk partition, you can provide
	// coreosInstallerArgs:
	// - "--save-partindex"
	// - "6"
	// this will save previously created partition number 6
	// +optional
	CoreosInstallerArgs []string `json:"coreosInstallerArgs,omitempty"`
}

IBIPrepareConfig is the API for specifying configuration for lca cli.

func (*IBIPrepareConfig) SetDefaultValues

func (c *IBIPrepareConfig) SetDefaultValues()

func (*IBIPrepareConfig) Validate

func (c *IBIPrepareConfig) Validate() error

type ImageBasedInstallConfig

type ImageBasedInstallConfig struct {
	// Params that are used to configure the installation iso and will be moved to installer
	RHCOSLiveISO string `json:"rhcosLiveIso,omitempty"`

	// NMStateConfig contains nmstate configuration YAML file provided as string.
	// String will be written to file and will be applied with "nmstatectl apply" command.
	// Example of nmstate configurations can be found in this link https://nmstate.io/examples.html
	// +optional
	NMStateConfig string `json:"nmStateConfig,omitempty"`

	// PullSecret is the secret to use when pulling images. Equivalent to install-config.yaml's pullSecret.
	PullSecret string `json:"pullSecret,omitempty"`

	// Proxy is the proxy settings for the installation iso. Equivalent to
	// install-config.yaml's proxy. This will be set to the installation service
	// +optional
	Proxy *seedreconfig.Proxy `json:"proxy,omitempty"`

	// ImageDigestSources lists sources/repositories for the release-image content.
	// +optional
	ImageDigestSources []ImageDigestSource `json:"imageDigestSources,omitempty"`

	// PEM-encoded X.509 certificate bundle. Will be copied to /etc/pki/ca-trust/source/anchors/
	// in the installation iso
	// +optional
	AdditionalTrustBundle string `json:"additionalTrustBundle,omitempty"`

	// SSHKey is the public Secure Shell (SSH) key to provide access to
	// instances. Equivalent to install-config.yaml's sshKey. T
	// This key will be added to the host to allow ssh access while running with installation iso
	SSHKey string `json:"sshKey,omitempty"`

	// IgnitionConfigOverride JSON formatted string containing the user overrides for the initial ignition config.
	// This will be merged with the ignition config generated by the ibi-cli for installation iso.
	// Supported version is 3.2
	// +optional
	IgnitionConfigOverride string `json:"ignitionConfigOverride,omitempty"`

	// IBIPrepareConfig parameter that should be provided to lca cli installation service
	IBIPrepareConfig `json:",inline"`
}

ImageBasedInstallConfig is the API for specifying configuration for the image-based installation iso.

func (*ImageBasedInstallConfig) SetDefaultValues

func (i *ImageBasedInstallConfig) SetDefaultValues()

func (*ImageBasedInstallConfig) Validate

func (i *ImageBasedInstallConfig) Validate() error

type ImageDigestSource

type ImageDigestSource struct {
	// Source is the repository that users refer to, e.g. in image pull specifications.
	Source string `json:"source"`

	// Mirrors is one or more repositories that may also contain the same images.
	Mirrors []string `json:"mirrors,omitempty"`
}