Component

core/datastore/mysql

A MySQL relational database. Provider-agnostic: the same component is implemented by Helm Recipes (Workload synthesis to native Kubernetes resources), Terraform Recipes (AWS RDS, Google Cloud SQL), CloudFormation Recipes, and Compose Recipes (local development). On AWS RDS through Terraform, reach for terraform/mysql-rds-terraform-aws-modules, which vendors the terraform-aws-modules project's published RDS module, where the pull may fetch it from its git repository; reach for terraform/mysql-rds, which authors its own body, or terraform/mysql-rds-module, which vendors a module kept beside it, where nothing may be fetched, and for terraform/mysql-rds where read replicas are needed. On Google Cloud SQL, reach for terraform/mysql-cloud-sql, which vendors the terraform-google-modules project's published Cloud SQL module, where the database runs in a Google Cloud project whose VPC network already has private services access to Cloud SQL; the instance gets a private address in that network and no public one. Backup is the core/backup attachment, written in the Release. The managed Recipes configure the service's own automated backups from it, bound to terraform/backup-native or cloudformation/backup-native, and keep them for 7 days with none attached. The Helm Recipe is backed up by the backup product the Manifest binds; the Compose Recipe has none, so an attachment halts there.

Provenance

OfficialSigned by a signing identity this catalog recognizes as an official publisher.
Content digest
sha256:49d95d69b6de38270b656b475ca4603b8fcec72ec84d385336b10094758df983
Published
2026-11-10T10:10:56Z
Signing identity
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

Signature

  • Officialapplication/vnd.dev.sigstore.bundle.v0.3+json

    https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

    sha256:b867a63645b07b98e72f9009350f0bc394c3f4bf27d56bea3427c837ac03068e

Reference at this version

oci://hub.aggrega.ai/component/core/datastore/mysql:1.0.0

Developer parameters

Values the developer sets in the Aggregate.

NameTypeDefaultRequiredDescription
databasestring—yesLogical database name created on startup.
userstring—noApplication-level database user (non-root). Omit for root-only access. RDS creates only its master user, admin, which the RDS Recipes publish as provides.user, so each of them halts the build when this is set; terraform/mysql-cloud-sql creates this user beside root and publishes it, or root where it is unset.
charsetstringutf8mb4noDefault character set. terraform/mysql-rds-terraform-aws-modules sets it in the parameter group it creates, and terraform/mysql-cloud-sql on the database it creates; the other managed Recipes do not read it, and the instance takes its parameter group's.
collationstringutf8mb4_general_cinoDefault collation. terraform/mysql-rds-terraform-aws-modules sets it in the parameter group it creates, and terraform/mysql-cloud-sql on the database it creates; the other managed Recipes do not read it, and the instance takes its parameter group's.
init_scriptsobject—noSQL scripts executed on first database initialization. Each key is a filename, each value is the SQL content. Scripts run in alphabetical key order.
custom_configstring—noRaw server configuration block (my.cnf format). Injected verbatim into the server configuration file.

Operator sizing

Infrastructure sizing the operator tunes per environment.

NameTypeDefaultRequiredDescription
portinteger (min 1024, max 65535)3306noServer listen port. Most operators should omit this and let the Recipe assign the default (3306). Cloud SQL serves MySQL on 3306 alone, so terraform/mysql-cloud-sql halts the build on any other value.
engine_versionstring8.4noServer binary version. Selects the container image tag on container targets and the database engine version on managed targets.
computeobject—no—
storageobject—no—
haobject—no—
overridesobject (open)—noProvider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads.

Output contract

Values this component publishes to consumers over the uses topology.

NameTypeDefaultRequiredDescription
hoststring—yesAddress a client opens its database connection to. On the in-cluster realizations it is the Service's DNS name; on a managed one it is a pointer string the provisioning tool resolves to the instance's address once the infrastructure has been applied, or the DNS name the Release sets in infra.overrides.host, so a consumer on another target receives an address it can resolve.
portinteger—yesTCP port the server accepts connections on. It follows the port an operator set, so a consumer reads it rather than assuming 3306.
userstring—noName of the login role a consumer authenticates as. The matching password arrives through the credential attached to the component, never through this contract.
databasestring—noName of the logical database created at startup. A consumer names it in its connection string to land in the right database rather than the server's default.
protocolstring—noWire protocol the published address speaks — `mysql`, which is what a consumer selects a driver for.

Uses sockets

The dependency sockets this component connects through. The target of every connection wired through a socket must satisfy its label selector, and each connection may carry an attachment in the slots the socket declares. A required slot is owed by each connection the Aggregate or the Release wires through the socket.

No uses sockets declared.

Attachment slots

Named binding points at which a Feature attaches to this component. A slot's selector constrains which Feature may fill it and its inject list names how the Feature's material may be delivered. A required slot must be bound on every instance, by an attachment on the instance or at a scope above it, and a sensitive slot is declared to handle secret material. A Feature may also attach under a name no slot declares.

SlotSelectorRequiredInjectSensitiveDescription
root_password—yes—yesRoot database password. Recipe controls delivery (Black-Box). On the RDS Recipes RDS generates the password of the master user, admin, and keeps it in AWS Secrets Manager, so the slot takes core/generated-secret there, and any other credential halts the build. terraform/mysql-cloud-sql takes core/random-password alone, since Cloud SQL creates root with no password, and halts on any other credential.
user_password—noenv, fileyesApplication user password. Unattached, helm/mysql sets it to the development literal `apppass`, which this catalog publishes, so every Release built with that Recipe that leaves the slot unattached shares that password. The RDS Recipes create only the master user, admin, and halt the build when this slot is filled. terraform/mysql-cloud-sql takes core/random-password here, has the module it sources draw one with nothing attached, and halts on any other credential, or on an attachment while values.user is unset.

Self-inject allowlist

env, file

Relationships

Typed edges to and from other published entities. A reference with no published target renders as a broken edge rather than a link.

Uses

This entity uses nothing in the catalog.

Used by

Component concept reference →

The Aggrega catalog — an open index of components, features, recipes, and the plugins that render them.

Built with the shared Aggrega design system.

Privacy