ClusterExtension [olm.operatorframework.io/v1alpha1] - OperatorHub APIs | API reference

Specification
API endpoints

Description: ClusterExtension is the Schema for the clusterextensions API
Type: object

Specification

Property Type Description

Property	Type	Description
`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
`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
`metadata`	`ObjectMeta`	Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`object`	ClusterExtensionSpec defines the desired state of ClusterExtension
`status`	`object`	ClusterExtensionStatus defines the observed state of ClusterExtension.

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

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

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

ClusterExtensionSpec defines the desired state of ClusterExtension

status

object

ClusterExtensionStatus defines the observed state of ClusterExtension.

.spec

Description

ClusterExtensionSpec defines the desired state of ClusterExtension

Type

object

Required

installNamespace
packageName
serviceAccount

Property Type Description

Property	Type	Description
`channel`	`string`	Channel constraint definition
`installNamespace`	`string`	installNamespace is the namespace where the bundle should be installed. However, note that the bundle may contain resources that are cluster-scoped or that are installed in a different namespace. This namespace is expected to exist.
`packageName`	`string`
`preflight`	`object`	Preflight defines the configuration of preflight checks.
`serviceAccount`	`object`	ServiceAccount is used to install and manage resources. The service account is expected to exist in the InstallNamespace.
`upgradeConstraintPolicy`	`string`	Defines the policy for how to handle upgrade constraints
`version`	`string`	Version is an optional semver constraint on the package version. If not specified, the latest version available of the package will be installed. If specified, the specific version of the package will be installed so long as it is available in any of the content sources available. Examples: 1.2.3, 1.0.0-alpha, 1.0.0-rc.1 For more information on semver, please see https://semver.org/

channel

string

Channel constraint definition

installNamespace

string

installNamespace is the namespace where the bundle should be installed. However, note that the bundle may contain resources that are cluster-scoped or that are installed in a different namespace. This namespace is expected to exist.

packageName

string

preflight

object

Preflight defines the configuration of preflight checks.

serviceAccount

object

ServiceAccount is used to install and manage resources. The service account is expected to exist in the InstallNamespace.

upgradeConstraintPolicy

string

Defines the policy for how to handle upgrade constraints

version

string

Version is an optional semver constraint on the package version. If not specified, the latest version available of the package will be installed. If specified, the specific version of the package will be installed so long as it is available in any of the content sources available. Examples: 1.2.3, 1.0.0-alpha, 1.0.0-rc.1

For more information on semver, please see https://semver.org/

.spec.preflight

Description: Preflight defines the configuration of preflight checks.
Type: object

Property Type Description

Property	Type	Description
`crdUpgradeSafety`	`object`	CRDUpgradeSafety holds necessary configuration for the CRD Upgrade Safety preflight checks.

crdUpgradeSafety

object

CRDUpgradeSafety holds necessary configuration for the CRD Upgrade Safety preflight checks.

.spec.preflight.crdUpgradeSafety

Description: CRDUpgradeSafety holds necessary configuration for the CRD Upgrade Safety preflight checks.
Type: object

Property Type Description

Property	Type	Description
`disabled`	`boolean`	Disabled represents the state of the CRD upgrade safety preflight check being disabled/enabled.

disabled

boolean

Disabled represents the state of the CRD upgrade safety preflight check being disabled/enabled.

.spec.serviceAccount

Description

ServiceAccount is used to install and manage resources. The service account is expected to exist in the InstallNamespace.

Type

object

Required

name

Property Type Description

Property	Type	Description
`name`	`string`	name is the metadata.name of the referenced serviceAccount object.

name

string

name is the metadata.name of the referenced serviceAccount object.

.status

Description: ClusterExtensionStatus defines the observed state of ClusterExtension.
Type: object

Property Type Description

Property	Type	Description
`conditions`	`array`
`conditions[]`	`object`	Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` // other fields }
`installedBundle`	`object`	InstalledBundle should only be modified when a new bundle is successfully installed. This ensures that if there is a previously successfully installed a bundle, and an upgrade fails, it is still communicated that there is still a bundle that is currently installed and owned by the ClusterExtension.
`resolvedBundle`	`object`

conditions

array

conditions[]

object

Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example,

type FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"

// other fields }

installedBundle

object

InstalledBundle should only be modified when a new bundle is successfully installed. This ensures that if there is a previously successfully installed a bundle, and an upgrade fails, it is still communicated that there is still a bundle that is currently installed and owned by the ClusterExtension.

resolvedBundle

object

.status.conditions

Description
Type: array

.status.conditions[]

Description

Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example,

type FooStatus struct{
    // Represents the observations of a foo's current state.
    // Known .status.conditions.type are: "Available", "Progressing", and "Degraded"
    // +patchMergeKey=type
    // +patchStrategy=merge
    // +listType=map
    // +listMapKey=type
    Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`

    // other fields
}

Type

object

Required

lastTransitionTime
message
reason
status
type

Property Type Description

Property	Type	Description
`lastTransitionTime`	`string`	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
`message`	`string`	message is a human readable message indicating details about the transition. This may be an empty string.
`observedGeneration`	`integer`	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
`reason`	`string`	reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
`status`	`string`	status of the condition, one of True, False, Unknown.
`type`	`string`	type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)

lastTransitionTime

string

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

message

string

message is a human readable message indicating details about the transition. This may be an empty string.

observedGeneration

integer

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

reason

string

reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

status

string

status of the condition, one of True, False, Unknown.

type

string

type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)

.status.installedBundle

Description

Type

object

Required

name
version

Property Type Description

Property	Type	Description
`name`	`string`
`version`	`string`

name

string

version

string

.status.resolvedBundle

Description

Type

object

Required

name
version

Property Type Description

Property	Type	Description
`name`	`string`
`version`	`string`

name

string

version

string

API endpoints

The following API endpoints are available:

/apis/olm.operatorframework.io/v1alpha1/clusterextensions
- DELETE: delete collection of ClusterExtension
- GET: list objects of kind ClusterExtension
- POST: create a ClusterExtension
/apis/olm.operatorframework.io/v1alpha1/clusterextensions/{name}
- DELETE: delete a ClusterExtension
- GET: read the specified ClusterExtension
- PATCH: partially update the specified ClusterExtension
- PUT: replace the specified ClusterExtension
/apis/olm.operatorframework.io/v1alpha1/clusterextensions/{name}/status
- GET: read status of the specified ClusterExtension
- PATCH: partially update status of the specified ClusterExtension
- PUT: replace status of the specified ClusterExtension

/apis/olm.operatorframework.io/v1alpha1/clusterextensions

HTTP method: DELETE
Description: delete collection of ClusterExtension

Table 1. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: list objects of kind ClusterExtension

Table 2. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterExtensionList` schema
401 - Unauthorized	Empty

HTTP method: POST
Description: create a ClusterExtension

Table 3. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 4. Body parameters
Parameter	Type	Description
`body`	`ClusterExtension` schema

Table 5. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterExtension` schema
201 - Created	`ClusterExtension` schema
202 - Accepted	`ClusterExtension` schema
401 - Unauthorized	Empty

/apis/olm.operatorframework.io/v1alpha1/clusterextensions/{name}

Table 6. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the ClusterExtension

HTTP method: DELETE
Description: delete a ClusterExtension

Table 7. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 8. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified ClusterExtension

Table 9. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterExtension` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified ClusterExtension

Table 10. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 11. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterExtension` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified ClusterExtension

Table 12. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 13. Body parameters
Parameter	Type	Description
`body`	`ClusterExtension` schema

Table 14. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterExtension` schema
201 - Created	`ClusterExtension` schema
401 - Unauthorized	Empty

/apis/olm.operatorframework.io/v1alpha1/clusterextensions/{name}/status

Table 15. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the ClusterExtension

HTTP method: GET
Description: read status of the specified ClusterExtension

Table 16. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterExtension` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update status of the specified ClusterExtension

Table 17. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 18. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterExtension` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace status of the specified ClusterExtension

Table 19. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 20. Body parameters
Parameter	Type	Description
`body`	`ClusterExtension` schema

Table 21. HTTP responses
HTTP code	Reponse body
200 - OK	`ClusterExtension` schema
201 - Created	`ClusterExtension` schema
401 - Unauthorized	Empty