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
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 |
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
-
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. |
|
| Deprecation conveys information regarding a deprecated resource. |
|
|
PackageName is the name of the overall package, ala |
|
| AppLink defines a link to an application |
9.1.3. .status.channels
- Description
-
Channels are the declared channels for the package, ala
stable
oralpha
. - 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
-
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 |
|
| Deprecation conveys information regarding a deprecated resource. |
|
| Entries lists all CSVs in the channel, with their upgrade edges. |
|
| ChannelEntry defines a member of a package channel. |
|
|
Name is the name of the channel, e.g. |
9.1.5. .status.channels[].currentCSVDesc
- Description
- CSVDescription defines a description of a CSV
- Type
-
object
Property | Type | Description |
---|---|---|
|
| |
| ||
| ||
|
| 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 | |
|
| |
|
| |
|
| 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 |
| 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
Property | Type | Description |
---|---|---|
|
| |
|
|
9.1.8. .status.channels[].currentCSVDesc.links
- Description
- Type
-
array
9.1.9. .status.channels[].currentCSVDesc.links[]
- Description
- AppLink defines a link to an application
- Type
-
object
Property | Type | Description |
---|---|---|
|
| |
|
|
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
Property | Type | Description |
---|---|---|
|
| |
|
|
9.1.12. .status.channels[].currentCSVDesc.provider
- Description
- AppLink defines a link to an application
- Type
-
object
Property | Type | Description |
---|---|---|
|
| |
|
|
9.1.13. .status.channels[].deprecation
- Description
- Deprecation conveys information regarding a deprecated resource.
- Type
-
object
- Required
-
message
-
Property | Type | Description |
---|---|---|
|
| 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
-
Property | Type | Description |
---|---|---|
|
| Deprecation conveys information regarding a deprecated resource. |
|
| Name is the name of the bundle for this entry. |
|
| 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
-
Property | Type | Description |
---|---|---|
|
| 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
-
Property | Type | Description |
---|---|---|
|
| Message is a human readable message describing the deprecation. |
9.1.18. .status.provider
- Description
- AppLink defines a link to an application
- Type
-
object
Property | Type | Description |
---|---|---|
|
| |
|
|
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
HTTP code | Reponse body |
---|---|
200 - OK |
|
9.2.2. /apis/packages.operators.coreos.com/v1/namespaces/{namespace}/packagemanifests
- HTTP method
-
GET
- Description
- list objects of kind PackageManifest
HTTP code | Reponse body |
---|---|
200 - OK |
|
9.2.3. /apis/packages.operators.coreos.com/v1/namespaces/{namespace}/packagemanifests/{name}
Parameter | Type | Description |
---|---|---|
|
| name of the PackageManifest |
- HTTP method
-
GET
- Description
- read the specified PackageManifest
HTTP code | Reponse body |
---|---|
200 - OK |
|
9.2.4. /apis/packages.operators.coreos.com/v1/namespaces/{namespace}/packagemanifests/{name}/icon
Parameter | Type | Description |
---|---|---|
|
| name of the PackageManifest |
- HTTP method
-
GET
- Description
- connect GET requests to icon of PackageManifest
HTTP code | Reponse body |
---|---|
200 - OK |
|