diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index b5e29a69ebb5..4fe1740042a9 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -1879,6 +1879,8 @@ Topics: File: olmv1-packaging-format - Name: Managing catalogs File: olmv1-managing-catalogs + - Name: Installing an Operator from a catalog + File: olmv1-installing-an-operator-from-a-catalog --- Name: CI/CD Dir: cicd diff --git a/modules/olmv1-about-catalogs.adoc b/modules/olmv1-about-catalogs.adoc new file mode 100644 index 000000000000..c2c67a496130 --- /dev/null +++ b/modules/olmv1-about-catalogs.adoc @@ -0,0 +1,12 @@ +// Module included in the following assemblies: +// +// * operators/olm_v1/olmv1-installing-an-operator-from-a-catalog.adoc + +:_content-type: CONCEPT + +[id="olmv1-about-catalogs_{context}"] += About catalogs in OLM 1.0 + +Operator Lifecycle Manager (OLM) 1.0 introduces the catalogd component to the OLM suite of microservices. Catalogd is a Kubernetes extension that unpacks catalog content for on-cluster clients. Currently, catalogd unpacks catalog content that is packaged and distributed as container images. + +Catalogd helps customers discover installable content by hosting catalog metadata for Kubernetes extensions, such as Operators and controllers. diff --git a/modules/olmv1-about-target-versions.adoc b/modules/olmv1-about-target-versions.adoc new file mode 100644 index 000000000000..86b6b139fcc6 --- /dev/null +++ b/modules/olmv1-about-target-versions.adoc @@ -0,0 +1,138 @@ +// Module included in the following assemblies: +// +// * operators/olm_v1/olmv1-installing-an-operator-from-a-catalog.adoc + +:_content-type: CONCEPT + +[id="olmv1-about-operator-updates_{context}"] += About target versions in OLM 1.0 + +In Operator Lifecycle Manager 1.0, cluster administrators set the target version of an Operator declaratively in the Operator's custom resource (CR). + +If the Operator's version is not specified in the CR, then OLM 1.0 defaults to the latest version in the catalog as the target version. When updates to the Operator are published to the catalog, the Operator automatically updates to the latest version. + +.Example CR without a specified target version +[source,yaml] +---- +apiVersion: operators.operatorframework.io/v1alpha1 +kind: Operator +metadata: + name: quay-example +spec: + packageName: quay-operator +---- + +If you specify a channel in the Operator's CR, OLM 1.0 installs the latest release from the specified channel. When updates are published to the specified channel, OLM 1.0 automatically updates to the latest release from the channel. + +.Example CR with a specified channel +[source,yaml] +---- +apiVersion: operators.operatorframework.io/v1alpha1 +kind: Operator +metadata: + name: quay-example +spec: + packageName: quay-operator + channel: stable-3.8 <1> +---- +<1> Installs the latest release published to the specified channel. Updates to the channel are automatically installed. + +If you specify the Operator's target version in the CR, OLM 1.0 installs the specified version. When the target version is specified in the Operator's CR, OLM 1.0 does not change the target version. + +If you want to update the version of the Operator that is installed on the cluster, you must manually update the Operator's CR. Specifying a Operator's target version pins the Operator's version to the specified release. + +.Example CR with the target version specified +[source,yaml] +---- +apiVersion: operators.operatorframework.io/v1alpha1 +kind: Operator +metadata: + name: quay-example +spec: + packageName: quay-operator + version: 3.8.12 <1> +---- +<1> Specifies the target version. If you want to update the version of the Operator that is installed on the cluster, you must manually update the Operator's CR. + +If you want to change the installed version of an Operator, edit the Operator's CR to desired target version. + +.Example CR with an updated target version +[source,yaml] +---- +apiVersion: operators.operatorframework.io/v1alpha1 +kind: Operator +metadata: + name: quay-example +spec: + packageName: quay-operator + version: 3.9.1 <1> +---- +<1> Updates the target version of the Operator to version 3.9.1. + +[WARNING] +==== +In previous versions of OLM, Operator authors could define upgrade edges to prevent you from updating to unsupported versions. In its current state of development, OLM 1.0 does not enforce upgrade edge definitions. You can specify any version of an Operator and OLM 1.0 attempts to apply the update. +==== + +You can inspect an Operator's catalog contents, including supported versions, by running the following command: + +.Command syntax +[source,terminal] +---- +$ oc get package - -o yaml +---- + +After a CR is created or updated, run the following command to create or configure the Operator: + +.Command syntax +[source,terminal] +---- +$ oc apply -f .yaml +---- + +[NOTE] +==== +If you make a mistake and update to a target version or channel that does not exist, you can run the following command to check the status of your Operator: + +[source,terminal] +---- +$ oc get operators.operators.operatorframework.io -o yaml +---- + +.Example output +[source,text] +---- +apiVersion: operators.operatorframework.io/v1alpha1 +kind: Operator +metadata: + annotations: + kubectl.kubernetes.io/last-applied-configuration: | + {"apiVersion":"operators.operatorframework.io/v1alpha1","kind":"Operator","metadata":{"anno +tations":{},"name":"quay-example"},"spec":{"channel":"stable-3.9","packageName":"quay-operator"," +version":"999.99.9"}} + creationTimestamp: "2023-10-12T20:20:40Z" + generation: 2 + name: quay-example + resourceVersion: "45505" + uid: 01ba4dd6-4eaa-4e62-bff1-233770915f7b +spec: + channel: stable-3.9 + packageName: quay-operator + version: 999.99.9 +status: + conditions: + - lastTransitionTime: "2023-10-12T20:20:40Z" + message: installation has not been attempted as resolution failed + observedGeneration: 2 + reason: InstallationStatusUnknown + status: Unknown + type: Installed + - lastTransitionTime: "2023-10-12T20:20:40Z" + message: package 'quay-operator' at version '999.99.9' in channel 'stable-3.9' + not found + observedGeneration: 2 + reason: ResolutionFailed + status: "False" + type: Resolved +---- +==== diff --git a/modules/olmv1-adding-a-catalog.adoc b/modules/olmv1-adding-a-catalog.adoc new file mode 100644 index 000000000000..ed51789bad22 --- /dev/null +++ b/modules/olmv1-adding-a-catalog.adoc @@ -0,0 +1,110 @@ +// Module included in the following assemblies: +// +// * operators/olm_v1/olmv1-installing-an-operator-from-a-catalog.adoc + +:_content-type: PROCEDURE + +[id="olmv1-adding-a-catalog-to-a-cluster_{context}"] += Adding a catalog to a cluster + +To add a catalog to a cluster, create a catalog custom resource (CR) and apply it to the cluster. + +.Procedure + +. Create a catalog custom resource (CR), similar to the following example: ++ +.Example `redhat-operators.yaml` +[source,yaml,subs="attributes+"] +---- +apiVersion: catalogd.operatorframework.io/v1alpha1 +kind: Catalog +metadata: + name: redhat-operators +spec: + source: + type: image + image: + ref: registry.redhat.io/redhat/redhat-operator-index:v{product-version} <1> +---- +<1> Specify the catalog's image in the `spec.source.image` field. + +. Run the following command to add the catalog to your cluster: ++ +[source,terminal] +---- +$ oc apply -f redhat-operators.yaml +---- ++ +.Example output +[source,text] +---- +catalog.catalogd.operatorframework.io/redhat-operators created +---- + +.Verification + +* Run the following commands to verify the status of your catalog: + +.. Run the following command to check if your catalog is available: ++ +[source,terminal] +---- +$ oc get catalog +---- ++ +.Example output +[source,text] +---- +NAME AGE +redhat-operators 20s +---- + +.. Run the following command to check the status of your catalog: ++ +[source,terminal] +---- +$ oc get catalogs.catalogd.operatorframework.io -o yaml +---- ++ +.Example output +[source,text,subs="attributes+"] +---- +apiVersion: v1 +items: +- apiVersion: catalogd.operatorframework.io/v1alpha1 + kind: Catalog + metadata: + annotations: + kubectl.kubernetes.io/last-applied-configuration: | + {"apiVersion":"catalogd.operatorframework.io/v1alpha1","kind":"Catalog","metadata":{"annotations":{},"name":"redhat-operators"},"spec":{"source":{"image":{"ref":"registry.redhat.io/redhat/redhat-operator-index:v4.14"},"type":"image"}}} + creationTimestamp: "2023-10-16T13:30:59Z" + generation: 1 + name: redhat-operators + resourceVersion: "37304" + uid: cf00c68c-4312-4e06-aa8a-299f0bbf496b + spec: + source: + image: + ref: registry.redhat.io/redhat/redhat-operator-index:v4.14 + type: image + status: <1> + conditions: + - lastTransitionTime: "2023-10-16T13:32:25Z" + message: successfully unpacked the catalog image "registry.redhat.io/redhat/redhat-operator-index@sha256:bd2f1060253117a627d2f85caa1532ebae1ba63da2a46bdd99e2b2a08035033f" <2> + reason: UnpackSuccessful <3> + status: "True" + type: Unpacked + phase: Unpacked <4> + resolvedSource: + image: + ref: registry.redhat.io/redhat/redhat-operator-index@sha256:bd2f1060253117a627d2f85caa1532ebae1ba63da2a46bdd99e2b2a08035033f <5> + type: image +kind: List +metadata: + resourceVersion: "" +---- +<1> Stanza describing the status of the catalog. +<2> Output message of the status of the catalog. +<3> Displays the reason the catalog is in the current state. +<4> Displays the phase of the installion process. +<5> Displays the image reference of the catalog. diff --git a/modules/olmv1-deleting-an-operator.adoc b/modules/olmv1-deleting-an-operator.adoc new file mode 100644 index 000000000000..e43be45d3236 --- /dev/null +++ b/modules/olmv1-deleting-an-operator.adoc @@ -0,0 +1,50 @@ +// Module included in the following assemblies: +// +// * operators/olm_v1/olmv1-installing-an-operator-from-a-catalog.adoc + +:_content-type: PROCEDURE + +[id="olmv1-deleting-an-operator_{context}"] += Deleting an Operator + +You can delete an Operator and its custom resource definitions (CRDs) by deleting the Operator's custom resource (CR). + +.Prerequisites + +* You have a catalog installed. +* You have an Operator installed. + +.Procedure + +* Run the following command to delete an Operator and its CRDs: ++ +[source,terminal] +---- +$ oc delete operator.operators.operatorframework.io quay-example +---- ++ +.Example output +[source,text] +---- +operator.operators.operatorframework.io "quay-example" deleted +---- + +.Verification + +* Run the following commands to verify that your Operator was deleted: ++ +[source,terminal] +---- +$ oc get operator.operators.operatorframework.io +---- ++ +[source,terminal] +---- +$ oc get pod -n quay-operator-system +---- ++ +.Example output +[source,text] +---- +No resources found +---- diff --git a/modules/olmv1-finding-operators-to-install.adoc b/modules/olmv1-finding-operators-to-install.adoc new file mode 100644 index 000000000000..72a184acacc3 --- /dev/null +++ b/modules/olmv1-finding-operators-to-install.adoc @@ -0,0 +1,202 @@ +// Module included in the following assemblies: +// +// * operators/olm_v1/olmv1-installing-an-operator-from-a-catalog.adoc + +:_content-type: PROCEDURE + +[id="olmv1-finding-operators-to-install_{context}"] += Finding Operators to install from a catalog + +After you add a catalog to your cluster, you can query the catalog to find Operators and extensions to install. + +.Prerequisite + +* You have added a catalog to your cluster. + +.Procedure + +. Run the following command to return a list of the Operators and extensions in the catalog: ++ +[source,terminal] +---- +$ oc get packages +---- ++ +.Example output +[source,text] +---- +NAME AGE +redhat-operators-3scale-operator 5m27s +redhat-operators-advanced-cluster-management 5m27s +redhat-operators-amq-broker-rhel8 5m27s +redhat-operators-amq-online 5m27s +redhat-operators-amq-streams 5m27s +redhat-operators-amq7-interconnect-operator 5m27s +redhat-operators-ansible-automation-platform-operator 5m27s +redhat-operators-ansible-cloud-addons-operator 5m27s +redhat-operators-apicast-operator 5m27s +redhat-operators-aws-efs-csi-driver-operator 5m27s +redhat-operators-aws-load-balancer-operator 5m27s +... +---- + +. Inspect the contents of an Operator or extension's custom resource (CR) by running the following command: ++ +[source,terminal] +---- +$ oc get package - -o yaml +---- ++ +.Example command +[source,text] +---- +$ oc get package redhat-operators-quay-operator -o yaml +---- ++ +.Example output +[source,text] +---- +apiVersion: catalogd.operatorframework.io/v1alpha1 +kind: Package +metadata: + creationTimestamp: "2023-10-06T01:14:04Z" + generation: 1 + labels: + catalog: redhat-operators + name: redhat-operators-quay-operator + ownerReferences: + - apiVersion: catalogd.operatorframework.io/v1alpha1 + blockOwnerDeletion: true + controller: true + kind: Catalog + name: redhat-operators + uid: 403004b6-54a3-4471-8c90-63419f6a2c3e + resourceVersion: "45196" + uid: 252cfe74-936d-44fc-be5d-09a7be7e36f5 +spec: + catalog: + name: redhat-operators + channels: + - entries: + - name: quay-operator.v3.4.7 + skips: + - red-hat-quay.v3.3.4 + - quay-operator.v3.4.6 + - quay-operator.v3.4.5 + - quay-operator.v3.4.4 + - quay-operator.v3.4.3 + - quay-operator.v3.4.2 + - quay-operator.v3.4.1 + - quay-operator.v3.4.0 + name: quay-v3.4 + - entries: + - name: quay-operator.v3.5.7 + replaces: quay-operator.v3.5.6 + skipRange: '>=3.4.x <3.5.7' + name: quay-v3.5 + - entries: + - name: quay-operator.v3.6.0 + skipRange: '>=3.3.x <3.6.0' + - name: quay-operator.v3.6.1 + replaces: quay-operator.v3.6.0 + skipRange: '>=3.3.x <3.6.1' + - name: quay-operator.v3.6.10 + replaces: quay-operator.v3.6.9 + skipRange: '>=3.3.x <3.6.10' + - name: quay-operator.v3.6.2 + replaces: quay-operator.v3.6.1 + skipRange: '>=3.3.x <3.6.2' + - name: quay-operator.v3.6.4 + replaces: quay-operator.v3.6.2 + skipRange: '>=3.3.x <3.6.4' + - name: quay-operator.v3.6.5 + replaces: quay-operator.v3.6.4 + skipRange: '>=3.3.x <3.6.5' + - name: quay-operator.v3.6.6 + replaces: quay-operator.v3.6.5 + skipRange: '>=3.3.x <3.6.6' + - name: quay-operator.v3.6.7 + replaces: quay-operator.v3.6.6 + skipRange: '>=3.3.x <3.6.7' + - name: quay-operator.v3.6.8 + replaces: quay-operator.v3.6.7 + skipRange: '>=3.3.x <3.6.8' + - name: quay-operator.v3.6.9 + replaces: quay-operator.v3.6.8 + skipRange: '>=3.3.x <3.6.9' + name: stable-3.6 + - entries: + - name: quay-operator.v3.7.10 + replaces: quay-operator.v3.7.9 + skipRange: '>=3.4.x <3.7.10' + - name: quay-operator.v3.7.11 + replaces: quay-operator.v3.7.10 + skipRange: '>=3.4.x <3.7.11' + - name: quay-operator.v3.7.12 + replaces: quay-operator.v3.7.11 + skipRange: '>=3.4.x <3.7.12' + - name: quay-operator.v3.7.13 + replaces: quay-operator.v3.7.12 + skipRange: '>=3.4.x <3.7.13' + - name: quay-operator.v3.7.14 + replaces: quay-operator.v3.7.13 + skipRange: '>=3.4.x <3.7.14' + name: stable-3.7 + - entries: + - name: quay-operator.v3.8.0 + skipRange: '>=3.5.x <3.8.0' + - name: quay-operator.v3.8.1 + replaces: quay-operator.v3.8.0 + skipRange: '>=3.5.x <3.8.1' + - name: quay-operator.v3.8.10 + replaces: quay-operator.v3.8.9 + skipRange: '>=3.5.x <3.8.10' + - name: quay-operator.v3.8.11 + replaces: quay-operator.v3.8.10 + skipRange: '>=3.5.x <3.8.11' + - name: quay-operator.v3.8.12 + replaces: quay-operator.v3.8.11 + skipRange: '>=3.5.x <3.8.12' + - name: quay-operator.v3.8.2 + replaces: quay-operator.v3.8.1 + skipRange: '>=3.5.x <3.8.2' + - name: quay-operator.v3.8.3 + replaces: quay-operator.v3.8.2 + skipRange: '>=3.5.x <3.8.3' + - name: quay-operator.v3.8.4 + replaces: quay-operator.v3.8.3 + skipRange: '>=3.5.x <3.8.4' + - name: quay-operator.v3.8.5 + replaces: quay-operator.v3.8.4 + skipRange: '>=3.5.x <3.8.5' + - name: quay-operator.v3.8.6 + replaces: quay-operator.v3.8.5 + skipRange: '>=3.5.x <3.8.6' + - name: quay-operator.v3.8.7 + replaces: quay-operator.v3.8.6 + skipRange: '>=3.5.x <3.8.7' + - name: quay-operator.v3.8.8 + replaces: quay-operator.v3.8.7 + skipRange: '>=3.5.x <3.8.8' + - name: quay-operator.v3.8.9 + replaces: quay-operator.v3.8.8 + skipRange: '>=3.5.x <3.8.9' + name: stable-3.8 + - entries: + - name: quay-operator.v3.9.0 + skipRange: '>=3.6.x <3.9.0' + - name: quay-operator.v3.9.1 + replaces: quay-operator.v3.9.0 + skipRange: '>=3.6.x <3.9.1' + - name: quay-operator.v3.9.2 + replaces: quay-operator.v3.9.1 + skipRange: '>=3.6.x <3.9.2' + name: stable-3.9 + defaultChannel: stable-3.9 + description: "" + icon: + data: PD94bWwgdmVyc2lvbj ... + mediatype: image/svg+xml + packageName: quay-operator +status: {} +---- diff --git a/modules/olmv1-installing-an-operator.adoc b/modules/olmv1-installing-an-operator.adoc new file mode 100644 index 000000000000..cbba3061399e --- /dev/null +++ b/modules/olmv1-installing-an-operator.adoc @@ -0,0 +1,105 @@ +// Module included in the following assemblies: +// +// * operators/olm_v1/olmv1-installing-an-operator-from-a-catalog.adoc + +:_content-type: PROCEDURE + +[id="olmv1-installing-an-operator_{context}"] += Installing an Operator + +You can install an Operator from a catalog by creating an Operator custom resource (CR) and applying it to the cluster. + +.Prerequisite + +* You have added a catalog to your cluster. +* You have inspected the details of an Operator to find what version you want to install. + +.Procedure + +. Create an Operator CR, similar to the following example: ++ +.Example `test-operator.yaml` CR +[source,yaml] +---- +apiVersion: operators.operatorframework.io/v1alpha1 +kind: Operator +metadata: + name: quay-example +spec: + packageName: quay-operator + channel: stable-3.8 + version: 3.8.12 +---- + +. Run the following command to apply the Operator CR to the cluster: ++ +[source,terminal] +---- +$ oc apply -f test-operator.yaml +---- ++ +.Example output +[source,text] +---- +operator.operators.operatorframework.io/quay-example created +---- + +.Verification + +. Run the following command to view the Operator's CR in the YAML format: ++ +[source,terminal] +---- +$ oc get operator.operators.operatorframework.io/quay-example -o yaml +---- ++ +.Example output +[source,text] +---- +apiVersion: operators.operatorframework.io/v1alpha1 +kind: Operator +metadata: + annotations: + kubectl.kubernetes.io/last-applied-configuration: | + {"apiVersion":"operators.operatorframework.io/v1alpha1","kind":"Operator","metadata":{"annotations":{},"name":"quay-example"},"spec":{"channel":"stable-3.8","packageName":"quay-operator","version":"3.8.12"}} + creationTimestamp: "2023-10-06T01:50:25Z" + generation: 1 + name: quay-example + resourceVersion: "65292" + uid: 7e782643-71c2-4355-80ff-e8cc61bd44a1 +spec: + channel: stable-3.8 + packageName: quay-operator + version: 3.8.12 +status: + conditions: + - lastTransitionTime: "2023-10-06T01:50:25Z" + message: resolved to "registry.redhat.io/quay/quay-operator-bundle@sha256:bf26c7679ea1f7b47d2b362642a9234cddb9e366a89708a4ffcbaf4475788dc7" + observedGeneration: 1 + reason: Success + status: "True" + type: Resolved + - lastTransitionTime: "2023-10-06T01:50:38Z" + message: installed from "registry.redhat.io/quay/quay-operator-bundle@sha256:bf26c7679ea1f7b47d2b362642a9234cddb9e366a89708a4ffcbaf4475788dc7" + observedGeneration: 1 + reason: Success + status: "True" + type: Installed + installedBundleResource: registry.redhat.io/quay/quay-operator-bundle@sha256:bf26c7679ea1f7b47d2b362642a9234cddb9e366a89708a4ffcbaf4475788dc7 + resolvedBundleResource: registry.redhat.io/quay/quay-operator-bundle@sha256:bf26c7679ea1f7b47d2b362642a9234cddb9e366a89708a4ffcbaf4475788dc7 +---- + +. Run the following command to get information about your Operator's controller manager pod: ++ +[source,terminal] +---- +$ oc get pod -n quay-operator-system +---- ++ +.Example output +[source,text] +---- +NAME READY STATUS RESTARTS AGE +quay-operator.v3.8.12-6677b5c98f-2kdtb 1/1 Running 0 2m28s +---- + diff --git a/modules/olmv1-red-hat-catalogs.adoc b/modules/olmv1-red-hat-catalogs.adoc new file mode 100644 index 000000000000..31dfaa080d2b --- /dev/null +++ b/modules/olmv1-red-hat-catalogs.adoc @@ -0,0 +1,61 @@ +// Module included in the following assemblies: +// +// * operators/olm_v1/olmv1-installing-an-operator-from-a-catalog.adoc + +:_content-type: REFERENCE + +[id="olmv1-red-hat-catalogs_{context}"] += Red Hat-provided Operator catalogs in OLM 1.0 + +Operator Lifecycle Manager (OLM) 1.0 does not include Red Hat-provided Operator catalogs by default. If you want to add a Red Hat-provided catalog to your cluster, create a custom resource (CR) for the catalog and apply it to the cluster. The following custom resource (CR) examples show how to create a catalog resources for OLM 1.0. + +.Example Red Hat Operators catalog +[source,yaml,subs="attributes+"] +---- +apiVersion: catalogd.operatorframework.io/v1alpha1 +kind: Catalog +metadata: + name: redhat-operators +spec: + source: + type: image + image: + ref: registry.redhat.io/redhat/redhat-operator-index:v{product-version} +---- + +.Example Certified Operators catalog +[source,yaml,subs="attributes+"] +---- +apiVersion: catalogd.operatorframework.io/v1alpha1 +kind: Catalog +metadata: + name: certified-operators +spec: + source: + type: image + image: + ref: registry.redhat.io/redhat/certified-operator-index:v{product-version} +---- + +.Example Community Operators catalog +[source,yaml,subs="attributes+"] +---- +apiVersion: catalogd.operatorframework.io/v1alpha1 +kind: Catalog +metadata: + name: community-operators +spec: + source: + type: image + image: + ref: registry.redhat.io/redhat/community-operator-index:v{product-version} +---- + +The following command adds a catalog to your cluster: + +.Command syntax +[source,terminal] +---- +$ oc apply -f .yaml <1> +---- +<1> Specifies the catalog CR, such as `redhat-operators.yaml`. diff --git a/modules/olmv1-updating-an-operator.adoc b/modules/olmv1-updating-an-operator.adoc new file mode 100644 index 000000000000..4c0e504e0bc7 --- /dev/null +++ b/modules/olmv1-updating-an-operator.adoc @@ -0,0 +1,125 @@ +// Module included in the following assemblies: +// +// * operators/olm_v1/olmv1-installing-an-operator-from-a-catalog.adoc + +:_content-type: PROCEDURE + +[id="olmv1-updating-an-operator_{context}"] += Updating an Operator + +You can update your Operator by manually editing your Operator's custom resource (CR) and applying the changes. + +.Prerequisites + +* You have a catalog installed. +* You have an Operator installed. + +.Procedure + +. Run the following command to inspect your Operator's package contents in the catalog to find which channels and versions are available for updating: ++ +[source,terminal] +---- +$ oc get package - -o yaml +---- ++ +.Example command +[source,terminal] +---- +$ oc get package redhat-operators-quay-operator -o yaml +---- + +. Edit your Operator's CR to update the channel to `stable-3.9` and the version to `3.9.1`:, as shown in the following example: ++ +.Example `test-operator.yaml` CR +[source,yaml] +---- +apiVersion: operators.operatorframework.io/v1alpha1 +kind: Operator +metadata: + name: quay-example +spec: + packageName: quay-operator + channel: stable-3.9 <1> + version: 3.9.1 <2> +---- +<1> Update the channel to `stable-3.9`. +<2> Update the version to `3.9.1` + +. Run the following command to apply the update to the cluster: ++ +[source,terminal] +---- +$ oc apply -f test-operator.yaml +---- ++ +.Example output +[source,text] +---- +operator.operators.operatorframework.io/quay-example configured +---- ++ +[TIP] +==== +You can run the following command to patch and apply the changes to your Operator's channel and version from the CLI: + +[source,terminal] +---- +$ oc patch operator.operators.operatorframework.io/quay-example -p \ + '{"spec":{"channel":"stable-3.9","version":"3.9.1"}}' \ + --type=merge +---- + +.Example output +[source,text] +---- +operator.operators.operatorframework.io/quay-example patched +---- +==== + +.Verification + +* Run the following command verify that the channel and version updates have been applied: ++ +[source,terminal] +---- +$ oc get operator.operators.operatorframework.io/quay-example -o yaml +---- ++ +.Example output +[source,yaml] +---- +apiVersion: operators.operatorframework.io/v1alpha1 +kind: Operator +metadata: + annotations: + kubectl.kubernetes.io/last-applied-configuration: | + {"apiVersion":"operators.operatorframework.io/v1alpha1","kind":"Operator","metadata":{"annotations":{},"name":"quay-example"},"spec":{"channel":"stable-3.9","packageName":"quay-operator","version":"3.9.1"}} + creationTimestamp: "2023-10-06T01:50:25Z" + generation: 5 + name: quay-example + resourceVersion: "83322" + uid: 7e782643-71c2-4355-80ff-e8cc61bd44a1 +spec: + channel: stable-3.9 <1> + packageName: quay-operator + version: 3.9.1 <2> +status: + conditions: + - lastTransitionTime: "2023-10-06T02:12:30Z" + message: resolved to "registry.redhat.io/quay/quay-operator-bundle@sha256:4864bc0d5c18a84a5f19e5e664b58d3133a2ac2a309c6b5659ab553f33214b09" + observedGeneration: 5 + reason: Success + status: "True" + type: Resolved + - lastTransitionTime: "2023-10-06T02:12:30Z" + message: installed from "registry.redhat.io/quay/quay-operator-bundle@sha256:4864bc0d5c18a84a5f19e5e664b58d3133a2ac2a309c6b5659ab553f33214b09" + observedGeneration: 5 + reason: Success + status: "True" + type: Installed + installedBundleResource: registry.redhat.io/quay/quay-operator-bundle@sha256:4864bc0d5c18a84a5f19e5e664b58d3133a2ac2a309c6b5659ab553f33214b09 + resolvedBundleResource: registry.redhat.io/quay/quay-operator-bundle@sha256:4864bc0d5c18a84a5f19e5e664b58d3133a2ac2a309c6b5659ab553f33214b09 +---- +<1> Verify that the channel is updated to `stable-3.9`. +<2> Verify that the version is updated to `3.9.1`. diff --git a/operators/olm_v1/olmv1-installing-an-operator-from-a-catalog.adoc b/operators/olm_v1/olmv1-installing-an-operator-from-a-catalog.adoc new file mode 100644 index 000000000000..a6e8919eb81c --- /dev/null +++ b/operators/olm_v1/olmv1-installing-an-operator-from-a-catalog.adoc @@ -0,0 +1,61 @@ +:_content-type: ASSEMBLY +[id="olmv1-installing-an-operator-from-a-catalog"] += Installing an Operator from a catalog in OLM 1.0 (Technology Preview) +include::_attributes/common-attributes.adoc[] +:context: olmv1-installing-operator + +toc::[] + +Cluster administrators can add _catalogs_, or curated collections of Operators and Kubernetes extensions, to their clusters. Operator authors publish their products to these catalogs. + +[NOTE] +==== +In the current Technology Preview release of Operator Lifecycle Manager (OLM) 1.0, you manage catalogs and Operators declaratively from the CLI using custom resources (CRs). +==== + +When you add a catalog to your cluster, you have access to the versions, patches, and over-the-air updates of the Operators and extensions that are published to the catalog. + +:FeatureName: OLM 1.0 +include::snippets/technology-preview.adoc[] + +[id="prerequisites_olmv1-installing-an-operator-from-a-catalog"] +== Prerequisites + +* Access to an {product-title} cluster using an account with `cluster-admin` permissions +* The `oc` command installed on your workstation +* The `TechPreviewNoUpgrades` feature set enabled on the cluster ++ +[WARNING] +==== +Enabling the `TechPreviewNoUpgrade` feature set cannot be undone and prevents minor version updates. These feature sets are not recommended on production clusters. +==== + +[role="_additional-resources"] +.Additional resources + +* xref:../../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling[Enabling features using feature gates] + +include::modules/olmv1-about-catalogs.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources +* xref:../../operators/understanding/olm-packaging-format.adoc#olm-file-based-catalogs_olm-packaging-format[File-based catalogs] + +include::modules/olmv1-red-hat-catalogs.adoc[leveloffset=+2] + +[role="_additional-resources"] +.Additional resources +* xref:../../operators/olm_v1/olmv1-installing-an-operator-from-a-catalog.adoc#olmv1-adding-a-catalog-to-a-cluster_olmv1-installing-operator[Adding a catalog to a cluster] +* xref:../../operators/understanding/olm-rh-catalogs.adoc#olm-rh-catalogs_olm-rh-catalogs[About Red Hat-provided Operator catalogs] + +[NOTE] +==== +The following procedures use the Red Hat Operators catalog and the Quay Operator as examples. +==== + +include::modules/olmv1-about-target-versions.adoc[leveloffset=+1] +include::modules/olmv1-adding-a-catalog.adoc[leveloffset=+1] +include::modules/olmv1-finding-operators-to-install.adoc[leveloffset=+1] + +include::modules/olmv1-installing-an-operator.adoc[leveloffset=+1] +include::modules/olmv1-updating-an-operator.adoc[leveloffset=+1] +include::modules/olmv1-deleting-an-operator.adoc[leveloffset=+1]