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

  • Minimum supported version (in v6.1.0) - 5.2.3
  • Minimum supported version (in v6.0.0) - 4.4.4.
note

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

Refer to Installing Podman for more information.

Docker

  • Minimum supported version (in v6.1.0):

    • Docker Community Edition - 27.0.0

    • Docker Enterprise Edition - 27.0.0

  • Minimum supported version (in v6.0.0):

    • Docker - 24.0.6.

Refer to Installing Docker for more information about various options.

Helm

  • Required to manage your Kubernetes applications.

  • Minimum supported version (in v6.0.0 and v6.1.0) - 3.11.2

For the templates and charts, Helm API version 2 is used.

Refer to Installing Helm for more information.

Container Registry

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

Container Managers

Kubernetes

  • Required for deploying Local Edition application.
  • Minimum supported version (in v6.1.0) - 1.31
  • Minimum supported version (in v6.0.0) - 1.28

Kubernetes CLI and Kubeconfig

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

  • Minimum Kubectl version (in v6.0.0 and v6.1.0) - 1.25

The kubeconfig file has verbs defining the different access to the cluster.

At a minimum, you must have the following set of accesses:

  • Kubernetes API server: with abilities to create pods, jobs, and access secrets.

  • Kubernetes monitoring: run the command kubectl top. Refer to kubectl reference for a reference 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 - the /home directory.

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

OpenShift

  • Required to deploy Local Edition.
  • Minimum supported version (in v6.1.0) - 4.15 (stable version)
  • Minimum supported version (in v6.0.0) - 4.14

Runtime

  • crun - The lowest supported denominator. If it 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 clouds. Refer to cri-o 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. If it is a self-managed instance, use this minimum supported version 8.4 LTS.

  • Minimum supported version (in v6.1.0): 8.4 LTS
  • Minimum supported version (in v6.0.0): 8.0.23

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

  • Secured Connection with TLS: You may use TLS 1.2 or higher. TLS 1.3 is recommended.

  • Other requirements from the database service are:

    • Database URI or Service FQDN or IP address is available.

    • Database masherysolar is created.

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

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

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

Mail Service

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

The configuration are specific to each type with "log" requiring no other configuration.

SMTP

Configure mail server to expose SMTP port to send mails. Different mail services have different configurations. Check the provider documentation to configure mail service.

Requires the following:

  • SMTP host and port

  • SMTP creds

AWS

Requires the following:

  • AWS mail service as host.

  • AWS user and password (token or key)

  • Minimum supported version (EKS with Kubernetes) (in v6.1.0) - 1.31

  • RedHat OpenShift (in v6.1.0) - 4.17 (stable version)

Google Cloud (in v6.1.0)

  • Minimum supported version (in v6.1.0):

    • GKE with Kubernetes Client and Server - 1.30 (stable version)
    • RedHat OpenShift - 4.17

Microsoft Azure (in v6.1.0)

  • Minimum supported version (in v6.1.0):

    • AKS with Kubernetes Client and Server - 1.31

On-premise (in v6.1.0)

  • RedHat OpenShift (in v6.1.0) - 4.17

  • Bare-metal Kubernetes (in v6.1.0) - 1.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 can not view any application logs including error logs generated during installation and post-installation.

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

See Also

On this Page