📖 fix(docs): fix apiVersion for clustercatalogs. Replace 'catalogd.operatorframework.io/v1alpha1' with 'olm.operatorframework.io/v1alpha1' #1433
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for olmv1 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
camilamacedo86
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1433 +/- ##
==========================================
- Coverage 73.45% 73.26% -0.20%
==========================================
Files 42 42
Lines 3063 3063
==========================================
- Hits 2250 2244 -6
- Misses 640 644 +4
- Partials 173 175 +2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
joelanford
reviewed
Nov 6, 2024
| @@ -125,7 +125,7 @@ When multiple catalogs provide the same package, you can set priorities to resol | |||
| In your `ClusterCatalog` resource, set the `priority` field: | |||
|
|
|||
| ```yaml | |||
| apiVersion: catalogd.operatorframework.io/v1alpha1 | |||
| apiVersion: clustercatalogs.olm.operatorframework.io | |||
There was a problem hiding this comment.
Drop the clustercatalogs. prefix. That's the plural resource name, not part of the apiGroup.
There was a problem hiding this comment.
Oh boy, you have a good catcher too :
I did the test, create the title with the right apiVersion but I did the replace wrong :-P
) $ kubectl get crds | grep clustercatalog
clustercatalogs.olm.operatorframework.io 2024-11-06T21:34:38Z
camiladeomacedo@camilas-MacBook-Air ~/go/src/github.com/operator-framework/operator-controller (fix-install-script) $ kubectl apply -f - <<EOF
> apiVersion: olm.operatorframework.io/v1alpha1
> kind: ClusterCatalog
> metadata:
> name: operatorhubio
> spec:
> source:
> type: Image
> image:
> ref: quay.io/operatorhubio/catalog:latest
> pollInterval: 10m
> EOF
clustercatalog.olm.operatorframework.io/operatorhubio configured
There was a problem hiding this comment.
Done! Thanks.
Stopping for today to avoid missing any boats—at least for today. :-)
camilamacedo86
force-pushed
the
fix-api-doc
branch
from
565b9d4
to
d2c9f5c
Compare
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).
m1kola
approved these changes
Nov 7, 2024
camilamacedo86
force-pushed
the
fix-api-doc
branch
from
d2c9f5c
to
ec47a13
Compare
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
Merged
via the queue into
operator-framework:main
with commit Nov 7, 2024
481bd5d
17 of 18 checks passed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Replace
apiVersion: catalogd.operatorframework.io/v1alpha1withapiVersion: olm.operatorframework.io/v1alpha1forclustercatalogs.olm.operatorframework.io.Reason:
The API version referenced in the docs appears incorrect. After installing, the correct API name is confirmed with:
The API is listed under
clustercatalogs.olm.operatorframework.io, notcatalogd.Example error faced when trying to apply with the incorrect API name:
For reference, see the correct API name here:
olm.operatorframework.io_clustercatalogs.yaml.