Skip to main content
Version: v0.14 🚧

mysql

Module MySQL

MySQL describes the attributes to locally deploy or create a cloud provider managed mysql database instance for the workload.

Attributes

Name and DescriptionTypeDefault ValueRequired
cloud
Cloud specifies the type of the cloud vendor.
"aws" | "alicloud"Undefinedrequired
username
Username specifies the operation account for the mysql database.
str"root"optional
category
Category specifies the edition of the mysql instance provided by the cloud vendor.
str"Basic"optional
securityIPs
SecurityIPs specifies the list of IP addresses allowed to access the mysql instance provided by the cloud vendor.
[str]["0.0.0.0/0"]optional
privateRouting
PrivateRouting specifies whether the host address of the cloud mysql instance for the workload to connect with is via public network or private network of the cloud vendor.
booltrueoptional
size
Size specifies the allocated storage size of the mysql instance.
int10optional
subnetID
SubnetID specifies the virtual subnet ID associated with the VPC that the cloud mysql instance will be created in.
strUndefinedoptional
databaseName
databaseName specifies the database name.
strUndefinedoptional

Examples

# MySQL workspace configs for AWS RDS
modules:
mysql:
path: oci://ghcr.io/kusionstack/mysql
version: 0.2.0
configs:
default:
cloud: aws
size: 20
instanceType: db.t3.micro
privateRouting: false
databaseName: "my-mysql"
# MySQL workspace configs for Alicloud RDS
modules:
mysql:
path: oci://ghcr.io/kusionstack/mysql
version: 0.2.0
configs:
default:
cloud: alicloud
size: 20
instanceType: mysql.n2.serverless.1c
category: serverless_basic
privateRouting: false
subnetID: [your-subnet-id]
databaseName: "my-mysql"