Chainguard Container for vitess-lite

Vitess is a database clustering system for horizontal scaling of MySQL through generalized sharding.

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/vitess-lite:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Usage

To deploy Vitess on Kubernetes, you can use the Vitess Operator for Kubernetes.

For the best experience, please refer to the Vitess Operator Compatibility Matrix to ensure compatibility between your version of Vitess and Kubernetes.

Let's follow the official Operator Example to deploy a Vitess cluster:

1. Install the Operator

kubectl apply -f https://raw.githubusercontent.com/vitessio/vitess/refs/heads/main/examples/operator/operator.yaml

2. Download the VitessCluster resource

curl -sLO https://raw.githubusercontent.com/vitessio/vitess/refs/heads/main/examples/operator/101_initial_cluster.yaml

3. Replace the images with the Chainguard Image

sed -i "s|vitess/lite:v<CURRENT_VITESS_VERSION>|cgr.dev/chainguard/vitess-lite:latest|g" 101_initial_cluster.yaml

4. Apply the resource

kubectl apply -f 101_initial_cluster.yaml

5. Check the status of the cluster

NAME                                                         READY   STATUS    RESTARTS   AGE
example-commerce-x-x-zone1-vtorc-c13ef6ff-5dc567c466-h8xbx   1/1     Running   0          86s
example-etcd-faf13de3-1                                      1/1     Running   0          101s
example-etcd-faf13de3-2                                      1/1     Running   0          106s
example-etcd-faf13de3-3                                      1/1     Running   0          106s
example-vttablet-zone1-2469782763-bfadd780                   3/3     Running   0          86s
example-vttablet-zone1-2548885007-46a852d0                   3/3     Running   0          86s
example-zone1-vtadmin-c03d7eae-6db4c646bc-vmdj6              2/2     Running   0          106s
example-zone1-vtctld-1d4dcad0-5b797d9f9b-7svm9               1/1     Running   0          106s
example-zone1-vtgate-bc6cde92-659bbdbb5d-6xtzh               1/1     Running   0          86s
vitess-operator-68dd5f96-4v5sz                               1/1     Running   0          4h46m

6. Create a sample schema to ensure the cluster is operational

POD_NAME=$(kubectl get pods -l planetscale.com/component=vtctld -o jsonpath="{.items[0].metadata.name}")
SVC_NAME=$(kubectl get svc -l planetscale.com/component=vtctld -o jsonpath="{.items[0].metadata.name}")
VTGATE_SVC_NAME=$(kubectl get svc -l planetscale.com/component=vtgate -o jsonpath="{.items[0].metadata.name}")
kubectl exec -it $POD_NAME -- bash -c "cd /tmp && curl -sLO https://raw.githubusercontent.com/vitessio/vitess/refs/heads/main/examples/operator/create_commerce_schema.sql"
kubectl exec -it $POD_NAME -- bash -c "cd /tmp && curl -sLO https://raw.githubusercontent.com/vitessio/vitess/refs/heads/main/examples/operator/vschema_commerce_initial.json"
kubectl exec -it $POD_NAME -- bash -c "cd /tmp && vtctldclient --server=$SVC_NAME.default.svc.cluster.local:15999 ApplySchema --sql-file="create_commerce_schema.sql" commerce"
kubectl exec -it $POD_NAME -- bash -c "cd /tmp && vtctldclient --server=$SVC_NAME.default.svc.cluster.local:15999 ApplyVSchema --vschema-file="vschema_commerce_initial.json" commerce"
kubectl exec -it $POD_NAME -- bash -c "mysql -h $VTGATE_SVC_NAME.default.svc.cluster.local -P 3306 -u user -e 'SHOW DATABASES;'" | grep "commerce"

Error Logs

While testing the image, we noticed that the following error-severity logs also appear in the official upstream vitess/lite image:

• Config File "vtconfig" Not Found in "[/]".
• can't connect to syslog
• Client received GoAway with error
• Cannot start query service: Unknown database 'vt_commerce'
• unable to connect to tablet
• Error transitioning to the desired state

But eventually, the cluster becomes operational, all Pods are Ready and Running, and the schema is created successfully.

Notes

This image includes percona-server which is bundled with the DBD::Module

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.