Skip to content

Commit

Permalink
Remove Kogito Operator sections from Kogito Docs (#4535)
Browse files Browse the repository at this point in the history
  • Loading branch information
ricardozanini authored Feb 16, 2024
1 parent 0a3679a commit b7c23e8
Show file tree
Hide file tree
Showing 17 changed files with 2 additions and 3,203 deletions.
1 change: 0 additions & 1 deletion _artifacts/document-attributes-kogito-comm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@

:URL_RELEASE_NOTES: {URL_BASE}
:URL_CREATING_RUNNING: {URL_BASE}
:URL_DEPLOYING_ON_OPENSHIFT: {URL_BASE}
:URL_DECISION_SERVICES: {URL_BASE}
:URL_PROCESS_SERVICES: {URL_BASE}
:URL_CONFIGURING_KOGITO: {URL_BASE}
Expand Down
2 changes: 0 additions & 2 deletions _artifacts/document-attributes-kogito-ent.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
// URLs for titles for post Dev Preview
:URL_RELEASE_NOTES: {URL_BASE}/release_notes_for_{PRODUCT_INIT}_{ENTERPRISE_VERSION}
:URL_CREATING_RUNNING: {URL_BASE}/creating_and_running_your_first_{PRODUCT_INIT}_services
:URL_DEPLOYING_ON_OPENSHIFT: {URL_BASE}/deploying_{PRODUCT_INIT}_services_on_{URL_COMPONENT_OPENSHIFT}
:URL_DECISION_SERVICES: {URL_BASE}/developing_decision_services_with_{PRODUCT_INIT}
:URL_PROCESS_SERVICES: {URL_BASE}/developing_process_services_with_{PRODUCT_INIT}
:URL_CONFIGURING_KOGITO: {URL_BASE}/configuring_{PRODUCT_INIT}_supporting_services_and_runtime_capabilities
Expand All @@ -35,7 +34,6 @@
// URLs for titles for Dev Preview (FTP)
:URL_RELEASE_NOTES: {URL_BASE}/Kogito-0.12-Release_notes_for_Kogito_0.12-en-US.pdf
:URL_CREATING_RUNNING: {URL_BASE}/Kogito-0.12-Creating_and_running_your_first_Kogito_services-en-US.pdf
:URL_DEPLOYING_ON_OPENSHIFT: {URL_BASE}/Kogito-0.12-Deploying_Kogito_services_on_Red_Hat_OpenShift_Container_Platform-en-US.pdf
:URL_DECISION_SERVICES: {URL_BASE}/Kogito-0.12-Developing_decision_services_with_Kogito-en-US.pdf
:URL_PROCESS_SERVICES: {URL_BASE}/Kogito-0.12-Developing_process_services_with_Kogito-en-US.pdf
:URL_CONFIGURING_KOGITO: {URL_BASE}/Kogito-0.12-Configuring_Kogito_supporting_services_and_runtime_capabilities-en-US.pdf
Expand Down
1 change: 0 additions & 1 deletion _artifacts/document-attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,6 @@ endif::[]
// Title names, containing assemblies (several are currently single-assembly titles, such as release notes and creating-running, and thus function as both assembly and title for now)
:RELEASE_NOTES: Release notes for {PRODUCT} {ENTERPRISE_VERSION}
:CREATING_RUNNING: Creating and running your first {PRODUCT} services
:DEPLOYING_ON_OPENSHIFT: Deploying {PRODUCT} services on {OPENSHIFT}
:DECISION_SERVICES: Developing decision services with {PRODUCT}
:PROCESS_SERVICES: Developing process services with {PRODUCT}
:CONFIGURING_KOGITO: Configuring {PRODUCT} supporting services and runtime capabilities
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1738,7 +1738,7 @@ https://knative.dev/docs/eventing/[Knative Eventing] is a serverless platform th

{PRODUCT} provides the https://github.com/apache/incubator-kie-kogito-runtimes/tree/main/addons/common/knative/eventing[Knative Eventing add-on] that enables you to use Knative Eventing with {PRODUCT} services that consume or publish messages within a Business Process Model and Notation (BPMN) process model, Serverless Workflow, or decisions. {PRODUCT} runtime events for messages, processes, tasks, and other application activities are published in https://cloudevents.io/[CloudEvents] format so that they can be consumed efficiently by other entities, such as the Knative Eventing system.

NOTE: Knative Eventing is currently supported for {PRODUCT} services on Quarkus only. The https://github.com/apache/incubator-kie-kogito-operator/#kogito-operator-tested-integrations[{PRODUCT} Operator supports Knative Eventing 0.20] or later.
NOTE: Knative Eventing is currently supported for {PRODUCT} services on Quarkus only.

For example, the following `handle-travelers.bpmn2` process uses messaging start and end events to communicate with travelers:

Expand Down Expand Up @@ -1810,7 +1810,7 @@ image::kogito/bpmn/kogito-knative-deployment-architecture.png[{PRODUCT} service
[role="_abstract"]
You can enable https://knative.dev/docs/eventing/[Knative Eventing] support for {PRODUCT} services that consume or publish messages within a Business Process Model and Notation (BPMN) process model or Serverless Workflow. When you enable Knative Eventing for a {PRODUCT} project, event consumers and producers are generated from message start and end nodes in BPMN processes at build time. You can use these event consumers and producers as part of your {PRODUCT} service deployment in a Knative Eventing environment on Kubernetes or OpenShift clusters.

NOTE: Knative Eventing is currently supported for {PRODUCT} services on Quarkus only. The https://github.com/apache/incubator-kie-kogito-operator/#kogito-operator-tested-integrations[{PRODUCT} Operator supports Knative Eventing 0.20] or later.
NOTE: Knative Eventing is currently supported for {PRODUCT} services on Quarkus only.

.Prerequisites
* You have installed and deployed Knative Eventing 0.20.0 or later on a Kubernetes or an OpenShift cluster. For information about Knative Eventing on OpenShift, see https://docs.openshift.com/container-platform/4.5/serverless/installing_serverless/installing-knative-eventing.html[Installing Knative Eventing] in the OpenShift documentation.
Expand Down Expand Up @@ -1994,8 +1994,6 @@ For an example {PRODUCT} service with Knative Eventing enabled, see the https://

[role="_additional-resources"]
.Additional resources
* {URL_DEPLOYING_ON_OPENSHIFT}#chap-kogito-deploying-on-openshift[_{DEPLOYING_ON_OPENSHIFT}_]
* {URL_DEPLOYING_ON_OPENSHIFT}#proc-kogito-deploying-on-kubernetes_kogito-deploying-on-openshift[_{DEPLOYING_ON_OPENSHIFT}_]
* {URL_CREATING_RUNNING}#ref-kogito-add-ons_kogito-creating-running[_{CREATING_RUNNING}_]

[id="con-task-lifecycle_{context}"]
Expand Down Expand Up @@ -3772,89 +3770,6 @@ $ java \
-jar management-console-__VERSION__-runner.jar
----

In an OpenShift environment, you can use the {PRODUCT} command-line interface (CLI) or the OpenShift web console to add the Management Console to your {PRODUCT} infrastructure:

.Adding the Management Console to your OpenShift infrastructure using the {PRODUCT} CLI

The Management Console is requiring a Keycloak instance for the authentication. If you need to setup a Keycloak instance in your OpenShift cluster you can use to https://www.keycloak.org/getting-started/getting-started-operator-openshift[Keycloak Operator].

After this you have to configure on your Keycloak realm for the Management Console. You can refer to https://raw.githubusercontent.com/kiegroup/kogito-examples/398b48244cffcec7f93bf029974ddeae025640a5/kogito-quarkus-examples/process-usertasks-quarkus-with-console/docker-compose/keycloak/kogito-realm.json[this example] if you don't know how to do it.

Then you need to:

- Create a KogitoInfra resource for the Keycloak configuration based on:

[source,subs="+quotes"]
----
apiVersion: app.kiegroup.org/v1beta1
kind: KogitoInfra
metadata:
name: kogito-keycloak-infra
spec:
resource:
envs:
- name: -Dkogito.consoles.keycloak.config.realm
value: <keycloak_realm>
- name: -Dkogito.consoles.keycloak.config.url
value: <keycloak_url>
- name: -Dkogito.consoles.keycloak.config.client-id
value: <keyloak_console_client_id>
- name: -Dkogito.consoles.keycloak.config.health-check-url
value: <keycloak_health_check_url>
- name: -Dkogito.consoles.keycloak.config.disable-health-check
value: <keyloak_disable_health_check_flag>
- name: -Dkogito.consoles.keycloak.config.update-token-validity
value: <keycloak_update_token_validity>
- name: -Dkogito.svg.folder.path
value: /home/kogito/data/svg
----

Please remember to replace the placeholders in the above example (i.e. __keycloak_realm__, __keycloak_url__, __keyloak_console_client_id__, __keycloak_health_check_url__, __keyloak_disable_health_check_flag__ and __keycloak_update_token_validity__) with the right values based on your Keycloak setup (https://docs.jboss.org/kogito/release/latest/html_single/#proc-task-console-security_kogito-developing-process-services[here] you can find the meaning of each Keycloak property and its default value!).

[source,subs="+quotes"]
----
$ oc apply -f kogito-keycloak-infra.yaml -p __PROJECT_NAME__
----

- Install the Management Console KogitoSupportingService with this command with the Kogito CLI:

[source,subs="+quotes"]
----
$ kogito install mgmt-console -p __PROJECT_NAME__ --infra kogito-keycloak-infra
----

or if you don't want to use the Kogito CLI you can use this resource:

[source,subs="+quotes"]
----
apiVersion: app.kiegroup.org/v1beta1
kind: KogitoSupportingService
metadata:
name: management-console
spec:
serviceType: MgmtConsole
replicas: 1
infra:
- kogito-keycloak-infra
----

that you have to apply using the command:

[source,subs="+quotes"]
----
$ oc apply -f management-console-supportingservice.yaml -p __PROJECT_NAME__
----

.{PRODUCT} Management Console instance on OpenShift web console
image::kogito/openshift/kogito-management-console-instance.png[Image of Kogito Management Console instance on OpenShift]
--
. In a web browser, navigate to `http://localhost:8280` to open the Management Console. If you modified the configured Management Console port, use the modified location.
+
--
On OpenShift, navigate to the route URL for the Management Console instance.
--

[id="proc-management-console-structure_{context}"]
=== {PRODUCT} Management Console application

Expand Down Expand Up @@ -4155,22 +4070,6 @@ $ java \

NOTE: For more information about task lifecycles, see xref:con-task-lifecycle_kogito-developing-process-services[].

In an OpenShift environment, you can use the {PRODUCT} command-line interface (CLI) or the OpenShift web console to add the Task Console to your {PRODUCT} infrastructure:

.Adding the Task Console to your OpenShift infrastructure using the {PRODUCT} CLI
[source,subs="+quotes"]
----
$ kogito install task-console -p __PROJECT_NAME__
----

.{PRODUCT} Task Console instance on OpenShift web console
image::kogito/openshift/kogito-task-console-instance.png[Image of Kogito Task Console instance on OpenShift]
--
. In a web browser, navigate to `http://localhost:8280` to open the Task Console. If you modified the configured Task Console port, use the modified location.
+
--
On OpenShift, navigate to the route URL for the Task Console instance.

.{PRODUCT} Task Console
image::kogito/bpmn/kogito-task-console.png[Image of Kogito Task Console]

Expand Down Expand Up @@ -4360,7 +4259,6 @@ ifdef::KOGITO-ENT[]
[role="_additional-resources"]
== Additional resources
* {URL_CREATING_RUNNING}[_{CREATING_RUNNING}_]
* {URL_DEPLOYING_ON_OPENSHIFT}[_{DEPLOYING_ON_OPENSHIFT}_]
* {URL_DECISION_SERVICES}[_{DECISION_SERVICES}_]
* {URL_CONFIGURING_KOGITO}[_{CONFIGURING_KOGITO}_]
endif::[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -541,8 +541,6 @@ kogito.addon.cloudevents.kafka.kogito_outgoing_stream=processedtravellers
+
--

NOTE: As an alternative to enabling Kafka messaging explicitly in {PRODUCT} services, you can use the {PRODUCT} Operator to install the Kafka infrastructure and enable messaging for the service during deployment on OpenShift. For more information about enabling Kafka messaging with the {PRODUCT} Operator, see {URL_DEPLOYING_ON_OPENSHIFT}#con-kogito-operator-with-kafka_kogito-deploying-on-openshift[_{DEPLOYING_ON_OPENSHIFT}_].

For example {PRODUCT} services with Kafka messaging, see the following example applications in GitHub:

* https://github.com/apache/incubator-kie-kogito-examples/tree/stable/kogito-quarkus-examples/process-kafka-quickstart-quarkus[`process-kafka-quickstart-quarkus`]: Example on Quarkus
Expand Down Expand Up @@ -1475,8 +1473,6 @@ infinispan.remote.server-list=127.0.0.1:11222
----
--

NOTE: As an alternative to enabling Infinispan persistence explicitly in {PRODUCT} services, you can use the {PRODUCT} Operator to install the Infinispan infrastructure and enable persistence for the service during deployment on OpenShift. For more information about enabling Infinispan persistence with the {PRODUCT} Operator, see {URL_DEPLOYING_ON_OPENSHIFT}#con-kogito-operator-with-infinispan_kogito-deploying-on-openshift[_{DEPLOYING_ON_OPENSHIFT}_].

For example {PRODUCT} services with Infinispan persistence, see the following example applications in GitHub:

* https://github.com/apache/incubator-kie-kogito-examples/tree/stable/kogito-quarkus-examples/process-infinispan-persistence-quarkus[`process-infinispan-persistence-quarkus`]: Example on Quarkus
Expand Down Expand Up @@ -2032,7 +2028,6 @@ For available query types, click *Docs* in the upper-right corner of the GraphiQ
For more information about supported queries with the Data Index Service, see xref:ref-data-index-service-queries_kogito-configuring[].
NOTE: As an alternative to enabling the Data Index Service explicitly for {PRODUCT} services, you can use the {PRODUCT} Operator to install the Data Index Service custom resource for the service deployment on OpenShift. For more information about installing the Data Index Service with the {PRODUCT} Operator, see {URL_DEPLOYING_ON_OPENSHIFT}#con-kogito-operator-with-data-index-service_kogito-deploying-on-openshift[_{DEPLOYING_ON_OPENSHIFT}_].
--
[id="ref-data-index-service-queries_{context}"]
Expand Down Expand Up @@ -3386,8 +3381,6 @@ If the default REST clients used by the Jobs Service add-on do not meet your nee
In both cases, you produce an instance of the client to enable detailed setup of the client.
--
NOTE: As an alternative to enabling the Jobs Service explicitly for {PRODUCT} services, you can use the {PRODUCT} Operator to install the Jobs Service custom resource for the service deployment on OpenShift. For more information about installing the Jobs Service with the {PRODUCT} Operator, see {URL_DEPLOYING_ON_OPENSHIFT}#con-kogito-operator-with-jobs-service_kogito-deploying-on-openshift[_{DEPLOYING_ON_OPENSHIFT}_].
[id="proc-jobs-service-persistence_{context}"]
=== Persistence in the {PRODUCT} Jobs Service
Expand Down Expand Up @@ -3595,8 +3588,6 @@ The Trusty Service storage is provided by https://infinispan.org/[Infinispan]. C
After the tracing event is analyzed and stored, the Trusty Service exposes the data with a dedicated API.
For information about using the {PRODUCT} Trusty Service and Explainability Service with the {PRODUCT} Operator, see {URL_DEPLOYING_ON_OPENSHIFT}#con-kogito-operator-with-trusty-service_kogito-deploying-on-openshift[_{DEPLOYING_ON_OPENSHIFT}_].
For example {PRODUCT} services that use the Trusty Service and Explainability Service, see the following example applications in GitHub:
* https://github.com/apache/incubator-kie-kogito-examples/tree/stable/dmn-tracing-quarkus[`dmn-tracing-quarkus`]: A DMN decision service on Quarkus that uses the `kogito-addons-quarkus-tracing-decision` add-on to generate tracing events that the {PRODUCT} Trusty Service and Explainability Service can consume and expose.
Expand Down Expand Up @@ -3668,7 +3659,6 @@ ifdef::KOGITO-ENT[]
[role="_additional-resources"]
== Additional resources
* {URL_CREATING_RUNNING}[_{CREATING_RUNNING}_]
* {URL_DEPLOYING_ON_OPENSHIFT}[_{DEPLOYING_ON_OPENSHIFT}_]
* {URL_DECISION_SERVICES}[_{DECISION_SERVICES}_]
* {URL_PROCESS_SERVICES}[_{PROCESS_SERVICES}_]
endif::[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,6 @@ Another focus of {PRODUCT} is optimal developer experience. You can use much or
.Building a {PRODUCT} process service in VSCode
image::kogito/creating-running/kogito-run-quarkus-devmode-demo.gif[Demo of {PRODUCT} BPMN2 extension in VSCode]

To deploy your services into the cloud, you can use the {URL_DEPLOYING_ON_OPENSHIFT}#con-kogito-operator-and-cli_kogito-deploying-on-openshift[{PRODUCT} Operator], which guides you through every step. The {PRODUCT} Operator is based on the https://sdk.operatorframework.io/[Operator SDK] and automates many of the deployment steps for you. For example, when you give the operator a link to the Git repository that contains your application, the operator can automatically configure the components required to build your project from source and deploy the resulting services. {PRODUCT} also offers a command-line interface (CLI) to simplify some of these deployment tasks.
// end::con-kogito-automation[]

// tag::con-kogito-quarkus-springboot[]
Expand Down Expand Up @@ -3527,12 +3526,6 @@ A user interface for monitoring and investigating Decision Model and Notation (D
.Additional resources
* {URL_DECISION_SERVICES}#con-audit-console_kogito-dmn-models[_{PRODUCT} Audit Investigation Console_]

{PRODUCT} CLI::
A command-line interface (CLI) that enables you to interact with the {PRODUCT} Operator for deployment tasks. The {PRODUCT} CLI also enables you to deploy {PRODUCT} services from source instead of relying on custom resources and YAML files.
+
[role="_additional-resources"]
.Additional resources
* {URL_DEPLOYING_ON_OPENSHIFT}#proc-kogito-deploying-on-ocp-kogito-cli_kogito-deploying-on-openshift[_Deploying {PRODUCT} on {OPENSHIFT} using the {PRODUCT} CLI_]

////
//@comment: Excluding for now due to current build issues with the extension and we aren't using it at this point. (Stetson, 2 Apr 2020)
Expand Down Expand Up @@ -3571,13 +3564,6 @@ A user interface for viewing the state of all available {PRODUCT} services and m
.Additional resources
* {URL_PROCESS_SERVICES}#con-management-console_kogito-developing-process-services[_{PRODUCT} Management Console_]

{PRODUCT} Operator::
An operator that deploys {PRODUCT} services and manages the required {PRODUCT} infrastructure services. The {PRODUCT} Operator is based on the https://sdk.operatorframework.io/[Operator SDK] and automates many of the deployment steps for you.
+
[role="_additional-resources"]
.Additional resources
* {URL_DEPLOYING_ON_OPENSHIFT}#con-kogito-on-ocp_kogito-deploying-on-openshift[_{PRODUCT} on {OPENSHIFT}_]

{PRODUCT} runtime event::
A record of a significant change of state in the application domain at a point in time. {PRODUCT} emits runtime events as a result of successfully executed requests, or _units of work_, in a process instance or task instance in a process. {PRODUCT} can use these events to notify third parties about changes to the BPMN process instance and its data.
+
Expand Down Expand Up @@ -3683,7 +3669,6 @@ endif::[]
ifdef::KOGITO-ENT[]
[role="_additional-resources"]
== Additional resources
* {URL_DEPLOYING_ON_OPENSHIFT}[_{DEPLOYING_ON_OPENSHIFT}_]
* {URL_DECISION_SERVICES}[_{DECISION_SERVICES}_]
* {URL_PROCESS_SERVICES}[_{PROCESS_SERVICES}_]
* {URL_CONFIGURING_KOGITO}[_{CONFIGURING_KOGITO}_]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2771,7 +2771,6 @@ ifdef::KOGITO-ENT[]
[role="_additional-resources"]
== Additional resources
* {URL_CREATING_RUNNING}[_{CREATING_RUNNING}_]
* {URL_DEPLOYING_ON_OPENSHIFT}[_{DEPLOYING_ON_OPENSHIFT}_]
* {URL_PROCESS_SERVICES}[_{PROCESS_SERVICES}_]
* {URL_CONFIGURING_KOGITO}[_{CONFIGURING_KOGITO}_]
endif::[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -428,7 +428,6 @@ ifdef::KOGITO-ENT[]
[role="_additional-resources"]
== Additional resources
* {URL_CREATING_RUNNING}[_{CREATING_RUNNING}_]
* {URL_DEPLOYING_ON_OPENSHIFT}[_{DEPLOYING_ON_OPENSHIFT}_]
* {URL_PROCESS_SERVICES}[_{PROCESS_SERVICES}_]
* {URL_CONFIGURING_KOGITO}[_{CONFIGURING_KOGITO}_]
endif::[]
Expand Down
Loading

0 comments on commit b7c23e8

Please sign in to comment.