×

Specification

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

spec

object

PackageManifestSpec defines the desired state of PackageManifest

status

object

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

string

CatalogSource is the name of the CatalogSource this package belongs to

catalogSourceDisplayName

string

catalogSourceNamespace

string

CatalogSourceNamespace is the namespace of the owning CatalogSource

catalogSourcePublisher

string

channels

array

Channels are the declared channels for the package, ala stable or alpha.

channels[]

object

PackageChannel defines a single channel under a package, pointing to a version of that package.

defaultChannel

string

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

string

PackageName is the name of the overall package, ala etcd.

provider

object

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

  • entries

Property Type Description

currentCSV

string

CurrentCSV defines a reference to the CSV holding the version of this package currently for the channel.

currentCSVDesc

object

CSVDescription defines a description of a CSV

entries

array

Entries lists all CSVs in the channel, with their upgrade edges.

entries[]

object

ChannelEntry defines a member of a package channel.

name

string

Name is the name of the channel, e.g. alpha or stable

.status.channels[].currentCSVDesc

Description

CSVDescription defines a description of a CSV

Type

object

Property Type Description

annotations

object (string)

apiservicedefinitions

APIServiceDefinitions

customresourcedefinitions

CustomResourceDefinitions

description

string

LongDescription is the CSV’s description

displayName

string

DisplayName is the CSV’s display name

icon

array

Icon is the CSV’s base64 encoded icon

icon[]

object

Icon defines a base64 encoded icon and media type

installModes

array (InstallMode)

InstallModes specify supported installation types

keywords

array (string)

links

array

links[]

object

AppLink defines a link to an application

maintainers

array

maintainers[]

object

Maintainer defines a project maintainer

maturity

string

minKubeVersion

string

Minimum Kubernetes version for operator installation

nativeApis

array (GroupVersionKind)

provider

object

AppLink defines a link to an application

relatedImages

array (string)

List of related images

version

OperatorVersion

Version is the CSV’s semantic version

.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

base64data

string

mediatype

string

Description
Type

array

Description

AppLink defines a link to an application

Type

object

Property Type Description

name

string

url

string

.status.channels[].currentCSVDesc.maintainers

Description
Type

array

.status.channels[].currentCSVDesc.maintainers[]

Description

Maintainer defines a project maintainer

Type

object

Property Type Description

email

string

name

string

.status.channels[].currentCSVDesc.provider

Description

AppLink defines a link to an application

Type

object

Property Type Description

name

string

url

string

.status.channels[].entries

Description

Entries lists all CSVs in the channel, with their upgrade edges.

Type

array

.status.channels[].entries[]

Description

ChannelEntry defines a member of a package channel.

Type

object

Required
  • name

Property Type Description

name

string

Name is the name of the bundle for this entry.

version

string

Version is the version of the bundle for this entry.

.status.provider

Description

AppLink defines a link to an application

Type

object

Property Type Description

name

string

url

string

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/namespaces/{namespace}/packagemanifests/{name}/icon

    • GET: connect GET requests to icon of PackageManifest

/apis/packages.operators.coreos.com/v1/packagemanifests

Table 1. Global query parameters
Parameter Type Description

allowWatchBookmarks

boolean

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.

continue

string

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.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

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.

pretty

string

If 'true', then the output is pretty printed.

resourceVersion

string

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

sendInitialEvents

boolean

sendInitialEvents=true may be set together with watch=true. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic "Bookmark" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with "k8s.io/initial-events-end": "true" annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.

When sendInitialEvents option is set, we require resourceVersionMatch option to also be set. The semantic of the watch request is as following: - resourceVersionMatch = NotOlderThan is interpreted as "data at least as new as the provided resourceVersion`" and the bookmark event is send when the state is synced to a `resourceVersion at least as fresh as the one provided by the ListOptions. If resourceVersion is unset, this is interpreted as "consistent read" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - resourceVersionMatch set to any other value or unset Invalid error is returned.

Defaults to true if resourceVersion="" or resourceVersion="0" (for backward compatibility reasons) and to false otherwise.

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

boolean

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

Table 2. HTTP responses
HTTP code Reponse body

200 - OK

PackageManifestList schema

/apis/packages.operators.coreos.com/v1/namespaces/{namespace}/packagemanifests

Table 3. Global path parameters
Parameter Type Description

namespace

string

object name and auth scope, such as for teams and projects

Table 4. Global query parameters
Parameter Type Description

allowWatchBookmarks

boolean

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.

continue

string

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.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

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.

pretty

string

If 'true', then the output is pretty printed.

resourceVersion

string

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

sendInitialEvents

boolean

sendInitialEvents=true may be set together with watch=true. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic "Bookmark" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with "k8s.io/initial-events-end": "true" annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.

When sendInitialEvents option is set, we require resourceVersionMatch option to also be set. The semantic of the watch request is as following: - resourceVersionMatch = NotOlderThan is interpreted as "data at least as new as the provided resourceVersion`" and the bookmark event is send when the state is synced to a `resourceVersion at least as fresh as the one provided by the ListOptions. If resourceVersion is unset, this is interpreted as "consistent read" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - resourceVersionMatch set to any other value or unset Invalid error is returned.

Defaults to true if resourceVersion="" or resourceVersion="0" (for backward compatibility reasons) and to false otherwise.

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

boolean

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

Table 5. HTTP responses
HTTP code Reponse body

200 - OK

PackageManifestList schema

/apis/packages.operators.coreos.com/v1/namespaces/{namespace}/packagemanifests/{name}

Table 6. Global path parameters
Parameter Type Description

name

string

name of the PackageManifest

namespace

string

object name and auth scope, such as for teams and projects

Table 7. Global query parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.

HTTP method

GET

Description

read the specified PackageManifest

Table 8. HTTP responses
HTTP code Reponse body

200 - OK

PackageManifest schema

/apis/packages.operators.coreos.com/v1/namespaces/{namespace}/packagemanifests/{name}/icon

Table 9. Global path parameters
Parameter Type Description

name

string

name of the PackageManifest

namespace

string

object name and auth scope, such as for teams and projects

HTTP method

GET

Description

connect GET requests to icon of PackageManifest

Table 10. HTTP responses
HTTP code Reponse body

200 - OK

string