diff --git a/docs/Tasks/explore-available-packages.md b/docs/Tasks/explore-available-packages.md index bb35e12a6..117757f87 100644 --- a/docs/Tasks/explore-available-packages.md +++ b/docs/Tasks/explore-available-packages.md @@ -1,4 +1,4 @@ -After you add a catalog of exetensions to your cluster, you must port forward your catalog as a service. +After you add a catalog of extensions to your cluster, you must port forward your catalog as a service. Then you can query the catalog by using `curl` commands and the `jq` CLI tool to find extensions to install. ## Prerequisites @@ -8,7 +8,7 @@ Then you can query the catalog by using `curl` commands and the `jq` CLI tool to ## Procedure -1. Port forward the catalog server sevice: +1. Port forward the catalog server service: ``` terminal $ kubectl -n catalogd-system port-forward svc/catalogd-catalogserver 8080:80 diff --git a/docs/refs/catalog-queries.md b/docs/refs/catalog-queries.md index 199a9fb86..0f78b44e5 100644 --- a/docs/refs/catalog-queries.md +++ b/docs/refs/catalog-queries.md @@ -9,33 +9,60 @@ $ curl http://localhost:8080/catalogs/operatorhubio/all.json | ## Package queries Available packages in a catalog -: `jq -s '.[] | select( .schema == "olm.package")` +: +``` terminal +jq -s '.[] | select( .schema == "olm.package") +``` Packages that support `AllNamespaces` install mode and do not use webhooks -: `jq -c 'select(.schema == "olm.bundle") | {"package":.package, "version":.properties[] | select(.type == "olm.bundle.object").value.data | @base64d | fromjson | select(.kind == "ClusterServiceVersion" and (.spec.installModes[] | select(.type == "AllNamespaces" and .supported == true) != null) and .spec.webhookdefinitions == null).spec.version}'` +: +``` terminal +jq -c 'select(.schema == "olm.bundle") | {"package":.package, "version":.properties[] | select(.type == "olm.bundle.object").value.data | @base64d | fromjson | select(.kind == "ClusterServiceVersion" and (.spec.installModes[] | select(.type == "AllNamespaces" and .supported == true) != null) and .spec.webhookdefinitions == null).spec.version}' +``` Package metadata -: `jq -s '.[] | select( .schema == "olm.package") | select( .name == "")'` +: +``` terminal +jq -s '.[] | select( .schema == "olm.package") | select( .name == "")' +``` Catalog blobs in a package -: `jq -s '.[] | select( .package == "")'` +: +``` terminal +jq -s '.[] | select( .package == "")' +``` ## Channel queries Channels in a package -: `jq -s '.[] | select( .schema == "olm.channel" ) | select( .package == "") | .name'` +: +``` terminal +jq -s '.[] | select( .schema == "olm.channel" ) | select( .package == "") | .name' +``` Versions in a channel -: `jq -s '.[] | select( .package == "" ) | select( .schema == "olm.channel" ) | select( .name == "" ) | .entries | .[] | .name'` +: +``` terminal +jq -s '.[] | select( .package == "" ) | select( .schema == "olm.channel" ) | select( .name == "" ) | .entries | .[] | .name' +``` Latest version in a channel and upgrade path -: `jq -s '.[] | select( .schema == "olm.channel" ) | select ( .name == "") | select( .package == "")'` +: +``` terminal +jq -s '.[] | select( .schema == "olm.channel" ) | select ( .name == "") | select( .package == "")' +``` ## Bundle queries Bundles in a package -: `jq -s '.[] | select( .schema == "olm.bundle" ) | select( .package == "") | .name'` +: +``` terminal +jq -s '.[] | select( .schema == "olm.bundle" ) | select( .package == "") | .name' +``` Bundle dependencies and available APIs -: `jq -s '.[] | select( .schema == "olm.bundle" ) | select ( .name == "") | select( .package == "")'` +: +``` terminal +jq -s '.[] | select( .schema == "olm.bundle" ) | select ( .name == "") | select( .package == "")' +```