Manual Install Camunda 8 With RDBMS: A Complete Guide

Welcome to the definitive guide on manually installing a Camunda 8 orchestration cluster using an external RDBMS. This guide serves as your entry point for all VM, bare-metal, and Java-based RDBMS setups. Let’s dive in!

Introduction to Manual Installation with RDBMS

In this comprehensive guide, we will walk you through the intricacies of manually installing a Camunda 8 orchestration cluster, leveraging an external RDBMS (Relational Database Management System) for secondary storage. This approach is particularly suited for environments such as Virtual Machines (VMs), bare-metal servers, and Java applications, offering a flexible alternative to containerized deployments. By choosing manual installation, you gain granular control over your Camunda 8 setup, allowing for tailored configurations that precisely match your operational requirements. Throughout this guide, we will cover the essential prerequisites, the step-by-step installation process, and the critical configurations needed to ensure a robust and efficient Camunda 8 deployment.

The goal is to provide a clear and actionable path for those who prefer or require a more hands-on approach to setting up their Camunda 8 environment. Whether you are dealing with specific compliance requirements, optimizing for unique hardware configurations, or simply prefer the control that manual installation provides, this guide aims to be your primary resource. Each section is designed to build upon the previous one, ensuring that by the end of this guide, you will have a fully functional Camunda 8 cluster running on your chosen RDBMS.

Scope of this Guide

This guide focuses on the manual installation of Camunda 8 using an external RDBMS. We will cover:

• Creating /self-managed/install/manual-install/rdbms/index.md.
• Describing supported installation targets (VM, bare metal, Java application).
• Outlining prerequisites.
• Defining when to choose manual installation vs. Helm or C8 Run.
• Linking to deeper configuration pages.

Supported Installation Targets

When it comes to deploying Camunda 8, understanding the landscape of supported installation targets is crucial for aligning the platform with your existing infrastructure and operational preferences. Manual installation with an RDBMS (Relational Database Management System) offers a versatile solution that caters to a variety of environments, each with its unique characteristics and advantages. Here, we delve into the primary installation targets supported by this guide, providing a detailed overview of what each entails and why it might be the right choice for your organization.

Virtual Machines (VMs)

Deploying Camunda 8 on Virtual Machines (VMs) is a popular choice due to the flexibility and scalability that VMs offer. VMs allow you to abstract the underlying hardware, providing a consistent environment regardless of the physical infrastructure. This is particularly useful in cloud environments or in organizations that heavily rely on virtualization for resource management. Setting up Camunda 8 on a VM involves creating a virtual instance, installing the necessary operating system and Java Runtime Environment (JRE), and then configuring Camunda 8 to use the external RDBMS. The key benefit here is the ease of scaling and managing resources. You can quickly provision new VMs or adjust the resources allocated to existing ones based on the demands of your Camunda 8 workflows. Additionally, VMs provide a level of isolation that can be beneficial for security and compliance purposes.

Bare Metal Servers

For organizations that require maximum performance and control, deploying Camunda 8 on bare metal servers is an excellent option. Bare metal servers provide direct access to the hardware, eliminating the overhead associated with virtualization. This results in improved performance and lower latency, which can be critical for high-throughput workflow applications. The installation process on bare metal servers is similar to that on VMs, but it requires more hands-on management of the hardware and operating system. You'll need to handle tasks such as OS installation, driver configuration, and hardware maintenance. However, the performance gains can be significant, making it a worthwhile choice for performance-sensitive applications. Furthermore, bare metal servers offer enhanced security and compliance options, as you have complete control over the hardware and software stack.

Java Applications

Integrating Camunda 8 directly into Java applications offers a seamless and highly customizable deployment option. This approach involves embedding the Camunda 8 engine within your existing Java application, allowing you to leverage its workflow capabilities directly within your application's codebase. This is particularly useful for organizations that have complex, custom applications where workflow integration is a core requirement. Setting up Camunda 8 within a Java application involves adding the necessary Camunda 8 dependencies to your project, configuring the engine to use the external RDBMS, and then integrating the workflow logic into your application's code. The benefit of this approach is the tight integration between your application and the workflow engine, allowing for highly customized and efficient workflows. However, it requires a strong understanding of Java development and the Camunda 8 API.

Prerequisites

Before you begin, ensure you have the following prerequisites in place:

• Supported RDBMS: H2, PostgreSQL, Oracle, MariaDB
• JDBC drivers: Download the appropriate JDBC driver for your chosen RDBMS.
• Required schemas and scripts: Prepare the necessary schemas and scripts for your RDBMS.

Supported RDBMS

When embarking on the manual installation of Camunda 8 with an external RDBMS, one of the first and most critical decisions you'll make is selecting the appropriate database system. Camunda 8 offers robust support for a variety of RDBMS options, each with its own strengths, characteristics, and use-case suitability. Understanding these options is crucial for ensuring that your chosen database system aligns with your organization's needs, technical capabilities, and long-term goals. Here, we delve into the supported RDBMS options for Camunda 8, providing a detailed overview of each.

H2

H2 is a lightweight, open-source, Java-based RDBMS that is often used for development and testing purposes. Its key advantage lies in its simplicity and ease of setup, making it an ideal choice for quick prototyping and local development environments. H2 can run in embedded mode, meaning that the database runs within the same JVM process as your application, simplifying deployment and eliminating the need for a separate database server. However, due to its file-based storage and lack of advanced features, H2 is not recommended for production environments where performance, scalability, and reliability are critical. Its primary use case is for developers who need a quick and easy way to test their Camunda 8 workflows without the overhead of setting up a more complex database system.

PostgreSQL

PostgreSQL is a powerful, open-source RDBMS known for its robustness, reliability, and adherence to SQL standards. It offers a wide range of features, including advanced indexing, transaction management, and support for complex data types. PostgreSQL is well-suited for production environments where data integrity and performance are paramount. It can handle large volumes of data and concurrent users, making it a popular choice for organizations with demanding workflow requirements. Setting up Camunda 8 with PostgreSQL involves installing the PostgreSQL server, creating the necessary database schemas, and configuring Camunda 8 to connect to the database. While the setup process is more involved than with H2, the benefits in terms of performance, scalability, and reliability make it a worthwhile investment for production deployments.

Oracle

Oracle is a leading commercial RDBMS known for its scalability, performance, and advanced features. It offers a comprehensive set of tools and capabilities for managing large, complex databases, making it a popular choice for enterprise-level deployments. Oracle is well-suited for organizations with stringent performance and security requirements. It can handle massive amounts of data and concurrent users, making it ideal for mission-critical workflow applications. Setting up Camunda 8 with Oracle involves installing the Oracle database server, creating the necessary database schemas, and configuring Camunda 8 to connect to the database. Oracle also provides advanced features such as data partitioning, online indexing, and real-time data replication, which can further enhance the performance and availability of your Camunda 8 deployment.

MariaDB

MariaDB is a popular open-source RDBMS that is a fork of MySQL. It offers a wide range of features, including improved performance, scalability, and security. MariaDB is well-suited for production environments where cost-effectiveness and ease of use are important considerations. It can handle large volumes of data and concurrent users, making it a viable alternative to PostgreSQL and Oracle. Setting up Camunda 8 with MariaDB involves installing the MariaDB server, creating the necessary database schemas, and configuring Camunda 8 to connect to the database. MariaDB also offers features such as Galera Cluster for high availability and replication, which can further enhance the reliability of your Camunda 8 deployment.

JDBC Drivers

JDBC (Java Database Connectivity) drivers act as the crucial bridge that enables your Camunda 8 application to communicate with your chosen RDBMS. These drivers are specific to each database system and provide the necessary protocols and interfaces for establishing a connection, executing SQL queries, and retrieving data. Selecting and configuring the correct JDBC driver is paramount for ensuring seamless and reliable communication between Camunda 8 and your database. Each RDBMS vendor provides its own JDBC driver, which can be downloaded from their respective websites or repositories. Once downloaded, the driver needs to be added to the classpath of your Camunda 8 application, allowing it to be loaded and utilized at runtime. The configuration process typically involves specifying the driver class name, the database connection URL, and the authentication credentials in your Camunda 8 configuration file. Proper configuration of the JDBC driver ensures that Camunda 8 can successfully connect to your database, execute queries, and manage the data required for your workflows.

Required Schemas and Scripts

Preparing the required schemas and scripts is a fundamental step in the manual installation process. Schemas define the structure of your database, including the tables, columns, indexes, and constraints that will be used to store Camunda 8 data. Scripts, on the other hand, are used to create and initialize these schemas. Camunda 8 requires a specific set of schemas to function correctly, including schemas for process definitions, process instances, tasks, and variables. These schemas can be created manually using SQL commands or by running pre-built scripts provided by Camunda. The scripts typically include SQL statements for creating the necessary tables, indexes, and constraints. It's crucial to ensure that these schemas are created correctly and that the database user has the necessary privileges to access and modify them. Incorrectly configured schemas can lead to errors and data corruption, so it's important to follow the instructions carefully and verify that the schemas are created as expected.

Choosing Manual Installation

Deciding whether to opt for manual installation versus alternatives like Helm or C8 Run hinges on several factors unique to your environment and requirements. Manual installation offers a high degree of control and customization, making it ideal for scenarios where specific configurations or compliance requirements are paramount. Unlike Helm, which is designed for Kubernetes environments, manual installation is suitable for VMs, bare metal servers, and Java applications. This flexibility allows you to tailor the installation process to your specific infrastructure, ensuring optimal performance and resource utilization.

However, manual installation requires a deeper understanding of the underlying systems and configurations. It involves more hands-on management and can be more time-consuming than automated methods like Helm or C8 Run. Therefore, it's essential to weigh the benefits of control and customization against the increased complexity and effort required. If you have specific security requirements, custom hardware configurations, or the need to integrate Camunda 8 deeply into existing Java applications, manual installation may be the most appropriate choice. On the other hand, if you're running in a Kubernetes environment and prioritize ease of deployment and management, Helm or C8 Run may be more suitable.

• Manual Installation: Best for VM, bare metal, Java application setups requiring high customization.
• Helm: Ideal for Kubernetes environments, offering automated deployment and management.
• C8 Run: A managed service providing simplified deployment and operation of Camunda 8.

Deliverables

Upon completion of this guide, the following deliverables will be available:

• A new index page drafted and reviewed.
• Navigation entry added under “Self-Managed → Install → Manual installation”.
• Admonitions for limitations included.

Acceptance Criteria

To ensure the quality and accuracy of this guide, the following acceptance criteria must be met:

• Page published behind appropriate routing.
• All links to secondary pages function.
• Terminology aligns with Secondary Storage Architecture docs.

Important Considerations

Keep the following in mind:

• Not supported for Kubernetes.
• No ES/OS fallback.
• RDBMS-only constraints.

Conclusion

By following this guide, you will be well-equipped to manually install Camunda 8 with an RDBMS. This approach offers flexibility and control, making it suitable for various environments. Remember to consider the prerequisites and important considerations outlined in this guide. Good luck!

For more information about Camunda Platform, visit the official website at Camunda Platform.