diff --git a/api/v1/clustercatalog_types.go b/api/v1/clustercatalog_types.go index c18fa3c7e..0040dcb10 100644 --- a/api/v1/clustercatalog_types.go +++ b/api/v1/clustercatalog_types.go @@ -51,7 +51,7 @@ const ( //+kubebuilder:printcolumn:name="Serving",type=string,JSONPath=`.status.conditions[?(@.type=="Serving")].status` //+kubebuilder:printcolumn:name=Age,type=date,JSONPath=`.metadata.creationTimestamp` -// ClusterCatalog enables users to make File-Based Catalog (FBC) catalog data available to the cluster. +// The ClusterCatalog resource 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 type ClusterCatalog struct { metav1.TypeMeta `json:",inline"` @@ -60,16 +60,15 @@ type ClusterCatalog struct { // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metav1.ObjectMeta `json:"metadata"` - // spec is the desired state of the ClusterCatalog. - // spec is required. - // The controller will work to ensure that the desired - // catalog is unpacked and served over the catalog content HTTP server. + // The spec field defines the desired state of the ClusterCatalog. + // The spec field is required. + // The controller ensures that the catalog is unpacked and served over the catalog content HTTP server. // +kubebuilder:validation:Required Spec ClusterCatalogSpec `json:"spec"` - // status contains information about the state of the ClusterCatalog such as: - // - Whether or not the catalog contents are being served via the catalog content HTTP server - // - Whether or not the ClusterCatalog is progressing to a new state + // The status field 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"` @@ -93,15 +92,13 @@ type ClusterCatalogList struct { // ClusterCatalogSpec defines the desired state of ClusterCatalog type ClusterCatalogSpec struct { - // source allows a user to define the source of a catalog. - // A "catalog" contains information on content that can be installed on a cluster. - // Providing a catalog source makes the contents of the catalog discoverable and usable by - // other on-cluster components. - // These on-cluster components may do a variety of things with this information, such as - // presenting the content in a GUI dashboard or installing content from the catalog on the cluster. + // The source field 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. - // source is a required field. + // The source field is required. // // Below is a minimal example of a ClusterCatalogSpec that sources a catalog from an image: // @@ -113,19 +110,19 @@ type ClusterCatalogSpec struct { // +kubebuilder:validation:Required Source CatalogSource `json:"source"` - // priority allows the user to define a priority for a ClusterCatalog. - // priority is optional. + // The priority field defines a priority for this ClusterCatalog. + // The priority field is optional. // - // A ClusterCatalog's priority is used by clients as a tie-breaker between ClusterCatalogs that meet the client's requirements. - // A higher number means higher priority. + // Clients use the ClusterCatalog priority as a tie-breaker between ClusterCatalogs that meet their requirements. + // Higher numbers mean higher priority. // - // It is up to clients to decide how to handle scenarios where multiple ClusterCatalogs with the same priority meet their requirements. - // When deciding how to break the tie in this scenario, it is recommended that clients prompt their users for additional input. + // 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 because that is the zero value of integers. + // When omitted, the default priority is 0. // - // Negative numbers can be used to specify a priority lower than the default. - // Positive numbers can be used to specify a priority higher than the default. + // 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. @@ -136,21 +133,19 @@ type ClusterCatalogSpec struct { // +optional Priority int32 `json:"priority"` - // availabilityMode allows users to define how the ClusterCatalog is made available to clients on the cluster. - // availabilityMode is optional. + // The availabilityMode field defines how the ClusterCatalog is made available to clients on the cluster. + // The availabilityMode field is optional. // - // Allowed values are "Available" and "Unavailable" and omitted. + // Allowed values are "Available", "Unavailable", or omitted. // // When omitted, the default value is "Available". // - // When set to "Available", the catalog contents will be unpacked and served over the catalog content HTTP server. - // Setting the availabilityMode to "Available" tells clients that they should consider this ClusterCatalog - // and its contents as usable. + // 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 will no longer be served over the catalog content HTTP server. - // When set to this availabilityMode it should be interpreted the same as the ClusterCatalog not existing. - // Setting the availabilityMode to "Unavailable" can be useful in scenarios where a user may not want - // to delete the ClusterCatalog all together, but would still like it to be treated as if it doesn't exist. + // 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" @@ -160,59 +155,53 @@ type ClusterCatalogSpec struct { // ClusterCatalogStatus defines the observed state of ClusterCatalog type ClusterCatalogStatus struct { - // conditions is a representation of the current state for this ClusterCatalog. + // The conditions field represents the current state of this ClusterCatalog. // // The current condition types are Serving and Progressing. // - // The Serving condition is used to represent whether or not the contents of the catalog is being served via the HTTP(S) web server. - // When it has a status of True and a reason of Available, the contents of the catalog are being served. - // When it has a status of False and a reason of Unavailable, the contents of the catalog are not being served because the contents are not yet available. - // When it has a status of False and a reason of UserSpecifiedUnavailable, the contents of the catalog are not being served because the catalog has been intentionally marked as unavailable. + // 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 is used to represent whether or not the ClusterCatalog is progressing or is ready to progress towards a new state. - // When it has a status of True and a reason of Retrying, there was an error in the progression of the ClusterCatalog that may be resolved on subsequent reconciliation attempts. - // When it has a status of True and a reason of Succeeded, the ClusterCatalog has successfully progressed to a new state and is ready to continue progressing. - // When it has a status of False and a reason of Blocked, there was an error in the progression of the ClusterCatalog that requires manual intervention for recovery. + // 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. // - // In the case that the Serving condition is True with reason Available and Progressing is True with reason Retrying, the previously fetched - // catalog contents are still being served via the HTTP(S) web server while we are progressing towards serving a new version of the catalog - // contents. This could occur when we've initially fetched the latest contents from the source for this catalog and when polling for changes - // to the contents we identify that there are updates to the contents. + // 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. + // The resolvedSource field 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. + // The urls field contains the URLs that can be used to access the catalog. // +optional URLs *ClusterCatalogURLs `json:"urls,omitempty"` - // lastUnpacked represents the last time the contents of the - // catalog were extracted from their source format. As an example, - // when using an Image source, the OCI image will be pulled and the - // image layers written to a file-system backed cache. We refer to the - // act of this extraction from the source format as "unpacking". + // The lastUnpacked field 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"` } // ClusterCatalogURLs contains the URLs that can be used to access the catalog. type ClusterCatalogURLs struct { - // base is a cluster-internal URL that provides endpoints for - // accessing the content of the catalog. + // The base field is a cluster-internal URL that provides endpoints for accessing the catalog content. // - // It is expected that clients append the path for the endpoint they wish - // to access. + // 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. + // 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 entirety of the catalog contents in the FBC format + // - /all - this endpoint returns the entire catalog contents in the FBC format // - // As the needs of users and clients of the evolve, new endpoints may be added. + // New endpoints may be added as needs evolve. // // +kubebuilder:validation:Required // +kubebuilder:validation:MaxLength:=525 @@ -226,20 +215,20 @@ type ClusterCatalogURLs struct { // +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" type CatalogSource struct { - // type is a reference to the type of source the catalog is sourced from. - // type is required. + // The type field specifies the type of source for the catalog. + // The type field is required. // // The only allowed value is "Image". // - // When set to "Image", the ClusterCatalog content will be sourced from an OCI 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" // +kubebuilder:validation:Required Type SourceType `json:"type"` - // image is used to configure how catalog contents are sourced from an OCI image. - // This field is required when type is Image, and forbidden otherwise. + // The image field configures how catalog contents are sourced from an OCI image. + // The image field is required when type is Image, and forbidden otherwise. // +optional Image *ImageSource `json:"image,omitempty"` } @@ -249,27 +238,27 @@ type CatalogSource struct { // +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" type ResolvedCatalogSource struct { - // type is a reference to the type of source the catalog is sourced from. - // type is required. + // The type field specifies the type of source for the catalog. + // The type field is required. // // The only allowed value is "Image". // - // When set to "Image", information about the resolved image source will be set in the 'image' field. + // When set to "Image", information about the resolved image source is set in the image field. // // +unionDiscriminator // +kubebuilder:validation:Enum:="Image" // +kubebuilder:validation:Required Type SourceType `json:"type"` - // image is a field containing resolution information for a catalog sourced from an image. - // This field must be set when type is Image, and forbidden otherwise. + // The image field contains resolution information for a catalog sourced from an image. + // The image field must be set when type is Image, and forbidden otherwise. Image *ResolvedImageSource `json:"image"` } // ResolvedImageSource provides information about the resolved source of a Catalog sourced from an image. type ResolvedImageSource struct { - // ref contains the resolved image digest-based reference. - // The digest format is used so users can use other tooling to fetch the exact - // OCI manifests that were used to extract the catalog contents. + // The ref field 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. // +kubebuilder:validation: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." @@ -287,11 +276,11 @@ type ResolvedImageSource struct { // 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" type ImageSource struct { - // ref allows users to define the reference to a container image containing Catalog contents. - // ref is required. - // ref can not be more than 1000 characters. + // The ref field defines the reference to a container image containing catalog contents. + // The ref field is required. + // The ref field cannot be more than 1000 characters. // - // A reference can be broken down into 3 parts - the domain, name, and identifier. + // 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. @@ -337,11 +326,11 @@ type ImageSource struct { // +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 allows the user to set the interval, in minutes, at which the image source should be polled for new content. - // pollIntervalMinutes is optional. - // pollIntervalMinutes can not be specified when ref is a digest-based reference. + // The pollIntervalMinutes field sets the interval, in minutes, at which the image source is polled for new content. + // The pollIntervalMinutes field is optional. + // You cannot specify pollIntervalMinutes when ref is a digest-based reference. // - // When omitted, the image will not be polled for new content. + // When omitted, the image is not polled for new content. // +kubebuilder:validation:Minimum:=1 // +optional PollIntervalMinutes *int `json:"pollIntervalMinutes,omitempty"` diff --git a/api/v1/clusterextension_types.go b/api/v1/clusterextension_types.go index 6de62b0e1..0d9ad25db 100644 --- a/api/v1/clusterextension_types.go +++ b/api/v1/clusterextension_types.go @@ -48,16 +48,15 @@ const ( // ClusterExtensionSpec defines the desired state of ClusterExtension type ClusterExtensionSpec struct { - // namespace is a reference to a Kubernetes namespace. - // This is the namespace in which the provided ServiceAccount must exist. - // It also designates the default namespace where namespace-scoped resources - // for the extension are applied to the cluster. + // The namespace field 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. // - // namespace 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 + // 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 // @@ -67,20 +66,20 @@ type ClusterExtensionSpec struct { // +kubebuilder:validation:Required Namespace string `json:"namespace"` - // serviceAccount is a reference to a ServiceAccount used to perform all interactions - // with the cluster that are required to manage the extension. + // The serviceAccount field 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. - // serviceAccount is required. + // The serviceAccount field is required. // // +kubebuilder:validation:Required ServiceAccount ServiceAccountReference `json:"serviceAccount"` - // source is a required field which selects the installation source of content - // for this ClusterExtension. Selection is performed by setting the sourceType. + // The source field 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, and setting the - // sourcetype to "Catalog" requires the catalog field to also be defined. + // 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): // @@ -92,19 +91,19 @@ type ClusterExtensionSpec struct { // +kubebuilder:validation:Required Source SourceConfig `json:"source"` - // install is an optional field used to configure the installation options - // for the ClusterExtension such as the pre-flight check configuration. + // The install field is optional and configures installation options for the ClusterExtension, + // such as the pre-flight check configuration. // // +optional Install *ClusterExtensionInstallConfig `json:"install,omitempty"` - // config is an optional field used to specify bundle specific configuration - // used to configure the bundle. Configuration is bundle specific and a bundle may provide - // a configuration schema. When not specified, the default configuration of the resolved bundle will be used. + // The config field 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 final manifests will be derived on a best-effort basis. More information on how - // to configure the bundle should be found in its end-user documentation. + // The config field is validated against a configuration schema provided by the resolved bundle. + // If the bundle does not provide a configuration schema, the final manifests are derived on a best-effort basis. + // For more information on how to configure the bundle, see the bundle's end-user documentation. // // // +optional @@ -118,13 +117,12 @@ const SourceTypeCatalog = "Catalog" // +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" type SourceConfig struct { - // sourceType is a required reference to the type of install source. + // The sourceType field is required and specifies the type of install source. // - // Allowed values are "Catalog" + // The only allowed value is "Catalog". // - // When this field is set to "Catalog", information for determining the - // appropriate bundle of content to install will be fetched from - // ClusterCatalog resources existing on the cluster. + // 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 @@ -132,8 +130,8 @@ type SourceConfig struct { // +kubebuilder:validation:Required SourceType string `json:"sourceType"` - // catalog is used to configure how information is sourced from a catalog. - // This field is required when sourceType is "Catalog", and forbidden otherwise. + // The catalog field configures how information is sourced from a catalog. + // The catalog field is required when sourceType is "Catalog", and forbidden otherwise. // // +optional Catalog *CatalogFilter `json:"catalog,omitempty"` @@ -145,11 +143,11 @@ type SourceConfig struct { // +kubebuilder:validation:XValidation:rule="has(self.preflight)",message="at least one of [preflight] are required when install is specified" // +union type ClusterExtensionInstallConfig struct { - // preflight is an optional field that can be used to configure the checks that are - // run before installation or upgrade of the content for the package specified in the packageName field. + // The preflight field 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 will be used. + // When not specified, the default configuration is used. // // +optional Preflight *PreflightConfig `json:"preflight,omitempty"` @@ -161,24 +159,22 @@ type ClusterExtensionInstallConfig struct { // +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 type ClusterExtensionConfig struct { - // configType is a required reference to the type of configuration source. + // The configType field is required and specifies the type of configuration source. // - // Allowed values are "Inline" + // The only allowed value is "Inline". // - // When this field is set to "Inline", the cluster extension configuration is defined inline within the - // ClusterExtension resource. + // When set to "Inline", the cluster extension configuration is defined inline within the ClusterExtension resource. // // +unionDiscriminator // +kubebuilder:validation:Enum:="Inline" // +kubebuilder:validation:Required ConfigType ClusterExtensionConfigType `json:"configType"` - // inline contains JSON or YAML values specified directly in the - // ClusterExtension. + // The inline field contains JSON or YAML values specified directly in the ClusterExtension. // - // inline must be set if configType is 'Inline'. - // inline accepts arbitrary JSON/YAML objects. - // inline is validation at runtime against the schema provided by the bundle if a schema is provided. + // The inline field must be set if configType is "Inline". + // The inline field accepts arbitrary JSON/YAML objects. + // The inline field is validated at runtime against the schema provided by the bundle if a schema is provided. // // +kubebuilder:validation:Type=object // +optional @@ -187,13 +183,12 @@ type ClusterExtensionConfig struct { // CatalogFilter defines the attributes used to identify and filter content from a catalog. type CatalogFilter struct { - // packageName is a reference to the name of the package to be installed - // and is used to filter the content from catalogs. + // The packageName field specifies the name of the package to be installed and is used to filter + // the content from catalogs. // - // packageName 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. + // The packageName field 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 @@ -216,12 +211,13 @@ type CatalogFilter struct { // +kubebuilder:validation:Required PackageName string `json:"packageName"` - // version is an optional semver constraint (a specific version or range of versions). When unspecified, the latest version available will be installed. + // The version field 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. Additional - // comparison strings can be added using the OR operator (||). + // 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 // @@ -295,25 +291,24 @@ type CatalogFilter struct { // +optional Version string `json:"version,omitempty"` - // channels is an optional reference to a set of channels belonging to - // the package specified in the packageName field. + // The channels field 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. + // 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. No more than 256 channels can be specified. + // 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 is used to constrain the set of installable bundles and - // the automated upgrade path. This constraint is an AND operation with the - // version field. For example: + // 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 will be considered installable - // - Automatic upgrades will be constrained to upgrade edges defined by the selected channel + // - 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 will be used to identify valid automatic upgrade paths. + // When unspecified, upgrade edges across all channels are used to identify valid automatic upgrade paths. // // Some examples of valid values are: // - 1.1.x @@ -340,33 +335,28 @@ type CatalogFilter struct { // +optional Channels []string `json:"channels,omitempty"` - // selector is an optional field that can be used - // to filter the set of ClusterCatalogs used in the bundle - // selection process. + // The selector field is optional and filters the set of ClusterCatalogs used in the bundle selection process. // - // When unspecified, all ClusterCatalogs will be 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 an optional field that controls whether - // the upgrade path(s) defined in the catalog are enforced for the package - // referenced in the packageName field. + // The upgradeConstraintPolicy field 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" or "SelfCertified", or omitted. + // Allowed values are "CatalogProvided", "SelfCertified", or omitted. // - // When this field is set to "CatalogProvided", automatic upgrades will only occur - // when upgrade constraints specified by the package author are met. + // When set to "CatalogProvided", automatic upgrades only occur when upgrade constraints specified by the package + // author are met. // - // When this field is set to "SelfCertified", the upgrade constraints specified by - // the package author are ignored. This allows for 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. It is assumed that users have independently verified changes when - // using this option. + // 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 this field is omitted, the default value is "CatalogProvided". + // When omitted, the default value is "CatalogProvided". // // +kubebuilder:validation:Enum:=CatalogProvided;SelfCertified // +kubebuilder:default:=CatalogProvided @@ -376,16 +366,14 @@ type CatalogFilter struct { // ServiceAccountReference identifies the serviceAccount used fo install a ClusterExtension. type ServiceAccountReference struct { - // name is a required, immutable reference to the name of the ServiceAccount - // to be used for installation and management of the content for the package - // specified in the packageName field. + // The name field 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. // - // name 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. + // 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 @@ -411,26 +399,24 @@ type ServiceAccountReference struct { // // +kubebuilder:validation:XValidation:rule="has(self.crdUpgradeSafety)",message="at least one of [crdUpgradeSafety] are required when preflight is specified" type PreflightConfig struct { - // crdUpgradeSafety is used to configure the CRD Upgrade Safety pre-flight - // checks that run prior to upgrades of installed content. + // The crdUpgradeSafety field 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. + // The CRD Upgrade Safety pre-flight check safeguards from unintended consequences of upgrading a CRD, + // such as data loss. CRDUpgradeSafety *CRDUpgradeSafetyPreflightConfig `json:"crdUpgradeSafety"` } // CRDUpgradeSafetyPreflightConfig is the configuration for CRD upgrade safety preflight check. type CRDUpgradeSafetyPreflightConfig struct { - // enforcement is a required field, used to configure the state of the CRD Upgrade Safety pre-flight check. + // The enforcement field 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 will be skipped - // when performing an upgrade operation. This should be used with caution as - // unintended consequences such as data loss can occur. + // 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 will be run when - // performing an upgrade operation. + // When set to "Strict", the CRD Upgrade Safety pre-flight check runs during an upgrade operation. // // +kubebuilder:validation:Enum:="None";"Strict" // +kubebuilder:validation:Required @@ -453,17 +439,16 @@ const ( // BundleMetadata is a representation of the identifying attributes of a bundle. 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. + // The name field 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. // // +kubebuilder:validation: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 a required field and is a reference to the version that this bundle represents - // version follows the semantic versioning standard as defined in https://semver.org/. + // The version field is required and references the version that this bundle represents. + // The version field follows the semantic versioning standard as defined in https://semver.org/. // // +kubebuilder:validation: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" @@ -474,28 +459,28 @@ type BundleMetadata struct { type ClusterExtensionStatus struct { // The set of condition types which apply to all spec.source variations are Installed and Progressing. // - // The Installed condition represents whether or not 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 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. + // The Progressing condition represents whether 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. // - // When the ClusterExtension is sourced from a catalog, if may also communicate a deprecation condition. - // These are indications from a package owner to guide users away from a particular package, channel, or bundle. - // BundleDeprecated is set if the requested bundle version is marked deprecated in the catalog. - // ChannelDeprecated is set if the requested channel is marked deprecated in the catalog. - // PackageDeprecated is set if the requested package is marked deprecated in the catalog. - // Deprecated is a rollup condition that is present when any of the deprecated conditions are present. + // When the ClusterExtension is sourced from a catalog, it may also communicate a deprecation condition. + // These are indications from a package owner to guide users away from a particular package, channel, or bundle: + // - BundleDeprecated is set if the requested bundle version is marked deprecated in the catalog. + // - ChannelDeprecated is set if the requested channel is marked deprecated in the catalog. + // - PackageDeprecated is set if the requested package is marked deprecated in the catalog. + // - Deprecated is a rollup condition that is present when any of the deprecated conditions are present. // // +listType=map // +listMapKey=type // +optional Conditions []metav1.Condition `json:"conditions,omitempty"` - // install is a representation of the current installation status for this ClusterExtension. + // The install field is a representation of the current installation status for this ClusterExtension. // // +optional Install *ClusterExtensionInstallStatus `json:"install,omitempty"` @@ -503,10 +488,10 @@ type ClusterExtensionStatus struct { // ClusterExtensionInstallStatus is a representation of the status of the identified bundle. type ClusterExtensionInstallStatus struct { - // bundle is a required field which represents the identifying attributes of a bundle. + // The bundle field 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. + // A "bundle" is a versioned set of content that represents the resources that need to be applied + // to a cluster to install a package. // // +kubebuilder:validation:Required Bundle BundleMetadata `json:"bundle"` diff --git a/docs/api-reference/olmv1-api-reference.md b/docs/api-reference/olmv1-api-reference.md index 317b46a00..6577da509 100644 --- a/docs/api-reference/olmv1-api-reference.md +++ b/docs/api-reference/olmv1-api-reference.md @@ -46,8 +46,8 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | -| `name` _string_ | 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: \{\}
| -| `version` _string_ | version is a required field and is a reference to the version that this bundle represents
version follows the semantic versioning standard as defined in https://semver.org/. | | Required: \{\}
| +| `name` _string_ | The name field 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: \{\}
| +| `version` _string_ | The version field is required and references the version that this bundle represents.
The version field follows the semantic versioning standard as defined in https://semver.org/. | | Required: \{\}
| #### CRDUpgradeSafetyEnforcement @@ -80,7 +80,7 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | -| `enforcement` _[CRDUpgradeSafetyEnforcement](#crdupgradesafetyenforcement)_ | enforcement is a required field, used to configure 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 will be skipped
when performing an upgrade operation. This should be used with caution as
unintended consequences such as data loss can occur.
When set to "Strict", the CRD Upgrade Safety pre-flight check will be run when
performing an upgrade operation. | | Enum: [None Strict]
Required: \{\}
| +| `enforcement` _[CRDUpgradeSafetyEnforcement](#crdupgradesafetyenforcement)_ | The enforcement field 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. | | Enum: [None Strict]
Required: \{\}
| #### CatalogFilter @@ -96,11 +96,11 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | -| `packageName` _string_ | packageName is a reference to the name of the package to be installed
and is used to filter the content from catalogs.
packageName 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 | | MaxLength: 253
Required: \{\}
| -| `version` _string_ | version is an optional semver constraint (a specific version or range of versions). When unspecified, the latest version available will be 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. Additional
comparison strings can be added 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/ | | MaxLength: 64
| -| `channels` _string array_ | channels is an optional reference to 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. No more than 256 channels can be specified.
When specified, it is used to constrain 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 will be considered installable
- Automatic upgrades will be constrained to upgrade edges defined by the selected channel
When unspecified, upgrade edges across all channels will be 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 | | MaxItems: 256
items:MaxLength: 253
items:XValidation: \{self.matches("^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") channels entries must be valid DNS1123 subdomains \}
| -| `selector` _[LabelSelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#labelselector-v1-meta)_ | selector is an optional field that can be used
to filter the set of ClusterCatalogs used in the bundle
selection process.
When unspecified, all ClusterCatalogs will be used in
the bundle selection process. | | | -| `upgradeConstraintPolicy` _[UpgradeConstraintPolicy](#upgradeconstraintpolicy)_ | upgradeConstraintPolicy is an optional field that controls whether
the upgrade path(s) defined in the catalog are enforced for the package
referenced in the packageName field.
Allowed values are: "CatalogProvided" or "SelfCertified", or omitted.
When this field is set to "CatalogProvided", automatic upgrades will only occur
when upgrade constraints specified by the package author are met.
When this field is set to "SelfCertified", the upgrade constraints specified by
the package author are ignored. This allows for 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. It is assumed that users have independently verified changes when
using this option.
When this field is omitted, the default value is "CatalogProvided". | CatalogProvided | Enum: [CatalogProvided SelfCertified]
| +| `packageName` _string_ | The packageName field specifies the name of the package to be installed and is used to filter
the content from catalogs.
The packageName field 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 | | MaxLength: 253
Required: \{\}
| +| `version` _string_ | The version field 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/ | | MaxLength: 64
| +| `channels` _string array_ | The channels field 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 | | MaxItems: 256
items:MaxLength: 253
items:XValidation: \{self.matches("^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") channels entries must be valid DNS1123 subdomains \}
| +| `selector` _[LabelSelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#labelselector-v1-meta)_ | The selector field 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. | | | +| `upgradeConstraintPolicy` _[UpgradeConstraintPolicy](#upgradeconstraintpolicy)_ | The upgradeConstraintPolicy field 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". | CatalogProvided | Enum: [CatalogProvided SelfCertified]
| #### CatalogSource @@ -117,15 +117,15 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | -| `type` _[SourceType](#sourcetype)_ | type is a reference to the type of source the catalog is sourced from.
type is required.
The only allowed value is "Image".
When set to "Image", the ClusterCatalog content will be 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. | | Enum: [Image]
Required: \{\}
| -| `image` _[ImageSource](#imagesource)_ | image is used to configure how catalog contents are sourced from an OCI image.
This field is required when type is Image, and forbidden otherwise. | | | +| `type` _[SourceType](#sourcetype)_ | The type field specifies the type of source for the catalog.
The type field is required.
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. | | Enum: [Image]
Required: \{\}
| +| `image` _[ImageSource](#imagesource)_ | The image field configures how catalog contents are sourced from an OCI image.
The image field is required when type is Image, and forbidden otherwise. | | | #### ClusterCatalog -ClusterCatalog enables users to make File-Based Catalog (FBC) catalog data available to the cluster. +The ClusterCatalog resource 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 @@ -140,8 +140,8 @@ _Appears in:_ | `kind` _string_ | Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | | | `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | | | `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | -| `spec` _[ClusterCatalogSpec](#clustercatalogspec)_ | spec is the desired state of the ClusterCatalog.
spec is required.
The controller will work to ensure that the desired
catalog is unpacked and served over the catalog content HTTP server. | | Required: \{\}
| -| `status` _[ClusterCatalogStatus](#clustercatalogstatus)_ | status contains information about the state of the ClusterCatalog such as:
- Whether or not the catalog contents are being served via the catalog content HTTP server
- Whether or not the ClusterCatalog is progressing to a new state
- A reference to the source from which the catalog contents were retrieved | | | +| `spec` _[ClusterCatalogSpec](#clustercatalogspec)_ | The spec field defines the desired state of the ClusterCatalog.
The spec field is required.
The controller ensures that the catalog is unpacked and served over the catalog content HTTP server. | | Required: \{\}
| +| `status` _[ClusterCatalogStatus](#clustercatalogstatus)_ | The status field 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 | | | #### ClusterCatalogList @@ -177,9 +177,9 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | -| `source` _[CatalogSource](#catalogsource)_ | source allows a user to define the source of a catalog.
A "catalog" contains information on content that can be installed on a cluster.
Providing a catalog source makes the contents of the catalog discoverable and usable by
other on-cluster components.
These on-cluster components may do a variety of things with this information, such as
presenting the content in a GUI dashboard or installing 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.
source is a required field.
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: \{\}
| -| `priority` _integer_ | priority allows the user to define a priority for a ClusterCatalog.
priority is optional.
A ClusterCatalog's priority is used by clients as a tie-breaker between ClusterCatalogs that meet the client's requirements.
A higher number means higher priority.
It is up to clients to decide how to handle scenarios where multiple ClusterCatalogs with the same priority meet their requirements.
When deciding how to break the tie in this scenario, it is recommended that clients prompt their users for additional input.
When omitted, the default priority is 0 because that is the zero value of integers.
Negative numbers can be used to specify a priority lower than the default.
Positive numbers can be used to specify a priority higher than the default.
The lowest possible value is -2147483648.
The highest possible value is 2147483647. | 0 | | -| `availabilityMode` _[AvailabilityMode](#availabilitymode)_ | availabilityMode allows users to define how the ClusterCatalog is made available to clients on the cluster.
availabilityMode is optional.
Allowed values are "Available" and "Unavailable" and omitted.
When omitted, the default value is "Available".
When set to "Available", the catalog contents will be unpacked and served over the catalog content HTTP server.
Setting the availabilityMode to "Available" tells clients that they should consider this ClusterCatalog
and its contents as usable.
When set to "Unavailable", the catalog contents will no longer be served over the catalog content HTTP server.
When set to this availabilityMode it should be interpreted the same as the ClusterCatalog not existing.
Setting the availabilityMode to "Unavailable" can be useful in scenarios where a user may not want
to delete the ClusterCatalog all together, but would still like it to be treated as if it doesn't exist. | Available | Enum: [Unavailable Available]
| +| `source` _[CatalogSource](#catalogsource)_ | The source field 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.
The source field is required.
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: \{\}
| +| `priority` _integer_ | The priority field defines a priority for this ClusterCatalog.
The priority field is optional.
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. | 0 | | +| `availabilityMode` _[AvailabilityMode](#availabilitymode)_ | The availabilityMode field defines how the ClusterCatalog is made available to clients on the cluster.
The availabilityMode field is optional.
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. | Available | Enum: [Unavailable Available]
| #### ClusterCatalogStatus @@ -195,10 +195,10 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | -| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#condition-v1-meta) array_ | conditions is a representation of the current state for this ClusterCatalog.
The current condition types are Serving and Progressing.
The Serving condition is used to represent whether or not the contents of the catalog is being served via the HTTP(S) web server.
When it has a status of True and a reason of Available, the contents of the catalog are being served.
When it has a status of False and a reason of Unavailable, the contents of the catalog are not being served because the contents are not yet available.
When it has a status of False and a reason of UserSpecifiedUnavailable, the contents of the catalog are not being served because the catalog has been intentionally marked as unavailable.
The Progressing condition is used to represent whether or not the ClusterCatalog is progressing or is ready to progress towards a new state.
When it has a status of True and a reason of Retrying, there was an error in the progression of the ClusterCatalog that may be resolved on subsequent reconciliation attempts.
When it has a status of True and a reason of Succeeded, the ClusterCatalog has successfully progressed to a new state and is ready to continue progressing.
When it has a status of False and a reason of Blocked, there was an error in the progression of the ClusterCatalog that requires manual intervention for recovery.
In the case that the Serving condition is True with reason Available and Progressing is True with reason Retrying, the previously fetched
catalog contents are still being served via the HTTP(S) web server while we are progressing towards serving a new version of the catalog
contents. This could occur when we've initially fetched the latest contents from the source for this catalog and when polling for changes
to the contents we identify that there are updates to the contents. | | | -| `resolvedSource` _[ResolvedCatalogSource](#resolvedcatalogsource)_ | resolvedSource contains information about the resolved source based on the source type. | | | -| `urls` _[ClusterCatalogURLs](#clustercatalogurls)_ | urls contains the URLs that can be used to access the catalog. | | | -| `lastUnpacked` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#time-v1-meta)_ | lastUnpacked represents the last time the contents of the
catalog were extracted from their source format. As an example,
when using an Image source, the OCI image will be pulled and the
image layers written to a file-system backed cache. We refer to the
act of this extraction from the source format as "unpacking". | | | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#condition-v1-meta) array_ | The conditions field 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. | | | +| `resolvedSource` _[ResolvedCatalogSource](#resolvedcatalogsource)_ | The resolvedSource field contains information about the resolved source based on the source type. | | | +| `urls` _[ClusterCatalogURLs](#clustercatalogurls)_ | The urls field contains the URLs that can be used to access the catalog. | | | +| `lastUnpacked` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#time-v1-meta)_ | The lastUnpacked field 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". | | | #### ClusterCatalogURLs @@ -214,7 +214,7 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | -| `base` _string_ | base is a cluster-internal URL that provides endpoints for
accessing the content of the catalog.
It is expected that clients append the path for the endpoint they wish
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 entirety of the catalog contents in the FBC format
As the needs of users and clients of the evolve, new endpoints may be added. | | MaxLength: 525
Required: \{\}
| +| `base` _string_ | The base field 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. | | MaxLength: 525
Required: \{\}
| #### ClusterExtension @@ -253,8 +253,8 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | -| `configType` _[ClusterExtensionConfigType](#clusterextensionconfigtype)_ | configType is a required reference to the type of configuration source.
Allowed values are "Inline"
When this field is set to "Inline", the cluster extension configuration is defined inline within the
ClusterExtension resource. | | Enum: [Inline]
Required: \{\}
| -| `inline` _[JSON](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#json-v1-apiextensions-k8s-io)_ | inline contains JSON or YAML values specified directly in the
ClusterExtension.
inline must be set if configType is 'Inline'.
inline accepts arbitrary JSON/YAML objects.
inline is validation at runtime against the schema provided by the bundle if a schema is provided. | | Type: object
| +| `configType` _[ClusterExtensionConfigType](#clusterextensionconfigtype)_ | The configType field 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. | | Enum: [Inline]
Required: \{\}
| +| `inline` _[JSON](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#json-v1-apiextensions-k8s-io)_ | The inline field contains JSON or YAML values specified directly in the ClusterExtension.
The inline field must be set if configType is "Inline".
The inline field accepts arbitrary JSON/YAML objects.
The inline field is validated at runtime against the schema provided by the bundle if a schema is provided. | | Type: object
| #### ClusterExtensionConfigType @@ -287,7 +287,7 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | -| `preflight` _[PreflightConfig](#preflightconfig)_ | preflight is an optional field that can be used to configure the checks that are
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 will be used. | | | +| `preflight` _[PreflightConfig](#preflightconfig)_ | The preflight field 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. | | | #### ClusterExtensionInstallStatus @@ -303,7 +303,7 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | -| `bundle` _[BundleMetadata](#bundlemetadata)_ | bundle is a required field which 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](#bundlemetadata)_ | The bundle field 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: \{\}
| #### ClusterExtensionList @@ -339,11 +339,11 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | -| `namespace` _string_ | namespace is a reference to a Kubernetes namespace.
This is the namespace in which 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.
namespace 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 | | MaxLength: 63
Required: \{\}
| -| `serviceAccount` _[ServiceAccountReference](#serviceaccountreference)_ | serviceAccount is a reference to 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.
serviceAccount is required. | | Required: \{\}
| -| `source` _[SourceConfig](#sourceconfig)_ | source is a required field which selects the installation source of content
for this ClusterExtension. Selection is performed by setting the sourceType.
Catalog is currently the only implemented sourceType, and setting the
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: \{\}
| -| `install` _[ClusterExtensionInstallConfig](#clusterextensioninstallconfig)_ | install is an optional field used to configure the installation options
for the ClusterExtension such as the pre-flight check configuration. | | | -| `config` _[ClusterExtensionConfig](#clusterextensionconfig)_ | config is an optional field used to specify bundle specific configuration
used to configure the bundle. Configuration is bundle specific and a bundle may provide
a configuration schema. When not specified, the default configuration of the resolved bundle will be used.
config is validated against a configuration schema provided by the resolved bundle. If the bundle does not provide
a configuration schema the final manifests will be derived on a best-effort basis. More information on how
to configure the bundle should be found in its end-user documentation.
| | | +| `namespace` _string_ | The namespace field 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 | | MaxLength: 63
Required: \{\}
| +| `serviceAccount` _[ServiceAccountReference](#serviceaccountreference)_ | The serviceAccount field 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: \{\}
| +| `source` _[SourceConfig](#sourceconfig)_ | The source field 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: \{\}
| +| `install` _[ClusterExtensionInstallConfig](#clusterextensioninstallconfig)_ | The install field is optional and configures installation options for the ClusterExtension,
such as the pre-flight check configuration. | | | +| `config` _[ClusterExtensionConfig](#clusterextensionconfig)_ | The config field 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.
The config field is validated against a configuration schema provided by the resolved bundle.
If the bundle does not provide a configuration schema, the final manifests are derived on a best-effort basis.
For more information on how to configure the bundle, see the bundle's end-user documentation.
| | | #### ClusterExtensionStatus @@ -359,8 +359,8 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | -| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#condition-v1-meta) array_ | The set of condition types which apply to all spec.source variations are Installed and Progressing.
The Installed condition represents whether or not 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.
When the ClusterExtension is sourced from a catalog, if may also communicate a deprecation condition.
These are indications from a package owner to guide users away from a particular package, channel, or bundle.
BundleDeprecated is set if the requested bundle version is marked deprecated in the catalog.
ChannelDeprecated is set if the requested channel is marked deprecated in the catalog.
PackageDeprecated is set if the requested package is marked deprecated in the catalog.
Deprecated is a rollup condition that is present when any of the deprecated conditions are present. | | | -| `install` _[ClusterExtensionInstallStatus](#clusterextensioninstallstatus)_ | install is a representation of the current installation status for this ClusterExtension. | | | +| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#condition-v1-meta) array_ | 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 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.
When the ClusterExtension is sourced from a catalog, it may also communicate a deprecation condition.
These are indications from a package owner to guide users away from a particular package, channel, or bundle:
- BundleDeprecated is set if the requested bundle version is marked deprecated in the catalog.
- ChannelDeprecated is set if the requested channel is marked deprecated in the catalog.
- PackageDeprecated is set if the requested package is marked deprecated in the catalog.
- Deprecated is a rollup condition that is present when any of the deprecated conditions are present. | | | +| `install` _[ClusterExtensionInstallStatus](#clusterextensioninstallstatus)_ | The install field is a representation of the current installation status for this ClusterExtension. | | | @@ -381,8 +381,8 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | -| `ref` _string_ | ref allows users to define the reference to a container image containing Catalog contents.
ref is required.
ref can not be more than 1000 characters.
A reference can be broken down into 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" | | MaxLength: 1000
Required: \{\}
| -| `pollIntervalMinutes` _integer_ | pollIntervalMinutes allows the user to set the interval, in minutes, at which the image source should be polled for new content.
pollIntervalMinutes is optional.
pollIntervalMinutes can not be specified when ref is a digest-based reference.
When omitted, the image will not be polled for new content. | | Minimum: 1
| +| `ref` _string_ | The ref field defines the reference to a container image containing catalog contents.
The ref field is required.
The ref field 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" | | MaxLength: 1000
Required: \{\}
| +| `pollIntervalMinutes` _integer_ | The pollIntervalMinutes field sets the interval, in minutes, at which the image source is polled for new content.
The pollIntervalMinutes field is optional.
You cannot specify pollIntervalMinutes when ref is a digest-based reference.
When omitted, the image is not polled for new content. | | Minimum: 1
| #### PreflightConfig @@ -398,7 +398,7 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | -| `crdUpgradeSafety` _[CRDUpgradeSafetyPreflightConfig](#crdupgradesafetypreflightconfig)_ | crdUpgradeSafety is used to configure the CRD Upgrade Safety pre-flight
checks that run prior to 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](#crdupgradesafetypreflightconfig)_ | The crdUpgradeSafety field 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. | | | #### ResolvedCatalogSource @@ -415,8 +415,8 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | -| `type` _[SourceType](#sourcetype)_ | type is a reference to the type of source the catalog is sourced from.
type is required.
The only allowed value is "Image".
When set to "Image", information about the resolved image source will be set in the 'image' field. | | Enum: [Image]
Required: \{\}
| -| `image` _[ResolvedImageSource](#resolvedimagesource)_ | image is a field containing resolution information for a catalog sourced from an image.
This field must be set when type is Image, and forbidden otherwise. | | | +| `type` _[SourceType](#sourcetype)_ | The type field specifies the type of source for the catalog.
The type field is required.
The only allowed value is "Image".
When set to "Image", information about the resolved image source is set in the image field. | | Enum: [Image]
Required: \{\}
| +| `image` _[ResolvedImageSource](#resolvedimagesource)_ | The image field contains resolution information for a catalog sourced from an image.
The image field must be set when type is Image, and forbidden otherwise. | | | #### ResolvedImageSource @@ -432,7 +432,7 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | -| `ref` _string_ | ref contains the resolved image digest-based reference.
The digest format is used so users can use other tooling to fetch the exact
OCI manifests that were used to extract the catalog contents. | | MaxLength: 1000
Required: \{\}
| +| `ref` _string_ | The ref field 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. | | MaxLength: 1000
Required: \{\}
| #### ServiceAccountReference @@ -448,7 +448,7 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | -| `name` _string_ | name is a required, immutable reference to the name of the ServiceAccount
to be used for installation and management of the content for the package
specified in the packageName field.
This ServiceAccount must exist in the installNamespace.
name 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 | | MaxLength: 253
Required: \{\}
| +| `name` _string_ | The name field 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 | | MaxLength: 253
Required: \{\}
| #### SourceConfig @@ -464,8 +464,8 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | -| `sourceType` _string_ | sourceType is a required reference to the type of install source.
Allowed values are "Catalog"
When this field is set to "Catalog", information for determining the
appropriate bundle of content to install will be fetched from
ClusterCatalog resources existing on the cluster.
When using the Catalog sourceType, the catalog field must also be set. | | Enum: [Catalog]
Required: \{\}
| -| `catalog` _[CatalogFilter](#catalogfilter)_ | catalog is used to configure how information is sourced from a catalog.
This field is required when sourceType is "Catalog", and forbidden otherwise. | | | +| `sourceType` _string_ | The sourceType field 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. | | Enum: [Catalog]
Required: \{\}
| +| `catalog` _[CatalogFilter](#catalogfilter)_ | The catalog field configures how information is sourced from a catalog.
The catalog field is required when sourceType is "Catalog", and forbidden otherwise. | | | #### SourceType diff --git a/helm/olmv1/base/catalogd/crd/experimental/olm.operatorframework.io_clustercatalogs.yaml b/helm/olmv1/base/catalogd/crd/experimental/olm.operatorframework.io_clustercatalogs.yaml index c78a57b92..86d870293 100644 --- a/helm/olmv1/base/catalogd/crd/experimental/olm.operatorframework.io_clustercatalogs.yaml +++ b/helm/olmv1/base/catalogd/crd/experimental/olm.operatorframework.io_clustercatalogs.yaml @@ -29,7 +29,7 @@ spec: schema: openAPIV3Schema: description: |- - ClusterCatalog enables users to make File-Based Catalog (FBC) catalog data available to the cluster. + The ClusterCatalog resource 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 properties: apiVersion: @@ -51,29 +51,26 @@ spec: type: object spec: description: |- - spec is the desired state of the ClusterCatalog. - spec is required. - The controller will work to ensure that the desired - catalog is unpacked and served over the catalog content HTTP server. + The spec field defines the desired state of the ClusterCatalog. + The spec field is required. + The controller ensures that the catalog is unpacked and served over the catalog content HTTP server. properties: availabilityMode: default: Available description: |- - availabilityMode allows users to define how the ClusterCatalog is made available to clients on the cluster. - availabilityMode is optional. + The availabilityMode field defines how the ClusterCatalog is made available to clients on the cluster. + The availabilityMode field is optional. - Allowed values are "Available" and "Unavailable" and omitted. + Allowed values are "Available", "Unavailable", or omitted. When omitted, the default value is "Available". - When set to "Available", the catalog contents will be unpacked and served over the catalog content HTTP server. - Setting the availabilityMode to "Available" tells clients that they should consider this ClusterCatalog - and its contents as usable. + 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 will no longer be served over the catalog content HTTP server. - When set to this availabilityMode it should be interpreted the same as the ClusterCatalog not existing. - Setting the availabilityMode to "Unavailable" can be useful in scenarios where a user may not want - to delete the ClusterCatalog all together, but would still like it to be treated as if it doesn't exist. + 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. enum: - Unavailable - Available @@ -81,19 +78,19 @@ spec: priority: default: 0 description: |- - priority allows the user to define a priority for a ClusterCatalog. - priority is optional. + The priority field defines a priority for this ClusterCatalog. + The priority field is optional. - A ClusterCatalog's priority is used by clients as a tie-breaker between ClusterCatalogs that meet the client's requirements. - A higher number means higher priority. + Clients use the ClusterCatalog priority as a tie-breaker between ClusterCatalogs that meet their requirements. + Higher numbers mean higher priority. - It is up to clients to decide how to handle scenarios where multiple ClusterCatalogs with the same priority meet their requirements. - When deciding how to break the tie in this scenario, it is recommended that clients prompt their users for additional input. + 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 because that is the zero value of integers. + When omitted, the default priority is 0. - Negative numbers can be used to specify a priority lower than the default. - Positive numbers can be used to specify a priority higher than the default. + 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. @@ -101,15 +98,13 @@ spec: type: integer source: description: |- - source allows a user to define the source of a catalog. - A "catalog" contains information on content that can be installed on a cluster. - Providing a catalog source makes the contents of the catalog discoverable and usable by - other on-cluster components. - These on-cluster components may do a variety of things with this information, such as - presenting the content in a GUI dashboard or installing content from the catalog on the cluster. + The source field 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. - source is a required field. + The source field is required. Below is a minimal example of a ClusterCatalogSpec that sources a catalog from an image: @@ -120,25 +115,25 @@ spec: properties: image: description: |- - image is used to configure how catalog contents are sourced from an OCI image. - This field is required when type is Image, and forbidden otherwise. + The image field configures how catalog contents are sourced from an OCI image. + The image field is required when type is Image, and forbidden otherwise. properties: pollIntervalMinutes: description: |- - pollIntervalMinutes allows the user to set the interval, in minutes, at which the image source should be polled for new content. - pollIntervalMinutes is optional. - pollIntervalMinutes can not be specified when ref is a digest-based reference. + The pollIntervalMinutes field sets the interval, in minutes, at which the image source is polled for new content. + The pollIntervalMinutes field is optional. + You cannot specify pollIntervalMinutes when ref is a digest-based reference. - When omitted, the image will not be polled for new content. + When omitted, the image is not polled for new content. minimum: 1 type: integer ref: description: |- - ref allows users to define the reference to a container image containing Catalog contents. - ref is required. - ref can not be more than 1000 characters. + The ref field defines the reference to a container image containing catalog contents. + The ref field is required. + The ref field cannot be more than 1000 characters. - A reference can be broken down into 3 parts - the domain, name, and identifier. + 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. @@ -221,12 +216,12 @@ spec: : true' type: description: |- - type is a reference to the type of source the catalog is sourced from. - type is required. + The type field specifies the type of source for the catalog. + The type field is required. The only allowed value is "Image". - When set to "Image", the ClusterCatalog content will be sourced from an OCI 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. enum: - Image @@ -244,31 +239,30 @@ spec: type: object status: description: |- - status contains information about the state of the ClusterCatalog such as: - - Whether or not the catalog contents are being served via the catalog content HTTP server - - Whether or not the ClusterCatalog is progressing to a new state + The status field 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 properties: conditions: description: |- - conditions is a representation of the current state for this ClusterCatalog. + The conditions field represents the current state of this ClusterCatalog. The current condition types are Serving and Progressing. - The Serving condition is used to represent whether or not the contents of the catalog is being served via the HTTP(S) web server. - When it has a status of True and a reason of Available, the contents of the catalog are being served. - When it has a status of False and a reason of Unavailable, the contents of the catalog are not being served because the contents are not yet available. - When it has a status of False and a reason of UserSpecifiedUnavailable, the contents of the catalog are not being served because the catalog has been intentionally marked as unavailable. + 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 is used to represent whether or not the ClusterCatalog is progressing or is ready to progress towards a new state. - When it has a status of True and a reason of Retrying, there was an error in the progression of the ClusterCatalog that may be resolved on subsequent reconciliation attempts. - When it has a status of True and a reason of Succeeded, the ClusterCatalog has successfully progressed to a new state and is ready to continue progressing. - When it has a status of False and a reason of Blocked, there was an error in the progression of the ClusterCatalog that requires manual intervention for recovery. + 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. - In the case that the Serving condition is True with reason Available and Progressing is True with reason Retrying, the previously fetched - catalog contents are still being served via the HTTP(S) web server while we are progressing towards serving a new version of the catalog - contents. This could occur when we've initially fetched the latest contents from the source for this catalog and when polling for changes - to the contents we identify that there are updates to the contents. + 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. items: description: Condition contains details for one aspect of the current state of this API Resource. @@ -329,27 +323,25 @@ spec: x-kubernetes-list-type: map lastUnpacked: description: |- - lastUnpacked represents the last time the contents of the - catalog were extracted from their source format. As an example, - when using an Image source, the OCI image will be pulled and the - image layers written to a file-system backed cache. We refer to the - act of this extraction from the source format as "unpacking". + The lastUnpacked field 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". format: date-time type: string resolvedSource: - description: resolvedSource contains information about the resolved - source based on the source type. + description: The resolvedSource field contains information about the + resolved source based on the source type. properties: image: description: |- - image is a field containing resolution information for a catalog sourced from an image. - This field must be set when type is Image, and forbidden otherwise. + The image field contains resolution information for a catalog sourced from an image. + The image field must be set when type is Image, and forbidden otherwise. properties: ref: description: |- - ref contains the resolved image digest-based reference. - The digest format is used so users can use other tooling to fetch the exact - OCI manifests that were used to extract the catalog contents. + The ref field 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. maxLength: 1000 type: string x-kubernetes-validations: @@ -383,12 +375,12 @@ spec: type: object type: description: |- - type is a reference to the type of source the catalog is sourced from. - type is required. + The type field specifies the type of source for the catalog. + The type field is required. The only allowed value is "Image". - When set to "Image", information about the resolved image source will be set in the 'image' field. + When set to "Image", information about the resolved image source is set in the image field. enum: - Image type: string @@ -402,24 +394,21 @@ spec: rule: 'has(self.type) && self.type == ''Image'' ? has(self.image) : !has(self.image)' urls: - description: urls contains the URLs that can be used to access the - catalog. + description: The urls field contains the URLs that can be used to + access the catalog. properties: base: description: |- - base is a cluster-internal URL that provides endpoints for - accessing the content of the catalog. + The base field is a cluster-internal URL that provides endpoints for accessing the catalog content. - It is expected that clients append the path for the endpoint they wish - to access. + 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. + 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 entirety of the catalog contents in the FBC format + - /all - this endpoint returns the entire catalog contents in the FBC format - As the needs of users and clients of the evolve, new endpoints may be added. + New endpoints may be added as needs evolve. maxLength: 525 type: string x-kubernetes-validations: diff --git a/helm/olmv1/base/catalogd/crd/standard/olm.operatorframework.io_clustercatalogs.yaml b/helm/olmv1/base/catalogd/crd/standard/olm.operatorframework.io_clustercatalogs.yaml index 94f1d7121..15db3e7d2 100644 --- a/helm/olmv1/base/catalogd/crd/standard/olm.operatorframework.io_clustercatalogs.yaml +++ b/helm/olmv1/base/catalogd/crd/standard/olm.operatorframework.io_clustercatalogs.yaml @@ -29,7 +29,7 @@ spec: schema: openAPIV3Schema: description: |- - ClusterCatalog enables users to make File-Based Catalog (FBC) catalog data available to the cluster. + The ClusterCatalog resource 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 properties: apiVersion: @@ -51,29 +51,26 @@ spec: type: object spec: description: |- - spec is the desired state of the ClusterCatalog. - spec is required. - The controller will work to ensure that the desired - catalog is unpacked and served over the catalog content HTTP server. + The spec field defines the desired state of the ClusterCatalog. + The spec field is required. + The controller ensures that the catalog is unpacked and served over the catalog content HTTP server. properties: availabilityMode: default: Available description: |- - availabilityMode allows users to define how the ClusterCatalog is made available to clients on the cluster. - availabilityMode is optional. + The availabilityMode field defines how the ClusterCatalog is made available to clients on the cluster. + The availabilityMode field is optional. - Allowed values are "Available" and "Unavailable" and omitted. + Allowed values are "Available", "Unavailable", or omitted. When omitted, the default value is "Available". - When set to "Available", the catalog contents will be unpacked and served over the catalog content HTTP server. - Setting the availabilityMode to "Available" tells clients that they should consider this ClusterCatalog - and its contents as usable. + 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 will no longer be served over the catalog content HTTP server. - When set to this availabilityMode it should be interpreted the same as the ClusterCatalog not existing. - Setting the availabilityMode to "Unavailable" can be useful in scenarios where a user may not want - to delete the ClusterCatalog all together, but would still like it to be treated as if it doesn't exist. + 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. enum: - Unavailable - Available @@ -81,19 +78,19 @@ spec: priority: default: 0 description: |- - priority allows the user to define a priority for a ClusterCatalog. - priority is optional. + The priority field defines a priority for this ClusterCatalog. + The priority field is optional. - A ClusterCatalog's priority is used by clients as a tie-breaker between ClusterCatalogs that meet the client's requirements. - A higher number means higher priority. + Clients use the ClusterCatalog priority as a tie-breaker between ClusterCatalogs that meet their requirements. + Higher numbers mean higher priority. - It is up to clients to decide how to handle scenarios where multiple ClusterCatalogs with the same priority meet their requirements. - When deciding how to break the tie in this scenario, it is recommended that clients prompt their users for additional input. + 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 because that is the zero value of integers. + When omitted, the default priority is 0. - Negative numbers can be used to specify a priority lower than the default. - Positive numbers can be used to specify a priority higher than the default. + 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. @@ -101,15 +98,13 @@ spec: type: integer source: description: |- - source allows a user to define the source of a catalog. - A "catalog" contains information on content that can be installed on a cluster. - Providing a catalog source makes the contents of the catalog discoverable and usable by - other on-cluster components. - These on-cluster components may do a variety of things with this information, such as - presenting the content in a GUI dashboard or installing content from the catalog on the cluster. + The source field 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. - source is a required field. + The source field is required. Below is a minimal example of a ClusterCatalogSpec that sources a catalog from an image: @@ -120,25 +115,25 @@ spec: properties: image: description: |- - image is used to configure how catalog contents are sourced from an OCI image. - This field is required when type is Image, and forbidden otherwise. + The image field configures how catalog contents are sourced from an OCI image. + The image field is required when type is Image, and forbidden otherwise. properties: pollIntervalMinutes: description: |- - pollIntervalMinutes allows the user to set the interval, in minutes, at which the image source should be polled for new content. - pollIntervalMinutes is optional. - pollIntervalMinutes can not be specified when ref is a digest-based reference. + The pollIntervalMinutes field sets the interval, in minutes, at which the image source is polled for new content. + The pollIntervalMinutes field is optional. + You cannot specify pollIntervalMinutes when ref is a digest-based reference. - When omitted, the image will not be polled for new content. + When omitted, the image is not polled for new content. minimum: 1 type: integer ref: description: |- - ref allows users to define the reference to a container image containing Catalog contents. - ref is required. - ref can not be more than 1000 characters. + The ref field defines the reference to a container image containing catalog contents. + The ref field is required. + The ref field cannot be more than 1000 characters. - A reference can be broken down into 3 parts - the domain, name, and identifier. + 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. @@ -221,12 +216,12 @@ spec: : true' type: description: |- - type is a reference to the type of source the catalog is sourced from. - type is required. + The type field specifies the type of source for the catalog. + The type field is required. The only allowed value is "Image". - When set to "Image", the ClusterCatalog content will be sourced from an OCI 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. enum: - Image @@ -244,31 +239,30 @@ spec: type: object status: description: |- - status contains information about the state of the ClusterCatalog such as: - - Whether or not the catalog contents are being served via the catalog content HTTP server - - Whether or not the ClusterCatalog is progressing to a new state + The status field 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 properties: conditions: description: |- - conditions is a representation of the current state for this ClusterCatalog. + The conditions field represents the current state of this ClusterCatalog. The current condition types are Serving and Progressing. - The Serving condition is used to represent whether or not the contents of the catalog is being served via the HTTP(S) web server. - When it has a status of True and a reason of Available, the contents of the catalog are being served. - When it has a status of False and a reason of Unavailable, the contents of the catalog are not being served because the contents are not yet available. - When it has a status of False and a reason of UserSpecifiedUnavailable, the contents of the catalog are not being served because the catalog has been intentionally marked as unavailable. + 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 is used to represent whether or not the ClusterCatalog is progressing or is ready to progress towards a new state. - When it has a status of True and a reason of Retrying, there was an error in the progression of the ClusterCatalog that may be resolved on subsequent reconciliation attempts. - When it has a status of True and a reason of Succeeded, the ClusterCatalog has successfully progressed to a new state and is ready to continue progressing. - When it has a status of False and a reason of Blocked, there was an error in the progression of the ClusterCatalog that requires manual intervention for recovery. + 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. - In the case that the Serving condition is True with reason Available and Progressing is True with reason Retrying, the previously fetched - catalog contents are still being served via the HTTP(S) web server while we are progressing towards serving a new version of the catalog - contents. This could occur when we've initially fetched the latest contents from the source for this catalog and when polling for changes - to the contents we identify that there are updates to the contents. + 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. items: description: Condition contains details for one aspect of the current state of this API Resource. @@ -329,27 +323,25 @@ spec: x-kubernetes-list-type: map lastUnpacked: description: |- - lastUnpacked represents the last time the contents of the - catalog were extracted from their source format. As an example, - when using an Image source, the OCI image will be pulled and the - image layers written to a file-system backed cache. We refer to the - act of this extraction from the source format as "unpacking". + The lastUnpacked field 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". format: date-time type: string resolvedSource: - description: resolvedSource contains information about the resolved - source based on the source type. + description: The resolvedSource field contains information about the + resolved source based on the source type. properties: image: description: |- - image is a field containing resolution information for a catalog sourced from an image. - This field must be set when type is Image, and forbidden otherwise. + The image field contains resolution information for a catalog sourced from an image. + The image field must be set when type is Image, and forbidden otherwise. properties: ref: description: |- - ref contains the resolved image digest-based reference. - The digest format is used so users can use other tooling to fetch the exact - OCI manifests that were used to extract the catalog contents. + The ref field 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. maxLength: 1000 type: string x-kubernetes-validations: @@ -383,12 +375,12 @@ spec: type: object type: description: |- - type is a reference to the type of source the catalog is sourced from. - type is required. + The type field specifies the type of source for the catalog. + The type field is required. The only allowed value is "Image". - When set to "Image", information about the resolved image source will be set in the 'image' field. + When set to "Image", information about the resolved image source is set in the image field. enum: - Image type: string @@ -402,24 +394,21 @@ spec: rule: 'has(self.type) && self.type == ''Image'' ? has(self.image) : !has(self.image)' urls: - description: urls contains the URLs that can be used to access the - catalog. + description: The urls field contains the URLs that can be used to + access the catalog. properties: base: description: |- - base is a cluster-internal URL that provides endpoints for - accessing the content of the catalog. + The base field is a cluster-internal URL that provides endpoints for accessing the catalog content. - It is expected that clients append the path for the endpoint they wish - to access. + 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. + 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 entirety of the catalog contents in the FBC format + - /all - this endpoint returns the entire catalog contents in the FBC format - As the needs of users and clients of the evolve, new endpoints may be added. + New endpoints may be added as needs evolve. maxLength: 525 type: string x-kubernetes-validations: diff --git a/helm/olmv1/base/operator-controller/crd/experimental/olm.operatorframework.io_clusterextensions.yaml b/helm/olmv1/base/operator-controller/crd/experimental/olm.operatorframework.io_clusterextensions.yaml index 1038b7fdf..b10cd2d43 100644 --- a/helm/olmv1/base/operator-controller/crd/experimental/olm.operatorframework.io_clusterextensions.yaml +++ b/helm/olmv1/base/operator-controller/crd/experimental/olm.operatorframework.io_clusterextensions.yaml @@ -59,33 +59,31 @@ spec: properties: config: description: |- - config is an optional field used to specify bundle specific configuration - used to configure the bundle. Configuration is bundle specific and a bundle may provide - a configuration schema. When not specified, the default configuration of the resolved bundle will be used. + The config field 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 final manifests will be derived on a best-effort basis. More information on how - to configure the bundle should be found in its end-user documentation. + The config field is validated against a configuration schema provided by the resolved bundle. + If the bundle does not provide a configuration schema, the final manifests are derived on a best-effort basis. + For more information on how to configure the bundle, see the bundle's end-user documentation. properties: configType: description: |- - configType is a required reference to the type of configuration source. + The configType field is required and specifies the type of configuration source. - Allowed values are "Inline" + The only allowed value is "Inline". - When this field is set to "Inline", the cluster extension configuration is defined inline within the - ClusterExtension resource. + When set to "Inline", the cluster extension configuration is defined inline within the ClusterExtension resource. enum: - Inline type: string inline: description: |- - inline contains JSON or YAML values specified directly in the - ClusterExtension. + The inline field contains JSON or YAML values specified directly in the ClusterExtension. - inline must be set if configType is 'Inline'. - inline accepts arbitrary JSON/YAML objects. - inline is validation at runtime against the schema provided by the bundle if a schema is provided. + The inline field must be set if configType is "Inline". + The inline field accepts arbitrary JSON/YAML objects. + The inline field is validated at runtime against the schema provided by the bundle if a schema is provided. type: object x-kubernetes-preserve-unknown-fields: true required: @@ -98,37 +96,35 @@ spec: : !has(self.inline)' install: description: |- - install is an optional field used to configure the installation options - for the ClusterExtension such as the pre-flight check configuration. + The install field is optional and configures installation options for the ClusterExtension, + such as the pre-flight check configuration. properties: preflight: description: |- - preflight is an optional field that can be used to configure the checks that are - run before installation or upgrade of the content for the package specified in the packageName field. + The preflight field 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 will be used. + When not specified, the default configuration is used. properties: crdUpgradeSafety: description: |- - crdUpgradeSafety is used to configure the CRD Upgrade Safety pre-flight - checks that run prior to upgrades of installed content. + The crdUpgradeSafety field 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. + The CRD Upgrade Safety pre-flight check safeguards from unintended consequences of upgrading a CRD, + such as data loss. properties: enforcement: description: |- - enforcement is a required field, used to configure the state of the CRD Upgrade Safety pre-flight check. + The enforcement field 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 will be skipped - when performing an upgrade operation. This should be used with caution as - unintended consequences such as data loss can occur. + 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 will be run when - performing an upgrade operation. + When set to "Strict", the CRD Upgrade Safety pre-flight check runs during an upgrade operation. enum: - None - Strict @@ -150,16 +146,15 @@ spec: rule: has(self.preflight) namespace: description: |- - namespace is a reference to a Kubernetes namespace. - This is the namespace in which the provided ServiceAccount must exist. - It also designates the default namespace where namespace-scoped resources - for the extension are applied to the cluster. + The namespace field 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. - namespace 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 + 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 maxLength: 63 @@ -171,24 +166,22 @@ spec: rule: self.matches("^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") serviceAccount: description: |- - serviceAccount is a reference to a ServiceAccount used to perform all interactions - with the cluster that are required to manage the extension. + The serviceAccount field 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. - serviceAccount is required. + The serviceAccount field is required. properties: name: description: |- - name is a required, immutable reference to the name of the ServiceAccount - to be used for installation and management of the content for the package - specified in the packageName field. + The name field 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. - name 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. + 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 @@ -217,11 +210,11 @@ spec: type: object source: description: |- - source is a required field which selects the installation source of content - for this ClusterExtension. Selection is performed by setting the sourceType. + The source field 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, and setting the - sourcetype to "Catalog" requires the catalog field to also be defined. + 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): @@ -232,30 +225,29 @@ spec: properties: catalog: description: |- - catalog is used to configure how information is sourced from a catalog. - This field is required when sourceType is "Catalog", and forbidden otherwise. + The catalog field configures how information is sourced from a catalog. + The catalog field is required when sourceType is "Catalog", and forbidden otherwise. properties: channels: description: |- - channels is an optional reference to a set of channels belonging to - the package specified in the packageName field. + The channels field 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. + 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. No more than 256 channels can be specified. + 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 is used to constrain the set of installable bundles and - the automated upgrade path. This constraint is an AND operation with the - version field. For example: + 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 will be considered installable - - Automatic upgrades will be constrained to upgrade edges defined by the selected channel + - 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 will be used to identify valid automatic upgrade paths. + When unspecified, upgrade edges across all channels are used to identify valid automatic upgrade paths. Some examples of valid values are: - 1.1.x @@ -285,13 +277,12 @@ spec: type: array packageName: description: |- - packageName is a reference to the name of the package to be installed - and is used to filter the content from catalogs. + The packageName field specifies the name of the package to be installed and is used to filter + the content from catalogs. - packageName 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. + The packageName field 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 @@ -318,12 +309,9 @@ spec: rule: self.matches("^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") selector: description: |- - selector is an optional field that can be used - to filter the set of ClusterCatalogs used in the bundle - selection process. + The selector field is optional and filters the set of ClusterCatalogs used in the bundle selection process. - When unspecified, all ClusterCatalogs will be used in - the bundle selection process. + When unspecified, all ClusterCatalogs are used in the bundle selection process. properties: matchExpressions: description: matchExpressions is a list of label selector @@ -371,35 +359,34 @@ spec: upgradeConstraintPolicy: default: CatalogProvided description: |- - upgradeConstraintPolicy is an optional field that controls whether - the upgrade path(s) defined in the catalog are enforced for the package - referenced in the packageName field. + The upgradeConstraintPolicy field 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" or "SelfCertified", or omitted. + Allowed values are "CatalogProvided", "SelfCertified", or omitted. - When this field is set to "CatalogProvided", automatic upgrades will only occur - when upgrade constraints specified by the package author are met. + When set to "CatalogProvided", automatic upgrades only occur when upgrade constraints specified by the package + author are met. - When this field is set to "SelfCertified", the upgrade constraints specified by - the package author are ignored. This allows for 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. It is assumed that users have independently verified changes when - using this option. + 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 this field is omitted, the default value is "CatalogProvided". + When omitted, the default value is "CatalogProvided". enum: - CatalogProvided - SelfCertified type: string version: description: |- - version is an optional semver constraint (a specific version or range of versions). When unspecified, the latest version available will be installed. + The version field 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. Additional - comparison strings can be added using the OR operator (||). + 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 @@ -477,13 +464,12 @@ spec: type: object sourceType: description: |- - sourceType is a required reference to the type of install source. + The sourceType field is required and specifies the type of install source. - Allowed values are "Catalog" + The only allowed value is "Catalog". - When this field is set to "Catalog", information for determining the - appropriate bundle of content to install will be fetched from - ClusterCatalog resources existing on the cluster. + 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. enum: - Catalog @@ -509,21 +495,21 @@ spec: description: |- The set of condition types which apply to all spec.source variations are Installed and Progressing. - The Installed condition represents whether or not 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. - - When the ClusterExtension is sourced from a catalog, if may also communicate a deprecation condition. - These are indications from a package owner to guide users away from a particular package, channel, or bundle. - BundleDeprecated is set if the requested bundle version is marked deprecated in the catalog. - ChannelDeprecated is set if the requested channel is marked deprecated in the catalog. - PackageDeprecated is set if the requested package is marked deprecated in the catalog. - Deprecated is a rollup condition that is present when any of the deprecated conditions are present. + 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 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. + + When the ClusterExtension is sourced from a catalog, it may also communicate a deprecation condition. + These are indications from a package owner to guide users away from a particular package, channel, or bundle: + - BundleDeprecated is set if the requested bundle version is marked deprecated in the catalog. + - ChannelDeprecated is set if the requested channel is marked deprecated in the catalog. + - PackageDeprecated is set if the requested package is marked deprecated in the catalog. + - Deprecated is a rollup condition that is present when any of the deprecated conditions are present. items: description: Condition contains details for one aspect of the current state of this API Resource. @@ -583,22 +569,21 @@ spec: - type x-kubernetes-list-type: map install: - description: install is a representation of the current installation - status for this ClusterExtension. + description: The install field is a representation of the current + installation status for this ClusterExtension. properties: bundle: description: |- - bundle is a required field which represents the identifying attributes of a bundle. + The bundle field 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. + A "bundle" is a versioned set of content that represents the resources that need to be applied + to a cluster to install a package. properties: name: description: |- - 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. + The name field 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. type: string x-kubernetes-validations: - message: packageName must be a valid DNS1123 subdomain. @@ -608,8 +593,8 @@ spec: rule: self.matches("^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") version: description: |- - version is a required field and is a reference to the version that this bundle represents - version follows the semantic versioning standard as defined in https://semver.org/. + The version field is required and references the version that this bundle represents. + The version field follows the semantic versioning standard as defined in https://semver.org/. type: string x-kubernetes-validations: - message: version must be well-formed semver diff --git a/helm/olmv1/base/operator-controller/crd/standard/olm.operatorframework.io_clusterextensions.yaml b/helm/olmv1/base/operator-controller/crd/standard/olm.operatorframework.io_clusterextensions.yaml index a0983e41f..b8a13a35a 100644 --- a/helm/olmv1/base/operator-controller/crd/standard/olm.operatorframework.io_clusterextensions.yaml +++ b/helm/olmv1/base/operator-controller/crd/standard/olm.operatorframework.io_clusterextensions.yaml @@ -59,37 +59,35 @@ spec: properties: install: description: |- - install is an optional field used to configure the installation options - for the ClusterExtension such as the pre-flight check configuration. + The install field is optional and configures installation options for the ClusterExtension, + such as the pre-flight check configuration. properties: preflight: description: |- - preflight is an optional field that can be used to configure the checks that are - run before installation or upgrade of the content for the package specified in the packageName field. + The preflight field 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 will be used. + When not specified, the default configuration is used. properties: crdUpgradeSafety: description: |- - crdUpgradeSafety is used to configure the CRD Upgrade Safety pre-flight - checks that run prior to upgrades of installed content. + The crdUpgradeSafety field 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. + The CRD Upgrade Safety pre-flight check safeguards from unintended consequences of upgrading a CRD, + such as data loss. properties: enforcement: description: |- - enforcement is a required field, used to configure the state of the CRD Upgrade Safety pre-flight check. + The enforcement field 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 will be skipped - when performing an upgrade operation. This should be used with caution as - unintended consequences such as data loss can occur. + 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 will be run when - performing an upgrade operation. + When set to "Strict", the CRD Upgrade Safety pre-flight check runs during an upgrade operation. enum: - None - Strict @@ -111,16 +109,15 @@ spec: rule: has(self.preflight) namespace: description: |- - namespace is a reference to a Kubernetes namespace. - This is the namespace in which the provided ServiceAccount must exist. - It also designates the default namespace where namespace-scoped resources - for the extension are applied to the cluster. + The namespace field 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. - namespace 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 + 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 maxLength: 63 @@ -132,24 +129,22 @@ spec: rule: self.matches("^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") serviceAccount: description: |- - serviceAccount is a reference to a ServiceAccount used to perform all interactions - with the cluster that are required to manage the extension. + The serviceAccount field 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. - serviceAccount is required. + The serviceAccount field is required. properties: name: description: |- - name is a required, immutable reference to the name of the ServiceAccount - to be used for installation and management of the content for the package - specified in the packageName field. + The name field 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. - name 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. + 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 @@ -178,11 +173,11 @@ spec: type: object source: description: |- - source is a required field which selects the installation source of content - for this ClusterExtension. Selection is performed by setting the sourceType. + The source field 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, and setting the - sourcetype to "Catalog" requires the catalog field to also be defined. + 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): @@ -193,30 +188,29 @@ spec: properties: catalog: description: |- - catalog is used to configure how information is sourced from a catalog. - This field is required when sourceType is "Catalog", and forbidden otherwise. + The catalog field configures how information is sourced from a catalog. + The catalog field is required when sourceType is "Catalog", and forbidden otherwise. properties: channels: description: |- - channels is an optional reference to a set of channels belonging to - the package specified in the packageName field. + The channels field 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. + 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. No more than 256 channels can be specified. + 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 is used to constrain the set of installable bundles and - the automated upgrade path. This constraint is an AND operation with the - version field. For example: + 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 will be considered installable - - Automatic upgrades will be constrained to upgrade edges defined by the selected channel + - 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 will be used to identify valid automatic upgrade paths. + When unspecified, upgrade edges across all channels are used to identify valid automatic upgrade paths. Some examples of valid values are: - 1.1.x @@ -246,13 +240,12 @@ spec: type: array packageName: description: |- - packageName is a reference to the name of the package to be installed - and is used to filter the content from catalogs. + The packageName field specifies the name of the package to be installed and is used to filter + the content from catalogs. - packageName 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. + The packageName field 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 @@ -279,12 +272,9 @@ spec: rule: self.matches("^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") selector: description: |- - selector is an optional field that can be used - to filter the set of ClusterCatalogs used in the bundle - selection process. + The selector field is optional and filters the set of ClusterCatalogs used in the bundle selection process. - When unspecified, all ClusterCatalogs will be used in - the bundle selection process. + When unspecified, all ClusterCatalogs are used in the bundle selection process. properties: matchExpressions: description: matchExpressions is a list of label selector @@ -332,35 +322,34 @@ spec: upgradeConstraintPolicy: default: CatalogProvided description: |- - upgradeConstraintPolicy is an optional field that controls whether - the upgrade path(s) defined in the catalog are enforced for the package - referenced in the packageName field. + The upgradeConstraintPolicy field 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" or "SelfCertified", or omitted. + Allowed values are "CatalogProvided", "SelfCertified", or omitted. - When this field is set to "CatalogProvided", automatic upgrades will only occur - when upgrade constraints specified by the package author are met. + When set to "CatalogProvided", automatic upgrades only occur when upgrade constraints specified by the package + author are met. - When this field is set to "SelfCertified", the upgrade constraints specified by - the package author are ignored. This allows for 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. It is assumed that users have independently verified changes when - using this option. + 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 this field is omitted, the default value is "CatalogProvided". + When omitted, the default value is "CatalogProvided". enum: - CatalogProvided - SelfCertified type: string version: description: |- - version is an optional semver constraint (a specific version or range of versions). When unspecified, the latest version available will be installed. + The version field 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. Additional - comparison strings can be added using the OR operator (||). + 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 @@ -438,13 +427,12 @@ spec: type: object sourceType: description: |- - sourceType is a required reference to the type of install source. + The sourceType field is required and specifies the type of install source. - Allowed values are "Catalog" + The only allowed value is "Catalog". - When this field is set to "Catalog", information for determining the - appropriate bundle of content to install will be fetched from - ClusterCatalog resources existing on the cluster. + 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. enum: - Catalog @@ -470,21 +458,21 @@ spec: description: |- The set of condition types which apply to all spec.source variations are Installed and Progressing. - The Installed condition represents whether or not 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. - - When the ClusterExtension is sourced from a catalog, if may also communicate a deprecation condition. - These are indications from a package owner to guide users away from a particular package, channel, or bundle. - BundleDeprecated is set if the requested bundle version is marked deprecated in the catalog. - ChannelDeprecated is set if the requested channel is marked deprecated in the catalog. - PackageDeprecated is set if the requested package is marked deprecated in the catalog. - Deprecated is a rollup condition that is present when any of the deprecated conditions are present. + 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 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. + + When the ClusterExtension is sourced from a catalog, it may also communicate a deprecation condition. + These are indications from a package owner to guide users away from a particular package, channel, or bundle: + - BundleDeprecated is set if the requested bundle version is marked deprecated in the catalog. + - ChannelDeprecated is set if the requested channel is marked deprecated in the catalog. + - PackageDeprecated is set if the requested package is marked deprecated in the catalog. + - Deprecated is a rollup condition that is present when any of the deprecated conditions are present. items: description: Condition contains details for one aspect of the current state of this API Resource. @@ -544,22 +532,21 @@ spec: - type x-kubernetes-list-type: map install: - description: install is a representation of the current installation - status for this ClusterExtension. + description: The install field is a representation of the current + installation status for this ClusterExtension. properties: bundle: description: |- - bundle is a required field which represents the identifying attributes of a bundle. + The bundle field 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. + A "bundle" is a versioned set of content that represents the resources that need to be applied + to a cluster to install a package. properties: name: description: |- - 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. + The name field 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. type: string x-kubernetes-validations: - message: packageName must be a valid DNS1123 subdomain. @@ -569,8 +556,8 @@ spec: rule: self.matches("^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") version: description: |- - version is a required field and is a reference to the version that this bundle represents - version follows the semantic versioning standard as defined in https://semver.org/. + The version field is required and references the version that this bundle represents. + The version field follows the semantic versioning standard as defined in https://semver.org/. type: string x-kubernetes-validations: - message: version must be well-formed semver diff --git a/manifests/experimental-e2e.yaml b/manifests/experimental-e2e.yaml index 672830225..b49f6ca2f 100644 --- a/manifests/experimental-e2e.yaml +++ b/manifests/experimental-e2e.yaml @@ -177,7 +177,7 @@ spec: schema: openAPIV3Schema: description: |- - ClusterCatalog enables users to make File-Based Catalog (FBC) catalog data available to the cluster. + The ClusterCatalog resource 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 properties: apiVersion: @@ -199,29 +199,26 @@ spec: type: object spec: description: |- - spec is the desired state of the ClusterCatalog. - spec is required. - The controller will work to ensure that the desired - catalog is unpacked and served over the catalog content HTTP server. + The spec field defines the desired state of the ClusterCatalog. + The spec field is required. + The controller ensures that the catalog is unpacked and served over the catalog content HTTP server. properties: availabilityMode: default: Available description: |- - availabilityMode allows users to define how the ClusterCatalog is made available to clients on the cluster. - availabilityMode is optional. + The availabilityMode field defines how the ClusterCatalog is made available to clients on the cluster. + The availabilityMode field is optional. - Allowed values are "Available" and "Unavailable" and omitted. + Allowed values are "Available", "Unavailable", or omitted. When omitted, the default value is "Available". - When set to "Available", the catalog contents will be unpacked and served over the catalog content HTTP server. - Setting the availabilityMode to "Available" tells clients that they should consider this ClusterCatalog - and its contents as usable. + 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 will no longer be served over the catalog content HTTP server. - When set to this availabilityMode it should be interpreted the same as the ClusterCatalog not existing. - Setting the availabilityMode to "Unavailable" can be useful in scenarios where a user may not want - to delete the ClusterCatalog all together, but would still like it to be treated as if it doesn't exist. + 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. enum: - Unavailable - Available @@ -229,19 +226,19 @@ spec: priority: default: 0 description: |- - priority allows the user to define a priority for a ClusterCatalog. - priority is optional. + The priority field defines a priority for this ClusterCatalog. + The priority field is optional. - A ClusterCatalog's priority is used by clients as a tie-breaker between ClusterCatalogs that meet the client's requirements. - A higher number means higher priority. + Clients use the ClusterCatalog priority as a tie-breaker between ClusterCatalogs that meet their requirements. + Higher numbers mean higher priority. - It is up to clients to decide how to handle scenarios where multiple ClusterCatalogs with the same priority meet their requirements. - When deciding how to break the tie in this scenario, it is recommended that clients prompt their users for additional input. + 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 because that is the zero value of integers. + When omitted, the default priority is 0. - Negative numbers can be used to specify a priority lower than the default. - Positive numbers can be used to specify a priority higher than the default. + 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. @@ -249,15 +246,13 @@ spec: type: integer source: description: |- - source allows a user to define the source of a catalog. - A "catalog" contains information on content that can be installed on a cluster. - Providing a catalog source makes the contents of the catalog discoverable and usable by - other on-cluster components. - These on-cluster components may do a variety of things with this information, such as - presenting the content in a GUI dashboard or installing content from the catalog on the cluster. + The source field 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. - source is a required field. + The source field is required. Below is a minimal example of a ClusterCatalogSpec that sources a catalog from an image: @@ -268,25 +263,25 @@ spec: properties: image: description: |- - image is used to configure how catalog contents are sourced from an OCI image. - This field is required when type is Image, and forbidden otherwise. + The image field configures how catalog contents are sourced from an OCI image. + The image field is required when type is Image, and forbidden otherwise. properties: pollIntervalMinutes: description: |- - pollIntervalMinutes allows the user to set the interval, in minutes, at which the image source should be polled for new content. - pollIntervalMinutes is optional. - pollIntervalMinutes can not be specified when ref is a digest-based reference. + The pollIntervalMinutes field sets the interval, in minutes, at which the image source is polled for new content. + The pollIntervalMinutes field is optional. + You cannot specify pollIntervalMinutes when ref is a digest-based reference. - When omitted, the image will not be polled for new content. + When omitted, the image is not polled for new content. minimum: 1 type: integer ref: description: |- - ref allows users to define the reference to a container image containing Catalog contents. - ref is required. - ref can not be more than 1000 characters. + The ref field defines the reference to a container image containing catalog contents. + The ref field is required. + The ref field cannot be more than 1000 characters. - A reference can be broken down into 3 parts - the domain, name, and identifier. + 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. @@ -369,12 +364,12 @@ spec: : true' type: description: |- - type is a reference to the type of source the catalog is sourced from. - type is required. + The type field specifies the type of source for the catalog. + The type field is required. The only allowed value is "Image". - When set to "Image", the ClusterCatalog content will be sourced from an OCI 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. enum: - Image @@ -392,31 +387,30 @@ spec: type: object status: description: |- - status contains information about the state of the ClusterCatalog such as: - - Whether or not the catalog contents are being served via the catalog content HTTP server - - Whether or not the ClusterCatalog is progressing to a new state + The status field 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 properties: conditions: description: |- - conditions is a representation of the current state for this ClusterCatalog. + The conditions field represents the current state of this ClusterCatalog. The current condition types are Serving and Progressing. - The Serving condition is used to represent whether or not the contents of the catalog is being served via the HTTP(S) web server. - When it has a status of True and a reason of Available, the contents of the catalog are being served. - When it has a status of False and a reason of Unavailable, the contents of the catalog are not being served because the contents are not yet available. - When it has a status of False and a reason of UserSpecifiedUnavailable, the contents of the catalog are not being served because the catalog has been intentionally marked as unavailable. + 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 is used to represent whether or not the ClusterCatalog is progressing or is ready to progress towards a new state. - When it has a status of True and a reason of Retrying, there was an error in the progression of the ClusterCatalog that may be resolved on subsequent reconciliation attempts. - When it has a status of True and a reason of Succeeded, the ClusterCatalog has successfully progressed to a new state and is ready to continue progressing. - When it has a status of False and a reason of Blocked, there was an error in the progression of the ClusterCatalog that requires manual intervention for recovery. + 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. - In the case that the Serving condition is True with reason Available and Progressing is True with reason Retrying, the previously fetched - catalog contents are still being served via the HTTP(S) web server while we are progressing towards serving a new version of the catalog - contents. This could occur when we've initially fetched the latest contents from the source for this catalog and when polling for changes - to the contents we identify that there are updates to the contents. + 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. items: description: Condition contains details for one aspect of the current state of this API Resource. @@ -477,27 +471,25 @@ spec: x-kubernetes-list-type: map lastUnpacked: description: |- - lastUnpacked represents the last time the contents of the - catalog were extracted from their source format. As an example, - when using an Image source, the OCI image will be pulled and the - image layers written to a file-system backed cache. We refer to the - act of this extraction from the source format as "unpacking". + The lastUnpacked field 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". format: date-time type: string resolvedSource: - description: resolvedSource contains information about the resolved - source based on the source type. + description: The resolvedSource field contains information about the + resolved source based on the source type. properties: image: description: |- - image is a field containing resolution information for a catalog sourced from an image. - This field must be set when type is Image, and forbidden otherwise. + The image field contains resolution information for a catalog sourced from an image. + The image field must be set when type is Image, and forbidden otherwise. properties: ref: description: |- - ref contains the resolved image digest-based reference. - The digest format is used so users can use other tooling to fetch the exact - OCI manifests that were used to extract the catalog contents. + The ref field 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. maxLength: 1000 type: string x-kubernetes-validations: @@ -531,12 +523,12 @@ spec: type: object type: description: |- - type is a reference to the type of source the catalog is sourced from. - type is required. + The type field specifies the type of source for the catalog. + The type field is required. The only allowed value is "Image". - When set to "Image", information about the resolved image source will be set in the 'image' field. + When set to "Image", information about the resolved image source is set in the image field. enum: - Image type: string @@ -550,24 +542,21 @@ spec: rule: 'has(self.type) && self.type == ''Image'' ? has(self.image) : !has(self.image)' urls: - description: urls contains the URLs that can be used to access the - catalog. + description: The urls field contains the URLs that can be used to + access the catalog. properties: base: description: |- - base is a cluster-internal URL that provides endpoints for - accessing the content of the catalog. + The base field is a cluster-internal URL that provides endpoints for accessing the catalog content. - It is expected that clients append the path for the endpoint they wish - to access. + 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. + 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 entirety of the catalog contents in the FBC format + - /all - this endpoint returns the entire catalog contents in the FBC format - As the needs of users and clients of the evolve, new endpoints may be added. + New endpoints may be added as needs evolve. maxLength: 525 type: string x-kubernetes-validations: @@ -847,33 +836,31 @@ spec: properties: config: description: |- - config is an optional field used to specify bundle specific configuration - used to configure the bundle. Configuration is bundle specific and a bundle may provide - a configuration schema. When not specified, the default configuration of the resolved bundle will be used. + The config field 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 final manifests will be derived on a best-effort basis. More information on how - to configure the bundle should be found in its end-user documentation. + The config field is validated against a configuration schema provided by the resolved bundle. + If the bundle does not provide a configuration schema, the final manifests are derived on a best-effort basis. + For more information on how to configure the bundle, see the bundle's end-user documentation. properties: configType: description: |- - configType is a required reference to the type of configuration source. + The configType field is required and specifies the type of configuration source. - Allowed values are "Inline" + The only allowed value is "Inline". - When this field is set to "Inline", the cluster extension configuration is defined inline within the - ClusterExtension resource. + When set to "Inline", the cluster extension configuration is defined inline within the ClusterExtension resource. enum: - Inline type: string inline: description: |- - inline contains JSON or YAML values specified directly in the - ClusterExtension. + The inline field contains JSON or YAML values specified directly in the ClusterExtension. - inline must be set if configType is 'Inline'. - inline accepts arbitrary JSON/YAML objects. - inline is validation at runtime against the schema provided by the bundle if a schema is provided. + The inline field must be set if configType is "Inline". + The inline field accepts arbitrary JSON/YAML objects. + The inline field is validated at runtime against the schema provided by the bundle if a schema is provided. type: object x-kubernetes-preserve-unknown-fields: true required: @@ -886,37 +873,35 @@ spec: : !has(self.inline)' install: description: |- - install is an optional field used to configure the installation options - for the ClusterExtension such as the pre-flight check configuration. + The install field is optional and configures installation options for the ClusterExtension, + such as the pre-flight check configuration. properties: preflight: description: |- - preflight is an optional field that can be used to configure the checks that are - run before installation or upgrade of the content for the package specified in the packageName field. + The preflight field 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 will be used. + When not specified, the default configuration is used. properties: crdUpgradeSafety: description: |- - crdUpgradeSafety is used to configure the CRD Upgrade Safety pre-flight - checks that run prior to upgrades of installed content. + The crdUpgradeSafety field 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. + The CRD Upgrade Safety pre-flight check safeguards from unintended consequences of upgrading a CRD, + such as data loss. properties: enforcement: description: |- - enforcement is a required field, used to configure the state of the CRD Upgrade Safety pre-flight check. + The enforcement field 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 will be skipped - when performing an upgrade operation. This should be used with caution as - unintended consequences such as data loss can occur. + 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 will be run when - performing an upgrade operation. + When set to "Strict", the CRD Upgrade Safety pre-flight check runs during an upgrade operation. enum: - None - Strict @@ -938,16 +923,15 @@ spec: rule: has(self.preflight) namespace: description: |- - namespace is a reference to a Kubernetes namespace. - This is the namespace in which the provided ServiceAccount must exist. - It also designates the default namespace where namespace-scoped resources - for the extension are applied to the cluster. + The namespace field 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. - namespace 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 + 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 maxLength: 63 @@ -959,24 +943,22 @@ spec: rule: self.matches("^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") serviceAccount: description: |- - serviceAccount is a reference to a ServiceAccount used to perform all interactions - with the cluster that are required to manage the extension. + The serviceAccount field 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. - serviceAccount is required. + The serviceAccount field is required. properties: name: description: |- - name is a required, immutable reference to the name of the ServiceAccount - to be used for installation and management of the content for the package - specified in the packageName field. + The name field 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. - name 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. + 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 @@ -1005,11 +987,11 @@ spec: type: object source: description: |- - source is a required field which selects the installation source of content - for this ClusterExtension. Selection is performed by setting the sourceType. + The source field 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, and setting the - sourcetype to "Catalog" requires the catalog field to also be defined. + 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): @@ -1020,30 +1002,29 @@ spec: properties: catalog: description: |- - catalog is used to configure how information is sourced from a catalog. - This field is required when sourceType is "Catalog", and forbidden otherwise. + The catalog field configures how information is sourced from a catalog. + The catalog field is required when sourceType is "Catalog", and forbidden otherwise. properties: channels: description: |- - channels is an optional reference to a set of channels belonging to - the package specified in the packageName field. + The channels field 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. + 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. No more than 256 channels can be specified. + 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 is used to constrain the set of installable bundles and - the automated upgrade path. This constraint is an AND operation with the - version field. For example: + 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 will be considered installable - - Automatic upgrades will be constrained to upgrade edges defined by the selected channel + - 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 will be used to identify valid automatic upgrade paths. + When unspecified, upgrade edges across all channels are used to identify valid automatic upgrade paths. Some examples of valid values are: - 1.1.x @@ -1073,13 +1054,12 @@ spec: type: array packageName: description: |- - packageName is a reference to the name of the package to be installed - and is used to filter the content from catalogs. + The packageName field specifies the name of the package to be installed and is used to filter + the content from catalogs. - packageName 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. + The packageName field 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 @@ -1106,12 +1086,9 @@ spec: rule: self.matches("^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") selector: description: |- - selector is an optional field that can be used - to filter the set of ClusterCatalogs used in the bundle - selection process. + The selector field is optional and filters the set of ClusterCatalogs used in the bundle selection process. - When unspecified, all ClusterCatalogs will be used in - the bundle selection process. + When unspecified, all ClusterCatalogs are used in the bundle selection process. properties: matchExpressions: description: matchExpressions is a list of label selector @@ -1159,35 +1136,34 @@ spec: upgradeConstraintPolicy: default: CatalogProvided description: |- - upgradeConstraintPolicy is an optional field that controls whether - the upgrade path(s) defined in the catalog are enforced for the package - referenced in the packageName field. + The upgradeConstraintPolicy field 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" or "SelfCertified", or omitted. + Allowed values are "CatalogProvided", "SelfCertified", or omitted. - When this field is set to "CatalogProvided", automatic upgrades will only occur - when upgrade constraints specified by the package author are met. + When set to "CatalogProvided", automatic upgrades only occur when upgrade constraints specified by the package + author are met. - When this field is set to "SelfCertified", the upgrade constraints specified by - the package author are ignored. This allows for 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. It is assumed that users have independently verified changes when - using this option. + 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 this field is omitted, the default value is "CatalogProvided". + When omitted, the default value is "CatalogProvided". enum: - CatalogProvided - SelfCertified type: string version: description: |- - version is an optional semver constraint (a specific version or range of versions). When unspecified, the latest version available will be installed. + The version field 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. Additional - comparison strings can be added using the OR operator (||). + 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 @@ -1265,13 +1241,12 @@ spec: type: object sourceType: description: |- - sourceType is a required reference to the type of install source. + The sourceType field is required and specifies the type of install source. - Allowed values are "Catalog" + The only allowed value is "Catalog". - When this field is set to "Catalog", information for determining the - appropriate bundle of content to install will be fetched from - ClusterCatalog resources existing on the cluster. + 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. enum: - Catalog @@ -1297,21 +1272,21 @@ spec: description: |- The set of condition types which apply to all spec.source variations are Installed and Progressing. - The Installed condition represents whether or not 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. - - When the ClusterExtension is sourced from a catalog, if may also communicate a deprecation condition. - These are indications from a package owner to guide users away from a particular package, channel, or bundle. - BundleDeprecated is set if the requested bundle version is marked deprecated in the catalog. - ChannelDeprecated is set if the requested channel is marked deprecated in the catalog. - PackageDeprecated is set if the requested package is marked deprecated in the catalog. - Deprecated is a rollup condition that is present when any of the deprecated conditions are present. + 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 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. + + When the ClusterExtension is sourced from a catalog, it may also communicate a deprecation condition. + These are indications from a package owner to guide users away from a particular package, channel, or bundle: + - BundleDeprecated is set if the requested bundle version is marked deprecated in the catalog. + - ChannelDeprecated is set if the requested channel is marked deprecated in the catalog. + - PackageDeprecated is set if the requested package is marked deprecated in the catalog. + - Deprecated is a rollup condition that is present when any of the deprecated conditions are present. items: description: Condition contains details for one aspect of the current state of this API Resource. @@ -1371,22 +1346,21 @@ spec: - type x-kubernetes-list-type: map install: - description: install is a representation of the current installation - status for this ClusterExtension. + description: The install field is a representation of the current + installation status for this ClusterExtension. properties: bundle: description: |- - bundle is a required field which represents the identifying attributes of a bundle. + The bundle field 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. + A "bundle" is a versioned set of content that represents the resources that need to be applied + to a cluster to install a package. properties: name: description: |- - 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. + The name field 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. type: string x-kubernetes-validations: - message: packageName must be a valid DNS1123 subdomain. @@ -1396,8 +1370,8 @@ spec: rule: self.matches("^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") version: description: |- - version is a required field and is a reference to the version that this bundle represents - version follows the semantic versioning standard as defined in https://semver.org/. + The version field is required and references the version that this bundle represents. + The version field follows the semantic versioning standard as defined in https://semver.org/. type: string x-kubernetes-validations: - message: version must be well-formed semver diff --git a/manifests/experimental.yaml b/manifests/experimental.yaml index 199838eac..2c31b082b 100644 --- a/manifests/experimental.yaml +++ b/manifests/experimental.yaml @@ -142,7 +142,7 @@ spec: schema: openAPIV3Schema: description: |- - ClusterCatalog enables users to make File-Based Catalog (FBC) catalog data available to the cluster. + The ClusterCatalog resource 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 properties: apiVersion: @@ -164,29 +164,26 @@ spec: type: object spec: description: |- - spec is the desired state of the ClusterCatalog. - spec is required. - The controller will work to ensure that the desired - catalog is unpacked and served over the catalog content HTTP server. + The spec field defines the desired state of the ClusterCatalog. + The spec field is required. + The controller ensures that the catalog is unpacked and served over the catalog content HTTP server. properties: availabilityMode: default: Available description: |- - availabilityMode allows users to define how the ClusterCatalog is made available to clients on the cluster. - availabilityMode is optional. + The availabilityMode field defines how the ClusterCatalog is made available to clients on the cluster. + The availabilityMode field is optional. - Allowed values are "Available" and "Unavailable" and omitted. + Allowed values are "Available", "Unavailable", or omitted. When omitted, the default value is "Available". - When set to "Available", the catalog contents will be unpacked and served over the catalog content HTTP server. - Setting the availabilityMode to "Available" tells clients that they should consider this ClusterCatalog - and its contents as usable. + 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 will no longer be served over the catalog content HTTP server. - When set to this availabilityMode it should be interpreted the same as the ClusterCatalog not existing. - Setting the availabilityMode to "Unavailable" can be useful in scenarios where a user may not want - to delete the ClusterCatalog all together, but would still like it to be treated as if it doesn't exist. + 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. enum: - Unavailable - Available @@ -194,19 +191,19 @@ spec: priority: default: 0 description: |- - priority allows the user to define a priority for a ClusterCatalog. - priority is optional. + The priority field defines a priority for this ClusterCatalog. + The priority field is optional. - A ClusterCatalog's priority is used by clients as a tie-breaker between ClusterCatalogs that meet the client's requirements. - A higher number means higher priority. + Clients use the ClusterCatalog priority as a tie-breaker between ClusterCatalogs that meet their requirements. + Higher numbers mean higher priority. - It is up to clients to decide how to handle scenarios where multiple ClusterCatalogs with the same priority meet their requirements. - When deciding how to break the tie in this scenario, it is recommended that clients prompt their users for additional input. + 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 because that is the zero value of integers. + When omitted, the default priority is 0. - Negative numbers can be used to specify a priority lower than the default. - Positive numbers can be used to specify a priority higher than the default. + 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. @@ -214,15 +211,13 @@ spec: type: integer source: description: |- - source allows a user to define the source of a catalog. - A "catalog" contains information on content that can be installed on a cluster. - Providing a catalog source makes the contents of the catalog discoverable and usable by - other on-cluster components. - These on-cluster components may do a variety of things with this information, such as - presenting the content in a GUI dashboard or installing content from the catalog on the cluster. + The source field 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. - source is a required field. + The source field is required. Below is a minimal example of a ClusterCatalogSpec that sources a catalog from an image: @@ -233,25 +228,25 @@ spec: properties: image: description: |- - image is used to configure how catalog contents are sourced from an OCI image. - This field is required when type is Image, and forbidden otherwise. + The image field configures how catalog contents are sourced from an OCI image. + The image field is required when type is Image, and forbidden otherwise. properties: pollIntervalMinutes: description: |- - pollIntervalMinutes allows the user to set the interval, in minutes, at which the image source should be polled for new content. - pollIntervalMinutes is optional. - pollIntervalMinutes can not be specified when ref is a digest-based reference. + The pollIntervalMinutes field sets the interval, in minutes, at which the image source is polled for new content. + The pollIntervalMinutes field is optional. + You cannot specify pollIntervalMinutes when ref is a digest-based reference. - When omitted, the image will not be polled for new content. + When omitted, the image is not polled for new content. minimum: 1 type: integer ref: description: |- - ref allows users to define the reference to a container image containing Catalog contents. - ref is required. - ref can not be more than 1000 characters. + The ref field defines the reference to a container image containing catalog contents. + The ref field is required. + The ref field cannot be more than 1000 characters. - A reference can be broken down into 3 parts - the domain, name, and identifier. + 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. @@ -334,12 +329,12 @@ spec: : true' type: description: |- - type is a reference to the type of source the catalog is sourced from. - type is required. + The type field specifies the type of source for the catalog. + The type field is required. The only allowed value is "Image". - When set to "Image", the ClusterCatalog content will be sourced from an OCI 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. enum: - Image @@ -357,31 +352,30 @@ spec: type: object status: description: |- - status contains information about the state of the ClusterCatalog such as: - - Whether or not the catalog contents are being served via the catalog content HTTP server - - Whether or not the ClusterCatalog is progressing to a new state + The status field 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 properties: conditions: description: |- - conditions is a representation of the current state for this ClusterCatalog. + The conditions field represents the current state of this ClusterCatalog. The current condition types are Serving and Progressing. - The Serving condition is used to represent whether or not the contents of the catalog is being served via the HTTP(S) web server. - When it has a status of True and a reason of Available, the contents of the catalog are being served. - When it has a status of False and a reason of Unavailable, the contents of the catalog are not being served because the contents are not yet available. - When it has a status of False and a reason of UserSpecifiedUnavailable, the contents of the catalog are not being served because the catalog has been intentionally marked as unavailable. + 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 is used to represent whether or not the ClusterCatalog is progressing or is ready to progress towards a new state. - When it has a status of True and a reason of Retrying, there was an error in the progression of the ClusterCatalog that may be resolved on subsequent reconciliation attempts. - When it has a status of True and a reason of Succeeded, the ClusterCatalog has successfully progressed to a new state and is ready to continue progressing. - When it has a status of False and a reason of Blocked, there was an error in the progression of the ClusterCatalog that requires manual intervention for recovery. + 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. - In the case that the Serving condition is True with reason Available and Progressing is True with reason Retrying, the previously fetched - catalog contents are still being served via the HTTP(S) web server while we are progressing towards serving a new version of the catalog - contents. This could occur when we've initially fetched the latest contents from the source for this catalog and when polling for changes - to the contents we identify that there are updates to the contents. + 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. items: description: Condition contains details for one aspect of the current state of this API Resource. @@ -442,27 +436,25 @@ spec: x-kubernetes-list-type: map lastUnpacked: description: |- - lastUnpacked represents the last time the contents of the - catalog were extracted from their source format. As an example, - when using an Image source, the OCI image will be pulled and the - image layers written to a file-system backed cache. We refer to the - act of this extraction from the source format as "unpacking". + The lastUnpacked field 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". format: date-time type: string resolvedSource: - description: resolvedSource contains information about the resolved - source based on the source type. + description: The resolvedSource field contains information about the + resolved source based on the source type. properties: image: description: |- - image is a field containing resolution information for a catalog sourced from an image. - This field must be set when type is Image, and forbidden otherwise. + The image field contains resolution information for a catalog sourced from an image. + The image field must be set when type is Image, and forbidden otherwise. properties: ref: description: |- - ref contains the resolved image digest-based reference. - The digest format is used so users can use other tooling to fetch the exact - OCI manifests that were used to extract the catalog contents. + The ref field 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. maxLength: 1000 type: string x-kubernetes-validations: @@ -496,12 +488,12 @@ spec: type: object type: description: |- - type is a reference to the type of source the catalog is sourced from. - type is required. + The type field specifies the type of source for the catalog. + The type field is required. The only allowed value is "Image". - When set to "Image", information about the resolved image source will be set in the 'image' field. + When set to "Image", information about the resolved image source is set in the image field. enum: - Image type: string @@ -515,24 +507,21 @@ spec: rule: 'has(self.type) && self.type == ''Image'' ? has(self.image) : !has(self.image)' urls: - description: urls contains the URLs that can be used to access the - catalog. + description: The urls field contains the URLs that can be used to + access the catalog. properties: base: description: |- - base is a cluster-internal URL that provides endpoints for - accessing the content of the catalog. + The base field is a cluster-internal URL that provides endpoints for accessing the catalog content. - It is expected that clients append the path for the endpoint they wish - to access. + 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. + 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 entirety of the catalog contents in the FBC format + - /all - this endpoint returns the entire catalog contents in the FBC format - As the needs of users and clients of the evolve, new endpoints may be added. + New endpoints may be added as needs evolve. maxLength: 525 type: string x-kubernetes-validations: @@ -812,33 +801,31 @@ spec: properties: config: description: |- - config is an optional field used to specify bundle specific configuration - used to configure the bundle. Configuration is bundle specific and a bundle may provide - a configuration schema. When not specified, the default configuration of the resolved bundle will be used. + The config field 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 final manifests will be derived on a best-effort basis. More information on how - to configure the bundle should be found in its end-user documentation. + The config field is validated against a configuration schema provided by the resolved bundle. + If the bundle does not provide a configuration schema, the final manifests are derived on a best-effort basis. + For more information on how to configure the bundle, see the bundle's end-user documentation. properties: configType: description: |- - configType is a required reference to the type of configuration source. + The configType field is required and specifies the type of configuration source. - Allowed values are "Inline" + The only allowed value is "Inline". - When this field is set to "Inline", the cluster extension configuration is defined inline within the - ClusterExtension resource. + When set to "Inline", the cluster extension configuration is defined inline within the ClusterExtension resource. enum: - Inline type: string inline: description: |- - inline contains JSON or YAML values specified directly in the - ClusterExtension. + The inline field contains JSON or YAML values specified directly in the ClusterExtension. - inline must be set if configType is 'Inline'. - inline accepts arbitrary JSON/YAML objects. - inline is validation at runtime against the schema provided by the bundle if a schema is provided. + The inline field must be set if configType is "Inline". + The inline field accepts arbitrary JSON/YAML objects. + The inline field is validated at runtime against the schema provided by the bundle if a schema is provided. type: object x-kubernetes-preserve-unknown-fields: true required: @@ -851,37 +838,35 @@ spec: : !has(self.inline)' install: description: |- - install is an optional field used to configure the installation options - for the ClusterExtension such as the pre-flight check configuration. + The install field is optional and configures installation options for the ClusterExtension, + such as the pre-flight check configuration. properties: preflight: description: |- - preflight is an optional field that can be used to configure the checks that are - run before installation or upgrade of the content for the package specified in the packageName field. + The preflight field 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 will be used. + When not specified, the default configuration is used. properties: crdUpgradeSafety: description: |- - crdUpgradeSafety is used to configure the CRD Upgrade Safety pre-flight - checks that run prior to upgrades of installed content. + The crdUpgradeSafety field 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. + The CRD Upgrade Safety pre-flight check safeguards from unintended consequences of upgrading a CRD, + such as data loss. properties: enforcement: description: |- - enforcement is a required field, used to configure the state of the CRD Upgrade Safety pre-flight check. + The enforcement field 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 will be skipped - when performing an upgrade operation. This should be used with caution as - unintended consequences such as data loss can occur. + 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 will be run when - performing an upgrade operation. + When set to "Strict", the CRD Upgrade Safety pre-flight check runs during an upgrade operation. enum: - None - Strict @@ -903,16 +888,15 @@ spec: rule: has(self.preflight) namespace: description: |- - namespace is a reference to a Kubernetes namespace. - This is the namespace in which the provided ServiceAccount must exist. - It also designates the default namespace where namespace-scoped resources - for the extension are applied to the cluster. + The namespace field 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. - namespace 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 + 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 maxLength: 63 @@ -924,24 +908,22 @@ spec: rule: self.matches("^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") serviceAccount: description: |- - serviceAccount is a reference to a ServiceAccount used to perform all interactions - with the cluster that are required to manage the extension. + The serviceAccount field 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. - serviceAccount is required. + The serviceAccount field is required. properties: name: description: |- - name is a required, immutable reference to the name of the ServiceAccount - to be used for installation and management of the content for the package - specified in the packageName field. + The name field 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. - name 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. + 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 @@ -970,11 +952,11 @@ spec: type: object source: description: |- - source is a required field which selects the installation source of content - for this ClusterExtension. Selection is performed by setting the sourceType. + The source field 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, and setting the - sourcetype to "Catalog" requires the catalog field to also be defined. + 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): @@ -985,30 +967,29 @@ spec: properties: catalog: description: |- - catalog is used to configure how information is sourced from a catalog. - This field is required when sourceType is "Catalog", and forbidden otherwise. + The catalog field configures how information is sourced from a catalog. + The catalog field is required when sourceType is "Catalog", and forbidden otherwise. properties: channels: description: |- - channels is an optional reference to a set of channels belonging to - the package specified in the packageName field. + The channels field 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. + 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. No more than 256 channels can be specified. + 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 is used to constrain the set of installable bundles and - the automated upgrade path. This constraint is an AND operation with the - version field. For example: + 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 will be considered installable - - Automatic upgrades will be constrained to upgrade edges defined by the selected channel + - 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 will be used to identify valid automatic upgrade paths. + When unspecified, upgrade edges across all channels are used to identify valid automatic upgrade paths. Some examples of valid values are: - 1.1.x @@ -1038,13 +1019,12 @@ spec: type: array packageName: description: |- - packageName is a reference to the name of the package to be installed - and is used to filter the content from catalogs. + The packageName field specifies the name of the package to be installed and is used to filter + the content from catalogs. - packageName 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. + The packageName field 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 @@ -1071,12 +1051,9 @@ spec: rule: self.matches("^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") selector: description: |- - selector is an optional field that can be used - to filter the set of ClusterCatalogs used in the bundle - selection process. + The selector field is optional and filters the set of ClusterCatalogs used in the bundle selection process. - When unspecified, all ClusterCatalogs will be used in - the bundle selection process. + When unspecified, all ClusterCatalogs are used in the bundle selection process. properties: matchExpressions: description: matchExpressions is a list of label selector @@ -1124,35 +1101,34 @@ spec: upgradeConstraintPolicy: default: CatalogProvided description: |- - upgradeConstraintPolicy is an optional field that controls whether - the upgrade path(s) defined in the catalog are enforced for the package - referenced in the packageName field. + The upgradeConstraintPolicy field 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" or "SelfCertified", or omitted. + Allowed values are "CatalogProvided", "SelfCertified", or omitted. - When this field is set to "CatalogProvided", automatic upgrades will only occur - when upgrade constraints specified by the package author are met. + When set to "CatalogProvided", automatic upgrades only occur when upgrade constraints specified by the package + author are met. - When this field is set to "SelfCertified", the upgrade constraints specified by - the package author are ignored. This allows for 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. It is assumed that users have independently verified changes when - using this option. + 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 this field is omitted, the default value is "CatalogProvided". + When omitted, the default value is "CatalogProvided". enum: - CatalogProvided - SelfCertified type: string version: description: |- - version is an optional semver constraint (a specific version or range of versions). When unspecified, the latest version available will be installed. + The version field 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. Additional - comparison strings can be added using the OR operator (||). + 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 @@ -1230,13 +1206,12 @@ spec: type: object sourceType: description: |- - sourceType is a required reference to the type of install source. + The sourceType field is required and specifies the type of install source. - Allowed values are "Catalog" + The only allowed value is "Catalog". - When this field is set to "Catalog", information for determining the - appropriate bundle of content to install will be fetched from - ClusterCatalog resources existing on the cluster. + 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. enum: - Catalog @@ -1262,21 +1237,21 @@ spec: description: |- The set of condition types which apply to all spec.source variations are Installed and Progressing. - The Installed condition represents whether or not 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. - - When the ClusterExtension is sourced from a catalog, if may also communicate a deprecation condition. - These are indications from a package owner to guide users away from a particular package, channel, or bundle. - BundleDeprecated is set if the requested bundle version is marked deprecated in the catalog. - ChannelDeprecated is set if the requested channel is marked deprecated in the catalog. - PackageDeprecated is set if the requested package is marked deprecated in the catalog. - Deprecated is a rollup condition that is present when any of the deprecated conditions are present. + 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 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. + + When the ClusterExtension is sourced from a catalog, it may also communicate a deprecation condition. + These are indications from a package owner to guide users away from a particular package, channel, or bundle: + - BundleDeprecated is set if the requested bundle version is marked deprecated in the catalog. + - ChannelDeprecated is set if the requested channel is marked deprecated in the catalog. + - PackageDeprecated is set if the requested package is marked deprecated in the catalog. + - Deprecated is a rollup condition that is present when any of the deprecated conditions are present. items: description: Condition contains details for one aspect of the current state of this API Resource. @@ -1336,22 +1311,21 @@ spec: - type x-kubernetes-list-type: map install: - description: install is a representation of the current installation - status for this ClusterExtension. + description: The install field is a representation of the current + installation status for this ClusterExtension. properties: bundle: description: |- - bundle is a required field which represents the identifying attributes of a bundle. + The bundle field 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. + A "bundle" is a versioned set of content that represents the resources that need to be applied + to a cluster to install a package. properties: name: description: |- - 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. + The name field 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. type: string x-kubernetes-validations: - message: packageName must be a valid DNS1123 subdomain. @@ -1361,8 +1335,8 @@ spec: rule: self.matches("^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") version: description: |- - version is a required field and is a reference to the version that this bundle represents - version follows the semantic versioning standard as defined in https://semver.org/. + The version field is required and references the version that this bundle represents. + The version field follows the semantic versioning standard as defined in https://semver.org/. type: string x-kubernetes-validations: - message: version must be well-formed semver diff --git a/manifests/standard-e2e.yaml b/manifests/standard-e2e.yaml index 5c9590784..2bbe9e7db 100644 --- a/manifests/standard-e2e.yaml +++ b/manifests/standard-e2e.yaml @@ -177,7 +177,7 @@ spec: schema: openAPIV3Schema: description: |- - ClusterCatalog enables users to make File-Based Catalog (FBC) catalog data available to the cluster. + The ClusterCatalog resource 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 properties: apiVersion: @@ -199,29 +199,26 @@ spec: type: object spec: description: |- - spec is the desired state of the ClusterCatalog. - spec is required. - The controller will work to ensure that the desired - catalog is unpacked and served over the catalog content HTTP server. + The spec field defines the desired state of the ClusterCatalog. + The spec field is required. + The controller ensures that the catalog is unpacked and served over the catalog content HTTP server. properties: availabilityMode: default: Available description: |- - availabilityMode allows users to define how the ClusterCatalog is made available to clients on the cluster. - availabilityMode is optional. + The availabilityMode field defines how the ClusterCatalog is made available to clients on the cluster. + The availabilityMode field is optional. - Allowed values are "Available" and "Unavailable" and omitted. + Allowed values are "Available", "Unavailable", or omitted. When omitted, the default value is "Available". - When set to "Available", the catalog contents will be unpacked and served over the catalog content HTTP server. - Setting the availabilityMode to "Available" tells clients that they should consider this ClusterCatalog - and its contents as usable. + 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 will no longer be served over the catalog content HTTP server. - When set to this availabilityMode it should be interpreted the same as the ClusterCatalog not existing. - Setting the availabilityMode to "Unavailable" can be useful in scenarios where a user may not want - to delete the ClusterCatalog all together, but would still like it to be treated as if it doesn't exist. + 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. enum: - Unavailable - Available @@ -229,19 +226,19 @@ spec: priority: default: 0 description: |- - priority allows the user to define a priority for a ClusterCatalog. - priority is optional. + The priority field defines a priority for this ClusterCatalog. + The priority field is optional. - A ClusterCatalog's priority is used by clients as a tie-breaker between ClusterCatalogs that meet the client's requirements. - A higher number means higher priority. + Clients use the ClusterCatalog priority as a tie-breaker between ClusterCatalogs that meet their requirements. + Higher numbers mean higher priority. - It is up to clients to decide how to handle scenarios where multiple ClusterCatalogs with the same priority meet their requirements. - When deciding how to break the tie in this scenario, it is recommended that clients prompt their users for additional input. + 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 because that is the zero value of integers. + When omitted, the default priority is 0. - Negative numbers can be used to specify a priority lower than the default. - Positive numbers can be used to specify a priority higher than the default. + 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. @@ -249,15 +246,13 @@ spec: type: integer source: description: |- - source allows a user to define the source of a catalog. - A "catalog" contains information on content that can be installed on a cluster. - Providing a catalog source makes the contents of the catalog discoverable and usable by - other on-cluster components. - These on-cluster components may do a variety of things with this information, such as - presenting the content in a GUI dashboard or installing content from the catalog on the cluster. + The source field 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. - source is a required field. + The source field is required. Below is a minimal example of a ClusterCatalogSpec that sources a catalog from an image: @@ -268,25 +263,25 @@ spec: properties: image: description: |- - image is used to configure how catalog contents are sourced from an OCI image. - This field is required when type is Image, and forbidden otherwise. + The image field configures how catalog contents are sourced from an OCI image. + The image field is required when type is Image, and forbidden otherwise. properties: pollIntervalMinutes: description: |- - pollIntervalMinutes allows the user to set the interval, in minutes, at which the image source should be polled for new content. - pollIntervalMinutes is optional. - pollIntervalMinutes can not be specified when ref is a digest-based reference. + The pollIntervalMinutes field sets the interval, in minutes, at which the image source is polled for new content. + The pollIntervalMinutes field is optional. + You cannot specify pollIntervalMinutes when ref is a digest-based reference. - When omitted, the image will not be polled for new content. + When omitted, the image is not polled for new content. minimum: 1 type: integer ref: description: |- - ref allows users to define the reference to a container image containing Catalog contents. - ref is required. - ref can not be more than 1000 characters. + The ref field defines the reference to a container image containing catalog contents. + The ref field is required. + The ref field cannot be more than 1000 characters. - A reference can be broken down into 3 parts - the domain, name, and identifier. + 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. @@ -369,12 +364,12 @@ spec: : true' type: description: |- - type is a reference to the type of source the catalog is sourced from. - type is required. + The type field specifies the type of source for the catalog. + The type field is required. The only allowed value is "Image". - When set to "Image", the ClusterCatalog content will be sourced from an OCI 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. enum: - Image @@ -392,31 +387,30 @@ spec: type: object status: description: |- - status contains information about the state of the ClusterCatalog such as: - - Whether or not the catalog contents are being served via the catalog content HTTP server - - Whether or not the ClusterCatalog is progressing to a new state + The status field 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 properties: conditions: description: |- - conditions is a representation of the current state for this ClusterCatalog. + The conditions field represents the current state of this ClusterCatalog. The current condition types are Serving and Progressing. - The Serving condition is used to represent whether or not the contents of the catalog is being served via the HTTP(S) web server. - When it has a status of True and a reason of Available, the contents of the catalog are being served. - When it has a status of False and a reason of Unavailable, the contents of the catalog are not being served because the contents are not yet available. - When it has a status of False and a reason of UserSpecifiedUnavailable, the contents of the catalog are not being served because the catalog has been intentionally marked as unavailable. + 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 is used to represent whether or not the ClusterCatalog is progressing or is ready to progress towards a new state. - When it has a status of True and a reason of Retrying, there was an error in the progression of the ClusterCatalog that may be resolved on subsequent reconciliation attempts. - When it has a status of True and a reason of Succeeded, the ClusterCatalog has successfully progressed to a new state and is ready to continue progressing. - When it has a status of False and a reason of Blocked, there was an error in the progression of the ClusterCatalog that requires manual intervention for recovery. + 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. - In the case that the Serving condition is True with reason Available and Progressing is True with reason Retrying, the previously fetched - catalog contents are still being served via the HTTP(S) web server while we are progressing towards serving a new version of the catalog - contents. This could occur when we've initially fetched the latest contents from the source for this catalog and when polling for changes - to the contents we identify that there are updates to the contents. + 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. items: description: Condition contains details for one aspect of the current state of this API Resource. @@ -477,27 +471,25 @@ spec: x-kubernetes-list-type: map lastUnpacked: description: |- - lastUnpacked represents the last time the contents of the - catalog were extracted from their source format. As an example, - when using an Image source, the OCI image will be pulled and the - image layers written to a file-system backed cache. We refer to the - act of this extraction from the source format as "unpacking". + The lastUnpacked field 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". format: date-time type: string resolvedSource: - description: resolvedSource contains information about the resolved - source based on the source type. + description: The resolvedSource field contains information about the + resolved source based on the source type. properties: image: description: |- - image is a field containing resolution information for a catalog sourced from an image. - This field must be set when type is Image, and forbidden otherwise. + The image field contains resolution information for a catalog sourced from an image. + The image field must be set when type is Image, and forbidden otherwise. properties: ref: description: |- - ref contains the resolved image digest-based reference. - The digest format is used so users can use other tooling to fetch the exact - OCI manifests that were used to extract the catalog contents. + The ref field 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. maxLength: 1000 type: string x-kubernetes-validations: @@ -531,12 +523,12 @@ spec: type: object type: description: |- - type is a reference to the type of source the catalog is sourced from. - type is required. + The type field specifies the type of source for the catalog. + The type field is required. The only allowed value is "Image". - When set to "Image", information about the resolved image source will be set in the 'image' field. + When set to "Image", information about the resolved image source is set in the image field. enum: - Image type: string @@ -550,24 +542,21 @@ spec: rule: 'has(self.type) && self.type == ''Image'' ? has(self.image) : !has(self.image)' urls: - description: urls contains the URLs that can be used to access the - catalog. + description: The urls field contains the URLs that can be used to + access the catalog. properties: base: description: |- - base is a cluster-internal URL that provides endpoints for - accessing the content of the catalog. + The base field is a cluster-internal URL that provides endpoints for accessing the catalog content. - It is expected that clients append the path for the endpoint they wish - to access. + 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. + 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 entirety of the catalog contents in the FBC format + - /all - this endpoint returns the entire catalog contents in the FBC format - As the needs of users and clients of the evolve, new endpoints may be added. + New endpoints may be added as needs evolve. maxLength: 525 type: string x-kubernetes-validations: @@ -650,37 +639,35 @@ spec: properties: install: description: |- - install is an optional field used to configure the installation options - for the ClusterExtension such as the pre-flight check configuration. + The install field is optional and configures installation options for the ClusterExtension, + such as the pre-flight check configuration. properties: preflight: description: |- - preflight is an optional field that can be used to configure the checks that are - run before installation or upgrade of the content for the package specified in the packageName field. + The preflight field 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 will be used. + When not specified, the default configuration is used. properties: crdUpgradeSafety: description: |- - crdUpgradeSafety is used to configure the CRD Upgrade Safety pre-flight - checks that run prior to upgrades of installed content. + The crdUpgradeSafety field 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. + The CRD Upgrade Safety pre-flight check safeguards from unintended consequences of upgrading a CRD, + such as data loss. properties: enforcement: description: |- - enforcement is a required field, used to configure the state of the CRD Upgrade Safety pre-flight check. + The enforcement field 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 will be skipped - when performing an upgrade operation. This should be used with caution as - unintended consequences such as data loss can occur. + 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 will be run when - performing an upgrade operation. + When set to "Strict", the CRD Upgrade Safety pre-flight check runs during an upgrade operation. enum: - None - Strict @@ -702,16 +689,15 @@ spec: rule: has(self.preflight) namespace: description: |- - namespace is a reference to a Kubernetes namespace. - This is the namespace in which the provided ServiceAccount must exist. - It also designates the default namespace where namespace-scoped resources - for the extension are applied to the cluster. + The namespace field 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. - namespace 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 + 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 maxLength: 63 @@ -723,24 +709,22 @@ spec: rule: self.matches("^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") serviceAccount: description: |- - serviceAccount is a reference to a ServiceAccount used to perform all interactions - with the cluster that are required to manage the extension. + The serviceAccount field 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. - serviceAccount is required. + The serviceAccount field is required. properties: name: description: |- - name is a required, immutable reference to the name of the ServiceAccount - to be used for installation and management of the content for the package - specified in the packageName field. + The name field 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. - name 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. + 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 @@ -769,11 +753,11 @@ spec: type: object source: description: |- - source is a required field which selects the installation source of content - for this ClusterExtension. Selection is performed by setting the sourceType. + The source field 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, and setting the - sourcetype to "Catalog" requires the catalog field to also be defined. + 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): @@ -784,30 +768,29 @@ spec: properties: catalog: description: |- - catalog is used to configure how information is sourced from a catalog. - This field is required when sourceType is "Catalog", and forbidden otherwise. + The catalog field configures how information is sourced from a catalog. + The catalog field is required when sourceType is "Catalog", and forbidden otherwise. properties: channels: description: |- - channels is an optional reference to a set of channels belonging to - the package specified in the packageName field. + The channels field 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. + 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. No more than 256 channels can be specified. + 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 is used to constrain the set of installable bundles and - the automated upgrade path. This constraint is an AND operation with the - version field. For example: + 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 will be considered installable - - Automatic upgrades will be constrained to upgrade edges defined by the selected channel + - 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 will be used to identify valid automatic upgrade paths. + When unspecified, upgrade edges across all channels are used to identify valid automatic upgrade paths. Some examples of valid values are: - 1.1.x @@ -837,13 +820,12 @@ spec: type: array packageName: description: |- - packageName is a reference to the name of the package to be installed - and is used to filter the content from catalogs. + The packageName field specifies the name of the package to be installed and is used to filter + the content from catalogs. - packageName 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. + The packageName field 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 @@ -870,12 +852,9 @@ spec: rule: self.matches("^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") selector: description: |- - selector is an optional field that can be used - to filter the set of ClusterCatalogs used in the bundle - selection process. + The selector field is optional and filters the set of ClusterCatalogs used in the bundle selection process. - When unspecified, all ClusterCatalogs will be used in - the bundle selection process. + When unspecified, all ClusterCatalogs are used in the bundle selection process. properties: matchExpressions: description: matchExpressions is a list of label selector @@ -923,35 +902,34 @@ spec: upgradeConstraintPolicy: default: CatalogProvided description: |- - upgradeConstraintPolicy is an optional field that controls whether - the upgrade path(s) defined in the catalog are enforced for the package - referenced in the packageName field. + The upgradeConstraintPolicy field 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" or "SelfCertified", or omitted. + Allowed values are "CatalogProvided", "SelfCertified", or omitted. - When this field is set to "CatalogProvided", automatic upgrades will only occur - when upgrade constraints specified by the package author are met. + When set to "CatalogProvided", automatic upgrades only occur when upgrade constraints specified by the package + author are met. - When this field is set to "SelfCertified", the upgrade constraints specified by - the package author are ignored. This allows for 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. It is assumed that users have independently verified changes when - using this option. + 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 this field is omitted, the default value is "CatalogProvided". + When omitted, the default value is "CatalogProvided". enum: - CatalogProvided - SelfCertified type: string version: description: |- - version is an optional semver constraint (a specific version or range of versions). When unspecified, the latest version available will be installed. + The version field 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. Additional - comparison strings can be added using the OR operator (||). + 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 @@ -1029,13 +1007,12 @@ spec: type: object sourceType: description: |- - sourceType is a required reference to the type of install source. + The sourceType field is required and specifies the type of install source. - Allowed values are "Catalog" + The only allowed value is "Catalog". - When this field is set to "Catalog", information for determining the - appropriate bundle of content to install will be fetched from - ClusterCatalog resources existing on the cluster. + 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. enum: - Catalog @@ -1061,21 +1038,21 @@ spec: description: |- The set of condition types which apply to all spec.source variations are Installed and Progressing. - The Installed condition represents whether or not 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. - - When the ClusterExtension is sourced from a catalog, if may also communicate a deprecation condition. - These are indications from a package owner to guide users away from a particular package, channel, or bundle. - BundleDeprecated is set if the requested bundle version is marked deprecated in the catalog. - ChannelDeprecated is set if the requested channel is marked deprecated in the catalog. - PackageDeprecated is set if the requested package is marked deprecated in the catalog. - Deprecated is a rollup condition that is present when any of the deprecated conditions are present. + 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 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. + + When the ClusterExtension is sourced from a catalog, it may also communicate a deprecation condition. + These are indications from a package owner to guide users away from a particular package, channel, or bundle: + - BundleDeprecated is set if the requested bundle version is marked deprecated in the catalog. + - ChannelDeprecated is set if the requested channel is marked deprecated in the catalog. + - PackageDeprecated is set if the requested package is marked deprecated in the catalog. + - Deprecated is a rollup condition that is present when any of the deprecated conditions are present. items: description: Condition contains details for one aspect of the current state of this API Resource. @@ -1135,22 +1112,21 @@ spec: - type x-kubernetes-list-type: map install: - description: install is a representation of the current installation - status for this ClusterExtension. + description: The install field is a representation of the current + installation status for this ClusterExtension. properties: bundle: description: |- - bundle is a required field which represents the identifying attributes of a bundle. + The bundle field 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. + A "bundle" is a versioned set of content that represents the resources that need to be applied + to a cluster to install a package. properties: name: description: |- - 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. + The name field 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. type: string x-kubernetes-validations: - message: packageName must be a valid DNS1123 subdomain. @@ -1160,8 +1136,8 @@ spec: rule: self.matches("^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") version: description: |- - version is a required field and is a reference to the version that this bundle represents - version follows the semantic versioning standard as defined in https://semver.org/. + The version field is required and references the version that this bundle represents. + The version field follows the semantic versioning standard as defined in https://semver.org/. type: string x-kubernetes-validations: - message: version must be well-formed semver diff --git a/manifests/standard.yaml b/manifests/standard.yaml index 95e400c26..b458348c6 100644 --- a/manifests/standard.yaml +++ b/manifests/standard.yaml @@ -142,7 +142,7 @@ spec: schema: openAPIV3Schema: description: |- - ClusterCatalog enables users to make File-Based Catalog (FBC) catalog data available to the cluster. + The ClusterCatalog resource 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 properties: apiVersion: @@ -164,29 +164,26 @@ spec: type: object spec: description: |- - spec is the desired state of the ClusterCatalog. - spec is required. - The controller will work to ensure that the desired - catalog is unpacked and served over the catalog content HTTP server. + The spec field defines the desired state of the ClusterCatalog. + The spec field is required. + The controller ensures that the catalog is unpacked and served over the catalog content HTTP server. properties: availabilityMode: default: Available description: |- - availabilityMode allows users to define how the ClusterCatalog is made available to clients on the cluster. - availabilityMode is optional. + The availabilityMode field defines how the ClusterCatalog is made available to clients on the cluster. + The availabilityMode field is optional. - Allowed values are "Available" and "Unavailable" and omitted. + Allowed values are "Available", "Unavailable", or omitted. When omitted, the default value is "Available". - When set to "Available", the catalog contents will be unpacked and served over the catalog content HTTP server. - Setting the availabilityMode to "Available" tells clients that they should consider this ClusterCatalog - and its contents as usable. + 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 will no longer be served over the catalog content HTTP server. - When set to this availabilityMode it should be interpreted the same as the ClusterCatalog not existing. - Setting the availabilityMode to "Unavailable" can be useful in scenarios where a user may not want - to delete the ClusterCatalog all together, but would still like it to be treated as if it doesn't exist. + 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. enum: - Unavailable - Available @@ -194,19 +191,19 @@ spec: priority: default: 0 description: |- - priority allows the user to define a priority for a ClusterCatalog. - priority is optional. + The priority field defines a priority for this ClusterCatalog. + The priority field is optional. - A ClusterCatalog's priority is used by clients as a tie-breaker between ClusterCatalogs that meet the client's requirements. - A higher number means higher priority. + Clients use the ClusterCatalog priority as a tie-breaker between ClusterCatalogs that meet their requirements. + Higher numbers mean higher priority. - It is up to clients to decide how to handle scenarios where multiple ClusterCatalogs with the same priority meet their requirements. - When deciding how to break the tie in this scenario, it is recommended that clients prompt their users for additional input. + 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 because that is the zero value of integers. + When omitted, the default priority is 0. - Negative numbers can be used to specify a priority lower than the default. - Positive numbers can be used to specify a priority higher than the default. + 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. @@ -214,15 +211,13 @@ spec: type: integer source: description: |- - source allows a user to define the source of a catalog. - A "catalog" contains information on content that can be installed on a cluster. - Providing a catalog source makes the contents of the catalog discoverable and usable by - other on-cluster components. - These on-cluster components may do a variety of things with this information, such as - presenting the content in a GUI dashboard or installing content from the catalog on the cluster. + The source field 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. - source is a required field. + The source field is required. Below is a minimal example of a ClusterCatalogSpec that sources a catalog from an image: @@ -233,25 +228,25 @@ spec: properties: image: description: |- - image is used to configure how catalog contents are sourced from an OCI image. - This field is required when type is Image, and forbidden otherwise. + The image field configures how catalog contents are sourced from an OCI image. + The image field is required when type is Image, and forbidden otherwise. properties: pollIntervalMinutes: description: |- - pollIntervalMinutes allows the user to set the interval, in minutes, at which the image source should be polled for new content. - pollIntervalMinutes is optional. - pollIntervalMinutes can not be specified when ref is a digest-based reference. + The pollIntervalMinutes field sets the interval, in minutes, at which the image source is polled for new content. + The pollIntervalMinutes field is optional. + You cannot specify pollIntervalMinutes when ref is a digest-based reference. - When omitted, the image will not be polled for new content. + When omitted, the image is not polled for new content. minimum: 1 type: integer ref: description: |- - ref allows users to define the reference to a container image containing Catalog contents. - ref is required. - ref can not be more than 1000 characters. + The ref field defines the reference to a container image containing catalog contents. + The ref field is required. + The ref field cannot be more than 1000 characters. - A reference can be broken down into 3 parts - the domain, name, and identifier. + 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. @@ -334,12 +329,12 @@ spec: : true' type: description: |- - type is a reference to the type of source the catalog is sourced from. - type is required. + The type field specifies the type of source for the catalog. + The type field is required. The only allowed value is "Image". - When set to "Image", the ClusterCatalog content will be sourced from an OCI 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. enum: - Image @@ -357,31 +352,30 @@ spec: type: object status: description: |- - status contains information about the state of the ClusterCatalog such as: - - Whether or not the catalog contents are being served via the catalog content HTTP server - - Whether or not the ClusterCatalog is progressing to a new state + The status field 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 properties: conditions: description: |- - conditions is a representation of the current state for this ClusterCatalog. + The conditions field represents the current state of this ClusterCatalog. The current condition types are Serving and Progressing. - The Serving condition is used to represent whether or not the contents of the catalog is being served via the HTTP(S) web server. - When it has a status of True and a reason of Available, the contents of the catalog are being served. - When it has a status of False and a reason of Unavailable, the contents of the catalog are not being served because the contents are not yet available. - When it has a status of False and a reason of UserSpecifiedUnavailable, the contents of the catalog are not being served because the catalog has been intentionally marked as unavailable. + 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 is used to represent whether or not the ClusterCatalog is progressing or is ready to progress towards a new state. - When it has a status of True and a reason of Retrying, there was an error in the progression of the ClusterCatalog that may be resolved on subsequent reconciliation attempts. - When it has a status of True and a reason of Succeeded, the ClusterCatalog has successfully progressed to a new state and is ready to continue progressing. - When it has a status of False and a reason of Blocked, there was an error in the progression of the ClusterCatalog that requires manual intervention for recovery. + 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. - In the case that the Serving condition is True with reason Available and Progressing is True with reason Retrying, the previously fetched - catalog contents are still being served via the HTTP(S) web server while we are progressing towards serving a new version of the catalog - contents. This could occur when we've initially fetched the latest contents from the source for this catalog and when polling for changes - to the contents we identify that there are updates to the contents. + 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. items: description: Condition contains details for one aspect of the current state of this API Resource. @@ -442,27 +436,25 @@ spec: x-kubernetes-list-type: map lastUnpacked: description: |- - lastUnpacked represents the last time the contents of the - catalog were extracted from their source format. As an example, - when using an Image source, the OCI image will be pulled and the - image layers written to a file-system backed cache. We refer to the - act of this extraction from the source format as "unpacking". + The lastUnpacked field 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". format: date-time type: string resolvedSource: - description: resolvedSource contains information about the resolved - source based on the source type. + description: The resolvedSource field contains information about the + resolved source based on the source type. properties: image: description: |- - image is a field containing resolution information for a catalog sourced from an image. - This field must be set when type is Image, and forbidden otherwise. + The image field contains resolution information for a catalog sourced from an image. + The image field must be set when type is Image, and forbidden otherwise. properties: ref: description: |- - ref contains the resolved image digest-based reference. - The digest format is used so users can use other tooling to fetch the exact - OCI manifests that were used to extract the catalog contents. + The ref field 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. maxLength: 1000 type: string x-kubernetes-validations: @@ -496,12 +488,12 @@ spec: type: object type: description: |- - type is a reference to the type of source the catalog is sourced from. - type is required. + The type field specifies the type of source for the catalog. + The type field is required. The only allowed value is "Image". - When set to "Image", information about the resolved image source will be set in the 'image' field. + When set to "Image", information about the resolved image source is set in the image field. enum: - Image type: string @@ -515,24 +507,21 @@ spec: rule: 'has(self.type) && self.type == ''Image'' ? has(self.image) : !has(self.image)' urls: - description: urls contains the URLs that can be used to access the - catalog. + description: The urls field contains the URLs that can be used to + access the catalog. properties: base: description: |- - base is a cluster-internal URL that provides endpoints for - accessing the content of the catalog. + The base field is a cluster-internal URL that provides endpoints for accessing the catalog content. - It is expected that clients append the path for the endpoint they wish - to access. + 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. + 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 entirety of the catalog contents in the FBC format + - /all - this endpoint returns the entire catalog contents in the FBC format - As the needs of users and clients of the evolve, new endpoints may be added. + New endpoints may be added as needs evolve. maxLength: 525 type: string x-kubernetes-validations: @@ -615,37 +604,35 @@ spec: properties: install: description: |- - install is an optional field used to configure the installation options - for the ClusterExtension such as the pre-flight check configuration. + The install field is optional and configures installation options for the ClusterExtension, + such as the pre-flight check configuration. properties: preflight: description: |- - preflight is an optional field that can be used to configure the checks that are - run before installation or upgrade of the content for the package specified in the packageName field. + The preflight field 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 will be used. + When not specified, the default configuration is used. properties: crdUpgradeSafety: description: |- - crdUpgradeSafety is used to configure the CRD Upgrade Safety pre-flight - checks that run prior to upgrades of installed content. + The crdUpgradeSafety field 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. + The CRD Upgrade Safety pre-flight check safeguards from unintended consequences of upgrading a CRD, + such as data loss. properties: enforcement: description: |- - enforcement is a required field, used to configure the state of the CRD Upgrade Safety pre-flight check. + The enforcement field 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 will be skipped - when performing an upgrade operation. This should be used with caution as - unintended consequences such as data loss can occur. + 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 will be run when - performing an upgrade operation. + When set to "Strict", the CRD Upgrade Safety pre-flight check runs during an upgrade operation. enum: - None - Strict @@ -667,16 +654,15 @@ spec: rule: has(self.preflight) namespace: description: |- - namespace is a reference to a Kubernetes namespace. - This is the namespace in which the provided ServiceAccount must exist. - It also designates the default namespace where namespace-scoped resources - for the extension are applied to the cluster. + The namespace field 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. - namespace 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 + 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 maxLength: 63 @@ -688,24 +674,22 @@ spec: rule: self.matches("^[a-z0-9]([-a-z0-9]*[a-z0-9])?$") serviceAccount: description: |- - serviceAccount is a reference to a ServiceAccount used to perform all interactions - with the cluster that are required to manage the extension. + The serviceAccount field 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. - serviceAccount is required. + The serviceAccount field is required. properties: name: description: |- - name is a required, immutable reference to the name of the ServiceAccount - to be used for installation and management of the content for the package - specified in the packageName field. + The name field 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. - name 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. + 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 @@ -734,11 +718,11 @@ spec: type: object source: description: |- - source is a required field which selects the installation source of content - for this ClusterExtension. Selection is performed by setting the sourceType. + The source field 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, and setting the - sourcetype to "Catalog" requires the catalog field to also be defined. + 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): @@ -749,30 +733,29 @@ spec: properties: catalog: description: |- - catalog is used to configure how information is sourced from a catalog. - This field is required when sourceType is "Catalog", and forbidden otherwise. + The catalog field configures how information is sourced from a catalog. + The catalog field is required when sourceType is "Catalog", and forbidden otherwise. properties: channels: description: |- - channels is an optional reference to a set of channels belonging to - the package specified in the packageName field. + The channels field 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. + 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. No more than 256 channels can be specified. + 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 is used to constrain the set of installable bundles and - the automated upgrade path. This constraint is an AND operation with the - version field. For example: + 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 will be considered installable - - Automatic upgrades will be constrained to upgrade edges defined by the selected channel + - 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 will be used to identify valid automatic upgrade paths. + When unspecified, upgrade edges across all channels are used to identify valid automatic upgrade paths. Some examples of valid values are: - 1.1.x @@ -802,13 +785,12 @@ spec: type: array packageName: description: |- - packageName is a reference to the name of the package to be installed - and is used to filter the content from catalogs. + The packageName field specifies the name of the package to be installed and is used to filter + the content from catalogs. - packageName 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. + The packageName field 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 @@ -835,12 +817,9 @@ spec: rule: self.matches("^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") selector: description: |- - selector is an optional field that can be used - to filter the set of ClusterCatalogs used in the bundle - selection process. + The selector field is optional and filters the set of ClusterCatalogs used in the bundle selection process. - When unspecified, all ClusterCatalogs will be used in - the bundle selection process. + When unspecified, all ClusterCatalogs are used in the bundle selection process. properties: matchExpressions: description: matchExpressions is a list of label selector @@ -888,35 +867,34 @@ spec: upgradeConstraintPolicy: default: CatalogProvided description: |- - upgradeConstraintPolicy is an optional field that controls whether - the upgrade path(s) defined in the catalog are enforced for the package - referenced in the packageName field. + The upgradeConstraintPolicy field 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" or "SelfCertified", or omitted. + Allowed values are "CatalogProvided", "SelfCertified", or omitted. - When this field is set to "CatalogProvided", automatic upgrades will only occur - when upgrade constraints specified by the package author are met. + When set to "CatalogProvided", automatic upgrades only occur when upgrade constraints specified by the package + author are met. - When this field is set to "SelfCertified", the upgrade constraints specified by - the package author are ignored. This allows for 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. It is assumed that users have independently verified changes when - using this option. + 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 this field is omitted, the default value is "CatalogProvided". + When omitted, the default value is "CatalogProvided". enum: - CatalogProvided - SelfCertified type: string version: description: |- - version is an optional semver constraint (a specific version or range of versions). When unspecified, the latest version available will be installed. + The version field 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. Additional - comparison strings can be added using the OR operator (||). + 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 @@ -994,13 +972,12 @@ spec: type: object sourceType: description: |- - sourceType is a required reference to the type of install source. + The sourceType field is required and specifies the type of install source. - Allowed values are "Catalog" + The only allowed value is "Catalog". - When this field is set to "Catalog", information for determining the - appropriate bundle of content to install will be fetched from - ClusterCatalog resources existing on the cluster. + 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. enum: - Catalog @@ -1026,21 +1003,21 @@ spec: description: |- The set of condition types which apply to all spec.source variations are Installed and Progressing. - The Installed condition represents whether or not 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. - - When the ClusterExtension is sourced from a catalog, if may also communicate a deprecation condition. - These are indications from a package owner to guide users away from a particular package, channel, or bundle. - BundleDeprecated is set if the requested bundle version is marked deprecated in the catalog. - ChannelDeprecated is set if the requested channel is marked deprecated in the catalog. - PackageDeprecated is set if the requested package is marked deprecated in the catalog. - Deprecated is a rollup condition that is present when any of the deprecated conditions are present. + 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 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. + + When the ClusterExtension is sourced from a catalog, it may also communicate a deprecation condition. + These are indications from a package owner to guide users away from a particular package, channel, or bundle: + - BundleDeprecated is set if the requested bundle version is marked deprecated in the catalog. + - ChannelDeprecated is set if the requested channel is marked deprecated in the catalog. + - PackageDeprecated is set if the requested package is marked deprecated in the catalog. + - Deprecated is a rollup condition that is present when any of the deprecated conditions are present. items: description: Condition contains details for one aspect of the current state of this API Resource. @@ -1100,22 +1077,21 @@ spec: - type x-kubernetes-list-type: map install: - description: install is a representation of the current installation - status for this ClusterExtension. + description: The install field is a representation of the current + installation status for this ClusterExtension. properties: bundle: description: |- - bundle is a required field which represents the identifying attributes of a bundle. + The bundle field 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. + A "bundle" is a versioned set of content that represents the resources that need to be applied + to a cluster to install a package. properties: name: description: |- - 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. + The name field 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. type: string x-kubernetes-validations: - message: packageName must be a valid DNS1123 subdomain. @@ -1125,8 +1101,8 @@ spec: rule: self.matches("^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$") version: description: |- - version is a required field and is a reference to the version that this bundle represents - version follows the semantic versioning standard as defined in https://semver.org/. + The version field is required and references the version that this bundle represents. + The version field follows the semantic versioning standard as defined in https://semver.org/. type: string x-kubernetes-validations: - message: version must be well-formed semver