diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index f5ef3342c0..621529d5a0 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -1861,9 +1861,6 @@ Topics: - Name: Catalog source pod scheduling File: olm-cs-podsched Distros: openshift-origin,openshift-enterprise - - Name: Managing platform Operators - File: olm-managing-po - Distros: openshift-enterprise,openshift-origin - Name: Troubleshooting Operator issues File: olm-troubleshooting-operator-issues Distros: openshift-enterprise,openshift-origin diff --git a/_topic_maps/_topic_map_osd.yml b/_topic_maps/_topic_map_osd.yml index e8fedaffdb..dd6880706d 100644 --- a/_topic_maps/_topic_map_osd.yml +++ b/_topic_maps/_topic_map_osd.yml @@ -716,8 +716,6 @@ Topics: File: olm-managing-custom-catalogs - Name: Catalog source pod scheduling File: olm-cs-podsched -# - Name: Managing platform Operators <= Tech Preview -# File: olm-managing-po - Name: Troubleshooting Operator issues File: olm-troubleshooting-operator-issues - Name: Developing Operators diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml index 9c5d9d3c5a..743de310b1 100644 --- a/_topic_maps/_topic_map_rosa.yml +++ b/_topic_maps/_topic_map_rosa.yml @@ -937,8 +937,6 @@ Topics: File: olm-managing-custom-catalogs - Name: Catalog source pod scheduling File: olm-cs-podsched -# - Name: Managing platform Operators <= Tech Preview -# File: olm-managing-po - Name: Troubleshooting Operator issues File: olm-troubleshooting-operator-issues - Name: Developing Operators diff --git a/_topic_maps/_topic_map_rosa_hcp.yml b/_topic_maps/_topic_map_rosa_hcp.yml index 37873d275c..75f776e3df 100644 --- a/_topic_maps/_topic_map_rosa_hcp.yml +++ b/_topic_maps/_topic_map_rosa_hcp.yml @@ -940,8 +940,6 @@ Topics: # File: olm-managing-custom-catalogs # - Name: Catalog source pod scheduling # File: olm-cs-podsched -# - Name: Managing platform Operators <= Tech Preview -# File: olm-managing-po # - Name: Troubleshooting Operator issues # File: olm-troubleshooting-operator-issues # - Name: Developing Operators diff --git a/architecture/control-plane.adoc b/architecture/control-plane.adoc index abfde49056..3ca8747723 100644 --- a/architecture/control-plane.adoc +++ b/architecture/control-plane.adoc @@ -50,17 +50,6 @@ include::modules/arch-olm-operators.adoc[leveloffset=+2] * For more details on running add-on Operators in {product-title}, see the _Operators_ guide sections on xref:../operators/understanding/olm/olm-understanding-olm.adoc#olm-understanding-olm[Operator Lifecycle Manager (OLM)] and xref:../operators/understanding/olm-understanding-operatorhub.adoc#olm-understanding-operatorhub[OperatorHub]. * For more details on the Operator SDK, see xref:../operators/operator_sdk/osdk-about.adoc#osdk-about[Developing Operators]. -ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] -include::modules/arch-platform-operators.adoc[leveloffset=+2] - -[role="_additional-resources"] -.Additional resources -* xref:../operators/admin/olm-managing-po.adoc#olm-managing-po[Managing platform Operators] -* xref:../operators/admin/olm-managing-po.adoc#olm-po-techpreview_olm-managing-po[Technology Preview restrictions for platform Operators] -* xref:../operators/understanding/olm-packaging-format.adoc#olm-rukpak-about_olm-packaging-format[RukPak component and packaging format] -* xref:../installing/cluster-capabilities.adoc#cluster-capabilities[Cluster capabilities] -endif::[] - // This module does not apply to OSD/ROSA ifndef::openshift-dedicated,openshift-rosa[] include::modules/understanding-machine-config-operator.adoc[leveloffset=+1] diff --git a/modules/olm-deleting-po.adoc b/modules/olm-deleting-po.adoc deleted file mode 100644 index 94077dee3d..0000000000 --- a/modules/olm-deleting-po.adoc +++ /dev/null @@ -1,65 +0,0 @@ -// Module included in the following assemblies: -// -// * operators/admin/olm-managing-po.adoc - -:_mod-docs-content-type: PROCEDURE -[id="olm-deleting-po_{context}"] -= Deleting platform Operators - -As a cluster administrator, you can delete existing platform Operators. Operator Lifecycle Manager (OLM) performs a cascading deletion. First, OLM removes the bundle deployment for the platform Operator, which then deletes any objects referenced in the `registry+v1` type bundle. - -[NOTE] -==== -The platform Operator manager and bundle deployment provisioner only manage objects that are referenced in the bundle, but not objects subsequently deployed by any bundle workloads themselves. For example, if a bundle workload creates a namespace and the Operator is not configured to clean it up before the Operator is removed, it is outside of the scope of OLM to remove the namespace during platform Operator deletion. -==== - -.Procedure - -. Get a list of installed platform Operators and find the name for the Operator you want to delete: -+ -[source,terminal] ----- -$ oc get platformoperator ----- - -. Delete the `PlatformOperator` resource for the chosen Operator, for example, for the Quay Operator: -+ -[source,terminal] ----- -$ oc delete platformoperator quay-operator ----- -+ -.Example output -[source,terminal] ----- -platformoperator.platform.openshift.io "quay-operator" deleted ----- - -.Verification - -. Verify the namespace for the platform Operator is eventually deleted, for example, for the Quay Operator: -+ -[source,terminal] ----- -$ oc get ns quay-operator-system ----- -+ -.Example output -[source,terminal] ----- -Error from server (NotFound): namespaces "quay-operator-system" not found ----- - -. Verify the `platform-operators-aggregated` cluster Operator continues to report an `Available=True` status: -+ -[source,terminal] ----- -$ oc get co platform-operators-aggregated ----- -+ -.Example output -[source,terminal,subs="attributes+"] ----- -NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE MESSAGE -platform-operators-aggregated {product-version}.0-0 True False False 70s ----- \ No newline at end of file diff --git a/modules/olm-installing-po-during.adoc b/modules/olm-installing-po-during.adoc deleted file mode 100644 index a79f856514..0000000000 --- a/modules/olm-installing-po-during.adoc +++ /dev/null @@ -1,117 +0,0 @@ -// Module included in the following assemblies: -// -// * operators/admin/olm-managing-po.adoc - -:_mod-docs-content-type: PROCEDURE -[id="olm-installing-po-during_{context}"] -= Installing platform Operators during cluster creation - -As a cluster administrator, you can install platform Operators by providing `FeatureGate` and `PlatformOperator` manifests during cluster creation. - -.Procedure - -. Choose a platform Operator from the supported set of OLM-based Operators. For the list of this set and details on current limitations, see "Technology Preview restrictions for platform Operators". - -. Select a cluster installation method and follow the instructions through creating an `install-config.yaml` file. For more details on preparing for a cluster installation, see "Selecting a cluster installation method and preparing it for users". - -. After you have created the `install-config.yaml` file and completed any modifications to it, change to the directory that contains the installation program and create the manifests: -+ -[source,terminal] ----- -$ ./openshift-install create manifests --dir <1> ----- -<1> For ``, specify the name of the directory that contains the `install-config.yaml` file for your cluster. - -. Create a `FeatureGate` object YAML file in the `/manifests/` directory that enables the `TechPreviewNoUpgrade` feature set, for example a `feature-gate.yaml` file: -+ -.Example `feature-gate.yaml` file -[source,yaml] ----- -apiVersion: config.openshift.io/v1 -kind: FeatureGate -metadata: - annotations: - include.release.openshift.io/self-managed-high-availability: "true" - include.release.openshift.io/single-node-developer: "true" - release.openshift.io/create-only: "true" - name: cluster -spec: - featureSet: TechPreviewNoUpgrade <1> ----- -<1> Enable the `TechPreviewNoUpgrade` feature set. - -. Create a `PlatformOperator` object YAML file for your chosen platform Operator in the `/manifests/` directory, for example a `service-mesh-po.yaml` file for the {SMProductName} Operator: -+ -.Example `service-mesh-po.yaml` file -[source,yaml] ----- -apiVersion: platform.openshift.io/v1alpha1 -kind: PlatformOperator -metadata: - name: service-mesh-po -spec: - package: - name: servicemeshoperator ----- - -. When you are ready to complete the cluster install, refer to your chosen installation method and continue through running the `openshift-install create cluster` command. -+ -During cluster creation, your provided manifests are used to enable the `TechPreviewNoUpgrade` feature set and install your chosen platform Operator. -+ -[IMPORTANT] -==== -Failure of the platform Operator to successfully install will block the cluster installation process. -==== - -.Verification - -. Check the status of the `service-mesh-po` platform Operator by running the following command: -+ -[source,terminal] ----- -$ oc get platformoperator service-mesh-po -o yaml ----- -+ -.Example output -[source,yaml] ----- -... -status: - activeBundleDeployment: - name: service-mesh-po - conditions: - - lastTransitionTime: "2022-10-24T17:24:40Z" - message: Successfully applied the service-mesh-po BundleDeployment resource - reason: InstallSuccessful - status: "True" <1> - type: Installed ----- -<1> Wait until the `Installed` status condition reports `True`. - -. Verify that the `platform-operators-aggregated` cluster Operator is reporting an `Available=True` status: -+ -[source,terminal] ----- -$ oc get clusteroperator platform-operators-aggregated -o yaml ----- -+ -.Example output -[source,yaml] ----- -... -status: - conditions: - - lastTransitionTime: "2022-10-24T17:43:26Z" - message: All platform operators are in a successful state - reason: AsExpected - status: "False" - type: Progressing - - lastTransitionTime: "2022-10-24T17:43:26Z" - status: "False" - type: Degraded - - lastTransitionTime: "2022-10-24T17:43:26Z" - message: All platform operators are in a successful state - reason: AsExpected - status: "True" - type: Available ----- diff --git a/modules/olm-po-techpreview.adoc b/modules/olm-po-techpreview.adoc deleted file mode 100644 index f6f5accd16..0000000000 --- a/modules/olm-po-techpreview.adoc +++ /dev/null @@ -1,68 +0,0 @@ -// Module included in the following assemblies: -// -// * operators/admin/olm-managing-po.adoc - -:_mod-docs-content-type: CONCEPT -[id="olm-po-techpreview_{context}"] -= Technology Preview restrictions for platform Operators - -During the Technology Preview release of the platform Operators feature in {product-title} 4.12, the following restrictions determine whether an Operator can be installed through the platform Operators mechanism: - -* Kubernetes manifests must be packaged using the Operator Lifecycle Manager (OLM) `registry+v1` bundle format. -* The Operator cannot declare package or group/version/kind (GVK) dependencies. -* The Operator cannot specify cluster service version (CSV) install modes other than `AllNamespaces` -* The Operator cannot specify any `Webhook` or `APIService` definitions. -* All package bundles must be in the `redhat-operators` catalog source. - -After considering these restrictions, the following Operators can be successfully installed: - -.OLM-based Operators installable as platform Operators -[cols="1,1"] -|=== -|3scale-operator -|amq-broker-rhel8 - -|amq-online -|amq-streams - -|ansible-cloud-addons-operator -|apicast-operator - -|container-security-operator -|eap - -|file-integrity-operator -|gatekeeper-operator-product - -|integration-operator -|jws-operator - -|kiali-ossm -|node-healthcheck-operator - -|odf-csi-addons-operator -|odr-hub-operator - -|openshift-custom-metrics-autoscaler-operator -|openshift-gitops-operator - -|openshift-pipelines-operator-rh -|quay-operator - -|red-hat-camel-k -|rhpam-kogito-operator - -|service-registry-operator -|servicemeshoperator - -|skupper-operator -| -|=== - -[NOTE] -==== -The following features are not available during this Technology Preview release: - -* Automatically upgrading platform Operator packages after cluster rollout -* Extending the platform Operator mechanism to support any optional, CVO-based components -==== diff --git a/modules/olm-rukpak-about.adoc b/modules/olm-rukpak-about.adoc index 091b682f88..91944d2edf 100644 --- a/modules/olm-rukpak-about.adoc +++ b/modules/olm-rukpak-about.adoc @@ -11,9 +11,7 @@ ifeval::["{context}" == "olm-packaging-format"] :FeatureName: RukPak include::snippets/technology-preview.adoc[] -{product-title} 4.12 introduces the _platform Operator_ type as a Technology Preview feature. The platform Operator mechanism relies on the RukPak component, also introduced in {product-title} 4.12, and its resources to manage content. - -{product-title} 4.14 introduces {olmv1-first} as a Technology Preview feature, which also relies on the RukPak component. +{product-title} 4.14 introduces {olmv1-first} as a Technology Preview feature, which relies on the RukPak component. endif::[] ifeval::["{context}" == "olmv1-rukpak"] = About RukPak @@ -36,4 +34,4 @@ A Git repository that contains a bundle within a directory Provisioner:: Controllers that install and manage content on a Kubernetes cluster Bundle deployment:: -Generates deployed instances of a bundle \ No newline at end of file +Generates deployed instances of a bundle diff --git a/operators/understanding/olm-packaging-format.adoc b/operators/understanding/olm-packaging-format.adoc index e4e47667a0..105e9ca605 100644 --- a/operators/understanding/olm-packaging-format.adoc +++ b/operators/understanding/olm-packaging-format.adoc @@ -79,8 +79,6 @@ include::modules/olm-rukpak-about.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../../operators/admin/olm-managing-po.adoc#olm-managing-po[Managing platform Operators] -* xref:../../operators/admin/olm-managing-po.adoc#olm-po-techpreview_olm-managing-po[Technology Preview restrictions for platform Operators] * xref:../../operators/olm_v1/index.adoc#olmv1-about[About Operator Lifecycle Manager 1.0 (Technology Preview)] include::modules/olm-rukpak-bundle.adoc[leveloffset=+2]