Skip to main content

Install Aonnis Valkey Cluster CRD

Custom Resource Definitions (CRDs) enable Kubernetes to extend its capabilities by defining new resource types. The Aonnis Valkey Cluster CRD introduces the ability to manage Valkey clusters natively in Kubernetes.

This guide explains how to download and install the Aonnis Valkey Cluster CRD.

Installation Steps​

1. Download the CRD Definition​

The CRD file is hosted at a publicly accessible URL. Use curl to download it to your local system:

curl https://crd.aonnis.com/valkey/v1/valkeyclusters.aonnis.yaml -o valkeyclusters.aonnis.yaml

The CRD YAML file includes:​

  1. Resource definition for Aonnis Valkey Clusters.
  2. API version, group, and kind.
  3. Schema for validating custom resources.

2. Apply the CRD​

kubectl apply -f valkeyclusters.aonnis.yaml --server-side

a. Why use --server-side?​

  • Ensures the CRD is applied server-side, avoiding client-side validation issues.
  • Handles updates or changes to the CRD more gracefully by deferring schema validation and merge strategies to the server.

b. What happens here?​

  • Kubernetes registers the new CRD (Aonnis Valkey Clusters) and makes it available for use.
  • The Kubernetes API server is updated to recognize and validate custom resources based on this CRD.

3. Verifying the Installation​

1. List CRDs: Check if the CRD is successfully installed:​

kubectl get crds
You should see an entry like this:​
NAME                                        CREATED AT
valkeyclusters.valkeypanther.aonnis.com     2023-01-13T12:00:00Z

2. Describe the CRD: View details about the installed CRD:​

kubectl describe crd valkeyclusters.valkeypanther.aonnis.com

3. Check API Resources: Ensure the new resource type is available:​

kubectl api-resources | grep ValkeyClusters