ricardozanini commented on code in PR #674:
URL:
https://github.com/apache/incubator-kie-kogito-docs/pull/674#discussion_r1803544869
##########
serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/deployments/deploying-sonataflow-management-console-on-openshift.adoc:
##########
@@ -0,0 +1,149 @@
+= Deploying {product_name} Management Console on OpenShift
+:compat-mode!:
+// Metadata:
+:description: Deploying Management Console on OpenShift
+:keywords: kogito, workflow, quarkus, serverless, kn, oc, openshift, sonataflow
+:table-caption: Data Set
+// envs for common content
+:management_console: SonataFlow Management Console
+:registry: OpenShift's
+:command_line_tool: oc
+:command_line_tool_name: OpenShift CLI
+:ocp_name: OpenShift Container Platform
+:platform: OpenShift
+// links
+:ocp_cli_url:
https://docs.openshift.com/container-platform/4.12/cli_reference/openshift_cli/getting-started-cli.html#cli-about-cli_cli-developer-commands
+
+
+This document describes how to deploy the {product_name} Management Console
using on OpenShift.
+
+The SonataFlow Management Console is a web interface designed to manage and
monitor workflows in a production-ready environment. It allows users to
initiate workflows, trigger Cloud Events, and monitor their execution.
+
+.Prerequisites
+* Your
xref:use-cases/advanced-developer-use-cases/deployments/deploying-on-openshift.adoc[{product_name}
application] is deployed and ready to use.
+* link:{ocp_cli_url}[OpenShift CLI] is installed.
+* (Optional)
xref:security/orchestrating-third-party-services-with-oauth2.adoc[Keycloak
server] is installed in OpenShift.
+
+== Set up {ocp_name} and deploy your SonataFlow application on OpenShift
+
+The SonataFlow Management Console relies on the underlying services of the
SonataFlow application, including the Data Index service. The Data Index
provides data from workflow executions, enabling the Management Console to
display workflow information.
+
+Ensure that your Data Index service is deployed and accessible before
deploying the Management Console.
Review Comment:
Please add a link to the Data Index installation with the operator.
##########
serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/deployments/deploying-sonataflow-management-console-on-openshift.adoc:
##########
@@ -0,0 +1,149 @@
+= Deploying {product_name} Management Console on OpenShift
+:compat-mode!:
+// Metadata:
+:description: Deploying Management Console on OpenShift
+:keywords: kogito, workflow, quarkus, serverless, kn, oc, openshift, sonataflow
+:table-caption: Data Set
+// envs for common content
+:management_console: SonataFlow Management Console
+:registry: OpenShift's
+:command_line_tool: oc
+:command_line_tool_name: OpenShift CLI
+:ocp_name: OpenShift Container Platform
+:platform: OpenShift
+// links
+:ocp_cli_url:
https://docs.openshift.com/container-platform/4.12/cli_reference/openshift_cli/getting-started-cli.html#cli-about-cli_cli-developer-commands
+
+
+This document describes how to deploy the {product_name} Management Console
using on OpenShift.
+
+The SonataFlow Management Console is a web interface designed to manage and
monitor workflows in a production-ready environment. It allows users to
initiate workflows, trigger Cloud Events, and monitor their execution.
Review Comment:
```suggestion
The SonataFlow Management Console is a web interface designed to manage and
monitor workflows. It allows users to initiate workflows, trigger Cloud Events,
and monitor their execution.
```
We can't say production-ready still
##########
serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/deployments/deploying-sonataflow-management-console-on-openshift.adoc:
##########
@@ -0,0 +1,149 @@
+= Deploying {product_name} Management Console on OpenShift
+:compat-mode!:
+// Metadata:
+:description: Deploying Management Console on OpenShift
+:keywords: kogito, workflow, quarkus, serverless, kn, oc, openshift, sonataflow
+:table-caption: Data Set
+// envs for common content
+:management_console: SonataFlow Management Console
+:registry: OpenShift's
+:command_line_tool: oc
+:command_line_tool_name: OpenShift CLI
+:ocp_name: OpenShift Container Platform
+:platform: OpenShift
+// links
+:ocp_cli_url:
https://docs.openshift.com/container-platform/4.12/cli_reference/openshift_cli/getting-started-cli.html#cli-about-cli_cli-developer-commands
+
+
+This document describes how to deploy the {product_name} Management Console
using on OpenShift.
+
+The SonataFlow Management Console is a web interface designed to manage and
monitor workflows in a production-ready environment. It allows users to
initiate workflows, trigger Cloud Events, and monitor their execution.
+
+.Prerequisites
+* Your
xref:use-cases/advanced-developer-use-cases/deployments/deploying-on-openshift.adoc[{product_name}
application] is deployed and ready to use.
+* link:{ocp_cli_url}[OpenShift CLI] is installed.
+* (Optional)
xref:security/orchestrating-third-party-services-with-oauth2.adoc[Keycloak
server] is installed in OpenShift.
+
+== Set up {ocp_name} and deploy your SonataFlow application on OpenShift
+
+The SonataFlow Management Console relies on the underlying services of the
SonataFlow application, including the Data Index service. The Data Index
provides data from workflow executions, enabling the Management Console to
display workflow information.
+
+Ensure that your Data Index service is deployed and accessible before
deploying the Management Console.
+Instructions to set up {ocp_name} and deploy your SonataFlow application on
OpenShift can be found
xref:use-cases/advanced-developer-use-cases/deployments/deploying-on-openshift.adoc[here].
+
+== (Optional) Deploy Keycloak for production
+
+_If you already have Keycloak deployment or server available you can skip this
section._
+
+For production environments, deploy Keycloak to handle authentication or
choose your orwn OAuth2 server. You can refer to the SonataFlow Keycloak
documentation
xref:security/orchestrating-third-party-services-with-oauth2.adoc[here].
+
+== Deploy {management_console}
+
+Create the deployment for the SonataFlow Management Console by applying the
following YAML definition:
+
+.Example configuration in `osl-management-console-deployment.yaml`
+[source,yaml,subs="attributes+"]
+----
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+ name: osl-management-console
+spec:
+ replicas: 1
+ selector:
+ matchLabels:
+ app: osl-management-console
+ template:
+ metadata:
+ labels:
+ app: osl-management-console
+ spec:
+ containers:
+ - name: osl-management-console
+ image: {sonataflow_management_console_imagename}:latest
+ imagePullPolicy: Always
+ ports:
+ - containerPort: 8080
+ name: http
+ protocol: TCP
+ env:
+ - name: SONATAFLOW_MANAGEMENT_CONSOLE_KOGITO_ENV_MODE
+ value: DEV <1>
+ - name: SONATAFLOW_MANAGEMENT_CONSOLE_DATA_INDEX_ENDPOINT
+ value: DATA-INDEX-URL <2>
+----
+<1> (Optional) Environment mode: "PROD" or "DEV". PROD enables Keycloak
integration.
+<2> The URL to the Data Index Deployment created
xref:use-cases/advanced-developer-use-cases/deployments/deploying-on-openshift.adoc[here].
Review Comment:
Yes, we must mention it.
##########
serverlessworkflow/modules/ROOT/nav.adoc:
##########
@@ -107,6 +107,7 @@
****
xref:use-cases/advanced-developer-use-cases/deployments/deploying-on-minikube.adoc[Deploying
on Minikube]
****
xref:use-cases/advanced-developer-use-cases/deployments/deploying-on-kubernetes.adoc[Deploying
on Kubernetes]
****
xref:use-cases/advanced-developer-use-cases/deployments/deploying-on-openshift.adoc[Deploying
on OpenShift]
+****
xref:use-cases/advanced-developer-use-cases/deployments/deploying-sonataflow-management-console-on-openshift.adoc[Deploying
Management Console on OpenShift]
Review Comment:
Please, Cloud. Do not add under operator, thou.
##########
serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/deployments/deploying-sonataflow-management-console-on-openshift.adoc:
##########
@@ -0,0 +1,149 @@
+= Deploying {product_name} Management Console on OpenShift
+:compat-mode!:
+// Metadata:
+:description: Deploying Management Console on OpenShift
+:keywords: kogito, workflow, quarkus, serverless, kn, oc, openshift, sonataflow
+:table-caption: Data Set
+// envs for common content
+:management_console: SonataFlow Management Console
+:registry: OpenShift's
+:command_line_tool: oc
+:command_line_tool_name: OpenShift CLI
+:ocp_name: OpenShift Container Platform
+:platform: OpenShift
+// links
+:ocp_cli_url:
https://docs.openshift.com/container-platform/4.12/cli_reference/openshift_cli/getting-started-cli.html#cli-about-cli_cli-developer-commands
+
+
+This document describes how to deploy the {product_name} Management Console
using on OpenShift.
+
+The SonataFlow Management Console is a web interface designed to manage and
monitor workflows in a production-ready environment. It allows users to
initiate workflows, trigger Cloud Events, and monitor their execution.
+
+.Prerequisites
+* Your
xref:use-cases/advanced-developer-use-cases/deployments/deploying-on-openshift.adoc[{product_name}
application] is deployed and ready to use.
+* link:{ocp_cli_url}[OpenShift CLI] is installed.
+* (Optional)
xref:security/orchestrating-third-party-services-with-oauth2.adoc[Keycloak
server] is installed in OpenShift.
+
+== Set up {ocp_name} and deploy your SonataFlow application on OpenShift
+
+The SonataFlow Management Console relies on the underlying services of the
SonataFlow application, including the Data Index service. The Data Index
provides data from workflow executions, enabling the Management Console to
display workflow information.
+
+Ensure that your Data Index service is deployed and accessible before
deploying the Management Console.
+Instructions to set up {ocp_name} and deploy your SonataFlow application on
OpenShift can be found
xref:use-cases/advanced-developer-use-cases/deployments/deploying-on-openshift.adoc[here].
+
+== (Optional) Deploy Keycloak for production
+
+_If you already have Keycloak deployment or server available you can skip this
section._
+
+For production environments, deploy Keycloak to handle authentication or
choose your orwn OAuth2 server. You can refer to the SonataFlow Keycloak
documentation
xref:security/orchestrating-third-party-services-with-oauth2.adoc[here].
+
+== Deploy {management_console}
+
+Create the deployment for the SonataFlow Management Console by applying the
following YAML definition:
+
+.Example configuration in `osl-management-console-deployment.yaml`
+[source,yaml,subs="attributes+"]
+----
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+ name: osl-management-console
+spec:
+ replicas: 1
+ selector:
+ matchLabels:
+ app: osl-management-console
+ template:
+ metadata:
+ labels:
+ app: osl-management-console
+ spec:
+ containers:
+ - name: osl-management-console
+ image: {sonataflow_management_console_imagename}:latest
+ imagePullPolicy: Always
+ ports:
+ - containerPort: 8080
+ name: http
+ protocol: TCP
+ env:
+ - name: SONATAFLOW_MANAGEMENT_CONSOLE_KOGITO_ENV_MODE
+ value: DEV <1>
+ - name: SONATAFLOW_MANAGEMENT_CONSOLE_DATA_INDEX_ENDPOINT
+ value: DATA-INDEX-URL <2>
+----
+<1> (Optional) Environment mode: "PROD" or "DEV". PROD enables Keycloak
integration.
+<2> The URL to the Data Index Deployment created
xref:use-cases/advanced-developer-use-cases/deployments/deploying-on-openshift.adoc[here].
+
+.Apply {management_console} Deployment
+[source,shell]
+----
+oc apply -f osl-management-console-deployment.yaml
+----
+
+== Create the Service
+
+Once the deployment is created, expose it through a service. Create a service
definition by applying the following YAML:
+
+.Example configuration in `osl-management-console-service.yaml`
+[source,yaml]
+----
+apiVersion: v1
+kind: Service
+metadata:
+ name: osl-management-console-service
+spec:
+ selector:
+ app: osl-management-console
+ ports:
+ - name: http
+ protocol: TCP
+ port: 8080
+ targetPort: 8080
+----
+
+.Apply {management_console} Service
+[source,shell]
+----
+oc apply -f osl-management-console-service.yaml
Review Comment:
Please use `kubectl` instead of `oc`.
##########
serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/deployments/deploying-sonataflow-management-console-on-openshift.adoc:
##########
@@ -0,0 +1,149 @@
+= Deploying {product_name} Management Console on OpenShift
+:compat-mode!:
+// Metadata:
+:description: Deploying Management Console on OpenShift
+:keywords: kogito, workflow, quarkus, serverless, kn, oc, openshift, sonataflow
+:table-caption: Data Set
+// envs for common content
+:management_console: SonataFlow Management Console
+:registry: OpenShift's
+:command_line_tool: oc
+:command_line_tool_name: OpenShift CLI
+:ocp_name: OpenShift Container Platform
+:platform: OpenShift
+// links
+:ocp_cli_url:
https://docs.openshift.com/container-platform/4.12/cli_reference/openshift_cli/getting-started-cli.html#cli-about-cli_cli-developer-commands
+
+
+This document describes how to deploy the {product_name} Management Console
using on OpenShift.
+
+The SonataFlow Management Console is a web interface designed to manage and
monitor workflows in a production-ready environment. It allows users to
initiate workflows, trigger Cloud Events, and monitor their execution.
+
+.Prerequisites
+* Your
xref:use-cases/advanced-developer-use-cases/deployments/deploying-on-openshift.adoc[{product_name}
application] is deployed and ready to use.
+* link:{ocp_cli_url}[OpenShift CLI] is installed.
+* (Optional)
xref:security/orchestrating-third-party-services-with-oauth2.adoc[Keycloak
server] is installed in OpenShift.
+
+== Set up {ocp_name} and deploy your SonataFlow application on OpenShift
+
+The SonataFlow Management Console relies on the underlying services of the
SonataFlow application, including the Data Index service. The Data Index
provides data from workflow executions, enabling the Management Console to
display workflow information.
+
+Ensure that your Data Index service is deployed and accessible before
deploying the Management Console.
+Instructions to set up {ocp_name} and deploy your SonataFlow application on
OpenShift can be found
xref:use-cases/advanced-developer-use-cases/deployments/deploying-on-openshift.adoc[here].
+
+== (Optional) Deploy Keycloak for production
+
+_If you already have Keycloak deployment or server available you can skip this
section._
+
+For production environments, deploy Keycloak to handle authentication or
choose your orwn OAuth2 server. You can refer to the SonataFlow Keycloak
documentation
xref:security/orchestrating-third-party-services-with-oauth2.adoc[here].
+
+== Deploy {management_console}
+
+Create the deployment for the SonataFlow Management Console by applying the
following YAML definition:
+
+.Example configuration in `osl-management-console-deployment.yaml`
+[source,yaml,subs="attributes+"]
+----
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+ name: osl-management-console
+spec:
+ replicas: 1
+ selector:
+ matchLabels:
+ app: osl-management-console
+ template:
+ metadata:
+ labels:
+ app: osl-management-console
+ spec:
+ containers:
+ - name: osl-management-console
+ image: {sonataflow_management_console_imagename}:latest
+ imagePullPolicy: Always
+ ports:
+ - containerPort: 8080
+ name: http
+ protocol: TCP
+ env:
+ - name: SONATAFLOW_MANAGEMENT_CONSOLE_KOGITO_ENV_MODE
+ value: DEV <1>
+ - name: SONATAFLOW_MANAGEMENT_CONSOLE_DATA_INDEX_ENDPOINT
+ value: DATA-INDEX-URL <2>
+----
+<1> (Optional) Environment mode: "PROD" or "DEV". PROD enables Keycloak
integration.
+<2> The URL to the Data Index Deployment created
xref:use-cases/advanced-developer-use-cases/deployments/deploying-on-openshift.adoc[here].
+
+.Apply {management_console} Deployment
+[source,shell]
+----
+oc apply -f osl-management-console-deployment.yaml
+----
+
+== Create the Service
+
+Once the deployment is created, expose it through a service. Create a service
definition by applying the following YAML:
+
+.Example configuration in `osl-management-console-service.yaml`
+[source,yaml]
+----
+apiVersion: v1
+kind: Service
+metadata:
+ name: osl-management-console-service
+spec:
+ selector:
+ app: osl-management-console
+ ports:
+ - name: http
+ protocol: TCP
+ port: 8080
+ targetPort: 8080
+----
+
+.Apply {management_console} Service
+[source,shell]
+----
+oc apply -f osl-management-console-service.yaml
+----
+This will create a service exposing the SonataFlow Management Console.
+
+== Create the Route
Review Comment:
Applies to OpenShft Only
##########
serverlessworkflow/modules/ROOT/pages/use-cases/advanced-developer-use-cases/deployments/deploying-sonataflow-management-console-on-openshift.adoc:
##########
@@ -0,0 +1,149 @@
+= Deploying {product_name} Management Console on OpenShift
+:compat-mode!:
+// Metadata:
+:description: Deploying Management Console on OpenShift
Review Comment:
Can we make `Deploying Management Console on Kubernetes`?
We replaced `oc` with `kubectl`, and in the routes section, we added a note
that's only on OCP. For Kubernetes, users can create an Ingress:
https://kubernetes.io/docs/concepts/services-networking/ingress/
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
