Skip to content

Commit

Permalink
Update README.md - update for the 8.12 Release
Browse files Browse the repository at this point in the history
  • Loading branch information
lgrateau authored Jun 20, 2023
1 parent 9e5d64a commit 59fa96e
Showing 1 changed file with 6 additions and 23 deletions.
29 changes: 6 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ docker pull icr.io/cpopen/odm-k8s/odm
# Quick reference

- **Where to get help**:
* [ODM Documentation](https://www.ibm.com/docs/en/odm/8.11.1?topic=manager-introducing-operational-decision)
* [ODM Documentation](https://www.ibm.com/docs/en/odm/8.12.0?topic=manager-introducing-operational-decision)
* [IBM Business Automation Community](https://community.ibm.com/community/user/automation/communities/community-home?CommunityKey=c0005a22-520b-4181-bfad-feffd8bdc022)

- **Where to file issues**:
Expand All @@ -29,11 +29,8 @@ docker pull icr.io/cpopen/odm-k8s/odm
[latest release](https://docs.docker.com/engine/release-notes/#201021) (down to Engine 20.10)

- **Rule Designer development environment for ODM developers**:

Available from the [Eclipse marketplace](https://marketplace.eclipse.org/content/ibm-operational-decision-manager-developers-v-8111x-rule-designer)

Use [IDE 2020-06 R (4.16) Modeling Tools Packages](https://www.eclipse.org/downloads/packages/release/2020-06/r). The update site is https://raw.githubusercontent.com/ODMDev/ruledesigner/8.11.1.0/p2

Available from the [Eclipse marketplace](https://marketplace.eclipse.org/content/ibm-operational-decision-manager-developers-v-812x-rule-designer)
Use [IDE 2022-06 R (4.24) Modeling Tools Packages](https://www.eclipse.org/downloads/packages/release/2022-06/r). The update site is https://raw.githubusercontent.com/ODMDev/ruledesigner/8.12.0.0/p2

- **Sample projects**:

Expand All @@ -59,19 +56,10 @@ docker pull icr.io/cpopen/odm-k8s/odm

- [Getting started with ODM for Developers Docker image](https://github.com/ODMDev/odm-for-dev-getting-started)

- [Creating a decision service in Rule Designer](https://www.ibm.com/support/knowledgecenter/en/SS7J8H/com.ibm.odm.cloud.tutorials/tut_cloud_ds_topics/odm_cloud_dservice_tut.html). For this tutorial, you need some knowledge of Java and the Eclipse workspaces, perspectives, and views. The following instructions supersede the prerequisites given in the tutorial documentation:

- Get Rule Designer from the Eclipse marketplace, as indicated at the beginning of this page.
- Download the Miniloan sample project from the https://github.com/ODMDev/odm-for-dev-getting-started GitHub repository by clicking 'Clone or Code' and then 'Download ZIP'.
- Extract its contents to a new directory. The tutorial later refers to this directory as `<InstallDir>/miniloanservice-projects`. The size of the download file is about 13 KB.
- For Decision Server console and Decision Center Business console, use the URLs and the users/passwords provided in the table below on this page.

- [Getting started with decision modeling in the Business console](https://www.ibm.com/docs/en/odm/8.11.1?topic=tutorials-deprecated-getting-started-decision-modeling). For Decision Center Business console, use the URL and the user/password provided in the table below on this page.


# Overview

The image in this repository contains IBM Operational Decision Manager for Developers based on the IBM Websphere Application Server Liberty for Developer image. See the license section below for restrictions on the use of this image. For more information about IBM Operational Decision Manager, see the [ODM Documentation](https://www.ibm.com/docs/en/odm/8.11.1?topic=manager-introducing-operational-decision) site.
The image in this repository contains IBM Operational Decision Manager for Developers based on the IBM Websphere Application Server Liberty for Developer image. See the license section below for restrictions on the use of this image. For more information about IBM Operational Decision Manager, see the [ODM Documentation](https://www.ibm.com/docs/en/odm/8.12.0?topic=manager-introducing-operational-decision) site.


# Usage
Expand All @@ -87,18 +75,14 @@ You must accept the license before you launch the image. The license is availabl
To install the product with the sample projects, you need to specify the option -e SAMPLE=true. To be able to run simulations, you need to increase the size of the memory. Use the following docker command to run the image:

```console
docker run -e LICENSE=accept -p 9060:9060 -p 9443:9443 -m 2048M --memory-reservation 2048M -e SAMPLE=true icr.io/cpopen/odm-k8s/odm:8.11
docker run -e LICENSE=accept -p 9060:9060 -p 9443:9443 -m 2048M --memory-reservation 2048M -e SAMPLE=true icr.io/cpopen/odm-k8s/odm:8.12
```
> On some Docker version (Docker Engine 20.10.x) the memory management is different. You should run this command line:
> docker run -e LICENSE=accept -p 9060:9060 -p 9443:9443 -e JVM_ARGS='-Xmx3000m' -e SAMPLE=true icr.io/cpopen/odm-k8s/odm:8.11

Some decision artifacts, like simulation definitions, version history, or snapshots, cannot be exported from the Decision Center or the Decision Server instances of the Docker image. To avoid losing this data when you delete the Docker image container, store the Decision Center and the Decision Server databases outside of the ODM for Developers Docker image container, in a local mounted host volume. To do so, run the following docker command from an empty local folder:

```console
docker run -e LICENSE=accept -m 2048M --memory-reservation 2048M -p 9060:9060 -p 9443:9443 -v $PWD:/config/dbdata/ -e SAMPLE=false icr.io/cpopen/odm-k8s/odm:8.11
docker run -e LICENSE=accept -m 2048M --memory-reservation 2048M -p 9060:9060 -p 9443:9443 -v $PWD:/config/dbdata/ -e SAMPLE=false icr.io/cpopen/odm-k8s/odm:8.12
```
> On some Docker version (Docker Engine 20.10.x) the memory management is different. You should run this command line:
> docker run -e LICENSE=accept -e JVM_ARGS='-Xmx3000m' -p 9060:9060 -p 9443:9443 -v $PWD:/config/dbdata/ -e SAMPLE=false icr.io/cpopen/odm-k8s/odm:8.11

When you first run this command, it creates the .db files in your local folder. The following times, it reads and updates these files.

Expand All @@ -123,4 +107,3 @@ When the server is started, use the URL http://localhost:9060 to display a welco
**Note**: The IBM Operational Decision Manager for Developers license does not permit further distribution and the terms restrict usage to a developer machine.



0 comments on commit 59fa96e

Please sign in to comment.