×

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 meta/v1

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

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

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

object

APIServiceDefinitions declares all of the extension apis managed or required by an operator being ran by ClusterServiceVersion.

customresourcedefinitions

object

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.

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

InstallModes specify supported installation types

installModes[]

object

InstallMode associates an InstallModeType with a flag representing if the CSV supports it

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 meta/v1)

provider

object

AppLink defines a link to an application

relatedImages

array (string)

List of related images

version

string

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

owned

array

owned[]

object

APIServiceDescription provides details to OLM about apis provided via aggregation

required

array

required[]

object

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

actionDescriptors

array

actionDescriptors[]

object

ActionDescriptor describes a declarative action that can be performed on a custom resource instance

containerPort

integer

deploymentName

string

description

string

displayName

string

group

string

kind

string

name

string

resources

array

resources[]

object

APIResourceReference is a Kubernetes resource type used by a custom resource

specDescriptors

array

specDescriptors[]

object

SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it

statusDescriptors

array

statusDescriptors[]

object

StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it

version

string

.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

description

string

displayName

string

path

string

value

string

x-descriptors

array (string)

.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

kind

string

name

string

version

string

.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

description

string

displayName

string

path

string

value

string

x-descriptors

array (string)

.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

description

string

displayName

string

path

string

value

string

x-descriptors

array (string)

.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

actionDescriptors

array

actionDescriptors[]

object

ActionDescriptor describes a declarative action that can be performed on a custom resource instance

containerPort

integer

deploymentName

string

description

string

displayName

string

group

string

kind

string

name

string

resources

array

resources[]

object

APIResourceReference is a Kubernetes resource type used by a custom resource

specDescriptors

array

specDescriptors[]

object

SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it

statusDescriptors

array

statusDescriptors[]

object

StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it

version

string

.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

description

string

displayName

string

path

string

value

string

x-descriptors

array (string)

.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

kind

string

name

string

version

string

.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

description

string

displayName

string

path

string

value

string

x-descriptors

array (string)

.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

description

string

displayName

string

path

string

value

string

x-descriptors

array (string)

.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

owned

array

owned[]

object

CRDDescription provides details to OLM about the CRDs

required

array

required[]

object

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

actionDescriptors

array

actionDescriptors[]

object

ActionDescriptor describes a declarative action that can be performed on a custom resource instance

description

string

displayName

string

kind

string

name

string

resources

array

resources[]

object

APIResourceReference is a Kubernetes resource type used by a custom resource

specDescriptors

array

specDescriptors[]

object

SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it

statusDescriptors

array

statusDescriptors[]

object

StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it

version

string

.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

description

string

displayName

string

path

string

value

string

x-descriptors

array (string)

.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

kind

string

name

string

version

string

.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

description

string

displayName

string

path

string

value

string

x-descriptors

array (string)

.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

description

string

displayName

string

path

string

value

string

x-descriptors

array (string)

.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

actionDescriptors

array

actionDescriptors[]

object

ActionDescriptor describes a declarative action that can be performed on a custom resource instance

description

string

displayName

string

kind

string

name

string

resources

array

resources[]

object

APIResourceReference is a Kubernetes resource type used by a custom resource

specDescriptors

array

specDescriptors[]

object

SpecDescriptor describes a field in a spec block of a CRD so that OLM can consume it

statusDescriptors

array

statusDescriptors[]

object

StatusDescriptor describes a field in a status block of a CRD so that OLM can consume it

version

string

.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

description

string

displayName

string

path

string

value

string

x-descriptors

array (string)

.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