Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 1.15 KB

DEVELOPMENT.md

File metadata and controls

38 lines (26 loc) · 1.15 KB

Development

This doc explains how to set up a development environment for NumaFlow.

Install required tools

  1. go: 1.17+.
  2. git: For source control.
  3. kubectl: For managing development environments.
  4. protoc: For compiling protocol buffers.
  5. k3d for local development, if needed

Create a k8s cluster with k3d if needed

# Create a cluster with default name k3s-default
k3d cluster create -i rancher/k3s:v1.21.7-k3s1

# Get kubeconfig for the cluster
k3d kubeconfig get k3s-default

Useful Commands

  • make build Binaries are placed in ./dist.

  • make codegen Run after making changes to ./pkg/api/ Can we add a Makefile rule to do this automatically?

  • make test Run unit tests.

  • make image Build conatiner image, and import it to k3d cluster if corresponding kubeconfig is sourced.

  • make start Build the source code, image, and install the Numa controller in the numaflow-system namespace.