PackageManifest [packages.operators.coreos.com/v1]
Description
PackageManifest holds information about a package, which is a reference to one (or more) channels under a single package.
Type
object
Specification
Property | Type | Description |
---|---|---|
|
| 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 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 |
| ||
|
| PackageManifestSpec defines the desired state of PackageManifest |
|
| PackageManifestStatus represents the current status of the PackageManifest |
.spec
Description
PackageManifestSpec defines the desired state of PackageManifest
Type
object
.status
Description
PackageManifestStatus represents the current status of the PackageManifest
Type
object
Required
catalogSource
catalogSourceDisplayName
catalogSourcePublisher
catalogSourceNamespace
packageName
channels
defaultChannel
Property | Type | Description |
---|---|---|
|
| CatalogSource is the name of the CatalogSource this package belongs to |
|
| |
|
| CatalogSourceNamespace is the namespace of the owning CatalogSource |
|
| |
|
| Channels are the declared channels for the package, ala |
|
| PackageChannel defines a single channel under a package, pointing to a version of that package. |
|
| DefaultChannel is, if specified, the name of the default channel for the package. The default channel will be installed if no other channel is explicitly given. If the package has a single channel, then that channel is implicitly the default. |
|
| PackageName is the name of the overall package, ala |
|
| AppLink defines a link to an application |
.status.channels
Description
Channels are the declared channels for the package, ala stable
or alpha
.
Type
array
.status.channels[]
Description
PackageChannel defines a single channel under a package, pointing to a version of that package.
Type
object
Required
name
currentCSV
Property | Type | Description |
---|---|---|
|
| CurrentCSV defines a reference to the CSV holding the version of this package currently for the channel. |
|
| CSVDescription defines a description of a CSV |
|
| Name is the name of the channel, e.g. |
.status.channels[].currentCSVDesc
Description
CSVDescription defines a description of a CSV
Type
object
Property | Type | Description |
---|---|---|
|
| |
|
| APIServiceDefinitions declares all of the extension apis managed or required by an operator being ran by ClusterServiceVersion. |
|
| CustomResourceDefinitions declares all of the CRDs managed or required by an operator being ran by ClusterServiceVersion. If the CRD is present in the Owned list, it is implicitly required. |
|
| LongDescription is the CSV’s description |
|
| DisplayName is the CSV’s display name |
|
| Icon is the CSV’s base64 encoded icon |
|
| Icon defines a base64 encoded icon and media type |
|
| InstallModes specify supported installation types |
|
| InstallMode associates an InstallModeType with a flag representing if the CSV supports it |
|
| |
|
| |
|
| AppLink defines a link to an application |
|
| |
|
| Maintainer defines a project maintainer |
|
| |
|
| Minimum Kubernetes version for operator installation |
| ||
|
| AppLink defines a link to an application |
|
| List of related images |
|
| OperatorVersion is a wrapper around semver.Version which supports correct marshaling to YAML and JSON. |
.status.channels[].currentCSVDesc.apiservicedefinitions
Description
APIServiceDefinitions declares all of the extension apis managed or required by an operator being ran by ClusterServiceVersion.
Type
object
Property | Type | Description |
---|---|---|
|
| |
|
| APIServiceDescription provides details to OLM about apis provided via aggregation |
|
| |
|
| APIServiceDescription provides details to OLM about apis provided via aggregation |
.status.channels[].currentCSVDesc.apiservicedefinitions.owned
Description
Type
array
.status.channels[].currentCSVDesc.apiservicedefinitions.owned[]
Description
APIServiceDescription provides details to OLM about apis provided via aggregation
Type
object
Required
name
group
version
kind
Property | Type | Description |
---|---|---|
|
| |
|
| ActionDescriptor describes a declarative action that can be performed on a custom resource instance |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| APIResourceReference is a Kubernetes resource type used by a custom resource |
|
| |
|
| SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it |
|
| |
|
| StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it |
|
|
.status.channels[].currentCSVDesc.apiservicedefinitions.owned[].actionDescriptors
Description
Type
array
.status.channels[].currentCSVDesc.apiservicedefinitions.owned[].actionDescriptors[]
Description
ActionDescriptor describes a declarative action that can be performed on a custom resource instance
Type
object
Required
path
Property | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
|
.status.channels[].currentCSVDesc.apiservicedefinitions.owned[].resources
Description
Type
array
.status.channels[].currentCSVDesc.apiservicedefinitions.owned[].resources[]
Description
APIResourceReference is a Kubernetes resource type used by a custom resource
Type
object
Required
name
kind
version
Property | Type | Description |
---|---|---|
|
| |
|
| |
|
|
.status.channels[].currentCSVDesc.apiservicedefinitions.owned[].specDescriptors
Description
Type
array
.status.channels[].currentCSVDesc.apiservicedefinitions.owned[].specDescriptors[]
Description
SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it
Type
object
Required
path
Property | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
|
.status.channels[].currentCSVDesc.apiservicedefinitions.owned[].statusDescriptors
Description
Type
array
.status.channels[].currentCSVDesc.apiservicedefinitions.owned[].statusDescriptors[]
Description
StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it
Type
object
Required
path
Property | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
|
.status.channels[].currentCSVDesc.apiservicedefinitions.required
Description
Type
array
.status.channels[].currentCSVDesc.apiservicedefinitions.required[]
Description
APIServiceDescription provides details to OLM about apis provided via aggregation
Type
object
Required
name
group
version
kind
Property | Type | Description |
---|---|---|
|
| |
|
| ActionDescriptor describes a declarative action that can be performed on a custom resource instance |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| APIResourceReference is a Kubernetes resource type used by a custom resource |
|
| |
|
| SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it |
|
| |
|
| StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it |
|
|
.status.channels[].currentCSVDesc.apiservicedefinitions.required[].actionDescriptors
Description
Type
array
.status.channels[].currentCSVDesc.apiservicedefinitions.required[].actionDescriptors[]
Description
ActionDescriptor describes a declarative action that can be performed on a custom resource instance
Type
object
Required
path
Property | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
|
.status.channels[].currentCSVDesc.apiservicedefinitions.required[].resources
Description
Type
array
.status.channels[].currentCSVDesc.apiservicedefinitions.required[].resources[]
Description
APIResourceReference is a Kubernetes resource type used by a custom resource
Type
object
Required
name
kind
version
Property | Type | Description |
---|---|---|
|
| |
|
| |
|
|
.status.channels[].currentCSVDesc.apiservicedefinitions.required[].specDescriptors
Description
Type
array
.status.channels[].currentCSVDesc.apiservicedefinitions.required[].specDescriptors[]
Description
SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it
Type
object
Required
path
Property | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
|
.status.channels[].currentCSVDesc.apiservicedefinitions.required[].statusDescriptors
Description
Type
array
.status.channels[].currentCSVDesc.apiservicedefinitions.required[].statusDescriptors[]
Description
StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it
Type
object
Required
path
Property | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
|
.status.channels[].currentCSVDesc.customresourcedefinitions
Description
CustomResourceDefinitions declares all of the CRDs managed or required by an operator being ran by ClusterServiceVersion.
If the CRD is present in the Owned list, it is implicitly required.
Type
object
Property | Type | Description |
---|---|---|
|
| |
|
| CRDDescription provides details to OLM about the CRDs |
|
| |
|
| CRDDescription provides details to OLM about the CRDs |
.status.channels[].currentCSVDesc.customresourcedefinitions.owned
Description
Type
array
.status.channels[].currentCSVDesc.customresourcedefinitions.owned[]
Description
CRDDescription provides details to OLM about the CRDs
Type
object
Required
name
version
kind
Property | Type | Description |
---|---|---|
|
| |
|
| ActionDescriptor describes a declarative action that can be performed on a custom resource instance |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| APIResourceReference is a Kubernetes resource type used by a custom resource |
|
| |
|
| SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it |
|
| |
|
| StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it |
|
|
.status.channels[].currentCSVDesc.customresourcedefinitions.owned[].actionDescriptors
Description
Type
array
.status.channels[].currentCSVDesc.customresourcedefinitions.owned[].actionDescriptors[]
Description
ActionDescriptor describes a declarative action that can be performed on a custom resource instance
Type
object
Required
path
Property | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
|
.status.channels[].currentCSVDesc.customresourcedefinitions.owned[].resources
Description
Type
array
.status.channels[].currentCSVDesc.customresourcedefinitions.owned[].resources[]
Description
APIResourceReference is a Kubernetes resource type used by a custom resource
Type
object
Required
name
kind
version
Property | Type | Description |
---|---|---|
|
| |
|
| |
|
|
.status.channels[].currentCSVDesc.customresourcedefinitions.owned[].specDescriptors
Description
Type
array
.status.channels[].currentCSVDesc.customresourcedefinitions.owned[].specDescriptors[]
Description
SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it
Type
object
Required
path
Property | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
|
.status.channels[].currentCSVDesc.customresourcedefinitions.owned[].statusDescriptors
Description
Type
array
.status.channels[].currentCSVDesc.customresourcedefinitions.owned[].statusDescriptors[]
Description
StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it
Type
object
Required
path
Property | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
|
.status.channels[].currentCSVDesc.customresourcedefinitions.required
Description
Type
array
.status.channels[].currentCSVDesc.customresourcedefinitions.required[]
Description
CRDDescription provides details to OLM about the CRDs
Type
object
Required
name
version
kind
Property | Type | Description |
---|---|---|
|
| |
|
| ActionDescriptor describes a declarative action that can be performed on a custom resource instance |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| APIResourceReference is a Kubernetes resource type used by a custom resource |
|
| |
|
| SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it |
|
| |
|
| StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it |
|
|
.status.channels[].currentCSVDesc.customresourcedefinitions.required[].actionDescriptors
Description
Type
array
.status.channels[].currentCSVDesc.customresourcedefinitions.required[].actionDescriptors[]
Description
ActionDescriptor describes a declarative action that can be performed on a custom resource instance
Type
object
Required
path
Property | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
|
.status.channels[].currentCSVDesc.customresourcedefinitions.required[].resources
Description
Type
array
.status.channels[].currentCSVDesc.customresourcedefinitions.required[].resources[]
Description
APIResourceReference is a Kubernetes resource type used by a custom resource
Type
object
Required
name
kind
version
Property | Type | Description |
---|---|---|
|
| |
|
| |
|
|
.status.channels[].currentCSVDesc.customresourcedefinitions.required[].specDescriptors
Description
Type
array
.status.channels[].currentCSVDesc.customresourcedefinitions.required[].specDescriptors[]
Description
SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it
Type
object
Required
path
Property | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
|
.status.channels[].currentCSVDesc.customresourcedefinitions.required[].statusDescriptors
Description
Type
array
.status.channels[].currentCSVDesc.customresourcedefinitions.required[].statusDescriptors[]
Description
StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it
Type
object
Required
path
Property | Type | Description |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
|
.status.channels[].currentCSVDesc.icon
Description
Icon is the CSV’s base64 encoded icon
Type
array
.status.channels[].currentCSVDesc.icon[]
Description
Icon defines a base64 encoded icon and media type
Type
object
Property | Type | Description |
---|---|---|
|
| |
|
|
.status.channels[].currentCSVDesc.installModes
Description
InstallModes specify supported installation types
Type
array
.status.channels[].currentCSVDesc.installModes[]
Description
InstallMode associates an InstallModeType with a flag representing if the CSV supports it
Type
object
Required
type
supported
Property | Type | Description |
---|---|---|
|
| |
|
|
.status.channels[].currentCSVDesc.links
Description
Type
array
.status.channels[].currentCSVDesc.links[]
Description
AppLink defines a link to an application
Type
object
Property | Type | Description |
---|---|---|
|
| |
|
|
.status.channels[].currentCSVDesc.maintainers
Description
Type
array
.status.channels[].currentCSVDesc.maintainers[]
Description
Maintainer defines a project maintainer
Type
object
Property | Type | Description |
---|---|---|
|
| |
|
|
.status.channels[].currentCSVDesc.provider
Description
AppLink defines a link to an application
Type
object
Property | Type | Description |
---|---|---|
|
| |
|
|
.status.provider
Description
AppLink defines a link to an application
Type
object
Property | Type | Description |
---|---|---|
|
| |
|
|
API endpoints
The following API endpoints are available:
/apis/packages.operators.coreos.com/v1/packagemanifests
GET
: list objects of kind PackageManifest
/apis/packages.operators.coreos.com/v1/namespaces/{namespace}/packagemanifests
GET
: list objects of kind PackageManifest
/apis/packages.operators.coreos.com/v1/namespaces/{namespace}/packagemanifests/{name}
GET
: read the specified PackageManifest
/apis/packages.operators.coreos.com/v1/packagemanifests
Parameter | Type | Description |
---|---|---|
|
| allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
|
| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
|
| A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
| A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
|
| If ‘true’, then the output is pretty printed. |
|
| When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
|
| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
HTTP method
GET
Description
list objects of kind PackageManifest
HTTP code | Reponse body |
---|---|
200 - OK |
/apis/packages.operators.coreos.com/v1/namespaces/{namespace}/packagemanifests
Parameter | Type | Description |
---|---|---|
|
| object name and auth scope, such as for teams and projects |
Parameter | Type | Description |
---|---|---|
|
| allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
|
| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
|
| A selector to restrict the list of returned objects by their fields. Defaults to everything. |
|
| A selector to restrict the list of returned objects by their labels. Defaults to everything. |
|
| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
|
| If ‘true’, then the output is pretty printed. |
|
| When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
|
| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
|
| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
HTTP method
GET
Description
list objects of kind PackageManifest
HTTP code | Reponse body |
---|---|
200 - OK |
/apis/packages.operators.coreos.com/v1/namespaces/{namespace}/packagemanifests/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the PackageManifest |
|
| object name and auth scope, such as for teams and projects |
Parameter | Type | Description |
---|---|---|
|
| If ‘true’, then the output is pretty printed. |
HTTP method
GET
Description
read the specified PackageManifest
HTTP code | Reponse body |
---|---|
200 - OK |