Chapter 9. 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

9.1. Specification

PropertyTypeDescription

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

9.1.1. .spec

Description
PackageManifestSpec defines the desired state of PackageManifest
Type
object

9.1.2. .status

Description
PackageManifestStatus represents the current status of the PackageManifest
Type
object
Required
  • catalogSource
  • catalogSourceDisplayName
  • catalogSourcePublisher
  • catalogSourceNamespace
  • packageName
  • channels
  • defaultChannel
PropertyTypeDescription

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.

deprecation

object

Deprecation conveys information regarding a deprecated resource.

packageName

string

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

provider

object

AppLink defines a link to an application

9.1.3. .status.channels

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

9.1.4. .status.channels[]

Description
PackageChannel defines a single channel under a package, pointing to a version of that package.
Type
object
Required
  • name
  • currentCSV
  • entries
PropertyTypeDescription

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

deprecation

object

Deprecation conveys information regarding a deprecated resource.

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

9.1.5. .status.channels[].currentCSVDesc

Description
CSVDescription defines a description of a CSV
Type
object
PropertyTypeDescription

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

9.1.6. .status.channels[].currentCSVDesc.icon

Description
Icon is the CSV’s base64 encoded icon
Type
array

9.1.7. .status.channels[].currentCSVDesc.icon[]

Description
Icon defines a base64 encoded icon and media type
Type
object
PropertyTypeDescription

base64data

string

 

mediatype

string

 

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

Description
Type
array

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

Description
Maintainer defines a project maintainer
Type
object
PropertyTypeDescription

email

string

 

name

string

 

9.1.12. .status.channels[].currentCSVDesc.provider

Description
AppLink defines a link to an application
Type
object
PropertyTypeDescription

name

string

 

url

string

 

9.1.13. .status.channels[].deprecation

Description
Deprecation conveys information regarding a deprecated resource.
Type
object
Required
  • message
PropertyTypeDescription

message

string

Message is a human readable message describing the deprecation.

9.1.14. .status.channels[].entries

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

9.1.15. .status.channels[].entries[]

Description
ChannelEntry defines a member of a package channel.
Type
object
Required
  • name
PropertyTypeDescription

deprecation

object

Deprecation conveys information regarding a deprecated resource.

name

string

Name is the name of the bundle for this entry.

version

string

Version is the version of the bundle for this entry.

9.1.16. .status.channels[].entries[].deprecation

Description
Deprecation conveys information regarding a deprecated resource.
Type
object
Required
  • message
PropertyTypeDescription

message

string

Message is a human readable message describing the deprecation.

9.1.17. .status.deprecation

Description
Deprecation conveys information regarding a deprecated resource.
Type
object
Required
  • message
PropertyTypeDescription

message

string

Message is a human readable message describing the deprecation.

9.1.18. .status.provider

Description
AppLink defines a link to an application
Type
object
PropertyTypeDescription

name

string

 

url

string

 

9.2. 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

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

HTTP method
GET
Description
list objects of kind PackageManifest
Table 9.1. HTTP responses
HTTP codeReponse body

200 - OK

PackageManifestList schema

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

HTTP method
GET
Description
list objects of kind PackageManifest
Table 9.2. HTTP responses
HTTP codeReponse body

200 - OK

PackageManifestList schema

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

Table 9.3. Global path parameters
ParameterTypeDescription

name

string

name of the PackageManifest

HTTP method
GET
Description
read the specified PackageManifest
Table 9.4. HTTP responses
HTTP codeReponse body

200 - OK

PackageManifest schema

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

Table 9.5. Global path parameters
ParameterTypeDescription

name

string

name of the PackageManifest

HTTP method
GET
Description
connect GET requests to icon of PackageManifest
Table 9.6. HTTP responses
HTTP codeReponse body

200 - OK

string

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.