Merge pull request #70584 from michaelryanpeter/osdocs-9413-olmv1-supports-allnamespace-no-webhooks

OSDOCS#9413: OLM 1.0 supports AllNamespace install and no webhooks

Author: michaelryanpeter

modules/olmv1-catalog-queries.adoc

@@ -24,6 +24,20 @@ $ jq -s '.[] \| select( .schema == "olm.package") \| \
   .name' <catalog_name>.json
 ----
 
+|Packages that support `AllNamespaces` install mode and do not use webhooks
+a|
+[source,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}' \
+  <catalog_name>.json
+----
+
 |Package metadata
 a|
 [source,terminal]
@@ -56,6 +70,16 @@ $ jq -s '.[] \| select( .schema == "olm.channel" ) \| \
   <catalog_name>.json
 ----
 
+|Versions in a channel
+a|
+[source,terminal]
+----
+$ jq -s '.[] \| select( .package == "<package_name" ) \| \
+  select( .schema == "olm.channel" ) \| \
+  select( .name == "<channel_name>" ) \| \
+  .entries \| .[] \| .name' <catalog_name>.json
+----
+
 a|
 * Latest version in a channel
 * Upgrade path

modules/olmv1-finding-operators-to-install.adoc

@@ -16,7 +16,7 @@ After you add a catalog to your cluster, you can query the catalog to find Opera
 
 .Procedure
 
-. Port foward the catalog server service in the `openshift-catalogd` namespace by running the following command:
+. Port forward the catalog server service in the `openshift-catalogd` namespace by running the following command:
 +
 [source,terminal]
 ----
@@ -37,11 +37,18 @@ $ curl -L http://localhost:8080/catalogs/<catalog_name>/all.json \
 [source,terminal]
 ----
 $ curl -L http://localhost:8080/catalogs/redhat-operators/all.json \
-  -C - -o /home/<username>/catalogs/rhoc.json
+  -C - -o /home/username/catalogs/rhoc.json
 ----
 ====
 
-. Get a list of the Operators and extensions from the local catalog file by running the following command:
+. Run one of the following commands to return a list of Operators and extensions in a catalog.
++
+[IMPORTANT]
+====
+Currently, {olmv1-first} supports extensions that do not use webhooks and are configured to use the `AllNamespaces` install mode. Extensions that use webhooks or that target a single or specified set of namespaces cannot be installed.
+====
++
+* Get a list of all the Operators and extensions from the local catalog file by running the following command:
 +
 [source,terminal]
 ----
@@ -55,7 +62,7 @@ $ jq -s '.[] | select(.schema == "olm.package") | .name' \
 [source,terminal]
 ----
 $ jq -s '.[] | select(.schema == "olm.package") | .name' \
-  /home/<username>/catalogs/rhoc.json
+  /home/username/catalogs/rhoc.json
 ----
 ====
 +
@@ -83,13 +90,53 @@ NAME                                                        AGE
 ...
 ----
 ====
++
+* Get list of packages that support `AllNamespaces` install mode and do not use webhooks from the local catalog file by running the following command:
++
+[source,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}' \
+  /<path>/<catalog_name>.json
+----
++
+.Example output
+[%collapsible]
+====
+[source,text]
+----
+{"package":"3scale-operator","version":"0.10.0-mas"}
+{"package":"3scale-operator","version":"0.10.5"}
+{"package":"3scale-operator","version":"0.11.0-mas"}
+{"package":"3scale-operator","version":"0.11.1-mas"}
+{"package":"3scale-operator","version":"0.11.2-mas"}
+{"package":"3scale-operator","version":"0.11.3-mas"}
+{"package":"3scale-operator","version":"0.11.5-mas"}
+{"package":"3scale-operator","version":"0.11.6-mas"}
+{"package":"3scale-operator","version":"0.11.7-mas"}
+{"package":"3scale-operator","version":"0.11.8-mas"}
+{"package":"amq-broker-rhel8","version":"7.10.0-opr-1"}
+{"package":"amq-broker-rhel8","version":"7.10.0-opr-2"}
+{"package":"amq-broker-rhel8","version":"7.10.0-opr-3"}
+{"package":"amq-broker-rhel8","version":"7.10.0-opr-4"}
+{"package":"amq-broker-rhel8","version":"7.10.1-opr-1"}
+{"package":"amq-broker-rhel8","version":"7.10.1-opr-2"}
+{"package":"amq-broker-rhel8","version":"7.10.2-opr-1"}
+{"package":"amq-broker-rhel8","version":"7.10.2-opr-2"}
+...
+----
+====
 
 . Inspect the contents of an Operator or extension's metadata by running the following command:
 +
 [source,terminal]
 ----
 $ jq -s '.[] | select( .schema == "olm.package") | \
-  select( .name == "<package_name>")' <catalog_name>.json
+  select( .name == "<package_name>")' /<path>/<catalog_name>.json
 ----
 +
 .Example command
@@ -98,7 +145,8 @@ $ jq -s '.[] | select( .schema == "olm.package") | \
 [source,terminal]
 ----
 $ jq -s '.[] | select( .schema == "olm.package") | \
-  select( .name == "serverless-operator")' rhoc.json
+  select( .name == "openshift-pipelines-operator-rh")' \
+  /home/username/rhoc.json
 ----
 ====
 +
@@ -111,9 +159,9 @@ $ jq -s '.[] | select( .schema == "olm.package") | \
   "defaultChannel": "stable",
   "icon": {
     "base64data": "PHN2ZyB4bWxu..."
-    "mediatype": "image/svg+xml"
+    "mediatype": "image/png"
   },
-  "name": "serverless-operator",
+  "name": "openshift-pipelines-operator-rh",
   "schema": "olm.package"
 }
 ----