Boomerang Flow is packaged as a Helm® 3 chart with the values documented in the chart. Please make sure to read the prerequisites prior to installing.
You are expected to have one of the supported Kubernetes® platforms available with the additional software requirements presented in the following sections.
Ensure you have read and can meet all the dependencies listed in the Application Architecture.
Ensure you have Helm® 3 installed, as Boomerang Flow is packaged with Helm.
Ensure you have read and can meet all the dependencies listed in the Infrastructure Architecture.
MongoDB® is a mandatory dependency that needs to be installed prior. We highly recommend the MongoDB Helm chart from Bitnami.
We recommend that you install and create the Persistent Volume Claim (PVC) with
retain, with a minimum recommended storage of
Tekton® is another mandatory dependency that needs to be installed for Flow to properly function. The best way is to use the CD Foundation Tekton Helm Chart. The Tekton version can be found in the Application Architecture.
If you want to enable eventing, NATS Jetstream must be available to act as the messaging system. You can install NATS Jetstream via its Helm chart found here.
We recommend installing / using Cert Manager to generate your TLS certificates.
When standalone mode is disabled, integration to the Core services provided by IBM® Consulting Essentials is required.
To get started quickly, install into a Kubernetes® cluster via Helm, using the following commands:
Install a mmongodb instance for our Boomerang Flow will store the data.
helm repo add bitnami https://charts.bitnami.com/bitnami helm repo update helm upgrade --version 7.8.8 --install bmrg-mongodb bitnami/mongodb --set mongodbDatabase=boomerang --set mongodbUsername=boomerang
Install or upgrade the Helm chart using the relevant Helm commands and passing in any properties.
We've bundled in our Helm chart all the necessary dependencies required to install Boomerang Flow, like Tekton and auth2-proxy frameworks. We left them enabled for an easier installation experience however they would need to get configured for your specific use-case.
Note: To disable the tekton and oauth2-proxy use the
Explicit examples of the configuration files can be found here.
helm repo add boomerang-io https://raw.githubusercontent.com/boomerang-io/charts/index helm repo update helm upgrade --install --debug flow boomerang-io/bmrg-flow -f <configuration.yaml>
workers.security.enableis set to
workers.security.policyshould be set to a privileged PodSecurityPolicy (Kubernetes based platforms) / SecurityContextConstraint (OpenShift based platforms).
When installing Boomerang Flow in standalone mode, you will be presented with a token in the output of the Helm command, with some instructions on how to navigate to the installed running application.
Upon navigating to the links provided, a First Time Activation wizard appears, and redirection will occur, until the one-time activation token is provided.
This is an important step to ensure that an Administrator account is dynamically created, providing the user the correct entitlements to perform the post installation configuration steps.
After installation and activation, you will be able to administer the settings. These are dynamic configurations that can be changed during runtime. This ensures don't have to provide this via the values YAML at installation time, as there is nothing worse than having to put together a values YAML with greater than 100 values!
Currently, these settings will affect how the workers interface and execute. See Workers and Execute for details.
The Helm® 3 chart that we put in place for Boomerang Flow, allows you to install it, together with its dependencies on your laptop. The only pre-requirement is to have Docker installed before starting the installation process.
You can follow this step-by-step article on how to install Boomerang Flow locally on a “regular” laptop which covers:
- installing a Kubernetes cluster on the local machine using Kind,
- installing a mongodb instance to store our data,
- installing Boomerang Flow and its dependencies,
- finally activating it and doing a demo workflow.
If you encounter issues installing Boomerang Flow you can reach out on our Slack channels. The following are some of the known issues faced.
If you are attempting to run Workflows and they are coming up with an error including
serviceaccounts "pipeline" not found then its most likely that the pipelines service account needed by Tekton is not found. This can be solved by creating the required serviceaccount and rolebinding. Typically we link to a priviledged clusterrole.
kubectl create serviceaccount pipeline kubectl create rolebinding pipeline-rolebinding --serviceaccounts <namespace>:pipeline --clusterrole=<clusterrole>