Skip to content

Add documentation for running the operator locally for development #19

@mustela

Description

@mustela

It would be helpful to have clear documentation on how to run the network-services-operator locally during development. While the existing codebase is structured and follows typical operator patterns, having a step-by-step guide for local development would streamline onboarding for new contributors and make day-to-day development more efficient.

What would be useful:

  • A guide for running the operator locally, either directly using kubebuilder (make run) or via a local Kubernetes cluster setup.
  • Clarification on whether a cluster (e.g., kind, minikube, k3d) is required, or if there’s a way to mock parts of the environment.
  • Notes on any prerequisites (e.g., kubectl, go, make, Docker), including version expectations.
  • Overview of deploying CRDs and any permissions/RBAC considerations for local testing.
  • Tips for iterating quickly during development (e.g., hot reload, test tooling, etc.).

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

Status

Todo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions