yazio-challenge

This repository holds the code for an operator responsible of managing a Redis single-master deployment, following the challenge proposed features:

• Manage Redis instances
• CRD Definition (Which can be found here )
• Random password generation
• Secret management
• Redis deployment (Turned statefulsets due to the application's nature)
• Update and delete operations
• Documentation (This file will contain all required information or links to it)
• (Bonus) Basic tests
• (Bonus) Health watch mechanism/self healing capacity

Example redis manifest

apiVersion: cache.yazio.com/v1alpha1
kind: Redis
metadata:
  name: redis-sample
spec:
   replicas: 3 # Replicas will be the amount of replicas of the master, in this case we would have 1 master and 3 replicas in our deployment, master's amount is always 1
   version: "7.4.1" # Redis version to deploy, this will map directly to the image tag for bitnami/redis, so far only version 7.4.1 was tested, beware that using other versions might not be compatible with the configurations this operator provides to redis 
   volumeStorage: 2Gi # Storage for the /data volumes mounted into all redis instances, being equal for master and replicas

Getting Started

Prerequisites

• go version v1.22.0+
• docker version 17.03+.
• kubectl version v1.11.3+.
• Access to a Kubernetes v1.11.3+ cluster. (kind is recommended for local testing, as it was used for development)

Deployment steps

Knowing our kubectl context is pointing to the cluster we want to deploy the operator to:

Deployment using installer without cloning the repository

kubectl apply -f https://raw.githubusercontent.com/tomp21/yazio-challenge/main/dist/install.yaml

Deployment manually creating operator components

Install the CRDs into the cluster:

make install

Deploy the Manager to the cluster with the image specified by IMG:

make deploy IMG=ghcr.io/tomp21/yazio-challenge:main

And you will be ready to go!

NOTE: If you encounter RBAC errors, you may need to grant yourself cluster-admin privileges or be logged in as admin.

Delete the APIs(CRDs) from the cluster:

make uninstall

UnDeploy the controller from the cluster:

make undeploy

Creating a sample Redis instance

You can apply the sample the config/sample:

kubectl apply -k config/samples/cache_v1alpha1_redis.yaml

To Uninstall

Delete the instances (CRs) from the cluster:

kubectl delete -k config/samples/cache_v1alpha1_redis.yaml

If you renamed the resource after creation, you will need to delete it referncing its new name:

kubectl delete redis <whichever name you set to it>

Development workflow

While developing

In order to make it easier to iterate locally, a make target has been added

make kind-refresh

This target will rebuild the docker image, load it into the default kind cluster, regenerate the manifests, deploy them and manually delete the preexisting controller pod (this last step was not strictly necessary)

Running tests

EnvTest needs to be set up in order for our tests to have the binaries it will be using After EnvTest is set up and runnning appropiately, make test will run the test suites

Project Distribution

Following are the steps to build the installer and distribute this project to users.

1. Build the installer for the image built and published in the registry:

make build-installer IMG=ghcr.io/tomp21/yazio-challenge:main

NOTE: The makefile target mentioned above generates an 'install.yaml' file in the dist directory. This file contains all the resources built with Kustomize, which are necessary to install this project without its dependencies.

License

Copyright 2024.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.