Skip to content

Commit b03d1d2

Browse files
committed
Add pkgman-to-bundle OSDK docs
1 parent 64a3b66 commit b03d1d2

24 files changed

+182
-38
lines changed

_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1283,6 +1283,8 @@ Topics:
12831283
File: osdk-monitoring-prometheus
12841284
- Name: Configuring leader election
12851285
File: osdk-leader-election
1286+
- Name: Migrating package manifest projects to bundle format
1287+
File: osdk-pkgman-to-bundle
12861288
- Name: Operator SDK CLI reference
12871289
File: osdk-cli-ref
12881290
- Name: Migrating to Operator SDK v0.1.0

cli_reference/opm-cli.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ toc::[]
88
include::modules/olm-about-opm.adoc[leveloffset=+1]
99
.Additional resources
1010

11-
* See xref:../operators/understanding/olm-packaging-format.adoc#olm-bundle-format_olm-packaging-format[Operator Framework packaging formats] for more information about the Bundle Format.
11+
* See xref:../operators/understanding/olm-packaging-format.adoc#olm-bundle-format_olm-packaging-format[Operator Framework packaging formats] for more information about the bundle format.
1212
* To create a bundle image using the Operator SDK, see
1313
xref:../operators/operator_sdk/osdk-working-bundle-images.adoc#osdk-working-bundle-images[Working with bundle images].
1414

modules/olm-about-catalogs.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77

88
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_.
99

10-
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.
10+
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.
1111

1212
[NOTE]
1313
====
14-
Starting in {product-title} 4.6, index images provided by Red Hat replace the App Registry catalog images, based on the deprecated Package Manifest Format, that are distributed for previous versions of {product-title} 4. While App Registry catalog images are not distributed by Red Hat for {product-title} 4.6 and later, custom catalog images based on the Package Manifest Format are still supported.
14+
Starting in {product-title} 4.6, index images provided by Red Hat replace the App Registry catalog images, based on the deprecated package manifest format, that are distributed for previous versions of {product-title} 4. While App Registry catalog images are not distributed by Red Hat for {product-title} 4.6 and later, custom catalog images based on the package manifest format are still supported.
1515
====
1616

1717
As catalogs are updated, the latest versions of Operators change, and older versions may be removed or altered. In addition, when OLM runs on an {product-title} cluster in a restricted network environment, it is unable to access the catalogs directly from the Internet to pull the latest content.

modules/olm-about-opm.adoc

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

9-
The `opm` CLI tool is provided by the Operator Framework for use with the Operator Bundle Format. This tool allows you to create and maintain catalogs of Operators from a list of bundles, called an _index_, that are similar to software repositories. The result is a container image, called an _index image_, which can be stored in a container registry and then installed on a cluster.
9+
The `opm` CLI tool is provided by the Operator Framework for use with the Operator bundle format. This tool allows you to create and maintain catalogs of Operators from a list of bundles, called an _index_, that are similar to software repositories. The result is a container image, called an _index image_, which can be stored in a container registry and then installed on a cluster.
1010

1111
An index contains a database of pointers to Operator manifest content that can be queried through an included API that is served when the container image is run. On {product-title}, Operator Lifecycle Manager (OLM) can use the index image as a catalog by referencing it in a `CatalogSource` object, which polls the image at regular intervals to enable frequent updates to installed Operators on the cluster.

modules/olm-accessing-images-private-registries.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Other images required by an Operator or its Operands might require access to pri
1111

1212
The following types of images should be considered when determining whether Operators managed by OLM have appropriate pull access:
1313

14-
Index or catalog images:: A `CatalogSource` object can reference an index image or a catalog image, which are catalog sources packaged as container images hosted in images registries. Index images use the Bundle Format and reference bundle images, while catalog images use the Package Manifest Format. If an index or catalog image is hosted in a private registry, a secret can be used to enable pull access.
14+
Index or catalog images:: A `CatalogSource` object can reference an index image or a catalog image, which are catalog sources packaged as container images hosted in images registries. Index images use the bundle format and reference bundle images, while catalog images use the package manifest format. If an index or catalog image is hosted in a private registry, a secret can be used to enable pull access.
1515

1616
Bundle images:: Operator bundle images are metadata and manifests packaged as container images that represent a unique version of an Operator. If any bundle images referenced in a catalog source are hosted in one or more private registries, a secret can be used to enable pull access.
1717

modules/olm-building-operator-catalog-image.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ ifndef::openshift-origin[]
1010
endif::[]
1111

1212
[id="olm-building-operator-catalog-image_{context}"]
13-
= Building a Package Manifest Format catalog image
13+
= Building a package manifest format catalog image
1414

15-
Cluster administrators can build a custom Operator catalog image based on the Package Manifest Format to be used by Operator Lifecycle Manager (OLM). The catalog image can be pushed to a container image registry that supports link:https://docs.docker.com/registry/spec/manifest-v2-2/[Docker v2-2]. For a cluster on a restricted network, this registry can be a registry that the cluster has network access to, such as a mirror registry created during a restricted network cluster installation.
15+
Cluster administrators can build a custom Operator catalog image based on the package manifest format to be used by Operator Lifecycle Manager (OLM). The catalog image can be pushed to a container image registry that supports link:https://docs.docker.com/registry/spec/manifest-v2-2/[Docker v2-2]. For a cluster on a restricted network, this registry can be a registry that the cluster has network access to, such as a mirror registry created during a restricted network cluster installation.
1616

1717
For this example, the procedure assumes use of a mirror registry that has access to both your network and the Internet.
1818

modules/olm-bundle-format.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
// * operators/understanding/olm/olm-packaging-format.adoc
44

55
[id="olm-bundle-format_{context}"]
6-
= Bundle Format
6+
= Bundle format
77

8-
The _Bundle Format_ for Operators is a new packaging format introduced by the Operator Framework. To improve scalability and to better enable upstream users hosting their own catalogs, the Bundle Format specification simplifies the distribution of Operator metadata.
8+
The _bundle format_ for Operators is a new packaging format introduced by the Operator Framework. To improve scalability and to better enable upstream users hosting their own catalogs, the bundle format specification simplifies the distribution of Operator metadata.
99

1010
An Operator bundle represents a single version of an Operator. On-disk _bundle manifests_ are containerized and shipped as a _bundle image_, which is a non-runnable container image that stores the Kubernetes manifests and Operator metadata. Storage and distribution of the bundle image is then managed using existing container tools like `podman` and `docker` and container registries such as Quay.
1111

@@ -29,7 +29,7 @@ Bundle manifests refer to a set of Kubernetes manifests that define the deployme
2929

3030
A bundle includes one CSV per directory and typically the CRDs that define the owned APIs of the CSV in its `/manifests` directory.
3131

32-
.Example Bundle Format layout
32+
.Example bundle format layout
3333
[source,terminal]
3434
----
3535
etcd

modules/olm-mirroring-catalog.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ If your cluster uses an `ImageContentSourcePolicy` object to configure repositor
184184
+
185185
[IMPORTANT]
186186
====
187-
If you used the `--manifests-only` flag during the mirroring process and want to further trim the subset of packages to be mirrored, see the steps in the "Mirroring a Package Manifest Format catalog image" procedure about modifying your `mapping.txt` file and using the file with the `oc image mirror` command. After following those further actions, you can continue this procedure.
187+
If you used the `--manifests-only` flag during the mirroring process and want to further trim the subset of packages to be mirrored, see the steps in the "Mirroring a package manifest format catalog image" procedure about modifying your `mapping.txt` file and using the file with the `oc image mirror` command. After following those further actions, you can continue this procedure.
188188
====
189189
--
190190

modules/olm-mirroring-package-manifest-catalog.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
// * operators/admin/olm-managing-custom-catalogs.adoc
44

55
[id="olm-mirroring-package-manifest-catalog_{context}"]
6-
= Mirroring a Package Manifest Format catalog image
6+
= Mirroring a package manifest format catalog image
77

8-
Cluster administrators can mirror a custom Operator catalog image based on the Package Manifest Format into a registry and use a catalog source to load the content onto their cluster. For this example, the procedure uses a custom `redhat-operators` catalog image previously built and pushed to a supported registry.
8+
Cluster administrators can mirror a custom Operator catalog image based on the package manifest format into a registry and use a catalog source to load the content onto their cluster. For this example, the procedure uses a custom `redhat-operators` catalog image previously built and pushed to a supported registry.
99

1010
.Prerequisites
1111

1212
* Workstation with unrestricted network access
13-
* A custom Operator catalog image based on the Package Manifest Format pushed to a supported registry
13+
* A custom Operator catalog image based on the package manifest format pushed to a supported registry
1414
* `oc` version 4.3.5+
1515
* `podman` version 1.9.3+
1616
* Access to mirror registry that supports link:https://docs.docker.com/registry/spec/manifest-v2-2/[Docker v2-2]

modules/olm-package-manifest-format-catalogsource.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
// * operators/admin/olm-managing-custom-catalogs.adoc
44

55
[id="olm-package-manifest-format-catalogsource_{context}"]
6-
= Creating a catalog from a Package Manifest Format catalog image
6+
= Creating a catalog from a package manifest format catalog image
77

8-
Cluster administrators use a custom Operator catalog image based on the Package Manifest Format to create a catalog source that loads the Operator content onto their cluster. For this example, the procedure uses a custom `redhat-operators` catalog image previously built and pushed to a supported registry.
8+
Cluster administrators use a custom Operator catalog image based on the package manifest format to create a catalog source that loads the Operator content onto their cluster. For this example, the procedure uses a custom `redhat-operators` catalog image previously built and pushed to a supported registry.
99

1010
.Prerequisites
1111

12-
* A custom Operator catalog image based on the Package Manifest Format pushed to a supported registry
12+
* A custom Operator catalog image based on the package manifest format pushed to a supported registry
1313
* `oc` version 4.3.5+
1414

1515
.Procedure

0 commit comments

Comments
 (0)