Skip to content

Commit

Permalink
Merge branch '9.1.1' of https://github.com/IBM/bamoe-docs into 9.1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
justlmills committed Dec 6, 2024
2 parents 13bf229 + 5db9e29 commit c3d2adb
Show file tree
Hide file tree
Showing 31 changed files with 132 additions and 145 deletions.
13 changes: 5 additions & 8 deletions editing/authoring-scesim.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Authoring Scenario Simulations
= Authoring test scenarios
include::../partials/attributes.adoc[]

As a developer of business decisions, you can use test scenarios in {PRODUCT} to test the decision logic in your {PRODUCT} decision services. Test scenarios enable you to ensure that your {PRODUCT} decision services are functioning properly and as expected as you develop your {PRODUCT} project.
Expand Down Expand Up @@ -29,15 +29,12 @@ NOTE: All the DMN-based scesim assets created prior to version {VERSION} will re

NOTE: All the DMN-based scesim assets are compatible only with DMN 1.2 models. Due to this, use DMN Classic Editor instead of DMN New Editor to create DMN models, that will be tested using `.scesim` file.

=== Prerequisites
* {PRODUCT_SHORT} {VERSION_910}
* {DEV_TOOLS} {VERSION_910}
* VSCode (1.66.0+)
* Optional: Language Support for Java(TM) by Red Hat (1.32+) VSCode extension

=== Project Setup

To run this scenario, you must have set up {PRODUCT_SHORT} and Developer Tools for VS Code. See xref:../installation/installation.adoc[Installing]. Optionally, you can use Language Support for Java(TM).

==== Cloning the Example Project
If you are a new {PRODUCT_SHORT} user and you don't have any project to set up yet, or you prefer having an out-of-the-box project to deal with, you can use the previously mentioned example in the `incubator-kie-kogito-examples` repository.
If you are a new {PRODUCT_SHORT} user and you do not have any project to set up yet, or you prefer having an out-of-the-box project to deal with, you can use the previously mentioned example in the `incubator-kie-kogito-examples` repository.

1. Clone the `incubator-kie-kogito-examples` repository.
2. Open VSCode and navigate to `incubator-kie-kogito-examples/kogito-quarkus-examples/dmn-quarkus-example`.
Expand Down
4 changes: 2 additions & 2 deletions editing/creating-new-projects.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ image::tools/newProject/canvas-dmn-single-file-workspace-overview.png[Editor pag
. *Kebab menu* → Additional operations.
From here you can create a new commit in your project or delete your file.
. *“Problems” tab* → Lets you see what's wrong with your file, both statically and when running it.
More on running Decisions in the xref:../tools/running-decisions.adoc[Running Decisions] section.
More on running Decisions in the xref:../editing/running-decisions.adoc[Running Decisions] section.

From here, you can make this currently one-file project into a more complex one.
Let's do that by creating another file using the “New file menu”. You'll see that there are new controls available on the screen.
Expand All @@ -67,6 +67,6 @@ image::tools/newProject/canvas-multi-file-workspace-overview.png['Editor page on
More on all of that at xref:../tools/working-with-git.adoc[Working with Git]. You can click this element to see all the changes you made to your repository since your last Commit and revert them all, if you want.
To revert changes to individual files, use the “File switcher”.

Now that you're familiar with the elements of {CANVAS}, you can jump to xref:../tools/authoring-decisions.adoc[Authoring Decisions] or xref:../tools/authoring-workflows.adoc[Authoring Workflows] to start authoring Decisions and Workflows to create a Business Automation project. xref:../tools/applying-accelerators.adoc[Applying Accelerators] can also be interesting if you're starting a new project directly from BAMOE Canvas.
Now that you're familiar with the elements of {CANVAS}, you can jump to xref:../editing/authoring-decisions.adoc[Authoring Decisions] or xref:../editing/authoring-workflows.adoc[Authoring Workflows] to start authoring Decisions and Workflows to create a Business Automation project. xref:../tools/applying-accelerators.adoc[Applying Accelerators] can also be interesting if you're starting a new project directly from BAMOE Canvas.


8 changes: 4 additions & 4 deletions getting-started/orchestrating.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ include::../partials/attributes.adoc[]

The following example is a workflow scenario in {PRODUCT} that demonstrates how you can use process definitions to orchestrate your {PRODUCT} decision services. The example of a traffic violations project describes how to use decisions within the processes and how to integrate decisions in an embedded way using the business rule tasks, which must be deployed with a process in the same application.

NOTE: {PRODUCT} fully supports Straight-Through-Processing (STP) where processes are integrating decisions without any safe points and without persistence. For more {PRODUCT} examples that use process capabilities, see the references below. Stateful processing is provided as a technology preview (xref:../workflow/overview.adoc[Stateful processs overview]) in the {VERSION_910}.
NOTE: {PRODUCT} fully supports Straight-Through-Processing (STP) where processes are integrating decisions without any safe points and without persistence. For more {PRODUCT} examples that use process capabilities, see the references below. Stateful processing is provided as a technology preview (xref:../workflow/overview.adoc[Stateful processs overview]) in the {VERSION_910} and {VERSION_911}.

The following diagram illustrates how decisions are integrated with processes:

Expand All @@ -18,7 +18,7 @@ The tasks must be deployed with a process in the same application.

In Kogito, the decisions can be expressed in different domains or assets, such as DMN and DRL. All the assets, including BPMN, DMN, and DRL must be placed in the resources folder.

When the example application is running, there also must be different running processes, such as a process using a business rule task, containing the URL as `http://localhost:8080/traffic`.
When the example application is running, there also must be different running processes, such as a process using a business rule task, containing the URL as `+http://localhost:8080/traffic+`.

== Traffic violations example for embedded method

Expand Down Expand Up @@ -162,7 +162,7 @@ image::traffic-violation-dmn-businessrule.png[Image of traffic violation task (D
The properties that are required to be set for the DMN service task include `Rule Language`, which must be set as `DMN`. Also, you must set the values for `Namespace` and DMN Model Name` properties as defined in the DMN model, such as `TrafficViolation.dmn`. For example, you can set the following values:

- Rule Language: `DMN`
- Namespace: `https://github.com/kiegroup/drools/kie-dmn/_A4BCA8B8-CF08-433F-93B2-A2598F19ECFF`
- Namespace: `+https://github.com/kiegroup/drools/kie-dmn/_A4BCA8B8-CF08-433F-93B2-A2598F19ECFF+`
- DMN Model Name: `Traffic Violation`

The input for the traffic violation task includes `Driver` and `Violation` variables, and the output includes `Suspended` and `Fine` in the Data Assignment property.
Expand All @@ -182,7 +182,7 @@ You can start the Quarkus server with the following command in the project root:
mvn quarkus:dev
----

Then you can check the application Swagger UI at `http://localhost:8080/q/swagger-ui/#/`
Then you can check the application Swagger UI at `+http://localhost:8080/q/swagger-ui/#/+`

=== Other examples

Expand Down
6 changes: 3 additions & 3 deletions installation/build-maven-repo.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Build and run your own BAMOE v9.1.x Maven Repository image on OpenShift
= Build and run your own BAMOE version 9.1.x Maven Repository image on OpenShift
include::../partials/attributes.adoc[]

If you cannot run the container with elevated privileges, follow these instructions to build a version that does not require the elevated privileges.
Expand Down Expand Up @@ -76,7 +76,7 @@ spec:
output:
to:
kind: ImageStreamTag
name: bamoe-maven-repository-image:{IMAGE_VERSION_910}
name: bamoe-maven-repository-image:{IMAGE_VERSION}
strategy:
dockerStrategy:
dockerfilePath: Dockerfile
Expand All @@ -103,7 +103,7 @@ oc start-build --from-dir=. bamoe-maven-repository-image --follow
+
[source,shell,subs="attributes+"]
----
oc new-app --image-stream bamoe-maven-repository-image:{IMAGE_VERSION_910} --name bamoe-maven-repo
oc new-app --image-stream bamoe-maven-repository-image:{IMAGE_VERSION} --name bamoe-maven-repo
oc create route edge --service=bamoe-maven-repo
----

Expand Down
18 changes: 9 additions & 9 deletions installation/canvas.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ It depends on two backend applications to provide full functionality:
{CANVAS} and its two backend applications are available as container images.
These images are published to Quay.io and can be used to run containers locally or with any cloud provider.

* Canvas → https://quay.io/repository/bamoe/canvas[https://quay.io/repository/bamoe/canvas] @ {IMAGE_VERSION_910}
* Extended Services → https://quay.io/repository/bamoe/extended-services[https://quay.io/repository/bamoe/extended-services] @ {IMAGE_VERSION_910}
* CORS Proxy → https://quay.io/repository/bamoe/cors-proxy[https://quay.io/repository/bamoe/cors-proxy] @ {IMAGE_VERSION_910}
* Canvas → https://quay.io/repository/bamoe/canvas[https://quay.io/repository/bamoe/canvas] @ {IMAGE_VERSION}
* Extended Services → https://quay.io/repository/bamoe/extended-services[https://quay.io/repository/bamoe/extended-services] @ {IMAGE_VERSION}
* CORS Proxy → https://quay.io/repository/bamoe/cors-proxy[https://quay.io/repository/bamoe/cors-proxy] @ {IMAGE_VERSION}
NOTE: All three image versions must be the same for deployment to work.

Expand All @@ -38,7 +38,7 @@ export APP_NAME_BAMOE_CANVAS=bamoe-canvas
+
[source,shell,subs="attributes+"]
----
oc new-app quay.io/bamoe/extended-services:{IMAGE_VERSION_910} --name=$APP_NAME_EXTENDED_SERVICES
oc new-app quay.io/bamoe/extended-services:{IMAGE_VERSION} --name=$APP_NAME_EXTENDED_SERVICES
oc create route edge --service=$APP_NAME_EXTENDED_SERVICES
oc label services/$APP_NAME_EXTENDED_SERVICES app.kubernetes.io/part-of=$APP_PART_OF
oc label routes/$APP_NAME_EXTENDED_SERVICES app.kubernetes.io/part-of=$APP_PART_OF
Expand All @@ -49,7 +49,7 @@ oc label deployments/$APP_NAME_EXTENDED_SERVICES app.openshift.io/runtime=golang
+
[source,shell,subs="attributes+"]
----
oc new-app quay.io/bamoe/cors-proxy:{IMAGE_VERSION_910} --name=$APP_NAME_CORS_PROXY
oc new-app quay.io/bamoe/cors-proxy:{IMAGE_VERSION} --name=$APP_NAME_CORS_PROXY
oc create route edge --service=$APP_NAME_CORS_PROXY
oc label services/$APP_NAME_CORS_PROXY app.kubernetes.io/part-of=$APP_PART_OF
oc label routes/$APP_NAME_CORS_PROXY app.kubernetes.io/part-of=$APP_PART_OF
Expand All @@ -60,7 +60,7 @@ oc label deployments/$APP_NAME_CORS_PROXY app.openshift.io/runtime=nodejs
+
[source,shell,subs="attributes+"]
----
oc new-app quay.io/bamoe/canvas:{IMAGE_VERSION_910} --name=$APP_NAME_BAMOE_CANVAS \
oc new-app quay.io/bamoe/canvas:{IMAGE_VERSION} --name=$APP_NAME_BAMOE_CANVAS \
-e KIE_SANDBOX_EXTENDED_SERVICES_URL=https://$(oc get route $APP_NAME_EXTENDED_SERVICES --output jsonpath={.spec.host}) \
-e KIE_SANDBOX_CORS_PROXY_URL=https://$(oc get route $APP_NAME_CORS_PROXY --output jsonpath={.spec.host})
oc create route edge --service=$APP_NAME_BAMOE_CANVAS
Expand All @@ -87,7 +87,7 @@ NOTE: All services will be available via `https`, which means that if you're dep

[source,shell,subs="attributes+"]
----
docker run -p 21345:21345 -it quay.io/bamoe/extended-services:{IMAGE_VERSION_910}
docker run -p 21345:21345 -it quay.io/bamoe/extended-services:{IMAGE_VERSION}
# Add the -d flag to run in detached mode.
----
Access the API through port 21345, no additional configuration is necessary.
Expand All @@ -97,7 +97,7 @@ Access the API through port 21345, no additional configuration is necessary.

[source,shell,subs="attributes+"]
----
docker run -p 8090:8080 -it quay.io/bamoe/cors-proxy:{IMAGE_VERSION_910}
docker run -p 8090:8080 -it quay.io/bamoe/cors-proxy:{IMAGE_VERSION}
# Add the -d flag to run in detached mode.
----
The API is accessible via port 8090 (8080 is reserved for the bamoe-canvas image). No additional configuration is necessary.
Expand All @@ -116,7 +116,7 @@ If you are running locally, following the previous steps, use this command to st
docker run -p 8080:8080 -it \
-e KIE_SANDBOX_EXTENDED_SERVICES_URL=http://localhost:21345 \
-e KIE_SANDBOX_CORS_PROXY_URL=http://localhost:8090 \
quay.io/bamoe/canvas:{IMAGE_VERSION_910}
quay.io/bamoe/canvas:{IMAGE_VERSION}
# Add the -d flag to run in detached mode.
----
The HTTP server is accessed via port 8080.
Expand Down
4 changes: 2 additions & 2 deletions installation/configure-maven.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ docker run -d -p <PORT>:8080 quay.io/bamoe/maven-repository:{IMAGE_VERSION}
----
--

You can verify the repository is running by accessing the repository in your browser at http://localhost:<PORT>/com/ibm/bamoe.
You can verify the repository is running by accessing the repository in your browser at `+http://localhost:<PORT>/com/ibm/bamoe+`.

=== Configure Maven with the container image URL:
To configure Maven with a container image follow these steps:
Expand Down Expand Up @@ -223,7 +223,7 @@ To configure the {PRODUCT_SHORT} Maven repository locally follow these steps:
. Extract the downloaded archive.
. Go to the `~/.m2/` directory and open the Maven `settings.xml` file in a text editor or IDE.
. Add the following lines to the `<profiles>` element of the Maven settings.xml file, where `<MAVEN_REPOSITORY>` is the path of the Maven repository that you downloaded.
The format of `<MAVEN_REPOSITORY>` must be `file://$PATH`. For example, `file:///home/userX/bamoe-{VERSION}-maven-repository/:`.
The format of `<MAVEN_REPOSITORY>` must be `+file://$PATH+`. For example, `+file:///home/userX/bamoe-{VERSION}-maven-repository/+`:
+
[source]
----
Expand Down
6 changes: 3 additions & 3 deletions installation/licensing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ For both components, {PRODUCT_DM} and {PRODUCT_PAM}, clients can expect the foll

=== Licensing for Disaster Recovery or Backup

When considering backup installations, active licenses are required for backup copies that are running simultaneously with the primary installation. Inactive or idling backup copies typically don't need extra licenses. In-depth information can be found in the https://www.ibm.com/about/software-licensing/assets/guides_pdf/Backup.pdf[Backup and Disaster Recovery Licensing Guide].
When considering backup installations, active licenses are required for backup copies that are running simultaneously with the primary installation. Inactive or idling backup copies typically do not need extra licenses. In-depth information can be found in the https://www.ibm.com/about/software-licensing/assets/guides_pdf/Backup.pdf[Backup and Disaster Recovery Licensing Guide].


You can find the latest LI information for the available components, parts, and software versions in the https://www.ibm.com/about/software-licensing/us-en/product_search?search=5900-AR4&type=pid&platform=[License Information (LI) for {PRODUCT_LONG}].
Expand Down Expand Up @@ -86,9 +86,9 @@ In short, {PRODUCT_LONG} deployments are licensed by *Virtual Processor Core (VP

Regarding the usage of the product in association with the entitled number of VPCs:

** Active subscriptions allow product deployments into as many environments as clients choose, as long as they don’t exceed the total number of VPCs they have purchased.
** Active subscriptions allow product deployments into as many environments as clients choose, as long as they do not exceed the total number of VPCs they have purchased.
** The number of entitlements must cover the highest expected usage of VPCs during peak periods.
** Clients are responsible for ensuring they don’t exceed their deployment entitlement.
** Clients are responsible for ensuring they do not exceed their deployment entitlement.

Additional information, can be found at https://www.ibm.com/software/passportadvantage/about_software_licensing.html[IBM Licensing Metrics].

Expand Down
6 changes: 3 additions & 3 deletions installation/upgrading.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ You can use https://docs.openshift.com/container-platform/4.14/applications/depl

For the new DMN editor:
After upgrade, the New DMN Editor will be opened automatically when you first access it in Canvas or Developer tools for VS Code.
Existing DMN files (any version) can be opened directly in the editor. For more information, see xref:../tools/authoring-decisions.adoc[Authoring decisions]
Existing DMN files (any version) can be opened directly in the editor. For more information, see xref:../editing/authoring-decisions.adoc[Authoring decisions]

== Maven libraries mapping guide

With the transition of the KIE projets to the Apache Software Foundation (ASF), it has become necessary to rename a number of Maven modules. The following table(s) describe the changes to the Maven GAV (GroupID/ArtifactID/Version) in {VERSION_910}:
With the transition of the KIE projets to the Apache Software Foundation (ASF), it has become necessary to rename a number of Maven modules. The following table(s) describe the changes to the Maven GAV (GroupID/ArtifactID/Version) that happened in {VERSION_910}:

The general guidelines are:

* xref:../installation/gav-mapping-rules.adoc[Drools Maven mappings] for anything related to rules or decisions.
* xref:../installation/gav-mapping-process.adoc[jBPM Maven mappings] for anything related to BPMN-based stateless/stateful processes.
* xref:../installation/gav-mapping-kogito.adoc[Kogito Maven mappings] for anything related to infrastructure or extended services.
* xref:../installation/gav-mapping-kie.adoc[KIE Maven mappings] for anything else that doesn't fall into the above categories.
* xref:../installation/gav-mapping-kie.adoc[KIE Maven mappings] for anything else that does not fall into the above categories.
4 changes: 2 additions & 2 deletions introduction/components.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ include::../partials/attributes.adoc[]
{PRODUCT_LONG} is a developer-first technology that offers a highly customizable set-up and solution. {PRODUCT_SHORT} is developed using well-known technologies, specifications, and open standards.

The design of an automation solution, including the components that are part of the application lifecycle, can be easily be adapted to different scenarios. The modular structure of the solution allows for custom, lightweight deployment units that efficiently use computational resources by including only what is needed.
This approach is possible with {PRODUCT_SHORT} v9.1 through the architectural design of the solution, which allows the creation of solutions targeting the automation of decisions, business rules, straight-through processes, and long-running business processes.
This approach is possible with {PRODUCT_SHORT} version 9.1 through the architectural design of the solution, which allows the creation of solutions targeting the automation of decisions, business rules, straight-through processes, and long-running business processes.

Services designed to address particular domain business problems can improve team performance and simplify the application lifecycle from development to deployment.
An automation solution with IBM BAMOE includes:
Expand Down Expand Up @@ -41,7 +41,7 @@ More complex scenarios can be implemented through the orchestration of business
[IMPORTANT]
====
The stateful process automation feature is a technology preview in IBM {PRODUCT_SHORT} v9.1.0. For more information, see xref:../workflow/overview.html[Stateful processs overview].
The stateful process automation feature is a technology preview in IBM {PRODUCT_SHORT} version {VERSION_910} and {VERSION_911}. For more information, see xref:../workflow/overview.html[Stateful processs overview].
====

== Components overview
Expand Down
8 changes: 4 additions & 4 deletions introduction/release-notes/release-notes-main.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
= Release notes
include::../../partials/attributes.adoc[]

The release notes contain information that is important for the successful installation and use of {PRODUCT_LONG} {VERSION_911} and its product modules and components.
The release notes contain information that is important for the successful installation and use of {PRODUCT_LONG} {VERSION_91X} and its product modules and components.

- xref:whats-new-9-1-1.adoc[What's new in 9.1.1]
- xref:whats-new-9-1-1.adoc[What's new in 9.1.0]
- xref:version-mapping-9-1-1.adoc[Version mapping in 9.1.1]
- xref:supported-environments.adoc[Suported Environments]
- xref:whats-new-9-1-0.adoc[What's new in 9.1.0]
- xref:version-mapping-9-1-1.adoc[Version mapping]
- xref:supported-environments.adoc[Supported Environments]
- xref:fix-list.adoc[Fix List]
- xref:known-limitations.adoc[Known Limitations]
Expand Down
Loading

0 comments on commit c3d2adb

Please sign in to comment.