v1

package
v1.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 19, 2026 License: Apache-2.0 Imports: 6 Imported by: 4

Documentation

Overview

Package v1 contains API Schema definitions for the olm v1 API group +kubebuilder:object:generate=true +groupName=olm.operatorframework.io

Index

Constants

View Source
const (
	SourceTypeImage SourceType = "Image"

	MetadataNameLabel = "olm.operatorframework.io/metadata.name"

	AvailabilityModeAvailable   AvailabilityMode = "Available"
	AvailabilityModeUnavailable AvailabilityMode = "Unavailable"

	// Condition types
	TypeServing = "Serving"

	// Serving Reasons
	ReasonAvailable                = "Available"
	ReasonUnavailable              = "Unavailable"
	ReasonUserSpecifiedUnavailable = "UserSpecifiedUnavailable"
)
View Source
const (
	// The extension will only upgrade if the new version satisfies
	// the upgrade constraints set by the package author.
	UpgradeConstraintPolicyCatalogProvided UpgradeConstraintPolicy = "CatalogProvided"

	// Unsafe option which allows an extension to be
	// upgraded or downgraded to any available version of the package and
	// ignore the upgrade path designed by package authors.
	// This assumes that users independently verify the outcome of the changes.
	// Use with caution as this can lead to unknown and potentially
	// disastrous results such as data loss.
	UpgradeConstraintPolicySelfCertified UpgradeConstraintPolicy = "SelfCertified"

	ClusterExtensionConfigTypeInline ClusterExtensionConfigType = "Inline"
)
View Source
const (
	// TypeDeprecated is a rollup condition that is present when
	// any of the deprecated conditions are present.
	TypeDeprecated        = "Deprecated"
	TypePackageDeprecated = "PackageDeprecated"
	TypeChannelDeprecated = "ChannelDeprecated"
	TypeBundleDeprecated  = "BundleDeprecated"

	// None will not perform CRD upgrade safety checks.
	CRDUpgradeSafetyEnforcementNone CRDUpgradeSafetyEnforcement = "None"
	// Strict will enforce the CRD upgrade safety check and block the upgrade if the CRD would not pass the check.
	CRDUpgradeSafetyEnforcementStrict CRDUpgradeSafetyEnforcement = "Strict"
)
View Source
const (
	ClusterExtensionRevisionKind = "ClusterExtensionRevision"

	// Condition Types
	ClusterExtensionRevisionTypeAvailable   = "Available"
	ClusterExtensionRevisionTypeProgressing = "Progressing"
	ClusterExtensionRevisionTypeSucceeded   = "Succeeded"

	// Condition Reasons
	ClusterExtensionRevisionReasonArchived        = "Archived"
	ClusterExtensionRevisionReasonBlocked         = "Blocked"
	ClusterExtensionRevisionReasonProbeFailure    = "ProbeFailure"
	ClusterExtensionRevisionReasonProbesSucceeded = "ProbesSucceeded"
	ClusterExtensionRevisionReasonReconciling     = "Reconciling"
	ClusterExtensionRevisionReasonRetrying        = "Retrying"
)
View Source
const (
	TypeInstalled   = "Installed"
	TypeProgressing = "Progressing"

	// Installed reasons
	ReasonAbsent = "Absent"

	// Progressing reasons
	ReasonRollingOut           = "RollingOut"
	ReasonRetrying             = "Retrying"
	ReasonBlocked              = "Blocked"
	ReasonInvalidConfiguration = "InvalidConfiguration"

	// Deprecation reasons
	ReasonDeprecated               = "Deprecated"
	ReasonNotDeprecated            = "NotDeprecated"
	ReasonDeprecationStatusUnknown = "DeprecationStatusUnknown"

	// Common reasons
	ReasonSucceeded                = "Succeeded"
	ReasonFailed                   = "Failed"
	ReasonProgressDeadlineExceeded = "ProgressDeadlineExceeded"
)
View Source
const SourceTypeCatalog = "Catalog"

Variables

View Source
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "olm.operatorframework.io", Version: "v1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)
View Source
var ClusterExtensionKind = "ClusterExtension"

Functions

This section is empty.

Types

type AvailabilityMode added in v1.2.0

type AvailabilityMode string

AvailabilityMode defines the availability of the catalog

type BundleMetadata

type BundleMetadata struct {
	// name is required and follows the DNS subdomain standard as defined in [RFC 1123].
	// It must contain only lowercase alphanumeric characters, hyphens (-) or periods (.),
	// start and end with an alphanumeric character, and be no longer than 253 characters.
	//
	// +required
	// +kubebuilder:validation:XValidation:rule="self.matches(\"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$\")",message="packageName must be a valid DNS1123 subdomain. It must contain only lowercase alphanumeric characters, hyphens (-) or periods (.), start and end with an alphanumeric character, and be no longer than 253 characters"
	Name string `json:"name"`

	// version is required and references the version that this bundle represents.
	// It follows the semantic versioning standard as defined in https://semver.org/.
	//
	// +required
	// +kubebuilder:validation:XValidation:rule="self.matches(\"^([0-9]+)(\\\\.[0-9]+)?(\\\\.[0-9]+)?(-([-0-9A-Za-z]+(\\\\.[-0-9A-Za-z]+)*))?(\\\\+([-0-9A-Za-z]+(-\\\\.[-0-9A-Za-z]+)*))?\")",message="version must be well-formed semver"
	Version string `json:"version"`
}

BundleMetadata is a representation of the identifying attributes of a bundle.

func (*BundleMetadata) DeepCopy

func (in *BundleMetadata) DeepCopy() *BundleMetadata

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BundleMetadata.

func (*BundleMetadata) DeepCopyInto

func (in *BundleMetadata) DeepCopyInto(out *BundleMetadata)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CRDUpgradeSafetyEnforcement

type CRDUpgradeSafetyEnforcement string

type CRDUpgradeSafetyPreflightConfig

type CRDUpgradeSafetyPreflightConfig struct {
	// enforcement is required and configures the state of the CRD Upgrade Safety pre-flight check.
	//
	// Allowed values are "None" or "Strict". The default value is "Strict".
	//
	// When set to "None", the CRD Upgrade Safety pre-flight check is skipped during an upgrade operation.
	// Use this option with caution as unintended consequences such as data loss can occur.
	//
	// When set to "Strict", the CRD Upgrade Safety pre-flight check runs during an upgrade operation.
	//
	// +kubebuilder:validation:Enum:="None";"Strict"
	// +required
	Enforcement CRDUpgradeSafetyEnforcement `json:"enforcement"`
}

CRDUpgradeSafetyPreflightConfig is the configuration for CRD upgrade safety preflight check.

func (*CRDUpgradeSafetyPreflightConfig) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CRDUpgradeSafetyPreflightConfig.

func (*CRDUpgradeSafetyPreflightConfig) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CatalogFilter added in v1.2.0

type CatalogFilter struct {
	// packageName specifies the name of the package to be installed and is used to filter
	// the content from catalogs.
	//
	// It is required, immutable, and follows the DNS subdomain standard as defined in [RFC 1123].
	// It must contain only lowercase alphanumeric characters, hyphens (-) or periods (.),
	// start and end with an alphanumeric character, and be no longer than 253 characters.
	//
	// Some examples of valid values are:
	//   - some-package
	//   - 123-package
	//   - 1-package-2
	//   - somepackage
	//
	// Some examples of invalid values are:
	//   - -some-package
	//   - some-package-
	//   - thisisareallylongpackagenamethatisgreaterthanthemaximumlength
	//   - some.package
	//
	// [RFC 1123]: https://tools.ietf.org/html/rfc1123
	//
	// +kubebuilder:validation.Required
	// +kubebuilder:validation:MaxLength:=253
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="packageName is immutable"
	// +kubebuilder:validation:XValidation:rule="self.matches(\"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$\")",message="packageName must be a valid DNS1123 subdomain. It must contain only lowercase alphanumeric characters, hyphens (-) or periods (.), start and end with an alphanumeric character, and be no longer than 253 characters"
	// +required
	PackageName string `json:"packageName"`

	// version is an optional semver constraint (a specific version or range of versions).
	// When unspecified, the latest version available is installed.
	//
	// Acceptable version ranges are no longer than 64 characters.
	// Version ranges are composed of comma- or space-delimited values and one or more comparison operators,
	// known as comparison strings.
	// You can add additional comparison strings using the OR operator (||).
	//
	// # Range Comparisons
	//
	// To specify a version range, you can use a comparison string like ">=3.0,
	// <3.6". When specifying a range, automatic updates will occur within that
	// range. The example comparison string means "install any version greater than
	// or equal to 3.0.0 but less than 3.6.0.". It also states intent that if any
	// upgrades are available within the version range after initial installation,
	// those upgrades should be automatically performed.
	//
	// # Pinned Versions
	//
	// To specify an exact version to install you can use a version range that
	// "pins" to a specific version. When pinning to a specific version, no
	// automatic updates will occur. An example of a pinned version range is
	// "0.6.0", which means "only install version 0.6.0 and never
	// upgrade from this version".
	//
	// # Basic Comparison Operators
	//
	// The basic comparison operators and their meanings are:
	//   - "=", equal (not aliased to an operator)
	//   - "!=", not equal
	//   - "<", less than
	//   - ">", greater than
	//   - ">=", greater than OR equal to
	//   - "<=", less than OR equal to
	//
	// # Wildcard Comparisons
	//
	// You can use the "x", "X", and "*" characters as wildcard characters in all
	// comparison operations. Some examples of using the wildcard characters:
	//   - "1.2.x", "1.2.X", and "1.2.*" is equivalent to ">=1.2.0, < 1.3.0"
	//   - ">= 1.2.x", ">= 1.2.X", and ">= 1.2.*" is equivalent to ">= 1.2.0"
	//   - "<= 2.x", "<= 2.X", and "<= 2.*" is equivalent to "< 3"
	//   - "x", "X", and "*" is equivalent to ">= 0.0.0"
	//
	// # Patch Release Comparisons
	//
	// When you want to specify a minor version up to the next major version you
	// can use the "~" character to perform patch comparisons. Some examples:
	//   - "~1.2.3" is equivalent to ">=1.2.3, <1.3.0"
	//   - "~1" and "~1.x" is equivalent to ">=1, <2"
	//   - "~2.3" is equivalent to ">=2.3, <2.4"
	//   - "~1.2.x" is equivalent to ">=1.2.0, <1.3.0"
	//
	// # Major Release Comparisons
	//
	// You can use the "^" character to make major release comparisons after a
	// stable 1.0.0 version is published. If there is no stable version published, // minor versions define the stability level. Some examples:
	//   - "^1.2.3" is equivalent to ">=1.2.3, <2.0.0"
	//   - "^1.2.x" is equivalent to ">=1.2.0, <2.0.0"
	//   - "^2.3" is equivalent to ">=2.3, <3"
	//   - "^2.x" is equivalent to ">=2.0.0, <3"
	//   - "^0.2.3" is equivalent to ">=0.2.3, <0.3.0"
	//   - "^0.2" is equivalent to ">=0.2.0, <0.3.0"
	//   - "^0.0.3" is equvalent to ">=0.0.3, <0.0.4"
	//   - "^0.0" is equivalent to ">=0.0.0, <0.1.0"
	//   - "^0" is equivalent to ">=0.0.0, <1.0.0"
	//
	// # OR Comparisons
	// You can use the "||" character to represent an OR operation in the version
	// range. Some examples:
	//   - ">=1.2.3, <2.0.0 || >3.0.0"
	//   - "^0 || ^3 || ^5"
	//
	// For more information on semver, please see https://semver.org/
	//
	// +kubebuilder:validation:MaxLength:=64
	// +kubebuilder:validation:XValidation:rule="self.matches(\"^(\\\\s*(=||!=|>|<|>=|=>|<=|=<|~|~>|\\\\^)\\\\s*(v?(0|[1-9]\\\\d*|[x|X|\\\\*])(\\\\.(0|[1-9]\\\\d*|x|X|\\\\*]))?(\\\\.(0|[1-9]\\\\d*|x|X|\\\\*))?(-([0-9A-Za-z\\\\-]+(\\\\.[0-9A-Za-z\\\\-]+)*))?(\\\\+([0-9A-Za-z\\\\-]+(\\\\.[0-9A-Za-z\\\\-]+)*))?)\\\\s*)((?:\\\\s+|,\\\\s*|\\\\s*\\\\|\\\\|\\\\s*)(=||!=|>|<|>=|=>|<=|=<|~|~>|\\\\^)\\\\s*(v?(0|[1-9]\\\\d*|x|X|\\\\*])(\\\\.(0|[1-9]\\\\d*|x|X|\\\\*))?(\\\\.(0|[1-9]\\\\d*|x|X|\\\\*]))?(-([0-9A-Za-z\\\\-]+(\\\\.[0-9A-Za-z\\\\-]+)*))?(\\\\+([0-9A-Za-z\\\\-]+(\\\\.[0-9A-Za-z\\\\-]+)*))?)\\\\s*)*$\")",message="invalid version expression"
	// +optional
	Version string `json:"version,omitempty"`

	// channels is optional and specifies a set of channels belonging to the package
	// specified in the packageName field.
	//
	// A channel is a package-author-defined stream of updates for an extension.
	//
	// Each channel in the list must follow the DNS subdomain standard as defined in [RFC 1123].
	// It must contain only lowercase alphanumeric characters, hyphens (-) or periods (.),
	// start and end with an alphanumeric character, and be no longer than 253 characters.
	// You can specify no more than 256 channels.
	//
	// When specified, it constrains the set of installable bundles and the automated upgrade path.
	// This constraint is an AND operation with the version field. For example:
	//   - Given channel is set to "foo"
	//   - Given version is set to ">=1.0.0, <1.5.0"
	//   - Only bundles that exist in channel "foo" AND satisfy the version range comparison are considered installable
	//   - Automatic upgrades are constrained to upgrade edges defined by the selected channel
	//
	// When unspecified, upgrade edges across all channels are used to identify valid automatic upgrade paths.
	//
	// Some examples of valid values are:
	//   - 1.1.x
	//   - alpha
	//   - stable
	//   - stable-v1
	//   - v1-stable
	//   - dev-preview
	//   - preview
	//   - community
	//
	// Some examples of invalid values are:
	//   - -some-channel
	//   - some-channel-
	//   - thisisareallylongchannelnamethatisgreaterthanthemaximumlength
	//   - original_40
	//   - --default-channel
	//
	// [RFC 1123]: https://tools.ietf.org/html/rfc1123
	//
	// +kubebuilder:validation:items:MaxLength:=253
	// +kubebuilder:validation:MaxItems:=256
	// +kubebuilder:validation:items:XValidation:rule="self.matches(\"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$\")",message="channels entries must be valid DNS1123 subdomains"
	// +optional
	Channels []string `json:"channels,omitempty"`

	// selector is optional and filters the set of ClusterCatalogs used in the bundle selection process.
	//
	// When unspecified, all ClusterCatalogs are used in the bundle selection process.
	//
	// +optional
	Selector *metav1.LabelSelector `json:"selector,omitempty"`

	// upgradeConstraintPolicy is optional and controls whether the upgrade paths defined in the catalog
	// are enforced for the package referenced in the packageName field.
	//
	// Allowed values are "CatalogProvided", "SelfCertified", or omitted.
	//
	// When set to "CatalogProvided", automatic upgrades only occur when upgrade constraints specified by the package
	// author are met.
	//
	// When set to "SelfCertified", the upgrade constraints specified by the package author are ignored.
	// This allows upgrades and downgrades to any version of the package.
	// This is considered a dangerous operation as it can lead to unknown and potentially disastrous outcomes,
	// such as data loss.
	// Use this option only if you have independently verified the changes.
	//
	// When omitted, the default value is "CatalogProvided".
	//
	// +kubebuilder:validation:Enum:=CatalogProvided;SelfCertified
	// +kubebuilder:default:=CatalogProvided
	// +optional
	UpgradeConstraintPolicy UpgradeConstraintPolicy `json:"upgradeConstraintPolicy,omitempty"`
}

CatalogFilter defines the attributes used to identify and filter content from a catalog.

func (*CatalogFilter) DeepCopy added in v1.2.0

func (in *CatalogFilter) DeepCopy() *CatalogFilter

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CatalogFilter.

func (*CatalogFilter) DeepCopyInto added in v1.2.0

func (in *CatalogFilter) DeepCopyInto(out *CatalogFilter)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CatalogSource

type CatalogSource struct {
	// type is a required field that specifies the type of source for the catalog.
	//
	// The only allowed value is "Image".
	//
	// When set to "Image", the ClusterCatalog content is sourced from an OCI image.
	// When using an image source, the image field must be set and must be the only field defined for this type.
	//
	// +unionDiscriminator
	// +kubebuilder:validation:Enum:="Image"
	// +required
	Type SourceType `json:"type"`
	// image configures how catalog contents are sourced from an OCI image.
	// It is required when type is Image, and forbidden otherwise.
	// +optional
	Image *ImageSource `json:"image,omitempty"`
}

CatalogSource is a discriminated union of possible sources for a Catalog. CatalogSource contains the sourcing information for a Catalog +union +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'Image' ? has(self.image) : !has(self.image)",message="image is required when source type is Image, and forbidden otherwise"

func (*CatalogSource) DeepCopy

func (in *CatalogSource) DeepCopy() *CatalogSource

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CatalogSource.

func (*CatalogSource) DeepCopyInto

func (in *CatalogSource) DeepCopyInto(out *CatalogSource)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ClusterCatalog added in v1.2.0

type ClusterCatalog struct {
	metav1.TypeMeta `json:",inline"`

	// metadata is the standard object's metadata.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	metav1.ObjectMeta `json:"metadata"`

	// spec is a required field that defines the desired state of the ClusterCatalog.
	// The controller ensures that the catalog is unpacked and served over the catalog content HTTP server.
	// +required
	Spec ClusterCatalogSpec `json:"spec"`

	// status contains the following information about the state of the ClusterCatalog:
	//   - Whether the catalog contents are being served via the catalog content HTTP server
	//   - Whether the ClusterCatalog is progressing to a new state
	//   - A reference to the source from which the catalog contents were retrieved
	// +optional
	Status ClusterCatalogStatus `json:"status,omitempty"`
}

ClusterCatalog makes File-Based Catalog (FBC) data available to your cluster. For more information on FBC, see https://olm.operatorframework.io/docs/reference/file-based-catalogs/#docs

func (*ClusterCatalog) DeepCopy added in v1.2.0

func (in *ClusterCatalog) DeepCopy() *ClusterCatalog

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterCatalog.

func (*ClusterCatalog) DeepCopyInto added in v1.2.0

func (in *ClusterCatalog) DeepCopyInto(out *ClusterCatalog)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ClusterCatalog) DeepCopyObject added in v1.2.0

func (in *ClusterCatalog) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ClusterCatalogList added in v1.2.0

type ClusterCatalogList struct {
	metav1.TypeMeta `json:",inline"`

	// metadata is the standard object's metadata.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	metav1.ListMeta `json:"metadata"`

	// items is a list of ClusterCatalogs.
	// items is required.
	// +required
	Items []ClusterCatalog `json:"items"`
}

ClusterCatalogList contains a list of ClusterCatalog

func (*ClusterCatalogList) DeepCopy added in v1.2.0

func (in *ClusterCatalogList) DeepCopy() *ClusterCatalogList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterCatalogList.

func (*ClusterCatalogList) DeepCopyInto added in v1.2.0

func (in *ClusterCatalogList) DeepCopyInto(out *ClusterCatalogList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ClusterCatalogList) DeepCopyObject added in v1.2.0

func (in *ClusterCatalogList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ClusterCatalogSpec added in v1.2.0

type ClusterCatalogSpec struct {
	// source is a required field that defines the source of a catalog.
	// A catalog contains information on content that can be installed on a cluster.
	// The catalog source makes catalog contents discoverable and usable by other on-cluster components.
	// These components can present the content in a GUI dashboard or install content from the catalog on the cluster.
	// The catalog source must contain catalog metadata in the File-Based Catalog (FBC) format.
	// For more information on FBC, see https://olm.operatorframework.io/docs/reference/file-based-catalogs/#docs.
	//
	// Below is a minimal example of a ClusterCatalogSpec that sources a catalog from an image:
	//
	//  source:
	//    type: Image
	//    image:
	//      ref: quay.io/operatorhubio/catalog:latest
	//
	// +required
	Source CatalogSource `json:"source"`

	// priority is an optional field that defines a priority for this ClusterCatalog.
	//
	// Clients use the ClusterCatalog priority as a tie-breaker between ClusterCatalogs that meet their requirements.
	// Higher numbers mean higher priority.
	//
	// Clients decide how to handle scenarios where multiple ClusterCatalogs with the same priority meet their requirements.
	// Clients should prompt users for additional input to break the tie.
	//
	// When omitted, the default priority is 0.
	//
	// Use negative numbers to specify a priority lower than the default.
	// Use positive numbers to specify a priority higher than the default.
	//
	// The lowest possible value is -2147483648.
	// The highest possible value is 2147483647.
	//
	// +kubebuilder:default:=0
	// +kubebuilder:validation:Minimum:=-2147483648
	// +kubebuilder:validation:Maximum:=2147483647
	// +optional
	Priority int32 `json:"priority"`

	// availabilityMode is an optional field that defines how the ClusterCatalog is made available to clients on the cluster.
	//
	// Allowed values are "Available", "Unavailable", or omitted.
	//
	// When omitted, the default value is "Available".
	//
	// When set to "Available", the catalog contents are unpacked and served over the catalog content HTTP server.
	// Clients should consider this ClusterCatalog and its contents as usable.
	//
	// When set to "Unavailable", the catalog contents are no longer served over the catalog content HTTP server.
	// Treat this the same as if the ClusterCatalog does not exist.
	// Use "Unavailable" when you want to keep the ClusterCatalog but treat it as if it doesn't exist.
	//
	// +kubebuilder:validation:Enum:="Unavailable";"Available"
	// +kubebuilder:default:="Available"
	// +optional
	AvailabilityMode AvailabilityMode `json:"availabilityMode,omitempty"`
}

ClusterCatalogSpec defines the desired state of ClusterCatalog

func (*ClusterCatalogSpec) DeepCopy added in v1.2.0

func (in *ClusterCatalogSpec) DeepCopy() *ClusterCatalogSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterCatalogSpec.

func (*ClusterCatalogSpec) DeepCopyInto added in v1.2.0

func (in *ClusterCatalogSpec) DeepCopyInto(out *ClusterCatalogSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ClusterCatalogStatus added in v1.2.0

type ClusterCatalogStatus struct {
	// conditions represents the current state of this ClusterCatalog.
	//
	// The current condition types are Serving and Progressing.
	//
	// The Serving condition represents whether the catalog contents are being served via the HTTP(S) web server:
	//   - When status is True and reason is Available, the catalog contents are being served.
	//   - When status is False and reason is Unavailable, the catalog contents are not being served because the contents are not yet available.
	//   - When status is False and reason is UserSpecifiedUnavailable, the catalog contents are not being served because the catalog has been intentionally marked as unavailable.
	//
	// The Progressing condition represents whether the ClusterCatalog is progressing or is ready to progress towards a new state:
	//   - When status is True and reason is Retrying, an error occurred that may be resolved on subsequent reconciliation attempts.
	//   - When status is True and reason is Succeeded, the ClusterCatalog has successfully progressed to a new state and is ready to continue progressing.
	//   - When status is False and reason is Blocked, an error occurred that requires manual intervention for recovery.
	//
	// If the system initially fetched contents and polling identifies updates, both conditions can be active simultaneously:
	//   - The Serving condition remains True with reason Available because the previous contents are still served via the HTTP(S) web server.
	//   - The Progressing condition is True with reason Retrying because the system is working to serve the new version.
	//
	// +listType=map
	// +listMapKey=type
	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`
	// resolvedSource contains information about the resolved source based on the source type.
	// +optional
	ResolvedSource *ResolvedCatalogSource `json:"resolvedSource,omitempty"`
	// urls contains the URLs that can be used to access the catalog.
	// +optional
	URLs *ClusterCatalogURLs `json:"urls,omitempty"`
	// lastUnpacked represents the last time the catalog contents were extracted from their source format.
	// For example, when using an Image source, the OCI image is pulled and image layers are written to a file-system backed cache.
	// This extraction from the source format is called "unpacking".
	// +optional
	LastUnpacked *metav1.Time `json:"lastUnpacked,omitempty"`
}

ClusterCatalogStatus defines the observed state of ClusterCatalog

func (*ClusterCatalogStatus) DeepCopy added in v1.2.0

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterCatalogStatus.

func (*ClusterCatalogStatus) DeepCopyInto added in v1.2.0

func (in *ClusterCatalogStatus) DeepCopyInto(out *ClusterCatalogStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ClusterCatalogURLs added in v1.2.0

type ClusterCatalogURLs struct {
	// base is a cluster-internal URL that provides endpoints for accessing the catalog content.
	//
	// Clients should append the path for the endpoint they want to access.
	//
	// Currently, only a single endpoint is served and is accessible at the path /api/v1.
	//
	// The endpoints served for the v1 API are:
	//   - /all - this endpoint returns the entire catalog contents in the FBC format
	//
	// New endpoints may be added as needs evolve.
	//
	// +required
	// +kubebuilder:validation:MaxLength:=525
	// +kubebuilder:validation:XValidation:rule="isURL(self)",message="must be a valid URL"
	// +kubebuilder:validation:XValidation:rule="isURL(self) ? (url(self).getScheme() == \"http\" || url(self).getScheme() == \"https\") : true",message="scheme must be either http or https"
	Base string `json:"base"`
}

ClusterCatalogURLs contains the URLs that can be used to access the catalog.

func (*ClusterCatalogURLs) DeepCopy added in v1.2.0

func (in *ClusterCatalogURLs) DeepCopy() *ClusterCatalogURLs

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterCatalogURLs.

func (*ClusterCatalogURLs) DeepCopyInto added in v1.2.0

func (in *ClusterCatalogURLs) DeepCopyInto(out *ClusterCatalogURLs)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ClusterExtension

type ClusterExtension struct {
	metav1.TypeMeta `json:",inline"`

	// metadata is the standard object's metadata.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// spec is an optional field that defines the desired state of the ClusterExtension.
	// +optional
	Spec ClusterExtensionSpec `json:"spec,omitempty"`

	// status is an optional field that defines the observed state of the ClusterExtension.
	// +optional
	Status ClusterExtensionStatus `json:"status,omitempty"`
}

ClusterExtension is the Schema for the clusterextensions API

func (*ClusterExtension) DeepCopy

func (in *ClusterExtension) DeepCopy() *ClusterExtension

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterExtension.

func (*ClusterExtension) DeepCopyInto

func (in *ClusterExtension) DeepCopyInto(out *ClusterExtension)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ClusterExtension) DeepCopyObject

func (in *ClusterExtension) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ClusterExtensionConfig added in v1.5.1

type ClusterExtensionConfig struct {
	// configType is required and specifies the type of configuration source.
	//
	// The only allowed value is "Inline".
	//
	// When set to "Inline", the cluster extension configuration is defined inline within the ClusterExtension resource.
	//
	// +unionDiscriminator
	// +kubebuilder:validation:Enum:="Inline"
	// +required
	ConfigType ClusterExtensionConfigType `json:"configType"`

	// inline contains JSON or YAML values specified directly in the ClusterExtension.
	//
	// It is used to specify arbitrary configuration values for the ClusterExtension.
	// It must be set if configType is 'Inline' and must be a valid JSON/YAML object containing at least one property.
	// The configuration values are validated at runtime against a JSON schema provided by the bundle.
	//
	// +kubebuilder:validation:Type=object
	// +kubebuilder:validation:MinProperties=1
	// +optional
	// +unionMember
	Inline *apiextensionsv1.JSON `json:"inline,omitempty"`
}

ClusterExtensionConfig is a discriminated union which selects the source configuration values to be merged into the ClusterExtension's rendered manifests.

+kubebuilder:validation:XValidation:rule="has(self.configType) && self.configType == 'Inline' ?has(self.inline) : !has(self.inline)",message="inline is required when configType is Inline, and forbidden otherwise" +union

func (*ClusterExtensionConfig) DeepCopy added in v1.5.1

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterExtensionConfig.

func (*ClusterExtensionConfig) DeepCopyInto added in v1.5.1

func (in *ClusterExtensionConfig) DeepCopyInto(out *ClusterExtensionConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ClusterExtensionConfigType added in v1.5.1

type ClusterExtensionConfigType string

type ClusterExtensionInstallConfig

type ClusterExtensionInstallConfig struct {
	// preflight is optional and configures the checks that run before installation or upgrade
	// of the content for the package specified in the packageName field.
	//
	// When specified, it replaces the default preflight configuration for install/upgrade actions.
	// When not specified, the default configuration is used.
	//
	// +optional
	Preflight *PreflightConfig `json:"preflight,omitempty"`
}

ClusterExtensionInstallConfig is a union which selects the clusterExtension installation config. ClusterExtensionInstallConfig requires the namespace and serviceAccount which should be used for the installation of packages.

+kubebuilder:validation:XValidation:rule="has(self.preflight)",message="at least one of [preflight] are required when install is specified" +union

func (*ClusterExtensionInstallConfig) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterExtensionInstallConfig.

func (*ClusterExtensionInstallConfig) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ClusterExtensionInstallStatus

type ClusterExtensionInstallStatus struct {
	// bundle is required and represents the identifying attributes of a bundle.
	//
	// A "bundle" is a versioned set of content that represents the resources that need to be applied
	// to a cluster to install a package.
	//
	// +required
	Bundle BundleMetadata `json:"bundle"`
}

ClusterExtensionInstallStatus is a representation of the status of the identified bundle.

func (*ClusterExtensionInstallStatus) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterExtensionInstallStatus.

func (*ClusterExtensionInstallStatus) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ClusterExtensionList

type ClusterExtensionList struct {
	metav1.TypeMeta `json:",inline"`

	// +optional
	metav1.ListMeta `json:"metadata,omitempty"`

	// items is a required list of ClusterExtension objects.
	//
	// +required
	Items []ClusterExtension `json:"items"`
}

ClusterExtensionList contains a list of ClusterExtension

func (*ClusterExtensionList) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterExtensionList.

func (*ClusterExtensionList) DeepCopyInto

func (in *ClusterExtensionList) DeepCopyInto(out *ClusterExtensionList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ClusterExtensionList) DeepCopyObject

func (in *ClusterExtensionList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ClusterExtensionRevision added in v1.6.0

type ClusterExtensionRevision struct {
	metav1.TypeMeta `json:",inline"`

	// metadata is the standard object's metadata.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// spec defines the desired state of the ClusterExtensionRevision.
	// +optional
	Spec ClusterExtensionRevisionSpec `json:"spec,omitempty"`

	// status is optional and defines the observed state of the ClusterExtensionRevision.
	// +optional
	Status ClusterExtensionRevisionStatus `json:"status,omitempty"`
}

ClusterExtensionRevision represents an immutable snapshot of Kubernetes objects for a specific version of a ClusterExtension. Each revision contains objects organized into phases that roll out sequentially. The same object can only be managed by a single revision at a time. Ownership of objects is transitioned from one revision to the next as the extension is upgraded or reconfigured. Once the latest revision has rolled out successfully, previous active revisions are archived for posterity.

func (*ClusterExtensionRevision) DeepCopy added in v1.6.0

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterExtensionRevision.

func (*ClusterExtensionRevision) DeepCopyInto added in v1.6.0

func (in *ClusterExtensionRevision) DeepCopyInto(out *ClusterExtensionRevision)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ClusterExtensionRevision) DeepCopyObject added in v1.6.0

func (in *ClusterExtensionRevision) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ClusterExtensionRevisionLifecycleState added in v1.6.0

type ClusterExtensionRevisionLifecycleState string

ClusterExtensionRevisionLifecycleState specifies the lifecycle state of the ClusterExtensionRevision.

const (
	// ClusterExtensionRevisionLifecycleStateActive / "Active" is the default lifecycle state.
	ClusterExtensionRevisionLifecycleStateActive ClusterExtensionRevisionLifecycleState = "Active"
	// ClusterExtensionRevisionLifecycleStateArchived / "Archived" archives the revision for historical or auditing purposes.
	// The revision is removed from the owner list of all other objects previously under management and all objects
	// that did not transition to a succeeding revision are deleted.
	ClusterExtensionRevisionLifecycleStateArchived ClusterExtensionRevisionLifecycleState = "Archived"
)

type ClusterExtensionRevisionList added in v1.6.0

type ClusterExtensionRevisionList struct {
	metav1.TypeMeta `json:",inline"`

	// +optional
	metav1.ListMeta `json:"metadata,omitempty"`

	// items is a required list of ClusterExtensionRevision objects.
	//
	// +required
	Items []ClusterExtensionRevision `json:"items"`
}

ClusterExtensionRevisionList contains a list of ClusterExtensionRevision

func (*ClusterExtensionRevisionList) DeepCopy added in v1.6.0

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterExtensionRevisionList.

func (*ClusterExtensionRevisionList) DeepCopyInto added in v1.6.0

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ClusterExtensionRevisionList) DeepCopyObject added in v1.6.0

func (in *ClusterExtensionRevisionList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ClusterExtensionRevisionObject added in v1.6.0

type ClusterExtensionRevisionObject struct {
	// object is a required embedded Kubernetes object to be applied.
	//
	// This object must be a valid Kubernetes resource with apiVersion, kind, and metadata fields.
	//
	// +kubebuilder:validation:EmbeddedResource
	// +kubebuilder:pruning:PreserveUnknownFields
	Object unstructured.Unstructured `json:"object"`

	// collisionProtection controls whether the operator can adopt and modify objects
	// that already exist on the cluster.
	//
	// Allowed values are: "Prevent", "IfNoController", and "None".
	//
	// When set to "Prevent", the operator only manages objects it created itself.
	// This prevents ownership collisions.
	//
	// When set to "IfNoController", the operator can adopt and modify pre-existing objects
	// that are not owned by another controller.
	// This is useful for taking over management of manually-created resources.
	//
	// When set to "None", the operator can adopt and modify any pre-existing object, even if
	// owned by another controller.
	// Use this setting with extreme caution as it may cause multiple controllers to fight over
	// the same resource, resulting in increased load on the API server and etcd.
	//
	// +required
	// +kubebuilder:validation:Enum=Prevent;IfNoController;None
	CollisionProtection CollisionProtection `json:"collisionProtection,omitempty"`
}

ClusterExtensionRevisionObject represents a Kubernetes object to be applied as part of a phase, along with its collision protection settings.

func (*ClusterExtensionRevisionObject) DeepCopy added in v1.6.0

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterExtensionRevisionObject.

func (*ClusterExtensionRevisionObject) DeepCopyInto added in v1.6.0

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ClusterExtensionRevisionPhase added in v1.6.0

type ClusterExtensionRevisionPhase struct {
	// name is a required identifier for this phase.
	//
	// phase names must follow the DNS label standard as defined in [RFC 1123].
	// They must contain only lowercase alphanumeric characters or hyphens (-),
	// start and end with an alphanumeric character, and be no longer than 63 characters.
	//
	// Common phase names include: namespaces, policies, rbac, crds, storage, deploy, publish.
	//
	// [RFC 1123]: https://tools.ietf.org/html/rfc1123
	//
	// +required
	// +kubebuilder:validation:MinLength=1
	// +kubebuilder:validation:MaxLength=63
	// +kubebuilder:validation:XValidation:rule=`!format.dns1123Label().validate(self).hasValue()`,message="the value must consist of only lowercase alphanumeric characters and hyphens, and must start with an alphabetic character and end with an alphanumeric character."
	Name string `json:"name"`

	// objects is a required list of all Kubernetes objects that belong to this phase.
	//
	// All objects in this list are applied to the cluster in no particular order. The maximum number of objects per phase is 50.
	// +required
	// +kubebuilder:validation:MaxItems=50
	Objects []ClusterExtensionRevisionObject `json:"objects"`
}

ClusterExtensionRevisionPhase represents a group of objects that are applied together. The phase is considered complete only after all objects pass their status probes.

func (*ClusterExtensionRevisionPhase) DeepCopy added in v1.6.0

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterExtensionRevisionPhase.

func (*ClusterExtensionRevisionPhase) DeepCopyInto added in v1.6.0

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ClusterExtensionRevisionSpec added in v1.6.0

type ClusterExtensionRevisionSpec struct {
	// lifecycleState specifies the lifecycle state of the ClusterExtensionRevision.
	//
	// When set to "Active", the revision is actively managed and reconciled.
	// When set to "Archived", the revision is inactive and any resources not managed by a subsequent revision are deleted.
	// The revision is removed from the owner list of all objects previously under management.
	// All objects that did not transition to a succeeding revision are deleted.
	//
	// Once a revision is set to "Archived", it cannot be un-archived.
	//
	// It is possible for more than one revision to be "Active" simultaneously. This will occur when
	// moving from one revision to another. The old revision will not be set to "Archived" until the
	// new revision has been completely rolled out.
	//
	// +required
	// +kubebuilder:validation:Enum=Active;Archived
	// +kubebuilder:validation:XValidation:rule="oldSelf == 'Active' || oldSelf == 'Archived' && oldSelf == self", message="cannot un-archive"
	LifecycleState ClusterExtensionRevisionLifecycleState `json:"lifecycleState,omitempty"`

	// revision is a required, immutable sequence number representing a specific revision
	// of the parent ClusterExtension.
	//
	// The revision field must be a positive integer.
	// Each ClusterExtensionRevision belonging to the same parent ClusterExtension must have a unique revision number.
	// The revision number must always be the previous revision number plus one, or 1 for the first revision.
	//
	// +required
	// +kubebuilder:validation:Minimum:=1
	// +kubebuilder:validation:XValidation:rule="self == oldSelf", message="revision is immutable"
	Revision int64 `json:"revision"`

	// phases is an optional, immutable list of phases that group objects to be applied together.
	//
	// Objects are organized into phases based on their Group-Kind. Common phases include:
	//   - namespaces: Namespace objects
	//   - policies: ResourceQuota, LimitRange, NetworkPolicy objects
	//   - rbac: ServiceAccount, Role, RoleBinding, ClusterRole, ClusterRoleBinding objects
	//   - crds: CustomResourceDefinition objects
	//   - storage: PersistentVolume, PersistentVolumeClaim, StorageClass objects
	//   - deploy: Deployment, StatefulSet, DaemonSet, Service, ConfigMap, Secret objects
	//   - publish: Ingress, APIService, Route, Webhook objects
	//
	// All objects in a phase are applied in no particular order.
	// The revision progresses to the next phase only after all objects in the current phase pass their readiness probes.
	//
	// Once set, even if empty, the phases field is immutable.
	//
	// Each phase in the list must have a unique name. The maximum number of phases is 20.
	//
	// +kubebuilder:validation:XValidation:rule="self == oldSelf || oldSelf.size() == 0", message="phases is immutable"
	// +kubebuilder:validation:MaxItems=20
	// +listType=map
	// +listMapKey=name
	// +optional
	Phases []ClusterExtensionRevisionPhase `json:"phases,omitempty"`

	// progressDeadlineMinutes is an optional field that defines the maximum period
	// of time in minutes after which an installation should be considered failed and
	// require manual intervention. This functionality is disabled when no value
	// is provided. The minimum period is 10 minutes, and the maximum is 720 minutes (12 hours).
	//
	// +kubebuilder:validation:Minimum:=10
	// +kubebuilder:validation:Maximum:=720
	// +optional
	// <opcon:experimental>
	ProgressDeadlineMinutes int32 `json:"progressDeadlineMinutes,omitempty"`
}

ClusterExtensionRevisionSpec defines the desired state of ClusterExtensionRevision.

func (*ClusterExtensionRevisionSpec) DeepCopy added in v1.6.0

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterExtensionRevisionSpec.

func (*ClusterExtensionRevisionSpec) DeepCopyInto added in v1.6.0

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ClusterExtensionRevisionStatus added in v1.6.0

type ClusterExtensionRevisionStatus struct {
	// conditions is an optional list of status conditions describing the state of the
	// ClusterExtensionRevision.
	//
	// The Progressing condition represents whether the revision is actively rolling out:
	//   - When status is True and reason is RollingOut, the ClusterExtensionRevision rollout is actively making progress and is in transition.
	//   - When status is True and reason is Retrying, the ClusterExtensionRevision has encountered an error that could be resolved on subsequent reconciliation attempts.
	//   - When status is True and reason is Succeeded, the ClusterExtensionRevision has reached the desired state.
	//   - When status is False and reason is Blocked, the ClusterExtensionRevision has encountered an error that requires manual intervention for recovery.
	//   - When status is False and reason is Archived, the ClusterExtensionRevision is archived and not being actively reconciled.
	//
	// The Available condition represents whether the revision has been successfully rolled out and is available:
	//   - When status is True and reason is ProbesSucceeded, the ClusterExtensionRevision has been successfully rolled out and all objects pass their readiness probes.
	//   - When status is False and reason is ProbeFailure, one or more objects are failing their readiness probes during rollout.
	//   - When status is Unknown and reason is Reconciling, the ClusterExtensionRevision has encountered an error that prevented it from observing the probes.
	//   - When status is Unknown and reason is Archived, the ClusterExtensionRevision has been archived and its objects have been torn down.
	//   - When status is Unknown and reason is Migrated, the ClusterExtensionRevision was migrated from an existing release and object status probe results have not yet been observed.
	//
	// The Succeeded condition represents whether the revision has successfully completed its rollout:
	//   - When status is True and reason is Succeeded, the ClusterExtensionRevision has successfully completed its rollout. This condition is set once and persists even if the revision later becomes unavailable.
	//
	// +listType=map
	// +listMapKey=type
	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

ClusterExtensionRevisionStatus defines the observed state of a ClusterExtensionRevision.

func (*ClusterExtensionRevisionStatus) DeepCopy added in v1.6.0

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterExtensionRevisionStatus.

func (*ClusterExtensionRevisionStatus) DeepCopyInto added in v1.6.0

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ClusterExtensionSpec

type ClusterExtensionSpec struct {
	// namespace specifies a Kubernetes namespace.
	// This is the namespace where the provided ServiceAccount must exist.
	// It also designates the default namespace where namespace-scoped resources for the extension are applied to the cluster.
	// Some extensions may contain namespace-scoped resources to be applied in other namespaces.
	// This namespace must exist.
	//
	// The namespace field is required, immutable, and follows the DNS label standard as defined in [RFC 1123].
	// It must contain only lowercase alphanumeric characters or hyphens (-), start and end with an alphanumeric character,
	// and be no longer than 63 characters.
	//
	// [RFC 1123]: https://tools.ietf.org/html/rfc1123
	//
	// +kubebuilder:validation:MaxLength:=63
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="namespace is immutable"
	// +kubebuilder:validation:XValidation:rule="self.matches(\"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$\")",message="namespace must be a valid DNS1123 label"
	// +required
	Namespace string `json:"namespace"`

	// serviceAccount specifies a ServiceAccount used to perform all interactions with the cluster
	// that are required to manage the extension.
	// The ServiceAccount must be configured with the necessary permissions to perform these interactions.
	// The ServiceAccount must exist in the namespace referenced in the spec.
	// The serviceAccount field is required.
	//
	// +required
	ServiceAccount ServiceAccountReference `json:"serviceAccount"`

	// source is required and selects the installation source of content for this ClusterExtension.
	// Set the sourceType field to perform the selection.
	//
	// Catalog is currently the only implemented sourceType.
	// Setting sourceType to "Catalog" requires the catalog field to also be defined.
	//
	// Below is a minimal example of a source definition (in yaml):
	//
	// source:
	//   sourceType: Catalog
	//   catalog:
	//     packageName: example-package
	//
	// +required
	Source SourceConfig `json:"source"`

	// install is optional and configures installation options for the ClusterExtension,
	// such as the pre-flight check configuration.
	//
	// +optional
	Install *ClusterExtensionInstallConfig `json:"install,omitempty"`

	// config is optional and specifies bundle-specific configuration.
	// Configuration is bundle-specific and a bundle may provide a configuration schema.
	// When not specified, the default configuration of the resolved bundle is used.
	//
	// config is validated against a configuration schema provided by the resolved bundle. If the bundle does not provide
	// a configuration schema the bundle is deemed to not be configurable. More information on how
	// to configure bundles can be found in the OLM documentation associated with your current OLM version.
	//
	// +optional
	Config *ClusterExtensionConfig `json:"config,omitempty"`

	// progressDeadlineMinutes is an optional field that defines the maximum period
	// of time in minutes after which an installation should be considered failed and
	// require manual intervention. This functionality is disabled when no value
	// is provided. The minimum period is 10 minutes, and the maximum is 720 minutes (12 hours).
	//
	// +kubebuilder:validation:Minimum:=10
	// +kubebuilder:validation:Maximum:=720
	// +optional
	// <opcon:experimental>
	ProgressDeadlineMinutes int32 `json:"progressDeadlineMinutes,omitempty"`
}

ClusterExtensionSpec defines the desired state of ClusterExtension

func (*ClusterExtensionSpec) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterExtensionSpec.

func (*ClusterExtensionSpec) DeepCopyInto

func (in *ClusterExtensionSpec) DeepCopyInto(out *ClusterExtensionSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ClusterExtensionStatus

type ClusterExtensionStatus struct {
	// conditions represents the current state of the ClusterExtension.
	//
	// The set of condition types which apply to all spec.source variations are Installed and Progressing.
	//
	// The Installed condition represents whether the bundle has been installed for this ClusterExtension:
	//   - When Installed is True and the Reason is Succeeded, the bundle has been successfully installed.
	//   - When Installed is False and the Reason is Failed, the bundle has failed to install.
	//
	// The Progressing condition represents whether or not the ClusterExtension is advancing towards a new state.
	// When Progressing is True and the Reason is Succeeded, the ClusterExtension is making progress towards a new state.
	// When Progressing is True and the Reason is Retrying, the ClusterExtension has encountered an error that could be resolved on subsequent reconciliation attempts.
	// When Progressing is False and the Reason is Blocked, the ClusterExtension has encountered an error that requires manual intervention for recovery.
	// <opcon:experimental:description>
	// When Progressing is True and Reason is RollingOut, the ClusterExtension has one or more ClusterExtensionRevisions in active roll out.
	// </opcon:experimental:description>
	//
	// When the ClusterExtension is sourced from a catalog, it surfaces deprecation conditions based on catalog metadata.
	// These are indications from a package owner to guide users away from a particular package, channel, or bundle:
	//   - BundleDeprecated is True if the installed bundle is marked deprecated, False if not deprecated, or Unknown if no bundle is installed yet or if catalog data is unavailable.
	//   - ChannelDeprecated is True if any requested channel is marked deprecated, False if not deprecated, or Unknown if catalog data is unavailable.
	//   - PackageDeprecated is True if the requested package is marked deprecated, False if not deprecated, or Unknown if catalog data is unavailable.
	//   - Deprecated is a rollup condition that is True when any deprecation exists, False when none exist, or Unknown when catalog data is unavailable.
	//
	// +listType=map
	// +listMapKey=type
	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`

	// install is a representation of the current installation status for this ClusterExtension.
	//
	// +optional
	Install *ClusterExtensionInstallStatus `json:"install,omitempty"`

	// activeRevisions holds a list of currently active (non-archived) ClusterExtensionRevisions,
	// including both installed and rolling out revisions.
	// +listType=map
	// +listMapKey=name
	// +optional
	// <opcon:experimental>
	ActiveRevisions []RevisionStatus `json:"activeRevisions,omitempty"`
}

ClusterExtensionStatus defines the observed state of a ClusterExtension.

func (*ClusterExtensionStatus) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterExtensionStatus.

func (*ClusterExtensionStatus) DeepCopyInto

func (in *ClusterExtensionStatus) DeepCopyInto(out *ClusterExtensionStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CollisionProtection added in v1.6.0

type CollisionProtection string

CollisionProtection specifies if and how ownership collisions are prevented.

const (
	// CollisionProtectionPrevent prevents owner collisions entirely
	// by only allowing to work with objects itself has created.
	CollisionProtectionPrevent CollisionProtection = "Prevent"
	// CollisionProtectionIfNoController allows to patch and override
	// objects already present if they are not owned by another controller.
	CollisionProtectionIfNoController CollisionProtection = "IfNoController"
	// CollisionProtectionNone allows to patch and override objects
	// already present and owned by other controllers.
	// Be careful! This setting may cause multiple controllers to fight over a resource,
	// causing load on the API server and etcd.
	CollisionProtectionNone CollisionProtection = "None"
)

type ImageSource added in v1.2.0

type ImageSource struct {
	// ref is a required field that defines the reference to a container image containing catalog contents.
	// It cannot be more than 1000 characters.
	//
	// A reference has 3 parts: the domain, name, and identifier.
	//
	// The domain is typically the registry where an image is located.
	// It must be alphanumeric characters (lowercase and uppercase) separated by the "." character.
	// Hyphenation is allowed, but the domain must start and end with alphanumeric characters.
	// Specifying a port to use is also allowed by adding the ":" character followed by numeric values.
	// The port must be the last value in the domain.
	// Some examples of valid domain values are "registry.mydomain.io", "quay.io", "my-registry.io:8080".
	//
	// The name is typically the repository in the registry where an image is located.
	// It must contain lowercase alphanumeric characters separated only by the ".", "_", "__", "-" characters.
	// Multiple names can be concatenated with the "/" character.
	// The domain and name are combined using the "/" character.
	// Some examples of valid name values are "operatorhubio/catalog", "catalog", "my-catalog.prod".
	// An example of the domain and name parts of a reference being combined is "quay.io/operatorhubio/catalog".
	//
	// The identifier is typically the tag or digest for an image reference and is present at the end of the reference.
	// It starts with a separator character used to distinguish the end of the name and beginning of the identifier.
	// For a digest-based reference, the "@" character is the separator.
	// For a tag-based reference, the ":" character is the separator.
	// An identifier is required in the reference.
	//
	// Digest-based references must contain an algorithm reference immediately after the "@" separator.
	// The algorithm reference must be followed by the ":" character and an encoded string.
	// The algorithm must start with an uppercase or lowercase alpha character followed by alphanumeric characters and may contain the "-", "_", "+", and "." characters.
	// Some examples of valid algorithm values are "sha256", "sha256+b64u", "multihash+base58".
	// The encoded string following the algorithm must be hex digits (a-f, A-F, 0-9) and must be a minimum of 32 characters.
	//
	// Tag-based references must begin with a word character (alphanumeric + "_") followed by word characters or ".", and "-" characters.
	// The tag must not be longer than 127 characters.
	//
	// An example of a valid digest-based image reference is "quay.io/operatorhubio/catalog@sha256:200d4ddb2a73594b91358fe6397424e975205bfbe44614f5846033cad64b3f05"
	// An example of a valid tag-based image reference is "quay.io/operatorhubio/catalog:latest"
	//
	// +required
	// +kubebuilder:validation:MaxLength:=1000
	// +kubebuilder:validation:XValidation:rule="self.matches('^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])((\\\\.([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))+)?(:[0-9]+)?\\\\b')",message="must start with a valid domain. valid domains must be alphanumeric characters (lowercase and uppercase) separated by the \".\" character."
	// +kubebuilder:validation:XValidation:rule="self.find('(\\\\/[a-z0-9]+((([._]|__|[-]*)[a-z0-9]+)+)?((\\\\/[a-z0-9]+((([._]|__|[-]*)[a-z0-9]+)+)?)+)?)') != \"\"",message="a valid name is required. valid names must contain lowercase alphanumeric characters separated only by the \".\", \"_\", \"__\", \"-\" characters."
	// +kubebuilder:validation:XValidation:rule="self.find('(@.*:)') != \"\" || self.find(':.*$') != \"\"",message="must end with a digest or a tag"
	// +kubebuilder:validation:XValidation:rule="self.find('(@.*:)') == \"\" ? (self.find(':.*$') != \"\" ? self.find(':.*$').substring(1).size() <= 127 : true) : true",message="tag is invalid. the tag must not be more than 127 characters"
	// +kubebuilder:validation:XValidation:rule="self.find('(@.*:)') == \"\" ? (self.find(':.*$') != \"\" ? self.find(':.*$').matches(':[\\\\w][\\\\w.-]*$') : true) : true",message="tag is invalid. valid tags must begin with a word character (alphanumeric + \"_\") followed by word characters or \".\", and \"-\" characters"
	// +kubebuilder:validation:XValidation:rule="self.find('(@.*:)') != \"\" ? self.find('(@.*:)').matches('(@[A-Za-z][A-Za-z0-9]*([-_+.][A-Za-z][A-Za-z0-9]*)*[:])') : true",message="digest algorithm is not valid. valid algorithms must start with an uppercase or lowercase alpha character followed by alphanumeric characters and may contain the \"-\", \"_\", \"+\", and \".\" characters."
	// +kubebuilder:validation:XValidation:rule="self.find('(@.*:)') != \"\" ? self.find(':.*$').substring(1).size() >= 32 : true",message="digest is not valid. the encoded string must be at least 32 characters"
	// +kubebuilder:validation:XValidation:rule="self.find('(@.*:)') != \"\" ? self.find(':.*$').matches(':[0-9A-Fa-f]*$') : true",message="digest is not valid. the encoded string must only contain hex characters (A-F, a-f, 0-9)"
	Ref string `json:"ref"`

	// pollIntervalMinutes is an optional field that sets the interval, in minutes, at which the image source is polled for new content.
	// You cannot specify pollIntervalMinutes when ref is a digest-based reference.
	//
	// When omitted, the image is not polled for new content.
	// +kubebuilder:validation:Minimum:=1
	// +optional
	PollIntervalMinutes *int `json:"pollIntervalMinutes,omitempty"`
}

ImageSource enables users to define the information required for sourcing a Catalog from an OCI image

If we see that there is a possibly valid digest-based image reference AND pollIntervalMinutes is specified, reject the resource since there is no use in polling a digest-based image reference. +kubebuilder:validation:XValidation:rule="self.ref.find('(@.*:)') != \"\" ? !has(self.pollIntervalMinutes) : true",message="cannot specify pollIntervalMinutes while using digest-based image"

func (*ImageSource) DeepCopy added in v1.2.0

func (in *ImageSource) DeepCopy() *ImageSource

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageSource.

func (*ImageSource) DeepCopyInto added in v1.2.0

func (in *ImageSource) DeepCopyInto(out *ImageSource)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PreflightConfig

type PreflightConfig struct {
	// crdUpgradeSafety configures the CRD Upgrade Safety pre-flight checks that run
	// before upgrades of installed content.
	//
	// The CRD Upgrade Safety pre-flight check safeguards from unintended consequences of upgrading a CRD,
	// such as data loss.
	CRDUpgradeSafety *CRDUpgradeSafetyPreflightConfig `json:"crdUpgradeSafety"`
}

PreflightConfig holds the configuration for the preflight checks. If used, at least one preflight check must be non-nil.

+kubebuilder:validation:XValidation:rule="has(self.crdUpgradeSafety)",message="at least one of [crdUpgradeSafety] are required when preflight is specified"

func (*PreflightConfig) DeepCopy

func (in *PreflightConfig) DeepCopy() *PreflightConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PreflightConfig.

func (*PreflightConfig) DeepCopyInto

func (in *PreflightConfig) DeepCopyInto(out *PreflightConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ResolvedCatalogSource added in v1.2.0

type ResolvedCatalogSource struct {
	// type is a required field that specifies the type of source for the catalog.
	//
	// The only allowed value is "Image".
	//
	// When set to "Image", information about the resolved image source is set in the image field.
	//
	// +unionDiscriminator
	// +kubebuilder:validation:Enum:="Image"
	// +required
	Type SourceType `json:"type"`
	// image contains resolution information for a catalog sourced from an image.
	// It must be set when type is Image, and forbidden otherwise.
	Image *ResolvedImageSource `json:"image"`
}

ResolvedCatalogSource is a discriminated union of resolution information for a Catalog. ResolvedCatalogSource contains the information about a sourced Catalog +union +kubebuilder:validation:XValidation:rule="has(self.type) && self.type == 'Image' ? has(self.image) : !has(self.image)",message="image is required when source type is Image, and forbidden otherwise"

func (*ResolvedCatalogSource) DeepCopy added in v1.2.0

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResolvedCatalogSource.

func (*ResolvedCatalogSource) DeepCopyInto added in v1.2.0

func (in *ResolvedCatalogSource) DeepCopyInto(out *ResolvedCatalogSource)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ResolvedImageSource added in v1.2.0

type ResolvedImageSource struct {
	// ref contains the resolved image digest-based reference.
	// The digest format allows you to use other tooling to fetch the exact OCI manifests
	// that were used to extract the catalog contents.
	// +required
	// +kubebuilder:validation:MaxLength:=1000
	// +kubebuilder:validation:XValidation:rule="self.matches('^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])((\\\\.([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))+)?(:[0-9]+)?\\\\b')",message="must start with a valid domain. valid domains must be alphanumeric characters (lowercase and uppercase) separated by the \".\" character."
	// +kubebuilder:validation:XValidation:rule="self.find('(\\\\/[a-z0-9]+((([._]|__|[-]*)[a-z0-9]+)+)?((\\\\/[a-z0-9]+((([._]|__|[-]*)[a-z0-9]+)+)?)+)?)') != \"\"",message="a valid name is required. valid names must contain lowercase alphanumeric characters separated only by the \".\", \"_\", \"__\", \"-\" characters."
	// +kubebuilder:validation:XValidation:rule="self.find('(@.*:)') != \"\"",message="must end with a digest"
	// +kubebuilder:validation:XValidation:rule="self.find('(@.*:)') != \"\" ? self.find('(@.*:)').matches('(@[A-Za-z][A-Za-z0-9]*([-_+.][A-Za-z][A-Za-z0-9]*)*[:])') : true",message="digest algorithm is not valid. valid algorithms must start with an uppercase or lowercase alpha character followed by alphanumeric characters and may contain the \"-\", \"_\", \"+\", and \".\" characters."
	// +kubebuilder:validation:XValidation:rule="self.find('(@.*:)') != \"\" ? self.find(':.*$').substring(1).size() >= 32 : true",message="digest is not valid. the encoded string must be at least 32 characters"
	// +kubebuilder:validation:XValidation:rule="self.find('(@.*:)') != \"\" ? self.find(':.*$').matches(':[0-9A-Fa-f]*$') : true",message="digest is not valid. the encoded string must only contain hex characters (A-F, a-f, 0-9)"
	Ref string `json:"ref"`
}

ResolvedImageSource provides information about the resolved source of a Catalog sourced from an image.

func (*ResolvedImageSource) DeepCopy added in v1.2.0

func (in *ResolvedImageSource) DeepCopy() *ResolvedImageSource

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResolvedImageSource.

func (*ResolvedImageSource) DeepCopyInto added in v1.2.0

func (in *ResolvedImageSource) DeepCopyInto(out *ResolvedImageSource)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RevisionStatus added in v1.8.0

type RevisionStatus struct {
	// name of the ClusterExtensionRevision resource
	Name string `json:"name"`
	// conditions optionally expose Progressing and Available condition of the revision,
	// in case when it is not yet marked as successfully installed (condition Succeeded is not set to True).
	// Given that a ClusterExtension should remain available during upgrades, an observer may use these conditions
	// to get more insights about reasons for its current state.
	//
	// +listType=map
	// +listMapKey=type
	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

RevisionStatus defines the observed state of a ClusterExtensionRevision.

func (*RevisionStatus) DeepCopy added in v1.8.0

func (in *RevisionStatus) DeepCopy() *RevisionStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RevisionStatus.

func (*RevisionStatus) DeepCopyInto added in v1.8.0

func (in *RevisionStatus) DeepCopyInto(out *RevisionStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ServiceAccountReference

type ServiceAccountReference struct {
	// name is a required, immutable reference to the name of the ServiceAccount used for installation
	// and management of the content for the package specified in the packageName field.
	//
	// This ServiceAccount must exist in the installNamespace.
	//
	// The name field follows the DNS subdomain standard as defined in [RFC 1123].
	// It must contain only lowercase alphanumeric characters, hyphens (-) or periods (.),
	// start and end with an alphanumeric character, and be no longer than 253 characters.
	//
	// Some examples of valid values are:
	//   - some-serviceaccount
	//   - 123-serviceaccount
	//   - 1-serviceaccount-2
	//   - someserviceaccount
	//   - some.serviceaccount
	//
	// Some examples of invalid values are:
	//   - -some-serviceaccount
	//   - some-serviceaccount-
	//
	// [RFC 1123]: https://tools.ietf.org/html/rfc1123
	//
	// +kubebuilder:validation:MaxLength:=253
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="name is immutable"
	// +kubebuilder:validation:XValidation:rule="self.matches(\"^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$\")",message="name must be a valid DNS1123 subdomain. It must contain only lowercase alphanumeric characters, hyphens (-) or periods (.), start and end with an alphanumeric character, and be no longer than 253 characters"
	// +required
	Name string `json:"name"`
}

ServiceAccountReference identifies the serviceAccount used fo install a ClusterExtension.

func (*ServiceAccountReference) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServiceAccountReference.

func (*ServiceAccountReference) DeepCopyInto

func (in *ServiceAccountReference) DeepCopyInto(out *ServiceAccountReference)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SourceConfig

type SourceConfig struct {
	// sourceType is required and specifies the type of install source.
	//
	// The only allowed value is "Catalog".
	//
	// When set to "Catalog", information for determining the appropriate bundle of content to install
	// is fetched from ClusterCatalog resources on the cluster.
	// When using the Catalog sourceType, the catalog field must also be set.
	//
	// +unionDiscriminator
	// +kubebuilder:validation:Enum:="Catalog"
	// +required
	SourceType string `json:"sourceType"`

	// catalog configures how information is sourced from a catalog.
	// It is required when sourceType is "Catalog", and forbidden otherwise.
	//
	// +optional
	Catalog *CatalogFilter `json:"catalog,omitempty"`
}

SourceConfig is a discriminated union which selects the installation source.

+union +kubebuilder:validation:XValidation:rule="has(self.sourceType) && self.sourceType == 'Catalog' ? has(self.catalog) : !has(self.catalog)",message="catalog is required when sourceType is Catalog, and forbidden otherwise"

func (*SourceConfig) DeepCopy

func (in *SourceConfig) DeepCopy() *SourceConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SourceConfig.

func (*SourceConfig) DeepCopyInto

func (in *SourceConfig) DeepCopyInto(out *SourceConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SourceType added in v1.2.0

type SourceType string

SourceType defines the type of source used for catalogs. +enum

type UpgradeConstraintPolicy

type UpgradeConstraintPolicy string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL