Skip to content

Commit 63ed1eb

Browse files
michaelryanpetermichaelryanpeter
authored
Merge pull request #48113 from michaelryanpeter/osdocs-3463--olm-fbc-refs-for-operator-catalogs
OSDOCS-3463 OLM file-based catalog update
2 parents 3243c4a + da37609 commit 63ed1eb

File tree

8 files changed

+60
-9
lines changed

8 files changed

+60
-9
lines changed

‎cli_reference/opm/cli-opm-ref.adoc‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,15 @@ $ opm <command> [<subcommand>] [<argument>] [<flags>]
2727
:FeatureName: The SQLite-based catalog format, including the related CLI commands,
2828
include::modules/deprecated-feature.adoc[]
2929

30-
include::modules/opm-cli-ref-index.adoc[leveloffset=+1]
3130
include::modules/opm-cli-ref-init.adoc[leveloffset=+1]
3231
include::modules/opm-cli-ref-render.adoc[leveloffset=+1]
3332
include::modules/opm-cli-ref-validate.adoc[leveloffset=+1]
3433
include::modules/opm-cli-ref-serve.adoc[leveloffset=+1]
34+
include::modules/opm-cli-ref-index.adoc[leveloffset=+1]
35+
36+
[role="_additional-resources"]
37+
.Additional resources
38+
39+
* xref:../../operators/understanding/olm-packaging-format.adoc#olm-file-based-catalogs_olm-packaging-format[Operator Framework packaging format]
40+
* xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-managing-custom-catalogs-fb[Managing custom catalogs]
41+
* xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plug-in]

‎modules/olm-about-catalogs.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="olm-about-catalogs_{context}"]
77
= About Operator catalogs
88

9-
An Operator catalog is a repository of metadata that Operator Lifecycle Manager (OLM) can query to discover and install Operators and their dependencies on a cluster. OLM always installs Operators from the latest version of a catalog. As of {product-title} 4.6, Red Hat-provided catalogs are distributed using _index images_.
9+
An Operator catalog is a repository of metadata that Operator Lifecycle Manager (OLM) can query to discover and install Operators and their dependencies on a cluster. OLM always installs Operators from the latest version of a catalog.
1010

1111
An index image, based on the Operator bundle format, is a containerized snapshot of a catalog. It is an immutable artifact that contains the database of pointers to a set of Operator manifest content. A catalog can reference an index image to source its content for OLM on the cluster.
1212

‎modules/olm-fb-catalogs.adoc‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,12 @@
22
//
33
// * operators/understanding/olm-packaging-format.adoc
44

5+
:_content-type: CONCEPT
56
[id="olm-file-based-catalogs_{context}"]
67
= File-based catalogs
78

89
_File-based catalogs_ are the latest iteration of the catalog format in Operator Lifecycle Manager (OLM). It is a plain text-based (JSON or YAML) and declarative config evolution of the earlier SQLite database format, and it is fully backwards compatible. The goal of this format is to enable Operator catalog editing, composability, and extensibility.
910

10-
[NOTE]
11-
====
12-
The default Red Hat-provided Operator catalogs for {product-title} 4.6 and later are currently still shipped in the SQLite database format.
13-
====
14-
1511
Editing::
1612
With file-based catalogs, users interacting with the contents of a catalog are able to make direct changes to the format and verify that their changes are valid. Because this format is plain text JSON or YAML, catalog maintainers can easily manipulate catalog metadata by hand or with widely known and supported JSON or YAML tooling, such as the `jq` CLI.
1713
+

‎modules/opm-cli-ref-index.adoc‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,16 @@
55
[id="opm-cli-ref-index_{context}"]
66
= index
77

8-
Generate Operator index container images from pre-existing Operator bundles.
8+
Generate Operator index for SQLite database format container images from pre-existing Operator bundles.
9+
10+
[IMPORTANT]
11+
====
12+
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.
13+
14+
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.
15+
16+
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. For more information about working with file-based catalogs, see "Additional resources".
17+
====
918

1019
.Command syntax
1120
[source,terminal]

‎operators/admin/olm-managing-custom-catalogs.adoc‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,14 @@ If your cluster is using custom catalogs, see xref:../../operators/operator_sdk/
3030

3131
_File-based catalogs_ are the latest iteration of the catalog format in Operator Lifecycle Manager (OLM). It is a plain text-based (JSON or YAML) and declarative config evolution of the earlier SQLite database format, and it is fully backwards compatible.
3232

33-
For more details about the file-based catalog specification, see xref:../../operators/understanding/olm-packaging-format.adoc#olm-file-based-catalogs_olm-packaging-format[Operator Framework packaging format].
33+
[IMPORTANT]
34+
====
35+
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.
36+
37+
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.
38+
39+
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. For more information about working with file-based catalogs, see xref:../../operators/understanding/olm-packaging-format.adoc#olm-file-based-catalogs_olm-packaging-format[Operator Framework packaging format] and xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plug-in].
40+
====
3441

3542
include::modules/olm-creating-fb-catalog-image.adoc[leveloffset=+2]
3643

‎operators/admin/olm-restricted-networks.adoc‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,15 @@ include::modules/olm-pruning-index-image.adoc[leveloffset=+1]
5757

5858
For instructions about mirroring Operator catalogs for use with disconnected clusters, see xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#olm-mirroring-catalog_installing-mirroring-installation-images[Installing -> Mirroring images for a disconnected installation].
5959

60+
[IMPORTANT]
61+
====
62+
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.
63+
64+
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.
65+
66+
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. For more information about working with file-based catalogs, see xref:../../operators/understanding/olm-packaging-format.adoc#olm-file-based-catalogs_olm-packaging-format[Operator Framework packaging format], xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-managing-custom-catalogs-fb[Managing custom catalogs], and xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plug-in].
67+
====
68+
6069
include::modules/olm-creating-catalog-from-index.adoc[leveloffset=+1]
6170

6271
[role="_additional-resources"]

‎operators/understanding/olm-packaging-format.adoc‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ include::modules/olm-dependencies.adoc[leveloffset=+2]
2323
* xref:../../operators/understanding/olm/olm-understanding-dependency-resolution.adoc#olm-understanding-dependency-resolution[Operator Lifecycle Manager dependency resolution]
2424
2525
include::modules/olm-about-opm.adoc[leveloffset=+2]
26+
2627
* See xref:../../cli_reference/opm/cli-opm-install.adoc#cli-opm-install[CLI tools] for steps on installing the `opm` CLI.
2728
2829
ifdef::openshift-origin[]
@@ -38,6 +39,15 @@ ifdef::openshift-origin[]
3839
endif::[]
3940
4041
include::modules/olm-fb-catalogs.adoc[leveloffset=+1]
42+
[IMPORTANT]
43+
====
44+
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.
45+
46+
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.
47+
48+
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. 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:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plug-in].
49+
====
50+
4151
include::modules/olm-fb-catalogs-structure.adoc[leveloffset=+2]
4252
include::modules/olm-fb-catalogs-schemas.adoc[leveloffset=+2]
4353
include::modules/olm-fb-catalogs-prop.adoc[leveloffset=+2]

‎operators/understanding/olm-rh-catalogs.adoc‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,25 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9+
Red Hat provides several Operator catalogs that are included with {product-title} by default.
10+
11+
[IMPORTANT]
12+
====
13+
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.
14+
15+
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.
16+
17+
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. For more information about working with file-based catalogs, see xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-managing-custom-catalogs[Managing custom catalogs],
18+
xref:../../operators/understanding/olm-packaging-format.adoc#olm-file-based-catalogs_olm-packaging-format[Operator Framework packaging format], and xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[Mirroring images for a disconnected installation using the oc-mirror plug-in].
19+
====
20+
921
include::modules/olm-about-catalogs.adoc[leveloffset=+1]
1022

1123
[role="_additional-resources"]
1224
.Additional resources
1325

1426
* xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-managing-custom-catalogs[Managing custom catalogs]
27+
* xref:../../operators/understanding/olm-packaging-format.adoc#olm-file-based-catalogs_olm-packaging-format[Packaging format]
1528
* xref:../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks]
1629
1730
include::modules/olm-rh-catalogs.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)