mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
97bae04edb
resolving error in HCP topic map indentation removed the < and replaced with brackets for tech preview in HCP topic map removed the < and replaced with brackets for Operators tech preview in HCP topic map removed the file with tech preview for Operators in HCP topic map applied conditions to 20 xrefs because the networking, cli, authentication and observability books are not in HCP repo yet added blank line after and endif and an include module
79 lines
4.5 KiB
Plaintext
79 lines
4.5 KiB
Plaintext
:_mod-docs-content-type: ASSEMBLY
|
|
[id="olm-packaging-format"]
|
|
= Operator Framework packaging format
|
|
include::_attributes/common-attributes.adoc[]
|
|
:context: olm-packaging-format
|
|
|
|
toc::[]
|
|
|
|
This guide outlines the packaging format for Operators supported by Operator Lifecycle Manager (OLM) in {product-title}.
|
|
|
|
include::modules/olm-bundle-format.adoc[leveloffset=+1]
|
|
include::modules/olm-dependencies.adoc[leveloffset=+2]
|
|
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
|
|
* xref:../../operators/understanding/olm/olm-understanding-dependency-resolution.adoc#olm-understanding-dependency-resolution[Operator Lifecycle Manager dependency resolution]
|
|
|
|
include::modules/olm-about-opm.adoc[leveloffset=+2]
|
|
// TODO-HCP remove conditions for HCP after cli_tools book is migrated
|
|
ifndef::openshift-rosa-hcp[]
|
|
* See xref:../../cli_reference/opm/cli-opm-install.adoc#cli-opm-install[CLI tools] for steps on installing the `opm` CLI.
|
|
endif::openshift-rosa-hcp[]
|
|
|
|
ifdef::openshift-origin[]
|
|
[id="olm-packaging-format-addtl-resources"]
|
|
[role="_additional-resources"]
|
|
== Additional resources
|
|
|
|
* See the upstream `operator-framework/operator-registry` project repository for more information on the Operator bundle format:
|
|
** link:https://github.com/operator-framework/operator-registry/blob/master/docs/design/operator-bundle.md[Operator Bundle Overview]
|
|
** link:https://github.com/operator-framework/operator-registry/blob/master/README.md[Operator Registry README]
|
|
* See the project *Releases* page for `opm` CLI downloads:
|
|
** link:https://github.com/operator-framework/operator-registry/releases[Releases]
|
|
endif::[]
|
|
|
|
include::modules/olm-fb-catalogs.adoc[leveloffset=+1]
|
|
[IMPORTANT]
|
|
====
|
|
As of {product-title} 4.11, the default Red Hat-provided Operator catalog releases in the file-based catalog format. The default Red Hat-provided Operator catalogs for {product-title} 4.6 through 4.10 released in the deprecated SQLite database format.
|
|
|
|
The `opm` subcommands, flags, and functionality related to the SQLite database format are also deprecated and will be removed in a future release. The features are still supported and must be used for catalogs that use the deprecated SQLite database format.
|
|
|
|
Many of the `opm` subcommands and flags for working with the SQLite database format, such as `opm index prune`, do not work with the file-based catalog format.
|
|
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
For more information about working with file-based catalogs, see xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-managing-custom-catalogs-fb[Managing custom catalogs] and xref:../../disconnected/mirroring/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plugin].
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
For more information about working with file-based catalogs, see xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-managing-custom-catalogs-fb[Managing custom catalogs].
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
====
|
|
|
|
include::modules/olm-fb-catalogs-structure.adoc[leveloffset=+2]
|
|
|
|
include::modules/olm-fb-catalogs-schemas.adoc[leveloffset=+2]
|
|
include::modules/olm-package-schema.adoc[leveloffset=+3]
|
|
include::modules/olm-channel-schema.adoc[leveloffset=+3]
|
|
include::modules/olm-bundle-schema.adoc[leveloffset=+3]
|
|
include::modules/olm-deprecations-schema.adoc[leveloffset=+3]
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
|
|
* xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-filtering-fbc_olm-managing-custom-catalogs[Updating or filtering a file-based catalog image]
|
|
|
|
include::modules/olm-fb-catalogs-prop.adoc[leveloffset=+2]
|
|
include::modules/olm-fb-catalogs-example.adoc[leveloffset=+2]
|
|
include::modules/olm-fb-catalogs-guidelines.adoc[leveloffset=+2]
|
|
|
|
[id="olm-fb-catalogs-cli"]
|
|
=== CLI usage
|
|
|
|
For instructions about creating file-based catalogs by using the `opm` CLI, see xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-creating-fb-catalog-image_olm-managing-custom-catalogs[Managing custom catalogs].
|
|
// TODO-HCP remove conditions for HCP after cli_tools book is migrated
|
|
ifndef::openshift-rosa-hcp[]
|
|
For reference documentation about the `opm` CLI commands related to managing file-based catalogs, see xref:../../cli_reference/opm/cli-opm-ref.adoc#cli-opm-ref[CLI tools].
|
|
endif::openshift-rosa-hcp[]
|
|
|
|
include::modules/olm-fb-catalogs-automation.adoc[leveloffset=+2]
|