Skip to content

Commit

Permalink
📖 Fix jq codeblocks (#728)
Browse files Browse the repository at this point in the history
* Fix catalog queries code blocks

Improve the formatting of the code blocks in the catalog queries
description list

* Fix typos

Fix typos called out in
#696 (comment)
and
#696 (comment).
  • Loading branch information
michaelryanpeter authored Apr 1, 2024
1 parent d9b51d6 commit 8127270
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 11 deletions.
4 changes: 2 additions & 2 deletions docs/Tasks/explore-available-packages.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand Down
45 changes: 36 additions & 9 deletions docs/refs/catalog-queries.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,33 +9,60 @@ $ curl http://localhost:8080/catalogs/operatorhubio/all.json | <query>
## 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 == "<package_name>")'`
:
``` terminal
jq -s '.[] | select( .schema == "olm.package") | select( .name == "<package_name>")'
```

Catalog blobs in a package
: `jq -s '.[] | select( .package == "<package_name>")'`
:
``` terminal
jq -s '.[] | select( .package == "<package_name>")'
```

## Channel queries

Channels in a package
: `jq -s '.[] | select( .schema == "olm.channel" ) | select( .package == "<package_name>") | .name'`
:
``` terminal
jq -s '.[] | select( .schema == "olm.channel" ) | select( .package == "<package_name>") | .name'
```

Versions in a channel
: `jq -s '.[] | select( .package == "<package_name>" ) | select( .schema == "olm.channel" ) | select( .name == "<channel_name>" ) | .entries | .[] | .name'`
:
``` terminal
jq -s '.[] | select( .package == "<package_name>" ) | select( .schema == "olm.channel" ) | select( .name == "<channel_name>" ) | .entries | .[] | .name'
```

Latest version in a channel and upgrade path
: `jq -s '.[] | select( .schema == "olm.channel" ) | select ( .name == "<channel>") | select( .package == "<package_name>")'`
:
``` terminal
jq -s '.[] | select( .schema == "olm.channel" ) | select ( .name == "<channel>") | select( .package == "<package_name>")'
```

## Bundle queries

Bundles in a package
: `jq -s '.[] | select( .schema == "olm.bundle" ) | select( .package == "<package_name>") | .name'`
:
``` terminal
jq -s '.[] | select( .schema == "olm.bundle" ) | select( .package == "<package_name>") | .name'
```

Bundle dependencies and available APIs
: `jq -s '.[] | select( .schema == "olm.bundle" ) | select ( .name == "<bundle_name>") | select( .package == "<package_name>")'`
:
``` terminal
jq -s '.[] | select( .schema == "olm.bundle" ) | select ( .name == "<bundle_name>") | select( .package == "<package_name>")'
```

0 comments on commit 8127270

Please sign in to comment.