Component

core/datastore/mysql-innodb-cluster

A MySQL InnoDB Cluster, realized as an InnoDBCluster custom resource the MySQL Operator for Kubernetes reconciles. The emitted custom resource requests a count of MySQL server instances and a count of MySQL Router instances, and the controller acts on that request inside the target cluster — so what this component describes is what is asked for, never what ends up running. What it publishes is root access at an in-cluster address: the controller establishes the root account from the Secret the custom resource names, and creates neither a logical database nor an application user, so this component declares neither and whoever holds root creates the schemas and accounts an application needs. Reach for core/datastore/mysql where the application wants a logical database and a login role created for it, and where nothing may need installing first — its synthesized Recipe needs no controller and no chart repository, so it builds with nothing fetched. Reach for this component where the MySQL Operator control plane is already installed in the target cluster, which core/datastore/mysql-operator declares and installs.

Provenance

OfficialSigned by a signing identity this catalog recognizes as an official publisher.
Content digest
sha256:85ffc765ede3cd63d1f0a5901c86693301410d33d51c6967c3574f7092a2bdca
Published
2026-11-10T10:10:52Z
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:0f1da829095d0aad0c4c536b78c703b16cf839fffc27fa011e6b3b5c71609f65

Reference at this version

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

Developer parameters

Values the developer sets in the Aggregate.

NameTypeDefaultRequiredDescription
charsetstringutf8mb4noDefault character set. Written into the server configuration the custom resource carries.
collationstringutf8mb4_general_cinoDefault collation. Written into the server configuration the custom resource carries.
custom_configstring—noRaw server configuration block (my.cnf format). Appended verbatim to the server configuration the custom resource carries.

Operator sizing

Infrastructure sizing the operator tunes per environment.

NameTypeDefaultRequiredDescription
engine_versionstring8.4.0noMySQL Server version the custom resource requests. The custom resource accepts a three-part version — major, minor and patch, optionally followed by a suffix — so a two-part value renders and is then rejected when the resource is applied. A build halts on a value the custom resource would reject.
server_instancesinteger (min 1, max 9)1noNumber of MySQL server instances the custom resource requests. One is the custom resource's own default and nine is the highest it accepts.
router_instancesinteger (min 1)1noNumber of MySQL Router instances the custom resource requests. One is the custom resource's own default. The published address is the Service the routers answer on, so this component does not offer a request of zero: an address nothing answers on would render as cleanly as one that works.
control_plane_presentbooleanfalsenoOperator affirmation that the MySQL Operator control plane is installed in the target cluster. The build halts unless this is set true, so an InnoDBCluster custom resource is never emitted as an orphan into a cluster that cannot reconcile it.
credentialsstring (generated | supplied)suppliednoWho owns the Secret holding the cluster's root account — the Secret the custom resource names and the controller reads. `supplied` — the Secret already exists in the target cluster and is named in `credentials_secret`; nothing is rendered for it and no password reaches the rendered artifact. `generated` — the Secret is rendered beside the custom resource from the credential attached to the `root_password` slot, so the password is carried in the rendered output. `supplied` is the default because the controller establishes the root account from a Secret it is pointed at and creates none of its own.
credentials_secretstringnoName of the existing Secret the controller reads the root account from when `credentials` is `supplied`. The Secret lives in the same namespace as the cluster and carries the account's user name, host and password under the keys `rootUser`, `rootHost` and `rootPassword`. Leave it empty when `credentials` is `generated`; a build halts if `supplied` is selected without it.

Output contract

Values this component publishes to consumers over the uses topology.

NameTypeDefaultRequiredDescription
hoststring—yesAddress a client opens its database connection to. The controller creates a Service under the custom resource's own name, and that bare in-cluster name is what is published; a consumer in another namespace qualifies it with that namespace on its own side.
portinteger—yesTCP port the published address accepts connections on. The custom resource carries no field that moves it, so it is the port the controller publishes by 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—no—yesRoot account password. Read when `infra.credentials` is `generated`, to fill the Secret the custom resource names. Leave it unattached when the Secret is supplied.

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