Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .md_check_config.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@
{
"pattern": "^/LICENSE",
"replacement": "{{BASEURL}}/LICENSE"
},
{
"pattern": "https://www.ibm.com/docs",
"replacement": "https://ibmdocs-test.dcs.ibm.com/docs"
}
],
"timeout": "20s"
Expand Down
14 changes: 7 additions & 7 deletions README-license-annotations.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

License annotations let you track usage based on the limits defined on the container, rather than on the underlying machine. You configure the container to be deployed with specific annotations that the IBM® License Service then uses to track usage.

The IBM License Service needs to be installed on the Kubernetes cluster where the IBM ODM containers (predefined or custom) are deployed to track usage. Further information regarding the supported environments and installation instructions can be found on the [Installing License Service without Operator Lifecycle Manager documentation](https://www.ibm.com/docs/en/cloud-paks/foundational-services/4.9?topic=ils-installing-license-service-without-operator-lifecycle-manager-olm).
The IBM License Service needs to be installed on the Kubernetes cluster where the IBM ODM containers (predefined or custom) are deployed to track usage. Further information regarding the supported environments and installation instructions can be found on the [Installing License Service without Operator Lifecycle Manager documentation](https://www.ibm.com/docs/en/cloud-paks/foundational-services/4.12.0?topic=ilsfpcr-installing-license-service-without-operator-lifecycle-manager-olm).

The IBM License Service processes pod annotations to track licenses. Therefore product teams must use specific metering annotations in the `spec.template.metadata.annotations` section of their Kubernetes pod template for custom ODM containers, similarly to what is provided for the predefined ODM containers

Expand All @@ -13,7 +13,7 @@ Based on your deployment type, use the following annotations:
- [IBM ODM on Kubernetes (Non-Production)](#ibm-odm-on-kubernetes-non-production)
- [Example](#example)

The annotations below are defined for ODM version 9.0, but you can also use them for ODM v8.10.5.1 by replacing **productVersion** value with "8.10.5.1".
The annotations below are defined for ODM version 9.5, but you can also use them for ODM v8.10.5.1 by replacing **productVersion** value with "8.10.5.1".

## Guidance

Expand All @@ -31,7 +31,7 @@ The annotations below are defined for ODM version 9.0, but you can also use them
annotations:
productName: "IBM Operational Decision Manager"
productID: "b1a07d4dc0364452aa6206bb6584061d"
productVersion: "9.0.0.0"
productVersion: "9.5.0.0"
productMetric: "PROCESSOR_VALUE_UNIT"
productChargedContainers: <containername>
```
Expand All @@ -45,7 +45,7 @@ The annotations below are defined for ODM version 9.0, but you can also use them
annotations:
productName: "IBM Operational Decision Manager - Non Prod"
productID: "e32af5770e06427faae142993c691048"
productVersion: "9.0.0.0"
productVersion: "9.5.0.0"
productMetric: "PROCESSOR_VALUE_UNIT"
productChargedContainers: <containername>
```
Expand All @@ -61,7 +61,7 @@ spec:
annotations:
productName: "IBM Operational Decision Manager - Non Prod"
productID: "e32af5770e06427faae142993c691048"
productVersion: "9.0.0.0"
productVersion: "9.5.0.0"
productMetric: "PROCESSOR_VALUE_UNIT"
productChargedContainers: <containername>
```
Expand All @@ -84,14 +84,14 @@ spec:
annotations:
productName: "IBM Operational Decision Manager"
productID: "b1a07d4dc0364452aa6206bb6584061d"
productVersion: "9.0.0.0"
productVersion: "9.5.0.0"
productMetric: "PROCESSOR_VALUE_UNIT"
productChargedContainers: my-odm-decisionserverruntime
spec:
...

containers:
- name: my-odm-decisionserverruntime
image: my-repo/my-odm-decisionserverruntime:9.0.0.0-amd64
image: my-repo/my-odm-decisionserverruntime:9.5.0.0-amd64
...
```
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ IBM Operational Decision Manager on Docker
This repository centralizes the material to deploy IBM Operational Decision Manager in Docker.
It includes Docker files and Docker compose descriptors. Docker files are used to build images of ODM runtimes. And docker-compose descriptor can be used to group this build, push to your repository and run your topology from Development to production.

[IBM ODM](https://www.ibm.com/docs/en/odm/9.0.0) is a decisioning platform to automate your business policies. Business rules are used at the heart of the platform to implement decision logic on a business vocabulary and run it as web decision services.
[IBM ODM](https://www.ibm.com/docs/en/odm/9.5.0) is a decisioning platform to automate your business policies. Business rules are used at the heart of the platform to implement decision logic on a business vocabulary and run it as web decision services.


![Flow](docs/images/Architecture.png "Architecture")
Expand Down
8 changes: 4 additions & 4 deletions contrib/update-images/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@ To update your Docker images, follow these steps:

```bash
export SOURCEREGISTRY=cp.icr.io/cp/cp4a/odm
export SOURCETAG=9.0.0.0-amd64
export SOURCETAG=9.5.0.0-amd64
export TARGETREGISTRY=myrepo
export TARGETTAG=9.0.0.0-amd64
export TARGETTAG=9.5.0.0-amd64
docker compose build
```

Expand All @@ -66,9 +66,9 @@ If you want to push the updated images to your target registry, follow these ste

```bash
export SOURCEREGISTRY=cp.icr.io/cp/cp4a/odm
export SOURCETAG=9.0.0.0-amd64
export SOURCETAG=9.5.0.0-amd64
export TARGETREGISTRY=myrepo
export TARGETTAG=9.0.0.0-amd64
export TARGETTAG=9.5.0.0-amd64
docker compose push
```

Expand Down
2 changes: 1 addition & 1 deletion contrib/validate-odm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The script performs the following scenario:
- Decision Server Runtime (DSR) components
- Download and extract the zip file containing the script and resources.
- Set the required environment variables manually or use a `.env` file.
Refer to [Environment Variables](#Environment-Variables) for more information.
Refer to [Environment Variables](#environment-variables) for more information.

## Usage

Expand Down
17 changes: 9 additions & 8 deletions standalone/dockerhub/full-description.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/9.0.0?topic=manager-introducing-operational-decision)
* [ODM Documentation](https://www.ibm.com/docs/en/odm/9.5.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,12 +29,13 @@ 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-v900-rule-designer)
Available from the [Eclipse marketplace](https://marketplace.eclipse.org/content/ibm-operational-decision-manager-developers-v95x-rule-designer)

Use [IDE 2023-12 R (4.30) Modeling Tools Packages](https://www.eclipse.org/downloads/packages/release/2023-12/r).
Eclipse 2023-12 uses Java Development Kit (JDK) 17. You can download the JDK from [IBM Semeru Runtimes Downloads](https://developer.ibm.com/languages/java/semeru-runtimes/downloads/).
You install Rule Designer into [Eclipse 2024-12 (4.34)](https://www.eclipse.org/downloads/packages/release/2024-12/r). Use at least [Eclipse Modeling Tool](https://www.eclipse.org/downloads/packages/release/2024-12/r/eclipse-modeling-tools) or [Eclipse IDE for Enterprise Java and Web Developers](https://www.eclipse.org/downloads/packages/release/2024-12/r/eclipse-ide-enterprise-java-and-web-developers).

Eclipse 2024-12 uses Java Development Kit (JDK) 21. You can download the JDK from [IBM Semeru Runtimes Downloads](https://developer.ibm.com/languages/java/semeru-runtimes/downloads/).

More informations on [ODM Documentation- Installing Rule Designer](https://www.ibm.com/docs/en/odm/9.0.0?topic=900-installing-rule-designer)
More informations on [ODM Documentation- Installing Rule Designer](https://www.ibm.com/docs/en/odm/9.5.0?topic=950-installing-rule-designer)

- **Sample projects**:

Expand Down Expand Up @@ -63,7 +64,7 @@ docker pull icr.io/cpopen/odm-k8s/odm

# 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/9.0.0?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/9.5.0?topic=manager-introducing-operational-decision) site.


# Usage
Expand All @@ -77,13 +78,13 @@ 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 -e SAMPLE=true icr.io/cpopen/odm-k8s/odm:9.0
docker run -e LICENSE=accept -p 9060:9060 -p 9443:9443 -e SAMPLE=true icr.io/cpopen/odm-k8s/odm:9.5
```

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 -p 9060:9060 -p 9443:9443 -u $(id -u) -v $PWD:/config/dbdata/ -e SAMPLE=false icr.io/cpopen/odm-k8s/odm:9.0
docker run -e LICENSE=accept -p 9060:9060 -p 9443:9443 -u $(id -u) -v $PWD:/config/dbdata/ -e SAMPLE=false icr.io/cpopen/odm-k8s/odm:9.5
```

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 Down
2 changes: 1 addition & 1 deletion welcomepage/src/main/webapp/index.jsp
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ if(System.getenv("SAMPLE") != null && System.getenv("SAMPLE").equals("true")) {
<article>
<h2>Additional Resources</h2>
<ul>
<li><a href="https://www.ibm.com/docs/en/odm/9.0.0" target="_blank">ODM Documentation</a></li>
<li><a href="https://www.ibm.com/docs/en/odm/9.5.0" target="_blank">ODM Documentation</a></li>
<li><a href="https://github.com/DecisionsDev/odm-for-container-getting-started/tree/master" target="_blank">Getting Started</a></li>
<li><a href="https://community.ibm.com/community/user/automation/home" target="_blank">IBM Business Automation Community</a></li>
<li><a href="https://github.com/ODMDev/odm-ondocker/issues" target="_blank">To report an issue</a></li>
Expand Down