aerospike / aerospike-kubernetes-operator

Aerospike Kubernetes Operator Overview The Aerospike Kubernetes Operator automates the deployment and management of **Aerospike enterprise clusters** on Kubernetes. The Operator provides a controller that manages a Custom Resource Definition (CRD) to extend the Kubernetes API for Aerospike Enterprise clusters. Aerospike cluster deployment and life cycle management are performed by updating an Aerospike cluster Custom Resource (CR). Documentation For full documentation, please visit the **official documentation.** What features does it provide? The goal of the Operator is to give you the ability to deploy multi-node Aerospike clusters, recover automatically from node failures, scale up or down automatically as load changes, ensure nodes are evenly split across racks or zones, automatically update to new versions of Aerospike and manage configuration changes in your clusters. The Operator supports the following capabilities: • Deploy Aerospike clusters • Scale up and down existing Aerospike clusters • Version upgrade and downgrade • Configure persistent storage and resource allocation • Standardize and validate configurations • Cluster security management • Aerospike cluster monitoring • Backup and restore Aerospike clusters Building and quick start Generate CRD manifests Build and push operator image Run the following command with the appropriate name and version for the operator's image. **Note**: Change var as per host machine or remove it to build multi-arch image Developer testing You can use the following for quickly trying out the operator without using OLM. Deploy Make sure cert-manager is deployed on your Kubernetes cluster using instructions here. To deploy the operator build in the previous step run Undeploy To undeploy run **Note**: This will also delete the deployed Aerospike clusters because the CRD definitions and all operator related objects are deleted. Operator Lifecycle Manager (OLM) integration bundle Operator Lifecycle Manager (OLM) is a tool to help manage the Operators running on your cluster. This is the preferred way to manage Kubernetes operators in production. This section describes how to generate the OLM bundle and run the operator using OLM. Install operator-sdk Install operator-sdk version 1.41.1 using the installation guide Build the bundle Make sure the operator's image has also been pushed. Set up the environment with image names. Create the bundle Build bundle image and publish Deploy operator with OLM Install OLM if not already done Create **aerospike** namespace if it does not exist Deploy the operator targeting a single namespace Run the operator bundle Deploy the operator targeting multiple namespaces Assuming you want the operator to target two other namespaces ns1 and ns2, deploy the operator with MultiNamespace install mode. Deploy your Aerospike clusters Deploy Aerospike clusters using the Operator documentation here. Undeploy operator with OLM Running tests The operator tests require the following prerequisites • A running Kubernetes cluster with at least 3 nodes with at least 12 CPUs • A storage class named "ssd" that allows provisioning of filesystem and block devices • The command configured to use the above cluster • OLM bundle image created with as described here • No production services should be running on this cluster - including the operator or production Aerospike clusters The operator tests create and use 4 namespaces • test • test1 • test2 • aerospike Run the entire test suite Run tests matching a regex Architecture The Aerospike Kubernetes Operator has a custom controller (written in go) that allows us to embed specific lifecycle management logic to effectively manage the state of an Aerospike cluster. It does so by managing a Custom Resource Definition (CRD) to extend the Kubernetes API for Aerospike clusters. Regular maintenance to the Aerospike cluster deployment and management can be performed by updating an Aerospike cluster Custom Resource (CR). The Operator is deployed with StatefulSet and operates as a headless service to handle the DNS resolution of pods in the deployment. Kubernetes StatefulSets is the workload API object that is used to manage stateful applications. It is important because it manages the deployment and scaling of a set of Pods, and provides guarantees about the ordering and uniqueness of these Pods (e.g. as unique addressable identities). A layered approach is taken to orchestration which allows the Operator to manage Aerospike Cluster tasks outside the Aerospike deployment. See also • Kubernetes