netbird-kubernetes-operator/README.md

# NetBird Kubernetes Operator

The NetBird Kubernetes Operator automates the provisioning of NetBird network access for services running in your cluster.

## Documentation

- [Getting Started](/docs/getting-started.md)
- [Usage](/docs/usage.md)
- [API Reference](/docs/api-reference.md)

## How It Works

A `NetworkRouter` registers a NetBird router peer for a given DNS zone in your cluster.

```yaml
apiVersion: netbird.io/v1alpha1
kind: NetworkRouter
metadata:
  name: prod
  namespace: netbird
spec:
  dnsZoneRef:
    name: prod.company.internal
```

A `NetworkResource` then exposes a Kubernetes service through that router to one or more NetBird groups.

```yaml
apiVersion: netbird.io/v1alpha1
kind: NetworkResource
metadata:
  name: nginx
  namespace: default
spec:
  networkRouterRef:
    name: prod
    namespace: netbird
  serviceRef:
    name: nginx
  groups:
    - name: All
```