Skip to content

Commit

Permalink
docs(aws): restructure and resolve PR requests
Browse files Browse the repository at this point in the history
  • Loading branch information
Langleu committed Dec 12, 2024
1 parent 490926d commit 92644c3
Show file tree
Hide file tree
Showing 7 changed files with 33 additions and 30 deletions.
Original file line number Diff line number Diff line change
@@ -1,18 +1,13 @@
---
id: manual-overview
title: "Manual Deployment option overview"
sidebar_label: "Overview"
id: manual
title: "Manual JAR deployment overview"
sidebar_label: Manual JAR
description: "Camunda 8 Manual (Java) deployment Reference architecture home "
---

<!-- Could also be called manual? -->
<!-- Moving target, may be renamed, etc. -->

<!-- Moving target, may be renamed, different focus, etc. -->

<!-- Day 1 vs Day 2 operations? -->
<!-- Installation vs Operations -->

# Reference Architectures Overview: Manual Deployment
# Reference Architectures Overview: Manual JAR Deployment

This section of the Camunda Deployment Reference Architectures provides guidance on deploying Camunda Platform as a standalone Java application. This deployment method is ideal for users who prefer manual deployment on bare metal servers or virtual machines (VMs), offering full control over the environment and configuration. It is particularly suited for scenarios with specific infrastructure requirements or highly customized setups.

Expand All @@ -21,15 +16,15 @@ This section of the Camunda Deployment Reference Architectures provides guidance
- **Single application JAR**: Starting from Camunda 8.7, all core components (Zeebe, Tasklist, Operate, Optimize, and Identity) are bundled into a single JAR file. This simplifies deployment by reducing the number of artifacts to manage.
- **Full Control**: Users are responsible for all aspects of deployment, including installation, configuration, scaling, and maintenance. This offers maximum flexibility for custom environments.

Other deployment options, such as containerized deployments or managed services, might offer more convenience and automation. However, VM based deployment gives you the flexibility to tailor the deployment to your exact needs, which can be beneficial for regualted or highly customized environments.
Other deployment options, such as containerized deployments or managed services, might offer more convenience and automation. However, VM based deployment gives you the flexibility to tailor the deployment to your exact needs, which can be beneficial for regulated or highly customized environments.

For documentation on the orchestration cluster, Web Modeler and Console separation, refer to [the documentation](/self-managed/reference-architecture/reference-architecture.md#orchestration-cluster-vs-web-modeler-and-console)

## Reference implementations

This section includes deployment reference architectures for manual setups:

- [Aamazon EC2 deployment](./aws-ec2.md) - is a standard production setups with support for high availability.
- [Aamazon EC2 deployment](/self-managed/setup/deploy/amazon/aws-ec2.md) - is a standard production setups with support for high availability.

## Before You Start

Expand All @@ -51,7 +46,7 @@ Compared to the generalized architecture depicted in the [reference architecture

### High Availability (HA)

:::warning Non-HA Optimize importer
:::caution Non-HA Optimize importer
When scaling from a single machine to multiple machines, ensure that the `Optimize importer` is enabled on only one machine and disabled on the others. Enabling it on multiple machines will cause data inconsistencies. This limitation is known and will be addressed in future updates.
:::

Expand Down Expand Up @@ -96,10 +91,15 @@ Any of the following are just suggestions for the minimum viable setup, the sizi

#### Minimum Requirements Per Host

- CPU: 4 cores (amd64/arm64)
- Modern CPU: 4 cores
- Memory: 8 GB RAM
- Storage: 32 GB SSD (**1,000** IOPS recommended; avoid burstable disk types)

Suggested instance types from cloud providers:

- AWS: [m7i](https://aws.amazon.com/ec2/instance-types/m7i/) series
- GCP: [n1](https://cloud.google.com/compute/docs/general-purpose-machines#n1_machines) series

#### Networking

- Stable and high-speed network connection
Expand All @@ -113,7 +113,7 @@ Any of the following are just suggestions for the minimum viable setup, the sizi
- Load balancer for distributing traffic (if required)

:::info Customizing ports
Some ports can be overwritten and are not definitive, you may conduct the [documentation](#TODO) to see how it can be done for the different components, in case you want to use a different port. Or in our example `Connectors` and `Web UIs` overlap on 8080 due to which we moved connectors to a different port.
Some ports can be overwritten and are not definitive, you may conduct the documentation of each component to see how it can be done, in case you want to use a different port. Or in our example `Connectors` and `Web UIs` overlap on 8080 due to which we moved connectors to a different port.
:::

### Application
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,10 @@ It's important to note that reference architectures are not a one-size-fits-all

## Support Considerations

We recognize that deviations from the reference architecture are unavoidable. However, such changes will introduce additional complexity, making troubleshooting more difficult. When modifications are required, ensure they are well-documented to facilitate future maintenance and support more quickly. Camunda publishes [supported environments](/reference/supported-environments.md) information to help you navigate supported configurations.
We recognize that deviations from the reference architecture are unavoidable. However, such changes will introduce additional complexity, making troubleshooting more difficult. When modifications are required, ensure they are well-documented to facilitate future maintenance and troubleshooting more quickly. Camunda publishes [supported environments](/reference/supported-environments.md) information to help you navigate supported configurations.

## Architecture

<!-- TODO: include the overview that Andrey has done -->

### Orchestration Cluster

![Orchestration Cluster](./img/orchestration-cluster.jpg)
Expand Down Expand Up @@ -60,7 +58,7 @@ The orchestration cluster is central to Camunda's workflow automation, which foc

#### Web Modeler and Console

The Web Modeler and Console are designed to oversee and manage multiple orchestration clusters. It offers tools and interfaces for administrators and developers to monitor clusters and create BPMN models. The management cluster operates independently from the orchestration cluster and can function without requiring an orchestration cluster.
The Web Modeler and Console are designed to oversee and manage multiple orchestration clusters. It offers tools and interfaces for administrators and developers to monitor clusters and create BPMN models. The management cluster operates independently of the orchestration cluster and can function without requiring an orchestration cluster.

- [Console](/components/console/introduction-to-console.md): A central management interface for monitoring and managing multiple orchestration clusters.
- [Web Modeler](/self-managed/modeler/web-modeler/installation.md): A web-based tool for designing and deploying workflow models to any available orchestration cluster.
Expand All @@ -72,7 +70,7 @@ The orchestration cluster has its own integrated Identity component, while Web M

### Databases

Databases can be deployed as part of the Camunda clusters, but using externally managed database services offers several advantages:
Databases can be deployed as part of the Camunda clusters, but using external databases or managed services offers several advantages:

- **Flexibility**: Allows you to choose the database technology that best fits your needs and existing infrastructure while choosing one of the [supported environments](/reference/supported-environments.md#component-requirements).
- **Scalability**: External databases can be scaled independently of the Camunda components, providing better performance and resource management.
Expand Down Expand Up @@ -148,4 +146,4 @@ For more information and guides, have a look at the specific reference for [Cont
- Applicable for high availability but requires more detailed planning.
- Best for teams with expertise in managing physical servers or virtual machines.

For more information and guides, have a look at the specific reference for [Manual](./manual/manual-overview).
For more information and guides, have a look at the specific reference for [Manual](./manual/manual.md).
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The architecture as depicted focuses on a standard deployment consisting of a th
<!-- To export: click on the frame > "Export Image" > as PDF and as JPG (low res), then save it in the ./assets/ folder --->

_Infrastructure diagram for a 3 node EC2 architecture (click on the image to open the PDF version)_
[![AWS EC2 Architecture](./img/aws-ec2-arch.jpg)](./img/aws-ec2-arch.pdf)
[![AWS EC2 Architecture](./assets/aws-ec2-arch.jpg)](./assets/aws-ec2-arch.pdf)

The setup consists of:

Expand All @@ -57,7 +57,7 @@ Alternatively, one can run the same setup with a single AWS EC2 instance as well

- An AWS account to create any resources within AWS.
- On a high level, permissions are required on the **ec2**, **iam**, **elasticloadbalancing**, **kms**, **logs**, and **es** level.
- For a more fine-grained view of the permissions, check this [example policy](#TODO).
- For a more fine-grained view of the permissions, check this [example policy](https://github.com/camunda/camunda-deployment-references/blob/main/aws/ec2/example/policy.json).
- Terraform (1.7+)
- Unix based Operating System (OS) with ssh and sftp
- Windows may be used with [Cygwin](https://www.cygwin.com/) or [Windows WSL](https://learn.microsoft.com/en-us/windows/wsl/install) but has not been tested
Expand Down
11 changes: 10 additions & 1 deletion optimize_sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -2530,7 +2530,7 @@ module.exports = {
),
docsLink(
"Amazon EC2",
"self-managed/setup/deploy/amazon/amazon-ec2/"
"self-managed/setup/deploy/amazon/aws-ec2/"
),
],
},
Expand Down Expand Up @@ -3318,6 +3318,15 @@ module.exports = {
},
],
},
{
"Reference Architecture": [
docsLink("Overview", "self-managed/reference-architecture/"),
docsLink(
"Manual JAR",
"self-managed/reference-architecture/manual/"
),
],
},
],
},
],
Expand Down
8 changes: 2 additions & 6 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -960,6 +960,7 @@ module.exports = {
],
},
"self-managed/setup/deploy/amazon/aws-marketplace",
"self-managed/setup/deploy/amazon/aws-ec2",
],
"Microsoft (Azure)": [
"self-managed/setup/deploy/azure/microsoft-aks",
Expand Down Expand Up @@ -1565,12 +1566,7 @@ module.exports = {
{
"Reference Architecture": [
"self-managed/reference-architecture/reference-architecture",
{
Manual: [
"self-managed/reference-architecture/manual/manual-overview",
"self-managed/reference-architecture/manual/aws-ec2",
],
},
"self-managed/reference-architecture/manual/manual",
],
},
],
Expand Down

0 comments on commit 92644c3

Please sign in to comment.