📖 Update documentation for "Finding extensions to install" #696
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,135 +1,141 @@ | ||
| After you add a catalog of exetensions 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 | ||
|
|
||
| * You have added a catalog of extensions, such as [OperatorHub.io](https://operatorhub.io), to your cluster. | ||
| * You have installed the `jq` CLI tool. | ||
|
|
||
| ## Procedure | ||
|
|
||
| 1. Port forward the catalog server sevice: | ||
|
There was a problem hiding this comment. TY! Addressed in #728 |
||
|
|
||
| ``` terminal | ||
| $ kubectl -n catalogd-system port-forward svc/catalogd-catalogserver 8080:80 | ||
| ``` | ||
|
|
||
| 2. Return a list of all the extensions in a catalog: | ||
| ``` terminal | ||
| $ curl http://localhost:8080/catalogs/operatorhubio/all.json | jq -s '.[] | select(.schema == "olm.package") | .name' | ||
| ``` | ||
|
|
||
| ??? success | ||
|
There was a problem hiding this comment. Sorry, I had a draft for this comment, but I forgot to submit it. The I find it especially useful for long lists of example output after you run a command.
|
||
| ``` text title="Example output" | ||
| "ack-acm-controller" | ||
| "ack-acmpca-controller" | ||
| "ack-apigatewayv2-controller" | ||
| "ack-applicationautoscaling-controller" | ||
| "ack-cloudfront-controller" | ||
| "ack-cloudtrail-controller" | ||
| "ack-cloudwatch-controller" | ||
| "ack-cloudwatchlogs-controller" | ||
| "ack-dynamodb-controller" | ||
| "ack-ec2-controller" | ||
| "ack-ecr-controller" | ||
| "ack-ecs-controller" | ||
| "ack-efs-controller" | ||
| "ack-eks-controller" | ||
| "ack-elasticache-controller" | ||
| "ack-emrcontainers-controller" | ||
| "ack-eventbridge-controller" | ||
| "ack-iam-controller" | ||
| "ack-kafka-controller" | ||
| "ack-keyspaces-controller" | ||
| "ack-kinesis-controller" | ||
| "ack-kms-controller" | ||
| "ack-lambda-controller" | ||
| "ack-memorydb-controller" | ||
| "ack-mq-controller" | ||
| "ack-networkfirewall-controller" | ||
| "ack-opensearchservice-controller" | ||
| "ack-pipes-controller" | ||
| "ack-prometheusservice-controller" | ||
| "ack-rds-controller" | ||
| "ack-route53-controller" | ||
| "ack-route53resolver-controller" | ||
| "ack-s3-controller" | ||
| "ack-sagemaker-controller" | ||
| "ack-secretsmanager-controller" | ||
| "ack-sfn-controller" | ||
| "ack-sns-controller" | ||
| "ack-sqs-controller" | ||
| "aerospike-kubernetes-operator" | ||
| "airflow-helm-operator" | ||
| "aiven-operator" | ||
| "akka-cluster-operator" | ||
| "alvearie-imaging-ingestion" | ||
| "anchore-engine" | ||
| "apch-operator" | ||
| "api-operator" | ||
| "api-testing-operator" | ||
| "apicast-community-operator" | ||
| "apicurio-registry" | ||
| "apimatic-kubernetes-operator" | ||
| "app-director-operator" | ||
| "appdynamics-operator" | ||
| "application-services-metering-operator" | ||
| "appranix" | ||
| "aqua" | ||
| "argocd-operator" | ||
| ... | ||
| ``` | ||
|
|
||
| !!! important | ||
| Currently, OLM 1.0 does not support the installation of extensions that use webhooks or that target a single or specified set of namespaces. | ||
|
|
||
| * Return list of packages that support `AllNamespaces` install mode and do not use webhooks: | ||
|
|
||
| ``` terminal | ||
| $ curl http://localhost:8080/catalogs/operatorhubio/all.json | 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}' | ||
| ``` | ||
|
|
||
| ??? success | ||
| ``` text title="Example output" | ||
| {"package":"ack-acm-controller","version":"0.0.12"} | ||
| {"package":"ack-acmpca-controller","version":"0.0.5"} | ||
| {"package":"ack-apigatewayv2-controller","version":"1.0.7"} | ||
| {"package":"ack-applicationautoscaling-controller","version":"1.0.11"} | ||
| {"package":"ack-cloudfront-controller","version":"0.0.9"} | ||
| {"package":"ack-cloudtrail-controller","version":"1.0.8"} | ||
| {"package":"ack-cloudwatch-controller","version":"0.0.3"} | ||
| {"package":"ack-cloudwatchlogs-controller","version":"0.0.4"} | ||
| {"package":"ack-dynamodb-controller","version":"1.2.9"} | ||
| {"package":"ack-ec2-controller","version":"1.2.4"} | ||
| {"package":"ack-ecr-controller","version":"1.0.12"} | ||
| {"package":"ack-ecs-controller","version":"0.0.4"} | ||
| {"package":"ack-efs-controller","version":"0.0.5"} | ||
| {"package":"ack-eks-controller","version":"1.3.3"} | ||
| {"package":"ack-elasticache-controller","version":"0.0.29"} | ||
| {"package":"ack-emrcontainers-controller","version":"1.0.8"} | ||
| {"package":"ack-eventbridge-controller","version":"1.0.6"} | ||
| {"package":"ack-iam-controller","version":"1.3.6"} | ||
| {"package":"ack-kafka-controller","version":"0.0.4"} | ||
| {"package":"ack-keyspaces-controller","version":"0.0.11"} | ||
| ... | ||
| ``` | ||
|
|
||
| 3. Inspect the contents of an extension's metadata: | ||
|
|
||
| ``` terminal | ||
| $ curl http://localhost:8080/catalogs/operatorhubio/all.json | jq -s '.[] | select( .schema == "olm.package") | select( .name == "<package_name>")' | ||
| ``` | ||
|
|
||
| `package_name` | ||
| : Specifies the name of the package you want to inspect. | ||
|
|
||
| ??? success | ||
| ``` text title="Example output" | ||
| { | ||
| "defaultChannel": "stable-v6.x", | ||
| "icon": { | ||
| "base64data": "PHN2ZyB4bWxucz0ia... | ||
| "mediatype": "image/svg+xml" | ||
| }, | ||
| "name": "cockroachdb", | ||
| "schema": "olm.package" | ||
| } | ||
| ``` | ||
|
|
||
| ### Additional resources | ||
|
|
||
| * [Catalog queries](../refs/catalog-queries.md) | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # Catalog queries | ||
|
|
||
| You can use the `curl` command with `jq` to query catalogs that are installed on your cluster. | ||
|
|
||
| ``` terminal title="Query syntax" | ||
| $ curl http://localhost:8080/catalogs/operatorhubio/all.json | <query> | ||
| ``` | ||
|
|
||
| ## Package queries | ||
|
|
||
| Available packages in a catalog | ||
| : `jq -s '.[] | select( .schema == "olm.package")` | ||
|
There was a problem hiding this comment. Nit: For all of the There was a problem hiding this comment. I created a follow up issue: #698 Basically, I can't get the code blocks to render in the definition list. I think I might need to move the list to a table, but if I get the code block to work, the table gets stretched really wide. There is probably something really small that I am missing with mkdocs' bespoke syntax, but after an hour trying to figure it out yesterday, I thought I would try this temporary hack. In the interest of making the Kubecon deadline, I would prefer to get the rest of the content in place and circle back after. WDYT, @everettraven? There was a problem hiding this comment. SGTM - I don't think this nit should at all block this from merging! |
||
|
|
||
| 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}'` | ||
|
|
||
| Package metadata | ||
| : `jq -s '.[] | select( .schema == "olm.package") | select( .name == "<package_name>")'` | ||
|
|
||
| Catalog blobs in a package | ||
| : `jq -s '.[] | select( .package == "<package_name>")'` | ||
|
|
||
| ## Channel queries | ||
|
|
||
| Channels in a package | ||
| : `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'` | ||
|
|
||
| Latest version in a channel and upgrade path | ||
| : `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'` | ||
|
|
||
| Bundle dependencies and available APIs | ||
| : `jq -s '.[] | select( .schema == "olm.bundle" ) | select ( .name == "<bundle_name>") | select( .package == "<package_name>")'` | ||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo
exetensionsshould beextensionsThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TY! Addressed in #728