Skip to content

Latest commit

 

History

History
150 lines (103 loc) · 4.06 KB

development.md

File metadata and controls

150 lines (103 loc) · 4.06 KB

Development Guide

This document is a guide to start developing the Kvrocks operator.

Set up the development environment

We recommend you use a Linux/macOS platform for development.

Install Required Software

  • Go

    • Currently, building the Kvrocks operator requires Go 1.19 or later.

  • Docker

  • Kubernetes cluster

    • You can use the minikube to provision your local Kubernetes cluster

Start debugging

Before getting started, please run the following commands to perform some checks:

Check the Kubernetes cluster

kubectl version --short

Install the local manifests

The local manifests contain the CRD, run the following command to install it:

make install

Expected output:

$ kubectl get crds
NAME                           CREATED AT
kvrocks.kvrocks.apache.org            2023-04-22T06:23:33Z

Run the operator locally

  1. Install OpenKruise
helm repo add openkruise https://openkruise.github.io/charts/
helm repo update
helm install kruise openkruise/kruise --version 1.4.0
  1. Run the operator
make run

Now stop the process and we're ready for debugging.

Debugging in VSCode & Local Debugging with Telepresence

Telepresence is an open-source tool that allows you to access services in a Kubernets cluster as if you were in a local environment.

Note: You can refer the Telepresence github for more detail.

  1. To install Telepresence, run the following command or refer to the official installation guide
# 1. Download the latest binary (~50 MB):
sudo curl -fL https://app.getambassador.io/download/tel2/linux/amd64/latest/telepresence -o /usr/local/bin/telepresence

# 2. Make the binary executable:
sudo chmod a+x /usr/local/bin/telepresence
  1. Then run the following command to set up traffic manager:
telepresence helm install
  1. Now run the following command to connect the cluster:
telepresence connect
  1. Debug the operator with your favorite IDE. And we provide the VSCode launch configuration for debugging.

Debugging in VSCode requires a launch configuration, you can use the following configuration:

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Kvrocks Operator",
            "type": "go",
            "request": "launch",
            "mode": "auto",
            "program": "${workspaceFolder}/main.go",
            "args": [],
            "env": {
                "NO_PROXY": "kubernetes.docker.internal,127.0.0.1,localhost"
            },
        }
    ]
}

Now start debugging by clicking the menu [Run > Start Debugging] or pressing F5. The following is a list of significant functions/methods/files that might be useful as breakpoints:

  • main() main.go, the entry point of the Kvrocks operator
  • KVRocksReconciler.Reconcile() pkg/controller/kvrocks_controller.go, the core function of the Kvrocks operator
  1. After debugging, run the following command to clean up the traffic manager:
telepresence quit # disconnect from the cluster

telepresence quit -ur # stop telepresence's daemon processes

Building the Kvrocks operator

To build a binary of the Kvrocks operator, run the following command.

make build

The binary would be generated in the bin directory

To build a Docker/OCI-compatible image of the Kvrocks operator, run the following command:

# build image with tag "kvrocks.apache.org/rockslabs/kvrocks-operator:latest"
make docker-build

# build image with tag "rockslabs/kvrocks-operator:latest"
REGISTRY=rockslabs make docker-build

# build image with tag "kvrocks.apache.org/rockslabs/kvrocks-operator:nightly"
TAG=nightly make docker-build