Skip to content

Commit

Permalink
Fixes comment: #674 (comment)
Browse files Browse the repository at this point in the history
  • Loading branch information
fantonangeli committed Oct 16, 2024
1 parent 13c2afd commit cf06430
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 10 deletions.
2 changes: 1 addition & 1 deletion serverlessworkflow/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
// * Java Workflow Library TODO: https://issues.redhat.com/browse/KOGITO-9454
* xref:cloud/index.adoc[Cloud]
** xref:cloud/custom-ingress-authz.adoc[Securing Workflows]
** xref:cloud/deploying-sonataflow-management-console-on-openshift.adoc[Deploying Management Console on OpenShift]
** xref:cloud/deploying-sonataflow-management-console-on-kubernetes.adoc[Deploying Management Console on Kubernetes]
** Operator
*** xref:cloud/operator/install-serverless-operator.adoc[Installation]
*** xref:cloud/operator/global-configuration.adoc[Admin Configuration]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Deploying {product_name} Management Console on OpenShift
= Deploying {product_name} Management Console on Kubernetes
:compat-mode!:
// Metadata:
:description: Deploying Management Console on OpenShift
:description: Deploying Management Console on Kubernetes
:keywords: kogito, workflow, quarkus, serverless, kn, oc, openshift, sonataflow
:table-caption: Data Set
// envs for common content
Expand All @@ -11,20 +11,18 @@
: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.
This document describes how to deploy the {product_name} Management Console using on Kubernetes.

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.

.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.
* Your xref:cloud/operator/build-and-deploy-workflows.adoc[{product_name} application] is deployed and ready to use.
* A Kubernetes or OpenShift cluster with admin privileges and kubectl installed.
* (Optional) xref:security/orchestrating-third-party-services-with-oauth2.adoc[Keycloak server] is installed.
== Set up {ocp_name} and deploy your SonataFlow application on OpenShift
== Set up {ocp_name} and deploy your SonataFlow application

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.

Expand Down Expand Up @@ -140,6 +138,13 @@ spec:
kubeclt apply -f osl-management-console-route.yaml
----

== Create the Ingress (Kubernetes only)

For Kubernetes you can expose the SonataFlow Management Console using an Ingress.

To create an Ingress, refer to the official Kubernetes documentation here: link:https://kubernetes.io/docs/concepts/services-networking/ingress/[Kubernetes Ingress Guide].


== Optional: Keycloak authentication for Production

In a production environment, you can integrate the SonataFlow Management Console with a Keycloak server for authentication or any OAuth2 server.
Expand Down

0 comments on commit cf06430

Please sign in to comment.