[1.42.x] [KOGITO-9683] - Update Operator's installation guide to refl…

…ect OLM (#466) * [KOGITO-9683] - Update Operator's installation guide to reflect OLM (#460) * [KOGITO-9683] - Update Operator's installation guide to reflect OLM Signed-off-by: Ricardo Zanini <[email protected]> * Incorporating radtriste's and kaldesai's review Co-authored-by: Kalyani Desai <[email protected]> Co-authored-by: Tristan Radisson <[email protected]> * Adding Kris' review Signed-off-by: Ricardo Zanini <[email protected]> --------- Signed-off-by: Ricardo Zanini <[email protected]> Co-authored-by: Kalyani Desai <[email protected]> Co-authored-by: Tristan Radisson <[email protected]> * Fixing versions (1.42) --------- Signed-off-by: Ricardo Zanini <[email protected]> Co-authored-by: Ricardo Zanini <[email protected]> Co-authored-by: Kalyani Desai <[email protected]> Co-authored-by: Tristan Radisson <[email protected]>
apache · Aug 22, 2023 · 26143c9 · 26143c9
1 parent 3bbe8ab
commit 26143c9
Show file tree

Hide file tree

Showing 5 changed files with 50 additions and 24 deletions.
diff --git a/antora-playbook-author.yml b/antora-playbook-author.yml
@@ -1,5 +1,5 @@
 site:
-  title: Kogito Serverless Workflow Guides Local Preview
+  title: SonataFlow Guides Local Preview
   start_page: serverlessworkflow::index.adoc
 urls:
   latest_version_segment: latest

diff --git a/antora-playbook.yml b/antora-playbook.yml
@@ -1,5 +1,5 @@
 site:
-  title: Kogito Serverless Workflow Guides
+  title: SonataFlow Guides
   start_page: serverlessworkflow::index.adoc
 urls:
   latest_version_segment: latest

diff --git a/serverlessworkflow/antora.yml b/serverlessworkflow/antora.yml
@@ -1,16 +1,15 @@
 name: serverlessworkflow
-title: "Kogito Serverless Workflow Guides"
+title: "SonataFlow Guides"
 version: '1.42.0.Final'
 display_version: '1.42'
-
 start_page: index.adoc
 nav:
 - "modules/ROOT/nav.adoc"
 asciidoc:
   attributes:
     # for product names
     #in Downstream product_name: OpenShift Serverless Logic
-    product_name: Kogito Serverless Workflow
+    product_name: SonataFlow
     # upstream: empty
     #kogito_version_redhat: 1.24.0.Final-redhat-00001
     kogito_version_redhat: ""
@@ -37,6 +36,11 @@ asciidoc:
     docker_compose_min_version: 1.27.2
     # only used in downstream
     operator_version: 'v1.42.0'
+    # after TP1, change to Serverless Logic
+    operator_openshift_keyword: sonataflow
+    operator_openshift_catalog: sonataflow-operator
+    operator_k8s_keyword: sonataflow
+    operator_k8s_subscription: my-sonataflow-operator
     kogito_devservices_imagename: registry.redhat.io/openshift-serverless-1-tech-preview/logic-data-index-ephemeral-rhel8
     kogito_examples_repository_url: https://github.com/kiegroup/kogito-examples
     kogito_sw_examples_url: https://github.com/kiegroup/kogito-examples/tree/1.42.x/serverless-workflow-examples

diff --git a/...lessworkflow/modules/ROOT/pages/cloud/operator/install-serverless-operator.adoc b/...lessworkflow/modules/ROOT/pages/cloud/operator/install-serverless-operator.adoc
@@ -3,17 +3,53 @@
 // Metadata:
 :description: Install the operator on Kubernetes clusters
 :keywords: kogito, sonataflow, workflow, serverless, operator, kubernetes, minikube, openshift, containers
+// links
 
-This guide describes how to install the {operator_name} in a Kubernetes cluster. The operator is in an xref:/cloud/operator/known-issues.adoc[early development stage] (community only) and has been tested on Kubernetes 1.22+, and link:{minikube_url}[Minikube].
+:openshift_operator_install_url: https://docs.openshift.com/container-platform/4.13/operators/admin/olm-adding-operators-to-cluster.html
+:openshift_operator_uninstall_url: https://docs.openshift.com/container-platform/4.13/operators/admin/olm-deleting-operators-from-cluster.html
+:kubernetes_operator_install_url: https://operatorhub.io/how-to-install-an-operator
+:kubernetes_operator_uninstall_url: https://olm.operatorframework.io/docs/tasks/uninstall-operator/
+:operatorhub_url: https://operatorhub.io/
+
+This guide describes how to install the {operator_name} in a Kubernetes or OpenShift cluster. The operator is in an xref:/cloud/operator/known-issues.adoc[early development stage] (community only) and has been tested on OpenShift 4.11+, Kubernetes 1.22+, and link:{minikube_url}[Minikube].
 
 .Prerequisites
-* A Kubernetes cluster with admin privileges. Alternatively, you can use Minikube or KIND.
+* A Kubernetes or OpenShift cluster with admin privileges. Alternatively, you can use Minikube or KIND.
 * `kubectl` command-line tool is installed. Otherwise, Minikube provides it.
 
-== Prepare a Minikube Instance
+== {product_name} Operator OpenShift installation
+
+To install the operator on OpenShift refer to the "link:{openshift_operator_install_url}[Adding Operators to a cluster]" from the OpenShift's documentation.
+
+When searching for the operator in the *Filter by keyword* field, use the word `{operator_openshift_keyword}`. If you're installing from the CLI, the operator's catalog name is `{operator_openshift_catalog}`.
+
+=== Uninstall
+
+To remove the operator on OpenShift refer to the "link:{openshift_operator_uninstall_url}[Deleting Operators from a cluster]" from the OpenShift's documentation.
+
+== {product_name} Operator Kubernetes installation
+
+To install the operator on Kubernetes refer to the  "link:{kubernetes_operator_install_url}[How to install an Operator from OperatorHub.io]" from the OperatorHub's documentation.
+
+When link:{operatorhub_url}[searching for the operator in the *Search OperatorHub* field], use the word `{operator_k8s_keyword}`.
+
+=== Uninstall
+
+To remove the operator on Kubernetes follow the document "link:{kubernetes_operator_uninstall_url}[Uninstall your operator]" from the OLM's documentation.
+
+When searching for the subscription to remove, use the word `{operator_k8s_subscription}`.
+
+== {product_name} Operator Manual Installation
 
 [WARNING]
 ====
+If you're running on Kubernetes or OpenShift, it is highly recommended to install the operator from the OperatorHub or OpenShift Console instead since the installation is managed by OLM. Use this method only if you need a snapshot version or you're running locally on Minikube or KIND.
+====
+
+=== Prepare a Minikube instance
+
+[NOTE]
+====
 You can safely skip this section if you're not using Minikube.
 ====
 
@@ -41,11 +77,10 @@ If Minikube does not work with the default driver, also known as `docker`, you c
 minikube start [...] --driver podman
 ----
 
-== Install the {product_name} Operator
+=== Install
 
 To install the {product_name} Operator, you can use the following command:
 
-// TODO: replace this URI with the GitHub's artifact release instead.
 .Install {product_name} Operator on Kubernetes
 [source,shell,subs="attributes+"]
 ----
@@ -81,19 +116,7 @@ kubectl logs deployment/sonataflow-operator-controller-manager -n sonataflow-ope
 
 Once the operator is running, it will watch for instances of the {product_name} Custom Resources (CR). Using CRs, you can configure your {product_name} environment and define Workflows and builds to be handled by the operator.
 
-For the operator to correctly manage the CR instances, you must first install the {product_name} Custom Resource Definitions (CRDs). To check if the CRDs are correctly installed, try running:
-
-.Check if the CRDs are correctly installed
-[source,shell,subs="attributes+"]
-----
-kubectl get crds | grep sonataflow
-sonataflowbuilds.sonataflow.org      2023-03-08T18:31:15Z
-sonataflowplatforms.sonataflow.org   2023-03-08T18:31:15Z
-sonataflows.sonataflow.org   2023-03-08T18:31:15Z
-----
-
-== Uninstall the Operator
-// TODO: this is super verbose for now because we don't have OLM/OperatorHub. This procedure should be replaced as soon as we have them. Or it should be renamed to "Uninstalling snapshot/local versions", so crazy users that don't rely on operatorhub/olm can also install/uninstall their instances.
+=== Uninstall
 
 To uninstall the {operator_name}, first, you must delete all the {product_name} Custom Resources (CR) instances managed by it. Once the CRs are deleted, you can then delete all resources created during the operator installation.
 

diff --git a/serverlessworkflow/modules/ROOT/pages/cloud/operator/known-issues.adoc b/serverlessworkflow/modules/ROOT/pages/cloud/operator/known-issues.adoc
@@ -23,7 +23,6 @@ The following issues are currently being prioritized:
 - link:https://issues.redhat.com/browse/KOGITO-7755[Manage the Functions included in a Workflow with Operator]
 - link:https://issues.redhat.com/browse/KOGITO-8524[Enable toggle Workflow CR from devmode to production mode and vice-versa]
 - link:https://issues.redhat.com/browse/KOGITO-8792[Review build failures and signal the reasoning in the Events API]
-- link:https://issues.redhat.com/browse/KOGITO-8794[Handle deployment failures in prod profile]
 - link:https://issues.redhat.com/browse/KOGITO-8806[Evaluate internal registry integration on OpenShift, Kubernetes and Minikube]
 
 === Knative Integration