Skip to content

Commit

Permalink
add prerequisite readme
Browse files Browse the repository at this point in the history
  • Loading branch information
leiicamundi committed Jan 17, 2025
1 parent 7450fd1 commit bebd63b
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,16 @@ Consider installing Camunda 8 via [this guide](https://docs.camunda.io/docs/next

## Usage

### Prerequisites

- **AWS CLI**: Command-line interface for interacting with AWS.
- **jq**: A lightweight and flexible command-line JSON processor.
- **bash**: A command-line interpreter required for executing the verification scripts.

These tools are required because **verification scripts** are used to ensure that resources can be deployed within AWS quotas. These scripts rely on `jq` to parse the JSON data returned by the AWS CLI and `bash` for executing conditional commands.

### Example

Below is a simple example configuration for deploying both an EKS cluster, an Aurora PostgreSQL database and an OpenSearch domain.

See [AWS EKS Cluster inputs](./modules/eks-cluster/README.md#inputs), [AWS Aurora RDS inputs](./modules/aurora/README.md#inputs) and [AWS OpenSearch inputs](./modules/opensearch/README.md#inputs) for further configuration options and how they affect the cluster and database creation.
Expand Down

0 comments on commit bebd63b

Please sign in to comment.