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
For a more complete overview of OLM v1 and how it differs from OLM v0, see our [overview](./docs/olmv1_overview.md).
21
-
22
-
## Getting Started
23
-
You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster.
24
-
25
-
> [!NOTE]
26
-
> Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster `kubectl cluster-info` shows).
20
+
For a more complete overview of OLM v1 and how it differs from OLM v0, see our [overview](docs/olmv1_overview.md).
27
21
28
22
### Installation
29
23
24
+
The following script will install OLMv1 on a Kubernetes cluster. If you don't have one, you can deploy a Kubernetes cluster with [KIND](https://sigs.k8s.io/kind).
25
+
30
26
> [!CAUTION]
31
27
> Operator-Controller depends on [cert-manager](https://cert-manager.io/). Running the following command
32
28
> may affect an existing installation of cert-manager and cause cluster instability.
@@ -37,10 +33,24 @@ The latest version of Operator Controller can be installed with the following co
This quickstart procedure will guide you through the following processes:
39
+
* Deploying a catalog
40
+
* Installing, upgrading, or downgrading an extension
41
+
* Deleting catalogs and extensions
42
+
43
+
### Create a Catalog
41
44
42
-
The ClusterCatalog resource supports file-based catalog ([FBC](https://olm.operatorframework.io/docs/reference/file-based-catalogs/#docs)) images.
43
-
The following example uses the official [OperatorHub](https://operatorhub.io) catalog.
45
+
OLM v1 is designed to source content from an on-cluster catalog in the file-based catalog ([FBC](https://olm.operatorframework.io/docs/reference/file-based-catalogs/#docs)) format.
46
+
These catalogs are deployed and configured through the `ClusterCatalog` resource. More information on adding catalogs
47
+
can be found [here](./docs/Tasks/adding-a-catalog).
48
+
49
+
The following example uses the official [OperatorHub](https://operatorhub.io) catalog that contains many different
50
+
extensions to choose from. Note that this catalog contains packages designed to work with OLM v0, and that not all packages
51
+
will work with OLM v1. More information on catalog exploration and content compatibility can be found [here](./docs/refs/catalog-queries.md).
52
+
53
+
To create the catalog, run the following command:
44
54
45
55
```bash
46
56
# Create ClusterCatalog
@@ -58,148 +68,70 @@ spec:
58
68
EOF
59
69
```
60
70
71
+
Once the catalog is unpacked successfully, its content will be available for installation.
To uninstall an extension, delete the ClusterExtension resource. This will trigger the uninstallation process, which will
110
+
remove all resources created by the extension. More information on uninstalling extensions can be found [here](./docs/Tasks/uninstalling-an-extension).
The catalog content can be downloaded locally as a json file and queried using tools like [jq](The catalog content can be downloaded locally as a json file and queried using tools like [jq](The catalog content can be downloaded locally as a json file and queried using tools like [jq](https://jqlang.github.io/jq/).
157
-
The _catalogd-catalogserver_ service in the _olmv1-system_ namespace provides an endpoint from which to
158
-
download the catalog. This endpoint can be found in the status (.status.contentURL).
159
-
160
-
The [download-catalog.sh](hack/tools/catalogs/download-catalog) script automates this process:
119
+
Extension installation requires the creation of a namespace, an installer service account, and its RBAC. Once the
120
+
extension is uninstalled, these resources can be cleaned up.
161
121
162
122
```bash
163
-
# Download the catalog provided by the unpacked ClusterCatalog called operatorhuio
164
-
# The catalog will be downloaded to operatorhubio-catalog.json
0 commit comments