Development Environment

You can find the developer tools at the Visual Studio Marketplace, as BAMOE Developer Tools for VS Code.

The visual editors in BAMOE Developer Tools for VS Code automatically update files to the latest version, making them incompatible with the BAMOE version used in Business Services. To control updates, turn off the Auto Update option.

If you are developing in Java, make sure you set up the following elements:

For more information on using the extensions, see Available features → BAMOE Developer Tools for VS Code.

The recommended way of installing BAMOE Maven repository and BAMOE Canvas is to install the pre-configured Helm charts for the BAMOE Offering that you have purchased licenses for, IBM Decision Manager Open Edition or IBM Process Automation Manager Open Edition:

These Helm charts include the necessary licensing annotations and do not require any manual configuration, as was the case in previous releases. Required annotations are injected into all deployed containers, ensuring accurate license tracking from deployment, and simplifying the installation process. The charts are pre-configured with the correct product IDs, product names, and metrics for each BAMOE offering.

The charts integrate Canvas configuration via Helm parameters, enabling centralized configuration in a single values.yaml, version-controlled settings, and automatic conversion to environment variables during deployment, eliminating manual configuration, see Configuration reference for Dev Helm Charts

Each Dev Helm chart contains four sub-charts which you can install individually but you will need to manage licensing and other configuration manually:

The only difference between the PAMOE and DMOE Dev environment Helm chart is the License Service annotations which contain different productID and productName. All sub-charts receive License Service annotations automatically through the global configuration of the parent chart. The annotations are applied to every pod deployment, ensuring complete license tracking coverage for all BAMOE containers.

The BAMOE Dev Helm charts are architecture-agnostic and work for both:

If you prefer to install the Dev environment components individually using OpenShift CLI and Docker this can be done using the individual BAMOE container images. They are available as multi-architecture images on Quay.io. The host machine architecture is automatically resolved when you pull the container images. You can use the following command to specify a platform if required:

The following sections describe how to install the Dev environment components using the Helm chart or individually using OpenShift CLI and Docker.

The Helm chart provides a simple way to deploy BAMOE Canvas and BAMOE Maven repository in Kubernetes, OpenShift, and Minikube with pre-configured licensing depending on your licensed product (see License Guide). For more information on using the Helm tool, see Helm Docs.

Choose the required helm chart based on your licensed product:

BAMOE Canvas and its related services can be run locally by using Docker Compose.

For more information, see Docker Installation, and Compose Plugin Installation.

The bamoe-9.5.0-canvas-docker-compose.zip can only be downloaded from IBM Passport Advantage, and you can find information on the BAMOE 9.5 Download Document.

To Run BAMOE Canvas with Docker Compose follow these steps:

BAMOE Canvas will be available at http://localhost:9090.

If you have an air-gapped OpenShift cluster and need to deploy BAMOE Canvas using images from the internal registry, follow these steps. This procedure involves pulling images from Quay.io, pushing them to the OpenShift internal registry, and deploying the application.

The BAMOE Canvas application is now accessible at the route URL shown in the output (for example, https://bamoe-canvas-bamoecanvas.apps.example.com).

If you have a Maven Repository Manager such as Artifactory or Nexus, you can import the compressed BAMOE Maven repository content into Maven Repository Manager. Note that you will need to add licensing annotations manually if you follow this procedure rather than using the Dev environment Helm chart.

For organizations without such infrastructure, it is highly recommended to use the Dev environment Helm chart to install the Container image and make it available internally for developers and continuous integration (CI) systems.

For organizations that already use a Maven Repository Manager, developers and the CI systems are usually configured to connect to it.

If you are using the Container image, ensure that it is made available and provide the URL that developers and CI systems need to specify in their settings.xml file.

There are two ways to do this:

To configure Gradle with a container image installed via the Dev environment helm chart follow these steps:

BAMOE container images can optionally serve traffic directly over HTTPS using a TLS certificate and a key provided by the customer. This enables end-to-end encryption between the user browser and the container on OpenShift, through a passthrough Route. By default TLS not active and your existing deployment behavior is maintained.

In the Dev environment the following BAMOE container images support this:

When both variables are set, the container serves HTTPS on port 8443 (Canvas, Extended Services). CORS Proxy is the exception as it reuses its existing port (default 8080) and serves HTTPS on the same port when TLS is enabled. When the variables are unset, the container behaves exactly as before, serving HTTP only.

The matching Helm subcharts for each container expose a new tls block that wires this up automatically:

When tls.enabled=true, the chart mounts the TLS Secret into the container, sets the TLS environment variables, exposes the HTTPS port on the Service, and the OpenShift Route is configured for Passthrough termination using openshiftRoute.tls.termination=passthrough.

When installing through the Helm chart the procedure is:

The Secret must be of type kubernetes.io/tls and contain both tls.crt and tls.key keys. If tls.enabled=true is set without a secretName, the chart aborts with a clear error message before reaching the cluster.

For more information on how to implement this in the Runtime environment Helm chart containers see Configuring Runtime containers with Passthrough Transport Layer Security (TLS)

To integrate GitHub, GitHub Enterprise Server, GitLab, or Bitbucket Data Center with BAMOE Canvas, you must configure the KIE_SANDBOX_AUTH_PROVIDERS environment variable using the canvas.env Helm configuration parameter (see Configuration reference for Dev environment Helm Charts).

Example configuration:

After completing the configuration, you can access the features provided by each integration. For more information see Connecting to Git and Cloud providers.

Accelerators are Git repositories that contain a skeleton of an application and that are used to convert a working directory with your .dmn and .bpmn files into a fully functional application that can be built and deployed. They can be used to store configurations that are common to all new Business Services projects within an organization, making them available in BAMOE Canvas and BAMOE Developer Tools for VS Code for all users in your organization.

The default Quarkus and Spring Boot accelerators, available in BAMOE Canvas and BAMOE Developer Tools for VS Code, can be found in the IBM Business Automation Manager Open Editions Accelerators repository by selecting the branch that corresponds to 9.5.0. In BAMOE, you can use Accelerators that correspond to the cloud development frameworks it supports, including Quarkus and Spring Boot with either Maven or Gradle. Use these default accelerators to help identify what you want to modify in your own custom accelerator.

Accelerators are published as part of the release. You can access the following elements:

For more information, see Accessing Accelerators.

The KIE_SANDBOX_ACCELERATORS environment variable comes pre-configured with the default accelerators, accepting an array of Accelerator configurations.

You can create your custom Accelerators by overwriting the default values or by appending new accelerator definitions.

Your custom Accelerator must be a public Git repository. After creating it, write a specific JSON configuration to be used in the KIE_SANDBOX_ACCELERATORS environment variable for BAMOE Canvas:

For more information on using accelerators, see Using Accelerators

The following table lists and describes the configurable parameters of the two Dev Helm charts (IBM Process Automation Manager Open Edition and IBM Decision Manager Open Edition) and their default values.

Once you have successfully installed and configured BAMOE Canvas and BAMOE Maven repository via the Dev environment Helm chart, as well as BAMOE Developer Tools for VS Code, see the following sections: