diff --git a/editing/authoring-scesim.adoc b/editing/authoring-scesim.adoc index b9a96d826..769bfcde6 100644 --- a/editing/authoring-scesim.adoc +++ b/editing/authoring-scesim.adoc @@ -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. @@ -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`. diff --git a/editing/creating-new-projects.adoc b/editing/creating-new-projects.adoc index 8b7b128f9..fb7a6ce12 100644 --- a/editing/creating-new-projects.adoc +++ b/editing/creating-new-projects.adoc @@ -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. @@ -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. diff --git a/getting-started/orchestrating.adoc b/getting-started/orchestrating.adoc index 807f4469c..3225aa494 100644 --- a/getting-started/orchestrating.adoc +++ b/getting-started/orchestrating.adoc @@ -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: @@ -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 @@ -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. @@ -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 diff --git a/installation/build-maven-repo.adoc b/installation/build-maven-repo.adoc index c2a28ef2d..cc5abccec 100644 --- a/installation/build-maven-repo.adoc +++ b/installation/build-maven-repo.adoc @@ -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. @@ -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 @@ -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 ---- diff --git a/installation/canvas.adoc b/installation/canvas.adoc index ee9dd6de0..ddaa94781 100644 --- a/installation/canvas.adoc +++ b/installation/canvas.adoc @@ -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. @@ -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 @@ -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 @@ -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 @@ -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. @@ -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. @@ -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. diff --git a/installation/configure-maven.adoc b/installation/configure-maven.adoc index 0d2b4fbcb..d44c5184c 100644 --- a/installation/configure-maven.adoc +++ b/installation/configure-maven.adoc @@ -162,7 +162,7 @@ docker run -d -p :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:/com/ibm/bamoe. +You can verify the repository is running by accessing the repository in your browser at `+http://localhost:/com/ibm/bamoe+`. === Configure Maven with the container image URL: To configure Maven with a container image follow these steps: @@ -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 `` element of the Maven settings.xml file, where `` is the path of the Maven repository that you downloaded. - The format of `` must be `file://$PATH`. For example, `file:///home/userX/bamoe-{VERSION}-maven-repository/:`. + The format of `` must be `+file://$PATH+`. For example, `+file:///home/userX/bamoe-{VERSION}-maven-repository/+`: + [source] ---- diff --git a/installation/licensing.adoc b/installation/licensing.adoc index e6a8723c4..5ed9d03bf 100644 --- a/installation/licensing.adoc +++ b/installation/licensing.adoc @@ -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}]. @@ -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]. diff --git a/installation/upgrading.adoc b/installation/upgrading.adoc index 41647e46e..ea7bfc14a 100644 --- a/installation/upgrading.adoc +++ b/installation/upgrading.adoc @@ -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. diff --git a/introduction/components.adoc b/introduction/components.adoc index c5fe41275..b550966e5 100644 --- a/introduction/components.adoc +++ b/introduction/components.adoc @@ -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: @@ -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 diff --git a/introduction/release-notes/release-notes-main.adoc b/introduction/release-notes/release-notes-main.adoc index 323304035..a8d50ff6c 100644 --- a/introduction/release-notes/release-notes-main.adoc +++ b/introduction/release-notes/release-notes-main.adoc @@ -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] diff --git a/introduction/release-notes/supported-environments.adoc b/introduction/release-notes/supported-environments.adoc index fc30f9888..b7b7f10ce 100644 --- a/introduction/release-notes/supported-environments.adoc +++ b/introduction/release-notes/supported-environments.adoc @@ -1,8 +1,8 @@ -= BAMOE version 9.1 supported configurations += Supported environments include::../../partials/attributes.adoc[] -This section summarizes the tested and supported configurations available for {PRODUCT_SHORT} {VERSION}. Support is available for any issues you identify while using the functionality provided in the product in production or development, physical or virtual environments, and depending on your subscription agreement. For any supplementary details, in particular for patch releases, you can see the https://www.ibm.com/software/reports/compatibility/clarity-reports/report/html/softwareReqsForProduct?deliverableId=1EA3BE2E21944FDABF4A432FD818E438[IBM Support site link]. +This section summarizes the tested and supported configurations available for {PRODUCT_SHORT} {VERSION_91X}. Support is available for any issues you identify while using the functionality provided in the product in production or development, physical or virtual environments, and depending on your subscription agreement. For any supplementary details, in particular for patch releases, you can see the https://www.ibm.com/software/reports/compatibility/clarity-reports/report/html/softwareReqsForProduct?deliverableId=1EA3BE2E21944FDABF4A432FD818E438[IBM Support site link]. A supported configuration includes the application containers, the JVM version families and their corresponding Operating Systems. @@ -81,7 +81,7 @@ The following web browsers were tested as part of the {PRODUCT_SHORT} {VERSION_9 |=== -The following database was tested as part of the {PRODUCT_SHORT} {VERSION_911} release process for the stateful process technical preview: +The following database was tested as part of the {PRODUCT_SHORT} {VERSION_911} release process for the stateful process technology preview: [%header,cols=2] [%autowidth] @@ -197,7 +197,7 @@ The following web browsers were tested as part of the {PRODUCT_SHORT} {VERSION_9 |=== -The following database was tested as part of the {PRODUCT_SHORT} {VERSION_910} release process for the stateful process technical preview: +The following database was tested as part of the {PRODUCT_SHORT} {VERSION_910} release process for the stateful process technology preview: [%header,cols=2] [%autowidth] diff --git a/introduction/release-notes/version-mapping-9-1-1.adoc b/introduction/release-notes/version-mapping-9-1-1.adoc deleted file mode 100644 index 645d2d63d..000000000 --- a/introduction/release-notes/version-mapping-9-1-1.adoc +++ /dev/null @@ -1,19 +0,0 @@ -= Version mapping -include::../../partials/attributes.adoc[] - -Following table displays the version mapping for version {VERSION_911}: - -.Version Mapping for {PRODUCT} Version 9.1 -[cols="1,1,1"] -|=== -| Product Version | BOM Version | Maven Library Version - -| IBM BAMOE 9.1.0 -| {BOM_VERSION_910} -| {BOM_VERSION_910} -| IBM BAMOE 9.1.1 -| {BOM_VERSION_911} -| {BOM_VERSION_911} - -|=== - diff --git a/introduction/release-notes/version-mapping.adoc b/introduction/release-notes/version-mapping.adoc new file mode 100644 index 000000000..c8c8c46c7 --- /dev/null +++ b/introduction/release-notes/version-mapping.adoc @@ -0,0 +1,26 @@ += Version mapping +include::../../partials/attributes.adoc[] + +The following table displays the version mapping for {PRODUCT_SHORT} version {VERSION_91X}: + +.Version Mapping for {PRODUCT} version {VERSION_91X} +[cols="1,1,1"] +|=== +| Product Version | BOM Version | Maven Library Version + +| IBM BAMOE 9.1.0 +| {BOM_VERSION_910} +| {BOM_VERSION_910} + +| IBM BAMOE 9.1.1 +| {BOM_VERSION_911} +| {BOM_VERSION_911} + + +//| `IBM BAMOE 9.2.0` +//| `9.2.0-Final` +//| `9.2.0-Final` + +|=== + +The stateful process technology preview can be accessed via the product BOM and Maven library versions. diff --git a/introduction/release-notes/whats-changed.adoc b/introduction/release-notes/whats-changed copy.adoc similarity index 100% rename from introduction/release-notes/whats-changed.adoc rename to introduction/release-notes/whats-changed copy.adoc diff --git a/introduction/release-notes/whats-new-9-1-0.adoc b/introduction/release-notes/whats-new-9-1-0.adoc index 229bb103f..697381ccc 100644 --- a/introduction/release-notes/whats-new-9-1-0.adoc +++ b/introduction/release-notes/whats-new-9-1-0.adoc @@ -3,18 +3,18 @@ include::../../partials/attributes.adoc[] {PRODUCT_LONG}, version {VERSION_910} introduces significant enhancements and capabilities as well as providing critical security and known issue fixes. -{PRODUCT_SHORT} version {VERSION_910} supports the following: +This release supports the following features: + +=== Modernized Technology Stack * Java upgrade - Incorporates an upgraded technology stack featuring Java 17 and Jakarta EE 10. * Quarkus LTS upgrade - Supports the latest Long-Term Support (LTS) version of Quarkus 3.8.4 by enhancing performance and reliability. -For more information, see xref:supported-environments.adoc[Supported Environments] - === Transition to downstream build -* Independent build - With the version {VERSION_910} release, BAMOE employs a complete downstream build by eliminating any dependency on open-source binaries. +* Independent build - In this release, BAMOE employs a complete downstream build by eliminating any dependency on open-source binaries. * Maven Repository Distribution: @@ -42,15 +42,12 @@ A sample package that includes 19 additional examples, 16 of which focus on work xref:../../getting-started/examples.adoc[Learn more...] == System requirements + +You can find the detailed system requirements by accessing the following link: https://www.ibm.com/software/reports/compatibility/clarity-reports/report/html/softwareReqsForProduct?deliverableId=839878FFE5974B07B85E83D0B1D368B0[Detailed system requirements]. -A detailed system requirements that can be accessed using the IBM Support site link for {PRODUCT} {VERSION_911} release. -See https://www.ibm.com/software/reports/compatibility/clarity-reports/report/html/softwareReqsForProduct?deliverableId=839878FFE5974B07B85E83D0B1D368B0[Detailed system requirements]. - -An additional section is available inside the documentation that summarizes the tested and supported configurations for {PRODUCT_SHORT} {VERSION}. See xref:supported-environments.html[Supported Environments] +An additional section can be found inside the documentation that summarizes the tested and supported configurations. See xref:supported-environments.html[Supported Environments] == Download documents -A download document that contains the information for obtaining {PRODUCT_LONG} ({PRODUCT_SHORT}) {VERSION}, earlier release and its fix releases, currently Version {VERSION_910}. -{PRODUCT_SHORT} versions are designated with a numerical Major.Minor.Patch following Open Source community Semantic Versioning principle. -Fixes for on-premise installs are available through IBM Fix Central, and {CANVAS} container images are available through Quay Container Registry. -For more information, see https://www.ibm.com/support/pages/node/7151078[BAMOE 9.1 Download Document]. \ No newline at end of file +A download document that contains the information for obtaining {PRODUCT_LONG} can be found https://www.ibm.com/support/pages/node/7151078[here]. +All {PRODUCT_SHORT} versions are indicated with a numerical Major.Minor.Patch following Open Source community Semantic Versioning principles. Fixes for on-premise installs are available through IBM Fix Central, and {CANVAS} container images are available through Quay Container Registry. diff --git a/introduction/release-notes/whats-new-9-1-1.adoc b/introduction/release-notes/whats-new-9-1-1.adoc index 6e23eeccc..623ea30ef 100644 --- a/introduction/release-notes/whats-new-9-1-1.adoc +++ b/introduction/release-notes/whats-new-9-1-1.adoc @@ -1,12 +1,13 @@ = What's new in version 9.1.1 include::../../partials/attributes.adoc[] -{PRODUCT_LONG}, version {VERSION_911} introduces significant enhancements and capabilities as well as providing critical security and known issue fixes. +This version includes new standalone editors and some changes to the technology stack as well as providing critical security and known issue fixes. -=== Standalone editors released in version {VERSION_911} -Standalone BPMN and DMN Editors can be embedded in your application from version {VERSION_911} . The same editors used in both BAMOE Canvas and BAMOE Developer Tools for VS Code are available as standalone Javascript libraries that can be imported into any frontend web application. They are available in two separate libraries that can be installed from https://www.npmjs.com/org/ibm[npm] or downloaded from Passport advantage, see https://www.ibm.com/support/pages/node/7151078[BAMOE 9.1 Download Document]: +=== Standalone editors + +You can embedd the Standalone BPMN and DMN Editors in your application. The same editors used in both BAMOE Canvas and BAMOE Developer Tools for VS Code are available as standalone Javascript libraries that can be imported into any frontend web application. They are available in two separate libraries that can be installed from https://www.npmjs.com/org/ibm[npm] or downloaded from Passport advantage, see https://www.ibm.com/support/pages/node/7151078[BAMOE 9.1 Download Document]: * @ibm/bamoe-standalone-bpmn-and-dmn-editors-classic : The classic DMN and BPMN Editors * @ibm/bamoe-standalone-dmn-editor : The new DMN Editor @@ -16,7 +17,7 @@ For more information on using the editors, see xref:../../tools/editors-librarie === Modernized Technology Stack -{PRODUCT_SHORT} version {VERSION_911} supports the following new versions for the technology stack: +The following new versions are supported for the technology stack: * IBM Semeru Runtime Open Edition - 17.0.11.0 * Quarkus - 3.8.6 @@ -24,21 +25,13 @@ For more information on using the editors, see xref:../../tools/editors-librarie * OpenShift Container Platform - 4.15 * Kubernetes - 1.30 * Google Chrome - Latest release -* Postgres - 16.4 - -For more information, see xref:supported-environments.adoc[Supported Environments] +* PostgreSQL - 16.4 == System requirements -A detailed system requirements that can be accessed using the IBM Support site link for {PRODUCT} {VERSION_911} release. -See https://www.ibm.com/software/reports/compatibility/clarity-reports/report/html/softwareReqsForProduct?deliverableId=839878FFE5974B07B85E83D0B1D368B0[Detailed system requirements]. - -An additional section is available inside the documentation that summarizes the tested and supported configurations for {PRODUCT_SHORT} {VERSION}. See xref:supported-environments.html[Supported Environments] +You can find the supported configurations in the following link: xref:supported-environments.adoc[Supported Environments] == Download documents -A download document that contains the information for obtaining {PRODUCT_LONG} ({PRODUCT_SHORT}) {VERSION}, earlier release and its fix releases, currently Version {VERSION_910}. -{PRODUCT_SHORT} versions are designated with a numerical Major.Minor.Patch following Open Source community Semantic Versioning principle. -Fixes for on-premise installs are available through IBM Fix Central, and {CANVAS} container images are available through Quay Container Registry. -For more information, see https://www.ibm.com/support/pages/node/7151078[BAMOE 9.1 Download Document]. \ No newline at end of file +For more information on {PRODUCT_LONG} version {VERSION} download document, see https://www.ibm.com/support/pages/node/7151078[BAMOE 9.1 Download Document]. \ No newline at end of file diff --git a/migration-guide/90x-to-91x.adoc b/migration-guide/90x-to-91x.adoc index b9e12638b..2d4e84b3e 100644 --- a/migration-guide/90x-to-91x.adoc +++ b/migration-guide/90x-to-91x.adoc @@ -11,12 +11,11 @@ include::../partials/91x-prerequisites.adoc[] == Procedure -The project migration from {PRODUCT_SHORT} version {VERSION_90X} to {PRODUCT_SHORT} version {VERSION} requires a few steps. -Before proceeding, ensure that all prerequisite tools are installed or updated, then you need to properly set up Maven. +This section describes the process to migrate your projects from version {VERSION_90X} to {VERSION}. Before you start, ensure that you have installed or updated all prerequisite tools. This migration guide will show two ways of migrating your project. One way of migrating is by creating a new project from scratch and then moving the assets to it. -In the other way, you will be updating an existing BAMOE version {VERSION_90X} project. -Either way, the first step is to set up the Maven configuration. +The other way is by updating an existing BAMOE version {VERSION_90X} project. +The next step is to set up the Maven configuration. === Update Maven configuration @@ -156,10 +155,10 @@ You must also report to IBM that a dependency is missing so that the problem can -See xref:../introduction/release-notes/version-mapping-9-1-1.adoc[version mapping for {PRODUCT} version 9.1.1] +See xref:../introduction/release-notes/version-mapping.adoc[version mapping for {PRODUCT_SHORT} version {VERSION_91X}]. [start=5] -. Add the `IBM ILMT Compliance Library` to the `pom.xml` _(this is required to report on subscription entitlement usage within the system)_: +. Add the `IBM ILMT Compliance Library` to the `pom.xml` _(this is required to report on subscription entitlement usage within the system)_: + [source,xml] ---- @@ -181,7 +180,7 @@ This is due to importing the `bamoe-bom` into the project, where the various dep + For this example, you will be creating a project with only DMN files. So you must add the the Drools Kogito Quarkus dependency. -In the {PRODUCT_SHORT} version {VERSION} some dependencies had a slight name change, refer to the xref:../partials/gav-mapping-all.adoc[GAV mapping table] and update accordingly. +In the {PRODUCT_SHORT} version {VERSION} some dependencies had a slight name change, see section, 'Maven libraries mapping guide' in xref:../installation/upgrading.adoc[Upgrading] and update accordingly. + [source,xml] ---- @@ -322,7 +321,7 @@ Previously, the {PRODUCT_SHORT} version {VERSION_90x} used the BOM version {BOM_ Now, both versions are {BOM_VERSION_911}. Update the following lines in your `pom.xml`: + -[source,xml] +[source,xml,subs="attributes+"] ---- bamoe-bom --- {BOM_VERSION_901} @@ -334,7 +333,7 @@ Update the following lines in your `pom.xml`: [start=3] . Update the dependencies GAV. + -In the {PRODUCT_SHORT} version {VERSION} some dependencies had a slight name change, refer to the xref:../partials/gav-mapping-all.adoc[GAV mapping table] and update accordingly. +In the {PRODUCT_SHORT} version {VERSION} some dependencies had a slight name change, see section, 'Maven libraries mapping guide' in xref:../installation/upgrading.adoc[Upgrading] and update accordingly. + One of the renamed dependencies is the `groupdId=org.kie.kogito` and `artifactId=kogito-quarkus`, which was renamed to `groupdId=org.jbpm` and `jbpm-with-drools-quarkus`. + diff --git a/migration-guide/now-to-next.adoc b/migration-guide/now-to-next.adoc index c337fca10..7c45b6319 100644 --- a/migration-guide/now-to-next.adoc +++ b/migration-guide/now-to-next.adoc @@ -34,7 +34,7 @@ See https://quarkus.io/guides/maven-tooling[Quarkus and Maven] for more details. ==== Update Maven Settings -The `settings.xml` file is a repository for customizing Maven’s global operational parameters, distinguishing itself from the `pom.xml` by its non-association with particular projects. +A 'pom.xml' file is associated with a particular project whereas the Maven 'settings.xml' file is used to customize global operational parameters across projects. This file includes configurations such as the location of the local repository, alternative sources for remote repositories, and inputting credentials, among others. There are two directories for the storage of the settings.xml file: @@ -187,23 +187,8 @@ During the course of your Maven dependency update, if you encounter any dependen You must also report to IBM that a dependency is missing so that the problem can be resolved in the next release. ==== -The following table is useful in determining which community release is bound to the section details of the mapping of https://www.kie.org/[KIE Community] releases to the current {PRODUCT_LONG} enterprise release. +See xref:../introduction/release-notes/version-mapping.adoc[version mapping for {PRODUCT_SHORT} version {VERSION_91X}]. - - -.Version Mapping for {PRODUCT} Version 9.0 -[cols="1,1,1"] -|=== -| Product Version | BOM Version | Maven Library Version - -| IBM BAMOE 9.0.0 -| {BOM_VERSION_900} -| {BOM_VERSION_900} -| IBM BAMOE 9.0.1 -| {BOM_VERSION_901} -| {BOM_VERSION_901} - -|=== [start=5] . Add the `IBM ILMT Compliance Library` to the `pom.xml` _(this is required to report on subscription entitlement usage within the system)_: + diff --git a/migration-guide/redhat-to-ibm.adoc b/migration-guide/redhat-to-ibm.adoc index 1ea733d71..5507712f5 100644 --- a/migration-guide/redhat-to-ibm.adoc +++ b/migration-guide/redhat-to-ibm.adoc @@ -8,7 +8,7 @@ The offerings formally known as {RH_PAM} / {RH_DM} were transitioned to IBM in 2 {PRODUCT} version {VERSION_80} provides a seemless upgrade path for customers and workloads formally leveraging the Red Hat offerings. By remaining a functionally equivalent product to the Red Hat offering, customers can easily migrate from the former Red Hat offering once they have purchased an IBM subscription for {PRODUCT}. This section provides guidance on how to migrate from the former Red Hat offerings of {RH_PAM} / {RH_DM} to {PRODUCT} version {VERSION_80}. -It is recommended that you follow this migration path before attempting to migrate to the next generation of the product known as {PRODUCT} version {VERSION_910}. +It is recommended that you follow this migration path before attempting to migrate to the next generation of the product known as {PRODUCT} version {VERSION_91X}. If you have designed your jBPM application based on the deployment of the KIE Server using Spring Boot and want to upgrade from the latest community version to the enterprise-supported {PRODUCT_LONG} version 8.0.x, you can find more information on the procedure in the following link. See, https://community.ibm.com/community/user/automation/blogs/tim-wuthenow/2023/06/16/community-to-enterprise-bamoe. As both projects are based on Maven architectures, the process is considerably simplified, by design. @@ -91,7 +91,7 @@ The following archives are typically used in migrating to {PRODUCT_SHORT}: In the displayed table, you must replace **VERSION** with the version of {PRODUCT_SHORT} you are migrating to, such as {VERSION_8_LATEST}. ==== -_Now that you have the files, you can start to migrate our environment._ +Now that you have the files, you can start the migration process. === Step 2: Update Maven Configuration @@ -176,7 +176,8 @@ During the course of your Maven dependency update, if you encounter any dependen {PRODUCT_LONG} version {VERSION_80} is based on the former Red Hat 7.13.x offering: -include::../partials/version-mapping-now.adoc[] +include::../partials/version-mapping-v8.adoc[] + == Step 3: Update tooling & runtime @@ -431,20 +432,20 @@ They are all mapped by the version progression, so it will be fairly quick. So, for instance, if you are running a PostgreSQL database, you must do the following: . Connect to your database instance using your method of preference. -. Apply the SQL scripts appropriate for the version you are migrating from up to RHPAM 7.13. +. Apply the SQL scripts appropriate for the version you are migrating from up to RHPAM 7.13.x [source,shell,subs="attributes+"] ---- ... +$ psql -h $dbhost -U $user < rhpam-7.11-to-7.12.sql +$ psql -h $dbhost -U $user < rhpam-7.12-to-7.13.sql $ psql -h $dbhost -U $user < rhpam-7.13-to-7.13.1.sql -$ psql -h $dbhost -U $user < rhpam-7.13.1-to-7.13.2.sql -$ psql -h $dbhost -U $user < rhpam-7.13.2-to-7.13.3.sql ... ---- [NOTE] ==== -{PRODUCT_SHORT} version {VERSION_80}'s database is compatible with {RH_PAM} 7.13, so all you need to do is to update the database to that level, and you will be set to migrate the rest of your application. +{PRODUCT_SHORT} version {VERSION_80}'s database is compatible with {RH_PAM} 7.13.x, so all you need to do is to update the database to that level, and you will be set to migrate the rest of your application. ==== Once you have executed these SQL statements, your datasource is now up to date. diff --git a/nav.adoc b/nav.adoc index bc01cbc40..a858e962c 100644 --- a/nav.adoc +++ b/nav.adoc @@ -4,7 +4,7 @@ ** xref:introduction/release-notes/release-notes-main.html[Release notes] *** xref:introduction/release-notes/whats-new-9-1-1.html[What's new in 9.1.1] *** xref:introduction/release-notes/whats-new-9-1-0.html[What's new in 9.1.0] -*** xref:introduction/release-notes/version-mapping-9-1-1.html[Version mapping in 9.1.1] +*** xref:introduction/release-notes/version-mapping.html[Version mapping] *** xref:introduction/release-notes/supported-environments.html[Supported environments] *** xref:introduction/release-notes/fix-list.html[Fix list] *** xref:introduction/release-notes/known-limitations.html[Known limitations] diff --git a/partials/attributes.adoc b/partials/attributes.adoc index d1d9e8f71..5a4e811b5 100644 --- a/partials/attributes.adoc +++ b/partials/attributes.adoc @@ -15,6 +15,7 @@ :VERSION_910: 9.1.0 :VERSION_911: 9.1.1 :VERSION_90X : 9.0.x +:VERSION_91X : 9.1.x :VERSION: {VERSION_911} :PRODUCT_VERSION: {VERSION} :VERSION_80: 8.0.x diff --git a/partials/gav-mapping-all.adoc b/partials/gav-mapping-all.adoc index 67a9f3c6d..5c7c1ba79 100644 --- a/partials/gav-mapping-all.adoc +++ b/partials/gav-mapping-all.adoc @@ -1,3 +1,5 @@ + + .KIE Related Mapping for {PRODUCT} Version {VERSION_910} [cols="3,2,2,1"] |=== diff --git a/partials/maven-bom-next.adoc b/partials/maven-bom-next.adoc index 623b9ec80..79a0df787 100644 --- a/partials/maven-bom-next.adoc +++ b/partials/maven-bom-next.adoc @@ -1,15 +1,15 @@ -[source,xml] +[source,xml,subs="attributes+"] ---- com.ibm.bamoe bamoe-bom - + {BOM_VERSION_911} import pom ---- -include::version-mapping-next.adoc[] +See xref:../introduction/release-notes/version-mapping.adoc[version mapping for {PRODUCT_SHORT}] version 9.1. diff --git a/partials/maven-bom-techpreview.adoc b/partials/maven-bom-techpreview.adoc index 90d08656c..8c4f9a2f8 100644 --- a/partials/maven-bom-techpreview.adoc +++ b/partials/maven-bom-techpreview.adoc @@ -1,15 +1,15 @@ -[source,xml] +[source,xml,subs="attributes+"] ---- com.ibm.bamoe bamoe-techpreview-bom - + {BOM_VERSION_911} import pom ---- -include::version-mapping-next.adoc[] +See xref:../introduction/release-notes/version-mapping.adoc[version mapping for {PRODUCT_SHORT}] version 9.1. diff --git a/partials/version-mapping-now.adoc b/partials/version-mapping-v8.adoc similarity index 91% rename from partials/version-mapping-now.adoc rename to partials/version-mapping-v8.adoc index c8bbdef24..18dee2e0a 100644 --- a/partials/version-mapping-now.adoc +++ b/partials/version-mapping-v8.adoc @@ -38,5 +38,10 @@ | `8.0.5.redhat-00001` | `7.67.2.Final-redhat-00017` +| `IBM BAMOE 8.0.6` +| `N/A` +| `8.0.6.redhat-00006` +| `7.67.2.Final-redhat-00025` + |=== diff --git a/partials/version-mapping-next.adoc b/partials/version-mapping-v9copy.adoc similarity index 100% rename from partials/version-mapping-next.adoc rename to partials/version-mapping-v9copy.adoc diff --git a/runtime-services-modeling/building-decision-services.adoc b/runtime-services-modeling/building-decision-services.adoc index 4ba4676e2..bf3a96622 100644 --- a/runtime-services-modeling/building-decision-services.adoc +++ b/runtime-services-modeling/building-decision-services.adoc @@ -9,7 +9,7 @@ Before you can begin developing {PRODUCT} services, you need to create a Maven p .Procedure . Run {CANVAS} - see the xref:../installation/canvas.adoc[installation] chapter for more details on how to install and run it. -. If you don't already have a project or an asset file, create a DMN or BPMN file. +. If you do not already have a project or an asset file, create a DMN or BPMN file. . Use the xref:../tools/applying-accelerators.adoc[accelerator] functionality in {CANVAS} to create a project that is buildable and deployable. diff --git a/runtime-services-modeling/drl-rules-embedded-java-mode.adoc b/runtime-services-modeling/drl-rules-embedded-java-mode.adoc index ad3a73e0d..f0eb49685 100644 --- a/runtime-services-modeling/drl-rules-embedded-java-mode.adoc +++ b/runtime-services-modeling/drl-rules-embedded-java-mode.adoc @@ -148,7 +148,7 @@ The `KieRuntime` provides methods that are applicable to both rules and processe === Globals Globals are named objects that are made visible to the Drools rule engine, but in a way that is fundamentally different from the one for facts: changes in the object backing a global do not trigger reevaluation of rules. Still, globals are useful for providing static information, as an object offering services that are used in the RHS of a rule, or as a means to return objects from the Drools rule engine. -When you use a global on the LHS of a rule, make sure it is immutable, or, at least, don't expect changes to have any effect on the behavior of your rules. +When you use a global on the LHS of a rule, make sure it is immutable, or, at least, do not expect changes to have any effect on the behavior of your rules. A global must be declared in a rules file, then it needs to be backed up with a Java object. diff --git a/tools/create-custom-dev-deployment-image.adoc b/tools/create-custom-dev-deployment-image.adoc index b0ea8f2c0..fd2ca9ce0 100644 --- a/tools/create-custom-dev-deployment-image.adoc +++ b/tools/create-custom-dev-deployment-image.adoc @@ -13,14 +13,14 @@ For convenience, one of the deployment options in {CANVAS} allows the user to in == Example 1: Using the Canvas Dev Deployment Base image -The `quay.io/bamoe/canvas-dev-deployment-base:{IMAGE_VERSION_910}` image is used as a base since it already has the `dev-deployment-upload-service` pre-configured. +The `quay.io/bamoe/canvas-dev-deployment-base:{IMAGE_VERSION}` image is used as a base since it already has the `dev-deployment-upload-service` pre-configured. === Containerfile [source,docker,subs="+attributes"] ---- # Set the base image with Java 17, Maven, and the dev-deployment-upload-service. -FROM quay.io/bamoe/canvas-dev-deployment-base:{IMAGE_VERSION_910} +FROM quay.io/bamoe/canvas-dev-deployment-base:{IMAGE_VERSION} # Start as root to get elevated access. USER root diff --git a/tools/dev-deployments.adoc b/tools/dev-deployments.adoc index 872f5a117..9ffecf855 100644 --- a/tools/dev-deployments.adoc +++ b/tools/dev-deployments.adoc @@ -42,8 +42,8 @@ NOTE: The DMN Form Webapp only works for Decisions. Workflows should be handled Images used in this deployment: -- https://quay.io/repository/bamoe/canvas-dev-deployment-quarkus-blank-app[Canvas Dev Deployment Quarkus Blank App]: `quay.io/bamoe/canvas-dev-deployment-quarkus-blank-app:{IMAGE_VERSION_910}` -- https://quay.io/repository/bamoe/canvas-dev-deployment-dmn-form-webapp[Canvas Dev Deployment DMN Form Webapp]: `quay.io/bamoe/canvas-dev-deployment-dmn-form-webapp:{IMAGE_VERSION_910}` +- https://quay.io/repository/bamoe/canvas-dev-deployment-quarkus-blank-app[Canvas Dev Deployment Quarkus Blank App]: `quay.io/bamoe/canvas-dev-deployment-quarkus-blank-app:{IMAGE_VERSION}` +- https://quay.io/repository/bamoe/canvas-dev-deployment-dmn-form-webapp[Canvas Dev Deployment DMN Form Webapp]: `quay.io/bamoe/canvas-dev-deployment-dmn-form-webapp:{IMAGE_VERSION}` == Custom Image @@ -60,9 +60,9 @@ This combination of parameters makes it a highly flexible option, but should be Images used in this deployment: -- https://quay.io/repository/bamoe/canvas-dev-deployment-base[Canvas Dev Deployment Base]: `quay.io/bamoe/canvas-dev-deployment-base:{IMAGE_VERSION_910}` +- https://quay.io/repository/bamoe/canvas-dev-deployment-base[Canvas Dev Deployment Base]: `quay.io/bamoe/canvas-dev-deployment-base:{IMAGE_VERSION}` -NOTE: This image is used by default, but it can be changed to any other available image. If using another image, it's recommended creating it based off of `quay.io/bamoe/canvas-dev-deployment-base:{IMAGE_VERSION_910}`, xref:create-custom-dev-deployment-image.html[more information here]) +NOTE: This image is used by default, but it can be changed to any other available image. If using another image, it's recommended creating it based off of `quay.io/bamoe/canvas-dev-deployment-base:{IMAGE_VERSION}`, xref:create-custom-dev-deployment-image.html[more information here]) === Deployment tokens diff --git a/workflow/consoles.adoc b/workflow/consoles.adoc index 8823b1211..5fce2dbc3 100644 --- a/workflow/consoles.adoc +++ b/workflow/consoles.adoc @@ -117,7 +117,7 @@ quarkus.http.cors=true .Running the Management Console [source,subs="attributes"] ---- -$ docker run -p 8280:8080 quay.io/bamoe/management-console:{IMAGE_VERSION_910} +$ docker run -p 8280:8080 quay.io/bamoe/management-console:{IMAGE_VERSION} ---- + [NOTE] @@ -128,7 +128,7 @@ Also, the Management Console uses the default Data Index Service port 8180. If you modified this port in your Data Index Service instance, you can set the new Data Index URL using the `RUNTIME_TOOLS_MANAGEMENT_CONSOLE_DATA_INDEX_ENDPOINT` environment variable like: [source,subs="attributes"] ---- -$ docker run -e RUNTIME_TOOLS_MANAGEMENT_CONSOLE_DATA_INDEX_ENDPOINT=http:/_HOST_:_PORT_/graphql -p 8280:8080 quay.io/bamoe/management-console:{IMAGE_VERSION_910} +$ docker run -e RUNTIME_TOOLS_MANAGEMENT_CONSOLE_DATA_INDEX_ENDPOINT=http:/_HOST_:_PORT_/graphql -p 8280:8080 quay.io/bamoe/management-console:{IMAGE_VERSION} ---- ==== @@ -324,7 +324,7 @@ $ docker run -e RUNTIME_TOOLS_MANAGEMENT_CONSOLE_KOGITO_ENV_MODE=PROD -e KOGITO_CONSOLES_KEYCLOAK_URL=http://localhost:8480/auth -e KOGITO_CONSOLES_KEYCLOAK_REALM=kogito -e KOGITO_CONSOLES_KEYCLOAK_CLIENT_ID=kogito-console-react - -p 8280:8080 quay.io/bamoe/management-console:{IMAGE_VERSION_910} + -p 8280:8080 quay.io/bamoe/management-console:{IMAGE_VERSION} ---- == Task Console @@ -427,7 +427,7 @@ In a command terminal, enter the following command to run the Task Console: .Running the Task Console [source,subs="attributes"] ---- -$ docker run -p 8280:8080 quay.io/bamoe/task-console:{IMAGE_VERSION_910} +$ docker run -p 8280:8080 quay.io/bamoe/task-console:{IMAGE_VERSION} ---- [NOTE] @@ -438,7 +438,7 @@ Also, the Task Console uses the default Data Index Service port 8180. If you modified this port in your Data Index Service instance, you can set the new Data Index URL using the `RUNTIME_TOOLS_TASK_CONSOLE_DATA_INDEX_ENDPOINT` environment variable like: [source,subs="attributes"] ---- -$ docker run -e RUNTIME_TOOLS_TASK_CONSOLE_DATA_INDEX_ENDPOINT=http:/_HOST_:_PORT_/graphql -p 8280:8080 quay.io/bamoe/task-console:{IMAGE_VERSION_910} +$ docker run -e RUNTIME_TOOLS_TASK_CONSOLE_DATA_INDEX_ENDPOINT=http:/_HOST_:_PORT_/graphql -p 8280:8080 quay.io/bamoe/task-console:{IMAGE_VERSION} ---- ==== @@ -453,7 +453,7 @@ These states are used in the *Task Inbox* default filter. Without this property, .Configuring custom task states for the Task Console [source,subs="attributes"] ---- -$ docker run -e RUNTIME_TOOLS_TASK_CONSOLE_KOGITO_TASK_STATES_LIST=Started,Pending,Finished,Cancelled -e RUNTIME_TOOLS_TASK_CONSOLE_KOGITO_TASK_ACTIVE_STATES_LIST=Started,Pending -p 8280:8080 quay.io/bamoe/task-console:{IMAGE_VERSION_910} +$ docker run -e RUNTIME_TOOLS_TASK_CONSOLE_KOGITO_TASK_STATES_LIST=Started,Pending,Finished,Cancelled -e RUNTIME_TOOLS_TASK_CONSOLE_KOGITO_TASK_ACTIVE_STATES_LIST=Started,Pending -p 8280:8080 quay.io/bamoe/task-console:{IMAGE_VERSION} ---- .Task Console @@ -513,5 +513,5 @@ $ docker run -e RUNTIME_TOOLS_TASK_CONSOLE_KOGITO_ENV_MODE=PROD -e KOGITO_CONSOLES_KEYCLOAK_URL=http://localhost:8480/auth -e KOGITO_CONSOLES_KEYCLOAK_REALM=kogito -e KOGITO_CONSOLES_KEYCLOAK_CLIENT_ID=kogito-console-react - -p 8280:8080 quay.io/bamoe/task-console:{IMAGE_VERSION_910} + -p 8280:8080 quay.io/bamoe/task-console:{IMAGE_VERSION} ---- \ No newline at end of file