Terraform

This guide will walk you through the process of deploying Epsio for Epsio in your AWS environment.

Before you begin¶

Before proceeding with the deployment guide, ensure that you have the following:

• A MySQL Database with version 5.7+.
• Your account's access_token which can be retrieved from the cloud console settings page.
• Your account ID (contact support to receive your account id).

1. Launch Epsio in your environment using Terraform¶

Define the Epsio AMI:

data "aws_ami" "epsio_prod" {
  most_recent = true
  # Epsio AWS account ID
  owners = ["262744063927"]
  filter {
    name   = "name"
    values = ["epsio-prod"]
  }
}

Define the Epsio account id & token variables to be later used:

variable "epsio_token" {
  type = string
}

variable "epsio_account_id" {
  type = string
}

After defining the above variables, add the Epsio account id & token to your terraform environment variables.

Create an instance from AMI (with an EBS volume)
To create an Epsio instance from the AMI, use the following configuration template:

resource "aws_instance" "epsio_instance" {
  ami           = data.aws_ami.epsio_prod.id

  instance_type = "m6g.2xlarge"  # Lightweight
# instance_type = "m6g.4xlarge"  # Medium
# instance_type = "m6g.8xlarge"  # Power

  root_block_device {
    volume_type = "standard"
    volume_size = 64
    delete_on_termination = true
  }

  ebs_block_device {
    device_name = "/dev/xvda"
    volume_type = "gp2"
    volume_size = 512 # 500GB -- replace if needed
    delete_on_termination = true
  }

  user_data = <<-EOF
                #!/bin/bash
                curl -s https://storage.googleapis.com/epsio/init_ec2.sh | sudo ACCOUNT_ID=${var.epsio_account_id} TOKEN=${var.epsio_token} DATABASE_TYPE=mysql bash
              EOF

  lifecycle {
    ignore_changes = [ami]
  }

  vpc_security_group_ids = [aws_security_group.epsio_sg.id] # Replace me
  subnet_id     = aws_subnet.epsio_subnet.id                # Replace me


  # -- Add more configurations here
}

lifecycle {
  ignore_changes = [ami]
}

After you spin up the EC2, you should see the new deployment in your Epsio cloud console to further configure.

2. Connect Epsio to your database¶

Open a connection to your database and follow the steps below.

Create a database for Epsio's metadata:

CREATE DATABASE epsio;

Create a database user for Epsio's exclusive use:

CREATE USER epsio_user IDENTIFIED BY '<password>';

Grant new user permissions to the Epsio database

GRANT ALL PRIVILEGES ON epsio.* TO epsio_user;

Grant replication permissions to the Epsio user

GRANT REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO epsio_user;

Grant permission to create result tables and populate existing data

GRANT SELECT, CREATE, SHOW VIEW, CREATE VIEW, ALTER, INSERT, LOCK TABLES, DELETE, DROP ON *.* TO epsio_user;

Enter the credentials of the epsio user you've just created in the wizard and click connect:
You will also need to provide the hostname (or IP address), port and a default database name (the default database that Epsio will create result tables in or query from).

After connection, Epsio will check that your database is configured correctly and will create the functions under the epsio database.
Continue to the next step to configure binlog.

3. Configure Replication¶

3.1 Check if replication is configured correctly¶

Run the following command to check if your instance is already configured correctly:

-- Required configuration: ON
SHOW VARIABLES LIKE 'log_bin';

-- Required configuration: ON
SHOW VARIABLES LIKE 'log_bin_trust_function_creators';

-- Required configuration: ROW
SHOW VARIABLES LIKE 'binlog_format';

-- Value should be 1 hour or bigger
CALL mysql.rds_show_configuration();

-- Required configuration: ON
SHOW VARIABLES LIKE 'log_bin';

-- Required configuration: ON
SHOW VARIABLES LIKE 'log_bin_trust_function_creators';

-- Required configuration: ROW
SHOW VARIABLES LIKE 'binlog_format';

-- Value should be 1 hour or bigger
CALL mysql.rds_show_configuration();

-- Required configuration: ON
SHOW VARIABLES LIKE 'log_bin';

-- Required configuration: ROW
SHOW VARIABLES LIKE 'binlog_format';

-- Required configuration: ON
SHOW VARIABLES LIKE 'log_bin_trust_function_creators';

3.2 Enable replication¶

CALL mysql.rds_set_configuration('binlog retention hours', 3);

-- Required configuration: ON
SHOW VARIABLES LIKE 'log_bin';

-- Required configuration: ON
SHOW VARIABLES LIKE 'log_bin_trust_function_creators';

-- Required configuration: ROW
SHOW VARIABLES LIKE 'binlog_format';

-- Value should be 1 hour or bigger
CALL mysql.rds_show_configuration();

CALL mysql.rds_set_configuration('binlog retention hours', 3);

-- Required configuration: ON
SHOW VARIABLES LIKE 'log_bin';

-- Required configuration: ON
SHOW VARIABLES LIKE 'log_bin_trust_function_creators';

-- Required configuration: ROW
SHOW VARIABLES LIKE 'binlog_format';

-- Value should be 1 hour or bigger
CALL mysql.rds_show_configuration();

server-id = 223344
log_bin = mysql-bin
binlog_format = ROW
binlog_row_image = FULL
binlog_expire_logs_seconds  = 864000

SET PERSIST log_bin_trust_function_creators = 1;

-- Required configuration: ON
SHOW VARIABLES LIKE 'log_bin';

-- Required configuration: ROW
SHOW VARIABLES LIKE 'binlog_format';

-- Required configuration: ON
SHOW VARIABLES LIKE 'log_bin_trust_function_creators';

3.3 Finish the deployment¶

Once finished, click on the "Validate Configuration" and Epsio will verify that replication is set up correctly.

Congratulations! You've successfully enabled replication in your database.

Once Epsio successfully connects to your database, you'll be redirected to the Epsio dashboard.

You are set to go and can create your first view. Visit the create_view for further details.