types

Documentation

Index

• Constants
• type ApplianceConfig
• type Image
• type ImageRegistry
• type IncludeBundle
• type IncludeChannel
• type IncludeConfig
• type IncludePackage
• type Operator
• type ReleaseImage

Constants

const ApplianceConfigApiVersion = "v1beta1"

ApplianceConfigApiVersion is the version supported by this package.

Types

type ApplianceConfig

type ApplianceConfig struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	OcpRelease           ReleaseImage   `json:"ocpRelease"`
	DiskSizeGB           *int           `json:"diskSizeGb"`
	PullSecret           string         `json:"pullSecret"`
	SshKey               *string        `json:"sshKey"`
	UserCorePass         *string        `json:"userCorePass"`
	ImageRegistry        *ImageRegistry `json:"imageRegistry"`
	EnableDefaultSources *bool          `json:"enableDefaultSources"`
	StopLocalRegistry    *bool          `json:"stopLocalRegistry"`
	AdditionalImages     *[]Image       `json:"additionalImages,omitempty"`
	Operators            *[]Operator    `json:"operators,omitempty"`
}

type Image

type Image struct {
	// Name of the image. This should be an exact image pin (registry/namespace/name@sha256:<hash>)
	// but is not required to be.
	Name string `json:"name"`
}

Image contains image pull information.

type ImageRegistry

type ImageRegistry struct {
	URI  *string `json:"uri"`
	Port *int    `json:"port"`
}

type IncludeBundle

type IncludeBundle struct {
	// MinVersion to include, plus all versions in the upgrade graph to the MaxVersion.
	MinVersion string `json:"minVersion,omitempty" yaml:"minVersion,omitempty"`
	// MaxVersion to include as the channel head version.
	MaxVersion string `json:"maxVersion,omitempty" yaml:"maxVersion,omitempty"`
	// MinBundle to include, plus all bundles in the upgrade graph to the channel head.
	// Set this field only if the named bundle has no semantic version metadata.
	MinBundle string `json:"minBundle,omitempty" yaml:"minBundle,omitempty"`
}

IncludeBundle contains a name (required) and versions (optional) to include in the diff. The full package or channel is only included if no versions are specified.

type IncludeChannel

type IncludeChannel struct {
	// Name of channel.
	Name string `json:"name" yaml:"name"`

	IncludeBundle `json:",inline"`
}

IncludeChannel contains a name (required) and versions (optional) to include in the diff. The full channel is only included if no versions are specified.

type IncludeConfig

type IncludeConfig struct {
	// Packages to include.
	Packages []IncludePackage `json:"packages" yaml:"packages"`
}

IncludeConfig defines a list of packages for operator version selection.

type IncludePackage

type IncludePackage struct {
	// Name of package.
	Name string `json:"name" yaml:"name"`
	// Channels to include.
	Channels []IncludeChannel `json:"channels,omitempty" yaml:"channels,omitempty"`

	// All channels containing these bundles are parsed for an upgrade graph.
	IncludeBundle `json:",inline"`
}

IncludePackage contains a name (required) and channels and/or versions (optional) to include in the diff. The full package is only included if no channels or versions are specified.

type Operator

type Operator struct {
	// Mirror specific operator packages, channels, and versions, and their dependencies.
	// If HeadsOnly is true, these objects are mirrored on top of heads of all channels.
	// Otherwise, only these specific objects are mirrored.
	IncludeConfig `json:",inline"`

	// Catalog image to mirror. This image must be pullable and available for subsequent
	// pulls on later mirrors.
	// This image should be an exact image pin (registry/namespace/name@sha256:<hash>)
	// but is not required to be.
	Catalog string `json:"catalog"`
}

Operator defines the configuration for operator catalog mirroring.

type ReleaseImage

type ReleaseImage struct {
	Version         string                `json:"version"`
	Channel         *graph.ReleaseChannel `json:"channel"`
	CpuArchitecture *string               `json:"cpuArchitecture"`
	URL             *string               `json:"url"`
}