Skip to content

Latest commit

 

History

History

operator

README.md

pika-operator

pika-operator is a Kubernetes operator for managing Pika.

Description

This operator is responsible for managing the lifecycle of Pika. It is responsible for creating and managing the following resources:

  • StatefulSet
  • Service
  • PersistentVolumeClaim

Getting Started

You’ll need a Kubernetes cluster to run against. You can use MiniKube or KIND to get a local cluster for testing, or run against a remote cluster.

Note: Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster kubectl cluster-info shows).

Running locally with MiniKube

  1. Install MiniKube

  2. Start a local cluster:

make minikube-up # run this if you don't have a minikube cluster
make local-deploy

Or if you want to use a development pika image:

make local-deploy PIKA_IMAGE=<your-pika-image>

If you see some message like the following, it means that the pika-operator is running successfully:

************  TEST PIKA ************
kubectl run pika-minikub-test ...
pika_version:3.4.0
pika_git_sha:bd30511bf82038c2c6531b3d84872c9825fe836a
pika_build_compile_date: Dec  1 2020

Running on the cluster

  1. Install Instances of Custom Resources:
kubectl apply -f config/samples/
  1. Build and push your image to the location specified by IMG:
make docker-build docker-push IMG=<some-registry>/pika-operator:tag
  1. Deploy the controller to the cluster with the image specified by IMG:
make deploy IMG=<some-registry>/pika-operator:tag

Run Pika Instance

  1. Create a Pika instance:
kubectl apply -f examples/pika-sample/
  1. Check the status of the Pika instance:
kubectl get pika pika-sample
  1. Connection to the Pika instance:
kubectl run pika-sample-test --image redis -it --rm --restart=Never \
  -- /usr/local/bin/redis-cli -h pika-sample -p 9221 info

Uninstall CRDs

To delete the CRDs from the cluster:

make uninstall

Undeploy controller

UnDeploy the controller to the cluster:

make undeploy

Contributing

This project is still in its early stages and contributions are welcome. Please feel free to open issues and PRs. Please see this issue to discuss the design of the operator.

How it works

This project aims to follow the Kubernetes Operator pattern

It uses Controllers which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster

Test It Out

  1. Install the CRDs into the cluster:
make install
  1. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):
make run

NOTE: You can also run this in one step by running: make install run

Modifying the API definitions

If you are editing the API definitions, generate the manifests such as CRs or CRDs using:

make manifests

NOTE: Run make --help for more information on all potential make targets

More information can be found via the Kubebuilder Documentation

License

Copyright 2023.

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.