From c745ac965817c1a2725f2a9001a2d1a0d6d790de Mon Sep 17 00:00:00 2001 From: <> Date: Fri, 3 May 2024 17:12:13 +0000 Subject: [PATCH] Deployed 4383624 with MkDocs version: 1.6.0 --- .nojekyll | 0 404.html | 501 ++ Tasks/adding-a-catalog/index.html | 762 ++ Tasks/explore-available-packages/index.html | 784 ++ Tasks/installing-an-extension/index.html | 747 ++ Tasks/uninstall-an-extension/index.html | 675 ++ assets/images/favicon.png | Bin 0 -> 1870 bytes assets/javascripts/bundle.dd8806f2.min.js | 29 + assets/javascripts/bundle.dd8806f2.min.js.map | 7 + assets/javascripts/lunr/min/lunr.ar.min.js | 1 + assets/javascripts/lunr/min/lunr.da.min.js | 18 + assets/javascripts/lunr/min/lunr.de.min.js | 18 + assets/javascripts/lunr/min/lunr.du.min.js | 18 + assets/javascripts/lunr/min/lunr.el.min.js | 1 + assets/javascripts/lunr/min/lunr.es.min.js | 18 + assets/javascripts/lunr/min/lunr.fi.min.js | 18 + assets/javascripts/lunr/min/lunr.fr.min.js | 18 + assets/javascripts/lunr/min/lunr.he.min.js | 1 + assets/javascripts/lunr/min/lunr.hi.min.js | 1 + assets/javascripts/lunr/min/lunr.hu.min.js | 18 + assets/javascripts/lunr/min/lunr.hy.min.js | 1 + assets/javascripts/lunr/min/lunr.it.min.js | 18 + assets/javascripts/lunr/min/lunr.ja.min.js | 1 + assets/javascripts/lunr/min/lunr.jp.min.js | 1 + assets/javascripts/lunr/min/lunr.kn.min.js | 1 + assets/javascripts/lunr/min/lunr.ko.min.js | 1 + assets/javascripts/lunr/min/lunr.multi.min.js | 1 + assets/javascripts/lunr/min/lunr.nl.min.js | 18 + assets/javascripts/lunr/min/lunr.no.min.js | 18 + assets/javascripts/lunr/min/lunr.pt.min.js | 18 + assets/javascripts/lunr/min/lunr.ro.min.js | 18 + assets/javascripts/lunr/min/lunr.ru.min.js | 18 + assets/javascripts/lunr/min/lunr.sa.min.js | 1 + .../lunr/min/lunr.stemmer.support.min.js | 1 + assets/javascripts/lunr/min/lunr.sv.min.js | 18 + assets/javascripts/lunr/min/lunr.ta.min.js | 1 + assets/javascripts/lunr/min/lunr.te.min.js | 1 + assets/javascripts/lunr/min/lunr.th.min.js | 1 + assets/javascripts/lunr/min/lunr.tr.min.js | 18 + assets/javascripts/lunr/min/lunr.vi.min.js | 1 + assets/javascripts/lunr/min/lunr.zh.min.js | 1 + assets/javascripts/lunr/tinyseg.js | 206 + assets/javascripts/lunr/wordcut.js | 6708 +++++++++++++++++ .../workers/search.b8dbb3d2.min.js | 42 + .../workers/search.b8dbb3d2.min.js.map | 7 + assets/stylesheets/main.66ac8b77.min.css | 1 + assets/stylesheets/main.66ac8b77.min.css.map | 1 + assets/stylesheets/palette.06af60db.min.css | 1 + .../stylesheets/palette.06af60db.min.css.map | 1 + components/index.html | 548 ++ drafts/support-watchNamespaces/index.html | 582 ++ drafts/upgrade-support/index.html | 623 ++ drafts/version-ranges/index.html | 730 ++ index.html | 560 ++ olmv1_overview/index.html | 926 +++ olmv1_roadmap/index.html | 931 +++ refs/catalog-queries/index.html | 673 ++ search/search_index.json | 1 + sitemap.xml | 3 + sitemap.xml.gz | Bin 0 -> 127 bytes 60 files changed, 16336 insertions(+) create mode 100644 .nojekyll create mode 100644 404.html create mode 100644 Tasks/adding-a-catalog/index.html create mode 100644 Tasks/explore-available-packages/index.html create mode 100644 Tasks/installing-an-extension/index.html create mode 100644 Tasks/uninstall-an-extension/index.html create mode 100644 assets/images/favicon.png create mode 100644 assets/javascripts/bundle.dd8806f2.min.js create mode 100644 assets/javascripts/bundle.dd8806f2.min.js.map create mode 100644 assets/javascripts/lunr/min/lunr.ar.min.js create mode 100644 assets/javascripts/lunr/min/lunr.da.min.js create mode 100644 assets/javascripts/lunr/min/lunr.de.min.js create mode 100644 assets/javascripts/lunr/min/lunr.du.min.js create mode 100644 assets/javascripts/lunr/min/lunr.el.min.js create mode 100644 assets/javascripts/lunr/min/lunr.es.min.js create mode 100644 assets/javascripts/lunr/min/lunr.fi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.fr.min.js create mode 100644 assets/javascripts/lunr/min/lunr.he.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hu.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hy.min.js create mode 100644 assets/javascripts/lunr/min/lunr.it.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ja.min.js create mode 100644 assets/javascripts/lunr/min/lunr.jp.min.js create mode 100644 assets/javascripts/lunr/min/lunr.kn.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ko.min.js create mode 100644 assets/javascripts/lunr/min/lunr.multi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.nl.min.js create mode 100644 assets/javascripts/lunr/min/lunr.no.min.js create mode 100644 assets/javascripts/lunr/min/lunr.pt.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ro.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ru.min.js create mode 100644 assets/javascripts/lunr/min/lunr.sa.min.js create mode 100644 assets/javascripts/lunr/min/lunr.stemmer.support.min.js create mode 100644 assets/javascripts/lunr/min/lunr.sv.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ta.min.js create mode 100644 assets/javascripts/lunr/min/lunr.te.min.js create mode 100644 assets/javascripts/lunr/min/lunr.th.min.js create mode 100644 assets/javascripts/lunr/min/lunr.tr.min.js create mode 100644 assets/javascripts/lunr/min/lunr.vi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.zh.min.js create mode 100644 assets/javascripts/lunr/tinyseg.js create mode 100644 assets/javascripts/lunr/wordcut.js create mode 100644 assets/javascripts/workers/search.b8dbb3d2.min.js create mode 100644 assets/javascripts/workers/search.b8dbb3d2.min.js.map create mode 100644 assets/stylesheets/main.66ac8b77.min.css create mode 100644 assets/stylesheets/main.66ac8b77.min.css.map create mode 100644 assets/stylesheets/palette.06af60db.min.css create mode 100644 assets/stylesheets/palette.06af60db.min.css.map create mode 100644 components/index.html create mode 100644 drafts/support-watchNamespaces/index.html create mode 100644 drafts/upgrade-support/index.html create mode 100644 drafts/version-ranges/index.html create mode 100644 index.html create mode 100644 olmv1_overview/index.html create mode 100644 olmv1_roadmap/index.html create mode 100644 refs/catalog-queries/index.html create mode 100644 search/search_index.json create mode 100644 sitemap.xml create mode 100644 sitemap.xml.gz diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 000000000..e69de29bb diff --git a/404.html b/404.html new file mode 100644 index 000000000..99cce0184 --- /dev/null +++ b/404.html @@ -0,0 +1,501 @@ + + + +
+ + + + + + + + + + + + + + +Extension authors can publish their products in catalogs. +Catalogs are curated collections of Kubernetes extensions, such as Operators. +Cluster administrators can add these catalogs to their cluster. +Cluster administrators can enable polling to get over-the-air updates to catalogs when extension authors publish changes such as bug fixes and new features.
+For example, the Kubernetes community Operators catalog is a catalog of curated extensions that is developed by the Kubernetes community. +You can see the available extensions at Operatorhub.io. +This catalog is distributed as an image quay.io/operatorhubio/catalog that can be installed on clusters.
+kind
, using an account with cluster-admin
permissionskubectl
) installed on your workstationCreate a catalog custom resource (CR):
+apiVersion: catalogd.operatorframework.io/v1alpha1
+kind: Catalog
+metadata:
+ name: operatorhubio
+spec:
+ source:
+ type: image
+ image:
+ ref: <catalog_image>
+ pollInterval: <poll_interval_duration>
+
catalog_name
quay.io/operatorhubio/catalog:latest
.poll_interval_duration
24h
.
+ Valid units include seconds (s
), minutes (m
), and hours (h
).
+ To disable polling, set a zero value, such as 0s
.Apply the catalog CR:
+ + +Run the following commands to verify the status of your catalog:
+Check if your catalog is available on the cluster:
+ + +Check the status of your catalog:
+ +Name: operatorhubio
+Namespace:
+Labels: <none>
+Annotations: <none>
+API Version: catalogd.operatorframework.io/v1alpha1
+Kind: Catalog
+Metadata:
+ Creation Timestamp: 2024-03-12T19:34:50Z
+ Finalizers:
+ catalogd.operatorframework.io/delete-server-cache
+ Generation: 2
+ Resource Version: 6469
+ UID: 2e2778cb-dda6-4645-96b7-992e8dd37503
+Spec:
+ Source:
+ Image:
+ Poll Interval: 15m0s
+ Ref: quay.io/operatorhubio/catalog:latest
+ Type: image
+Status:
+ Conditions:
+ Last Transition Time: 2024-03-12T19:35:34Z
+ Message:
+ Reason: UnpackSuccessful
+ Status: True
+ Type: Unpacked
+ Content URL: http://catalogd-catalogserver.catalogd-system.svc/catalogs/operatorhubio/all.json
+ Observed Generation: 2
+ Phase: Unpacked
+ Resolved Source:
+ Image:
+ Last Poll Attempt: 2024-03-12T19:35:26Z
+ Ref: quay.io/operatorhubio/catalog:latest
+ Resolved Ref: quay.io/operatorhubio/catalog@sha256:dee29aaed76fd1c72b654b9bc8bebc4b48b34fd8d41ece880524dc0c3c1c55ec
+ Type: image
+Events: <none>
+
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.
jq
CLI tool.Port forward the catalog server service:
+ +Return a list of all the extensions in a catalog: +
$ curl http://localhost:8080/catalogs/operatorhubio/all.json | jq -s '.[] | select(.schema == "olm.package") | .name'
+
"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:
$ 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}'
+
{"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"}
+...
+
Inspect the contents of an extension's metadata:
+$ curl http://localhost:8080/catalogs/operatorhubio/all.json | jq -s '.[] | select( .schema == "olm.package") | select( .name == "<package_name>")'
+
package_name
In Operator Lifecycle Manager (OLM) 1.0, Kubernetes extensions are scoped to the cluster. +After you add a catalog to your cluster, you can install an extension by creating a custom resource (CR) and applying it.
+Important
+Currently, extensions that use webhooks or target a single or specified set of namespaces cannot be installed.
+Extensions must not include webhooks and must use the AllNamespaces
install mode.
jq
CLI tool is installed.Create a CR for the Kubernetes extension you want to install:
+apiVersion: olm.operatorframework.io/v1alpha1
+kind: ClusterExtension
+metadata:
+ name: <extension_name>
+spec:
+ packageName: <package_name>
+ channel: <channel>
+ version: "<version>"
+
extension_name
my-camel-k
.package_name
camel-k
.channel
stable
or candidate
.version
1.3.1
or "<2"
.
+ If you use a comparison string to define a version range, the string must be surrounded by double quotes ("
).Warning
+Currently, the following limitations affect the installation of extensions:
+As a result, if two catalogs have an extension with the same name, the installation might fail or lead to an unintended outcome. +For example, the first extension that matches might install successfully and finish without searching for a match in the second catalog.
+Apply the CR to the cluster:
+ + +Describe the installed extension:
+ +Name: my-camel-k
+Namespace:
+Labels: <none>
+Annotations: <none>
+API Version: olm.operatorframework.io/v1alpha1
+Kind: ClusterExtension
+Metadata:
+ Creation Timestamp: 2024-03-15T15:03:47Z
+ Generation: 1
+ Resource Version: 7691
+ UID: d756879f-217d-4ebe-85b1-8427bbb2f1df
+Spec:
+ Package Name: camel-k
+ Upgrade Constraint Policy: Enforce
+Status:
+ Conditions:
+ Last Transition Time: 2024-03-15T15:03:50Z
+ Message: resolved to "quay.io/operatorhubio/camel-k@sha256:d2b74c43ec8f9294450c9dcf2057be328d0998bb924ad036db489af79d1b39c3"
+ Observed Generation: 1
+ Reason: Success
+ Status: True
+ Type: Resolved
+ Last Transition Time: 2024-03-15T15:04:13Z
+ Message: installed from "quay.io/operatorhubio/camel-k@sha256:d2b74c43ec8f9294450c9dcf2057be328d0998bb924ad036db489af79d1b39c3"
+ Observed Generation: 1
+ Reason: Success
+ Status: True
+ Type: Installed
+ Installed Bundle Resource: quay.io/operatorhubio/camel-k@sha256:d2b74c43ec8f9294450c9dcf2057be328d0998bb924ad036db489af79d1b39c3
+ Resolved Bundle Resource: quay.io/operatorhubio/camel-k@sha256:d2b74c43ec8f9294450c9dcf2057be328d0998bb924ad036db489af79d1b39c3
+Events: <none>
+
You can uninstall a Kubernetes extension and its associated custom resource definitions (CRD) by deleting the extension's custom resource (CR).
+Delete the extension's CR:
+ +extension_name
metadata.name
field of the extension's CR.Verify that the Kubernetes extension is deleted:
+ + +