Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

Common Issues

No NodeOverlays Created

Symptom: Veneer is running but no NodeOverlays appear.

Check data availability:

# Check if Lumina data is available
kubectl port-forward -n veneer-system svc/veneer-metrics 8080:8080
curl -s http://localhost:8080/metrics | grep veneer_lumina_data_available
# Expected: veneer_lumina_data_available 1

If veneer_lumina_data_available is 0:

Verify Lumina is running: kubectl get pods -n lumina-system
Verify Prometheus is scraping Lumina: check Prometheus targets UI
Verify the Prometheus URL is correct in Veneer’s configuration

Check utilization threshold:

Development

Mon, 01 Jan 0001 00:00:00 +0000

Prerequisites

Required Tools

make: Build automation (usually pre-installed on macOS/Linux)
curl: For downloading Go (usually pre-installed)
kubectl: Kubernetes CLI configured with access to a cluster
git: Version control

Go is installed automatically by make targets – no manual installation required.

Optional Tools

kind: For local Kubernetes testing
golangci-lint: For full linting (currently disabled due to Go 1.24 compatibility)

Quick Start

# Clone the repository
git clone https://github.com/Nextdoor/veneer.git
cd veneer

# Build (automatically installs Go and downloads dependencies)
make build

# Run tests
make test

The first run of make build or make test will:

Documentation on Veneer