Skip to content

Commit 86898f2

Browse files
authoredJan 17, 2020
Update README.md
1 parent 2066c95 commit 86898f2

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed
 

‎README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ And libraries:
2323
# Manifest format
2424

2525

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.
2727

2828
```
2929
# example bundle
@@ -54,8 +54,6 @@ Using [OCI spec](https://github.com/opencontainers/image-spec/blob/master/spec.m
5454
podman build -t quay.io/my-container-registry-namespace/my-manifest-bundle:latest -f bundle.Dockerfile .
5555
```
5656

57-
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-
5957
Once you have built the container, you can publish it like any other container image:
6058

6159
```sh
@@ -73,6 +71,8 @@ opm index add --bundles quay.io/my-container-registry-namespace/my-manifest-bund
7371
podman push quay.io/my-container-registry-namespace/my-index:1.0.0
7472
```
7573

74+
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+
7676
Now that image is available for clusters to use and reference with CatalogSources on their cluster.
7777

7878
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
8383

8484
For more detail on using `opm` to generate index images, take a look at the [documentation](docs/design/opm-tooling.md).
8585

86-
# Using the catalog index with Operator Lifecycle Manager
86+
# Using the index with Operator Lifecycle Manager
8787

8888
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:
8989

0 commit comments

Comments
 (0)
Please sign in to comment.