You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ And libraries:
23
23
# Manifest format
24
24
25
25
26
-
We refer to a directory of files with one ClusterServiceVersion as a "bundle". A bundle typically includes a ClusterServiceVersion and the CRDs that define the owned APIs of the CSV in its manifest directory, though additional objects may be included. It also includes an annotations file in its metadata folder which defines some higher level aggregate data that helps describe the format and package information about how the bundle should be added into an index of bundles.
26
+
We refer to a directory of files with one ClusterServiceVersion as a "bundle". A bundle typically includes a ClusterServiceVersion and the CRDs that define the owned APIs of the CSV in its manifest directory, though additional objects may be included. It also includes an annotations file in its metadata folder which defines some higher level aggregate data that helps to describe the format and package information about how the bundle should be added into an index of bundles.
27
27
28
28
```
29
29
# example bundle
@@ -54,8 +54,6 @@ Using [OCI spec](https://github.com/opencontainers/image-spec/blob/master/spec.m
The operator-sdk also provides tooling to generate the metadata, Dockerfile, and even build the container image itself. Some basic documentation on how this works is located in [this repository's documentation](docs/design/operator-bundle.md#Operator-SDK-CLI).
58
-
59
57
Once you have built the container, you can publish it like any other container image:
60
58
61
59
```sh
@@ -73,6 +71,8 @@ opm index add --bundles quay.io/my-container-registry-namespace/my-manifest-bund
The resulting image is referred to as an "Index". It is an image which contains a database of pointers to operator manifest content that is easily queriable via an included API that is served when the container image is run.
75
+
76
76
Now that image is available for clusters to use and reference with CatalogSources on their cluster.
77
77
78
78
Index images are additive, so you can add a new version of your operator bundle when you publish a new version:
@@ -83,7 +83,7 @@ opm index add --bundles quay.io/my-container-registry-namespace/my-manifest-bund
83
83
84
84
For more detail on using `opm` to generate index images, take a look at the [documentation](docs/design/opm-tooling.md).
85
85
86
-
# Using the catalog index with Operator Lifecycle Manager
86
+
# Using the index with Operator Lifecycle Manager
87
87
88
88
To add an index packaged with `operator-registry` to your cluster for use with [Operator Lifecycle Manager](https://github.com/operator-framework/operator-lifecycle-manager) (OLM) create a `CatalogSource` referencing the image you created and pushed above:
0 commit comments