Skip to main content
Feedback

Installing a Flex Runtime

Updated 
note

Boomi Flex Runtime is part of Boomi's Early Access program, which offers beta versions of Boomi innovations on an "as is" basis, with no warranties. These features are not final production releases, are unsupported under Boomi's service agreements and support services, and are not intended for production use. While Boomi will work to address issues encountered during the preview and welcomes participant feedback, any feedback provided — whether ideas, suggestions, code, or recommendations, oral or written — is irrevocably assigned to Boomi, LP. By participating, you confirm you have the authority to provide that feedback, will not assert any intellectual property claims against Boomi, and that Boomi may freely implement it without violating any party's rights. If a beta feature doesn't meet Boomi's standards or raises significant concerns, it may never reach general availability, and Boomi cannot guarantee any particular innovation will be released in a supported form. Note that some innovations may only be available as open source or for specific runtime configurations. Documentation may be provided as PDFs, online, or on Community forums.

Refer to the Early Access page to view current programs and request Early Access for a specific feature.

Before you begin

  • Prepare your Kubernetes cluster before installing a Flex Runtime. Refer to Preparing your Kubernetes cluster for Flex Runtime for the full requirements, including cluster and node specifications, namespace and storage setup, and network access. At a high level, you need:
    • A Kubernetes cluster, with a dedicated namespace and persistent volume claim already created.
    • Outbound network access from your cluster to platform.boomi.com and ghcr.io — your Flex Runtime always initiates this connection, so no additional inbound access is required for platform communication itself.
    • A Linux machine (AMD or ARM) to run the installer CLI from. The CLI is currently available for Linux only — there's no Mac or Windows build during Early Access.

If you use your Flex Runtime to browse available Agentstudio agents in the Agent step, add Agent Control Tower's IP addresses to your allowlist. Refer to Host names and IP addresses for Boomi Enterprise Platforms.

Installation steps

Before running the install command, download runtimectl.

  1. In the Boomi Platform, navigate to Runtime Management and select Create Runtime.
  2. In the dialog box, under One Platform, select Flex Runtime.
  3. On the Basic Information step, enter a runtime name, an environment (optional), a namespace (the Kubernetes namespace the runtime will install into), and a persistent volume claim for stateful services.
  4. On the Select Workloads step, select your desired workload. Selected workloads need additional setup after installation to activate. (At this time, the only workload available to customers is Agent)
  5. Review your selections and finish the wizard.
  6. Copy the generated install token. The token is valid for 15 minutes — if it expires before you run the install command, generate a new one.
  7. In your Kubernetes cluster, create the namespace you specified above.
  8. Run the install command, using the token and your cluster's kube-context:
runtimectl install --token=<install-token> --kube-context=<kube-context>

This bootstraps the Flex Runtime platform services into the namespace you specified.

Note: If you plan to use your Flex Runtime with the Agent step, you must configure your runtime's ingress endpoint after installation. This is a post-install, runtime-level setting — Refer to "Configuring your runtime's ingress endpoint" in Managing a Flex Runtime. For Agentstep configuration, refer to Configuring the Agent step

Important considerations

Known issue

Some users may experience an authentication error when creating a flex runtime. If you experience this issue, follow the below steps:

note

These alternate steps work for any account where the user already exists (or after adding them to the account).

  1. In the Platform, navigate to User Management and select the User.
  2. In the dialog box, click on the pencil icon to open Add / Maintain User Roles and click Ok.
  3. After clicking Ok, the user is automatically updated with the current roles and privileges. Now visible in the UI.
On this Page