mirror of
https://github.com/YuzuZensai/netbird-kubernetes-operator.git
synced 2026-09-13 18:59:09 +00:00
Philip LaineandGitHub
dd054d50ec
This updates the documentation and examples to use the new resources. It also adds automatic documentation creation for the api reference. Signed-off-by: Philip Laine <philip.laine@gmail.com>
43 lines
892 B
Markdown
43 lines
892 B
Markdown
# 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
|
|
```
|