This guide provides instructions to deploy ProcessMaker on a Kubernetes cluster using Helm. This tutorial assumes a basic familiarity with Kubernetes concepts and commands. It is recommended to have a good understanding of concepts such as pods, deployments, services, and ingress. This knowledge will be beneficial for troubleshooting and managing the deployed application.
Prerequisites
System Requirements
See these on-premises server requirements prior to installing the ProcessMaker Platform open-source edition on-premises.
ProcessMaker Platform Spring 2024 has the following system requirements:
MySQL 8.0
PHP 8.1 or later
Before proceeding with the installation, ensure that you have met the following prerequisites.
A running Kubernetes cluster: Ensure that you have a Kubernetes cluster set up and accessible. This can be a local development cluster, a cloud-based Kubernetes service, or any other Kubernetes environment of your choice.
Requirement | Function | Version | Installation Guide |
|---|---|---|---|
Kubernetes | Kubernetes is a container orchestration platform that manages the deployment, scaling, and management of containerized applications. | 1.19+ | |
Helm | Helm is a package manager for Kubernetes that simplifies the deployment and management of applications. It allows you to define and manage application charts, which encapsulate all the necessary resources and configurations for your application. | 3.12.0+ |
Installation
Please follow the steps outlined below to successfully deploy ProcessMaker on your Kubernetes cluster.
Repository Configuration
To begin, add the ProcessMaker chart repository to Helm by executing the following command:
helm repo add processmaker https://charts.processmaker.ioThis command ensures that you can access the ProcessMaker chart for installation.
Update Repository
Update the list of repositories to fetch the latest charts:
helm repo updateInstall ProcessMaker on the Kubernetes Cluster
The following command deploys ProcessMaker on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.
helm install my-app processmaker/processmaker --set appConfig.host=my-app.example.comThis command deploys ProcessMaker on your Kubernetes cluster with the release name <my-app>. Replace <my-app> with a name of your choice. Also, set the appConfig.host parameter to your desired application host URL, such as my-app.example.com.
Verify the Installation
After the installation, you can verify the deployment by listing all releases using the following command:
helm listThis command displays a list of all Helm releases, including the ProcessMaker release you just installed.
Uninstall the ProcessMaker Deployment
If you need to uninstall or delete the ProcessMaker deployment, use the following command:
helm delete my-appThis command removes all the Kubernetes components associated with the ProcessMaker chart and deletes the release.
Additional Configuration Options
The ProcessMaker chart provides various configuration options that you can customize during the installation. To explore all configurable options along with detailed descriptions, you have the following options:
Review the
values.yamlfile: You can inspect the chart'svalues.yamlfile, which contains all the available configuration options and their default values.Use the
helm show valuescommand: Run the following command to view the configurable options with their descriptions:helm show values processmaker/processmakerThis command displays a detailed list of configuration options that can be customized during the installation.
For further insights into the
values.yamlfile, we recommend exploring the following resources to deepen your understanding. Configuration Values.
Conclusion
In conclusion, this guide offers a step-by-step approach to installing ProcessMaker on Kubernetes using Helm. By following the instructions outlined in this guide, users can quickly and efficiently set up ProcessMaker, leveraging the power and flexibility of Kubernetes orchestration.
Quick Start with Process Templates
Explore our ready-to-go Process Templates to kick-start your automation across several use cases and industries. Deploy into your Platform instance to spin up new processes and use as-is with all necessary assets included.