Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 1.34 KB

development.md

File metadata and controls

46 lines (32 loc) · 1.34 KB

Development

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

Install required tools

  1. go 1.19+
  2. git
  3. kubectl
  4. protoc for compiling protocol buffers
  5. Node.js® for running the UI
  6. yarn
  7. 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.24.4-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/.

  • make test Run unit tests.

  • make image Build container 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.

  • make docs Convert the docs to Github pages, check if there's any error.

  • make docs-serve Start an HTTP server on your local to host the docs generated Github pages.