Skip to main content
Feedback

Prerequisites

The following softwares, resources, and accesses are required for deploying a Local Edition cluster.

Container Tools

The container tool is required to build product images used to bring up Local Edition cluster. You may use either Docker or Podman to build and push images. You may build images on any Docker or Podman-enabled environment, for example, your laptop or a server with the following minimum requirements:

  • Number of CPUs: 2

  • RAM: 6 GB

note

Root privileges or sudo escalation is not required for building Local Edition images.

Podman

The following table lists the minimum supported Podman version for each Boomi Cloud API Management – Local Edition release:

Product release versionMinimum supported version
v6.2.04.9.4
v6.1.05.2.3
v6.0.04.4.4
important

To run a containerized runtime, you must use Podman version 4.4.4 or higher.

Refer to Installing Podman for installation instructions.

Docker

The following table lists the minimum supported Docker version for each Boomi Cloud API Management – Local Edition release:

Product release versionMinimum supported version
v6.2.028.3.0
v6.1.027.0.0 (Community Edition and Enterprise Edition)
v6.0.024.0.6

Refer to Installing Docker for detailed installation steps and options.

Helm

Helm is required to manage your Kubernetes applications. For the templates and charts, Helm API version 2 is used.

The following table lists the minimum supported Helm version for each Boomi Cloud API Management – Local Edition release:

Product release versionMinimum supported version
v6.1.03.11.2
v6.0.03.11.2

Refer to Installing Helm for installation instructions.

Container Registry

Use any Open Container Initiative (OCI) registry such as Amazon ECR, Microsoft Azure CR, Docker Hub, Google Artifact Registry.

Container Managers

Kubernetes

Kubernetes is required for deploying Local Edition application. The following table lists the minimum supported Kubernetes version for each Boomi Cloud API Management – Local Edition release:

Product release versionMinimum supported version
v6.2.01.33
v6.1.01.31
v6.0.01.28

Kubernetes CLI and Kubeconfig

For an ideal experience running Local Edition, it is recommended that the versions of kubectl CLI, Kubernetes Cluster, and Kubernetes API server match.

The following table lists the minimum supported kubectl version:

Product release versionMinimum supported version
v6.1.01.25
v6.0.01.25

The kubeconfig file defines the permissions required to access the Kubernetes cluster. At a minimum, you must have the following accesses:

  • Kubernetes API server: Ability to create pods, create jobs, and access secrets.
  • Kubernetes monitoring: Ability to run the command kubectl top. Refer to the kubectl reference for a full list of kubectl commands.

Kubeconfig Location

Local Edition uses Helm to manage the application, and it requires to know the location of the kubeconfig file. You can define the kubeconfig file location in one of the following ways:

  • Default location: /home directory.

  • KUBECONFIG environment variable: If you have a custom location, define an environment variable called KUBECONFIG.

OpenShift

OpenShift is required to deploy the Local Edition. The following table lists the minimum supported OpenShift version for each Boomi Cloud API Management – Local Edition release:

Product release versionMinimum supported version
v6.1.04.15 (stable version)
v6.0.04.14

Runtime

Local Edition supports the following container runtimes:

  • crun: - The lowest supported denominator. If Local Edition runs on crun, it can run on any runtime. It is faster than runc and containerd (Docker-contributed runtime). Refer to crun on GitHub for more information.

  • cri-o: The default runtime on popular cloud platforms. Refer to cri-o documentation for more information.

Tethered Mode (introduced in v6.1.0+)

In tethered mode, the loader (CacheLoader in v6.0.0; Loader from v6.1.0+) requires an API Key and secret to communicate with the service on Boomi Cloud API Management. To obtain these values - apikey and secret, contact Boomi Account Representative.

MySQL Database Service

The database service can be a self-managed instance or a cloud-provider service. For self-managed instances, the following table lists the minimum supported MySQL version for each Boomi Cloud API Management – Local Edition release:

Product release versionMinimum supported version
v6.1.08.4 LTS
v6.0.08.0.23

The APIM-LE components may communicate with the database service using unsecured or secured connections.

  • Secured Connection with TLS - TLS 1.2 or higher is supported. TLS 1.3 is recommended.

  • Other database requirements are:

    • Database URI or Service FQDN or IP address must be available.

    • The database masherysolar must be created.

    • A database user with privileges to create the database used by Local Edition components (default: masherysolar) and schema.

    • A database user with privileges to operate on database objects such as tables, triggers, stored procedure, etc., in the masherysolar database.

    • TLS resources such as client certificate and key, as applicable.

Mail Service

Local Edition can send notifications using registered notification templates from Config UI and Trafficmanager to notify events. Supported mail services include LOG (log to console), SMTP, and AWS.

The configuration is specific to each service type:

  • LOG: No additional configuration required.
  • SMTP and AWS: Require service-specific configuration settings.

SMTP

Configure your mail server to expose SMTP port to send mails. Different mail services have different configurations. Refer to your provider's documentation for detailed setup instructions.

The following settings are required:

  • SMTP host and port
  • SMTP credentials

AWS

To use AWS as a mail service, the following settings are required:

  • AWS mail service as host.

  • AWS user and password (token or key)

The following minimum supported versions apply when using AWS with Boomi Cloud API Management – Local Edition:

EnvironmentProduct release versionMinimum supported version
EKS with Kubernetesv6.1.01.31
RedHat OpenShiftv6.1.04.17 (stable version)

Google Cloud (v6.1.0)

The following table lists the minimum supported versions for Google Cloud environments when using Boomi Cloud API Management – Local Edition:

EnvironmentProduct release versionMinimum supported version
GKE with Kubernetes (Client and Server)v6.1.01.30 (stable version)
RedHat OpenShiftv6.1.04.17

Microsoft Azure (v6.1.0)

The following table lists the minimum supported version for Azure environments when using Boomi Cloud API Management – Local Edition:

EnvironmentProduct release versionMinimum supported version
AKS with Kubernetes (Client and Server)v6.1.01.31

On-premise (v6.1.0)

The following table lists the minimum supported versions for on-premise environments when using Boomi Cloud API Management – Local Edition:

EnvironmentProduct release versionMinimum supported version
RedHat OpenShiftv6.1.04.17
Bare-metal Kubernetesv6.1.01.31

External Log Destination or Observability Stack

Log destination support is governed by the choices from Fluent Bit output plug-ins. You must have the handy Fluent Bit configuration for chosen outputs. Refer to Fluent Bit documentation for more information.

Without the observability stack, you cannot view any application logs including error logs generated during installation and post-installation.

Your Kubernetes administrator is responsible for managing the log size and the retention. By default, the log size is 10 MB.

Reference

On this Page