Skip to content

Commit 481bd5d

Browse files
fix(docs): update API name to correct version (#1433)
Replace `apiVersion: catalogd.operatorframework.io/v1alpha1` with `apiVersion: olm.operatorframework.io/v1alpha1` for `clustercatalogs.olm.operatorframework.io`. Reason: The API version referenced in the docs appears incorrect. After installing, the correct API name is confirmed with: ``` $ kubectl get crds | grep clustercatalog clustercatalogs.olm.operatorframework.io 2024-11-06T21:34:38Z ``` The API is listed under `clustercatalogs.olm.operatorframework.io`, not `catalogd`. Example error faced when trying to apply with the incorrect API name: ``` $ kubectl apply -f - <<EOF > apiVersion: catalogd.operatorframework.io/v1alpha1 > kind: ClusterCatalog > metadata: > name: operatorhubio > spec: > source: > type: Image > image: > ref: quay.io/operatorhubio/catalog:latest > pollInterval: 10m > EOF error: resource mapping not found for name: "operatorhubio" namespace: "" from "STDIN": no matches for kind "ClusterCatalog" in version "catalogd.operatorframework.io/v1alpha1" ensure CRDs are installed first ``` For reference, see the correct API name here: [olm.operatorframework.io_clustercatalogs.yaml](https://github.com/operator-framework/catalogd/blob/main/config/base/crd/bases/olm.operatorframework.io_clustercatalogs.yaml).
1 parent 22004fa commit 481bd5d

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

docs/concepts/controlling-catalog-selection.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ When multiple catalogs provide the same package, you can set priorities to resol
125125
In your `ClusterCatalog` resource, set the `priority` field:
126126

127127
```yaml
128-
apiVersion: catalogd.operatorframework.io/v1alpha1
128+
apiVersion: olm.operatorframework.io/v1alpha1
129129
kind: ClusterCatalog
130130
metadata:
131131
name: high-priority-catalog
@@ -160,7 +160,7 @@ If the system cannot resolve to a single bundle due to ambiguity, it will genera
160160
1. **Create or Update `ClusterCatalogs` with Appropriate Labels and Priority**
161161

162162
```yaml
163-
apiVersion: catalogd.operatorframework.io/v1alpha1
163+
apiVersion: olm.operatorframework.io/v1alpha1
164164
kind: ClusterCatalog
165165
metadata:
166166
name: catalog-a
@@ -175,7 +175,7 @@ If the system cannot resolve to a single bundle due to ambiguity, it will genera
175175
```
176176

177177
```yaml
178-
apiVersion: catalogd.operatorframework.io/v1alpha1
178+
apiVersion: olm.operatorframework.io/v1alpha1
179179
kind: ClusterCatalog
180180
metadata:
181181
name: catalog-b

docs/getting-started/olmv1_getting_started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ To create the catalog, run the following command:
3535
```bash
3636
# Create ClusterCatalog
3737
kubectl apply -f - <<EOF
38-
apiVersion: catalogd.operatorframework.io/v1alpha1
38+
apiVersion: olm.operatorframework.io/v1alpha1
3939
kind: ClusterCatalog
4040
metadata:
4141
name: operatorhubio

0 commit comments

Comments
 (0)