Red Hat SummitCe contenu n'est pas disponible dans la langue sélectionnée.
Chapter 11. 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
11.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 |
11.1.1. .spec
- Description
- PackageManifestSpec defines the desired state of PackageManifest
- Type
-
object
11.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 |
11.1.3. .status.channels
- Description
-
Channels are the declared channels for the package, ala
stableoralpha. - Type
-
array
11.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. |
11.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 |
11.1.6. .status.channels[].currentCSVDesc.icon
- Description
- Icon is the CSV’s base64 encoded icon
- Type
-
array
11.1.7. .status.channels[].currentCSVDesc.icon[]
- Description
- Icon defines a base64 encoded icon and media type
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| |
|
|
|
11.1.8. .status.channels[].currentCSVDesc.links
- Description
- Type
-
array
11.1.9. .status.channels[].currentCSVDesc.links[]
- Description
- AppLink defines a link to an application
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| |
|
|
|
11.1.10. .status.channels[].currentCSVDesc.maintainers
- Description
- Type
-
array
11.1.11. .status.channels[].currentCSVDesc.maintainers[]
- Description
- Maintainer defines a project maintainer
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| |
|
|
|
11.1.12. .status.channels[].currentCSVDesc.provider
- Description
- AppLink defines a link to an application
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| |
|
|
|
11.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. |
11.1.14. .status.channels[].entries
- Description
- Entries lists all CSVs in the channel, with their upgrade edges.
- Type
-
array
11.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. |
11.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. |
11.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. |
11.1.18. .status.provider
- Description
- AppLink defines a link to an application
- Type
-
object
| Property | Type | Description |
|---|---|---|
|
|
| |
|
|
|
11.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
-
11.2.1. /apis/packages.operators.coreos.com/v1/packagemanifests
- HTTP method
-
GET - Description
- list objects of kind PackageManifest
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
11.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 |
|
11.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 |
|
11.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 |
|
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}