Managed MySQL

Beaker Studio can deploy fully managed and production-ready MySQL databases alongside your other services. Behind the scenes it uses Amazon’s RDS, so you get all the benefits of that, seamless integration into the rest of your environment, and simplified backup restoration.

To create a MySQL database, choose Managed MySQL as the Service Type on the deployment screen. This only appears as an option for services that have a mysql-prefixed image defined in compose.yaml. For example, image: mysql or image: mysql:8.

Parameters

This section describes the possible parameters for scheduled tasks that appear in the Beaker Studio UI.

MySQL Version

The version of MySQL to use. The default is the latest version available.

Allocated Storage

The amount of storage to reserve for the database. The default and minimum is 20 GiB.

Max Allocated Storage

The maximum size in GiB that the database is allowed to autoscale up to. The default is 100 GiB.

Instance Size

The RDS instance size to use. The default is db.t4g.micro. For pricing, see Amazon’s RDS for MySQL pricing.

Network Ingress Rule

What IP address ranges are allowed to access the database.

Choice between either Allow All, Allow from VPC, or Deny All. For databases that are supposed to be accessible to other services in the environment, you will probably want Allow from VPC. Selecting Deny All will disable access to the database entirely. All choices may be overridden by the Advanced: Additional Security Groups parameter.

Use of Allow All is not recommended. To access the database over the internet, you should choose Allow from VPC or Deny All and use the Advanced: Additional Security Groups parameter to add a security group that allows access from specified IP addresses instead.

Advanced: Additional Security Groups

A comma separated list of additional VPC security group IDs to attach to the database. This is useful if you need to add fine-grained access control to your database.

Daily Backup Retention

The number of days to retain backups for. The default is 7 days. Choosing Disabled will disable backups entirely.

Restore from Snapshot ARN

The ARN of a snapshot to restore from. If specified, a new database instance will be created from the snapshot, the new database will be connected to the environment, and the old database will be disconnected. To prevent accidental deletion of data, the old database will not be deleted when restoring via Beaker Studio. You will need to manually delete the old database from your AWS account after verifying that the new database is working correctly.

The connection parameters of the newly restored database will be different from the original. You will need to update your other services after restoring to use the new database credentials.

Note that the MySQL version of the snapshot must match. If you are restoring from a snapshot of an unsupported MySQL version, you will need to create a new database and manually restore from a MySQL dump instead.