Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/exasol/terraform-aws-exasol
Terraform module for deploying Exasol cluster on AWS.
https://github.com/exasol/terraform-aws-exasol
aws deployment exasol exasol-integration terraform terraform-modules
Last synced: 3 months ago
JSON representation
Terraform module for deploying Exasol cluster on AWS.
- Host: GitHub
- URL: https://github.com/exasol/terraform-aws-exasol
- Owner: exasol
- License: mit
- Created: 2019-09-04T14:26:46.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-28T05:21:41.000Z (9 months ago)
- Last Synced: 2024-04-28T07:45:39.433Z (9 months ago)
- Topics: aws, deployment, exasol, exasol-integration, terraform, terraform-modules
- Language: HCL
- Homepage:
- Size: 202 KB
- Stars: 4
- Watchers: 13
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Exasol AWS Terraform Module
[](https://github.com/exasol/terraform-aws-exasol/actions/workflows/ci-build.yml)
[![GitHub Latest Release][gh-release-badge]][gh-release-link]
![Terraform Version][terraform-version]
A [Terraform](https://www.terraform.io) module to create an [Exasol](https://www.exasol.com) cluster on [Amazon AWS](https://aws.amazon.com/).
## Prerequisites
- [terraform][terraform-install] version `>= 1.5.1`
- [aws-cli profile][aws-cli-profile] with administrative access
- [python3][python3-install]
## Usage example
```hcl
provider "aws" {
profile = var.profile
region = "eu-central-1"
}
module "exasol" {
source = "exasol/exasol/aws"
version = ""
cluster_name = "exasol-cluster"
database_name = "exadb"
ami_image_name = "Exasol-R7.1.26-PAYG"
sys_user_password = "eXaSol1337DB"
admin_user_password = "eXaSol1337OP"
management_server_instance_type = "m5.xlarge"
datanode_instance_type = "m5.2xlarge"
datanode_count = "3"
standbynode_count = "0"
public_ip = true
# These values can be obtained from other modules.
key_pair_name = "exasol-key-pair"
subnet_id = "subnet-ed85b690"
security_group_id = "sg-07599522f13906845"
# Variables used in tags.
project = "exasol-terraformed"
project_name = "exasol-terraformed"
owner = "[email protected]"
environment = "dev"
}
```
If you don't already have a vpc and security group you can use:
```hcl
resource "aws_vpc" "exasol_db_vpc" {
cidr_block = "10.0.0.0/16"
tags = {
"exa:owner": "[email protected]",
"exa:deputy": "[email protected]"
"exa:project": "exasol-terraformed"
"exa:project.name": "exasol-terraformed"
"exa:stage": "development"
"Name": "VPC for exasol cluster"
}
}
resource "aws_security_group" "exasol_db_security_group" {
name = "exasol_cluster_security_group"
description = "Security group for exasol cluster"
vpc_id = "${aws_vpc.exasol_db_vpc.id}"
ingress {
description = "SSH from VPC"
from_port = 22
to_port = 22
protocol = "tcp"
cidr_blocks = [
"0.0.0.0/0"]
}
ingress {
description = "HTTPS from VPC"
from_port = 443
to_port = 443
protocol = "tcp"
cidr_blocks = [
"0.0.0.0/0"]
}
ingress {
description = "SQL from VPC"
from_port = 8563
to_port = 8563
protocol = "tcp"
cidr_blocks = [
"0.0.0.0/0"]
}
ingress {
description = "BucketFS"
from_port = 2580
protocol = "tcp"
to_port = 2580
cidr_blocks = [
"0.0.0.0/0"]
}
ingress {
from_port = 0
protocol = "-1"
to_port = 0
self = true
}
egress {
from_port = 0
to_port = 0
protocol = "-1"
cidr_blocks = [
"0.0.0.0/0"]
}
tags = {
"exa:owner": "[email protected]",
"exa:deputy": "[email protected]"
"exa:project": "exasol-terraformed"
"exa:project.name": "exasol-terraformed"
"exa:stage": "development"
"Name": "VPC for exasol cluster"
}
}
```
Then you can configure the exasol module like:
```
subnet_id = aws_subnet.exasol_db_vpc.id
security_group_id = aws_security_group.exasol_db_security_group.id
```
## Inputs
The following configuration variables are available.
| Variable name | Default | Description |
| :-------------------------------- | :--------------- | :------------------------------------------------------------------------------------------------ |
| `cluster_name` | `exasol-cluster` | A name for the to be deployed cluster. |
| `database_name` | `exadb` | A name of the Exasol database. |
| `ami_image_id` | `null` | An Exasol release AMI image id, e.g, `ami-05fad9f0c2609cef0`. |
| `ami_image_name` | __ | An Exasol release AMI image name, e.g, `Exasol-R7.1.26-PAYG`. |
| `sys_user_password` | __ | An Exasol database `sys` user password. |
| `admin_user_password` | __ | An EXAOperation `admin` user password. |
| `management_server_instance_type` | `m5.large` | An EC2 instance type for management server. |
| `datanode_instance_type` | `m5.xlarge` | An EC2 instance type for Exasol datanodes. |
| `datanode_count` | `3` | The number of Exasol datanodes. |
| `standbynode_count` | `0` | The number of Exasol standby nodes. |
| `public_ip` | `true` | A boolean variable whether to set public IPv4 address to nodes. Skips waiting if set to `false`. |
| `key_pair_name` | __ | An EC2 key pair name to attach to nodes. |
| `subnet_id` | __ | A subnet id to deploy the Exasol cluster. |
| `security_group_id` | __ | A security group id to attach to nodes. Please ensure that it has correct inbound rules. |
| `project` | `""` | A name for the project used in resource tagging as `exa:project` and `Project`. |
| `project_name` | `""` | A name for the project used in resource tagging as `exa:project.name` |
| `owner` | `""` | An email address of the owner used in resource tagging. |
| `environment` | `""` | An environment name to deploy the cluster used in resource tagging. |
| `waited_on` | `null` | An optional variable that can include other resource id-s to wait before deploying the cluster. |
### Remarks
- If the `ami_image_id` is provided it will used. Otherwise, an AMI image id
will be used corresponding to the provided `ami_image_name` value.
- The `security_group_id` should have at least these ports open for basic
operations.
- `22` for SSH
- `443` for EXAOperation
- `8563` for Exasol database
- `8835` for Cloud UI
- The `project` input value is also used to create a `exa:project` tag.
- Similarly, the `owner` input value is used to create a `exa:owner` tag.
## Outputs
| Output name | Description |
| :--------------------- | :---------------------------------------------- |
| `management_server_ip` | The Exasol management server public ip address. |
| `first_datanode_ip` | The first Exasol datanode public ip address. |
## Additional Information
- [Changelog](doc/changes/changelog.md)
- [Developer Guide](doc/developers_guide/developers_guide.md)
- [Contribution guidelines](CONTRIBUTING.md)
[gh-release-badge]: https://img.shields.io/github/tag/exasol/terraform-aws-exasol.svg?label=latest
[gh-release-link]: https://github.com/exasol/terraform-aws-exasol/releases/latest
[terraform-version]: https://img.shields.io/badge/tf-%3E=1.5.1-blue.svg
[terraform-install]: https://www.terraform.io/downloads.html
[aws-cli-profile]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html
[python3-install]: https://www.python.org/downloads/