MySQL Operator for Kubernetes

The MySQL Operator for Kubernetes is designed to manage the full lifecycle of MySQL InnoDB Cluster setups within a Kubernetes cluster. It automates key operational tasks including:

• Initial setup of InnoDB Clusters
• Ongoing maintenance
• Automated upgrades
• Automated backups

The Enterprise Backup (MEB) logic is isolated and designed to be injected into the operator's workflow via a ConfigMap. When using MEB features, the logic is mounted into a Server container. Because of this deployment model, you must adhere to the following constraints:

1. Dependency Constraint: The logic can only utilize Python dependencies that are already available within the Server container.
2. Directory Structure Constraint: The logic must reside in a single, flat directory. The use of subdirectories is not supported.

The TLS Validation Proxy acts as a transparent TCP proxy. It does not perform TLS termination. Instead, it inspects the client's TLS hello package to identify offered ciphers and validates them against a list of allowed ciphers.

Because it does not terminate TLS, the certificate used by the actual destination server must be valid for the host the proxy is running on. When used with the MySQL Operator, the proxy is typically run in the same Pod as the operator, and the operator is configured to connect to 127.0.0.1, which is commonly included in server certificates.

To deploy an InnoDB Cluster via kubectl, follow these steps:

1. Create a credentials secret: Create a generic secret containing rootUser, rootHost, and rootPassword for administrative tasks.
2. Define the InnoDBCluster resource: Create a YAML manifest of kind InnoDBCluster (API version mysql.oracle.com/v2) that references your secret.
3. Apply the manifest: Use kubectl apply to trigger the operator to provision the cluster.

The cluster will transition from PENDING to ONLINE status.

# 1. Create secret
$> kubectl create secret generic mypwds \
        --from-literal=rootUser=root \
        --from-literal=rootHost=% \
        --from-literal=rootPassword="sakila"

# 2. Apply InnoDBCluster manifest (mycluster.yaml)
$> kubectl apply -f mycluster.yaml

# 3. Monitor status
$> kubectl get innodbcluster --watch

You can deploy an InnoDB Cluster using the mysql-operator/mysql-innodbcluster Helm chart. You can either use all defaults or provide custom configurations via --set flags.

Common customization options include:

• credentials.root.user
• credentials.root.password
• credentials.root.host
• serverInstances
• routerInstances

# Install with defaults
$> helm install mycluster mysql-operator/mysql-innodbcluster

# Install with custom configuration
$> helm install mycluster mysql-operator/mysql-innodbcluster \
        --namespace mynamespace \
        --create-namespace \
        --set credentials.root.user='root' \
        --set credentials.root.password='supersecret' \
        --set credentials.root.host='%' \
        --set serverInstances=3 \
        --set routerInstances=1

Before installing the MySQL Operator for Kubernetes, ensure your environment meets the following requirements:

• Kubernetes version 1.21 or higher
• Helm version 3 or higher

To install the MySQL Operator for Kubernetes, you must first add and update the official Helm repository, then deploy the operator using helm install. This installation deploys the latest version from DockerHub using default settings. You can customize the deployment using Helm options to override these defaults.

Pre-requisites

• Kubernetes 1.21+
• Helm v3

# Add and update the Helm repository
helm repo add mysql-operator https://mysql.github.io/mysql-operator/
helm repo update

# Deploy the operator into the 'mysql-operator' namespace
helm install mysql-operator mysql-operator/mysql-operator --namespace mysql-operator --create-namespace

To install the operator using manifest files, first apply the Custom Resource Definitions (CRDs) and then deploy the operator itself.

1. Deploy CRDs: kubectl apply -f https://raw.githubusercontent.com/mysql/mysql-operator/26.7.0-2.3.0/deploy/deploy-crds.yaml
2. Deploy the operator: kubectl apply -f https://raw.githubusercontent.com/mysql/mysql-operator/26.7.0-2.3.0/deploy/deploy-operator.yaml

Verify the installation by checking the deployment in the mysql-operator namespace.

$> kubectl apply -f https://raw.githubusercontent.com/mysql/mysql-operator/26.7.0-2.3.0/deploy/deploy-crds.yaml
$> kubectl apply -f https://raw.githubusercontent.com/mysql/mysql-operator/26.7.0-2.3.0/deploy/deploy-operator.yaml
$> kubectl get deployment -n mysql-operator mysql-operator

You can use Helm to manage the operator installation. This method allows for customization via Helm options.

1. Add and update the MySQL Operator Helm repository.
2. Install the operator into the mysql-operator namespace.

Note on Topology: In this release, operator topology is frozen after the initial startup. You must choose deployment.namespaces and deployment.standalone upfront. Changing these after bootstrap requires a full removal and reinstallation of the operator.

$> helm repo add mysql-operator https://mysql.github.io/mysql-operator/
$> helm repo update
$> helm install mysql-operator mysql-operator/mysql-operator --namespace mysql-operator --create-namespace