Update documentation with refactored resources (#204)

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>
This commit is contained in:
Philip Laine
2026-04-24 16:22:04 +02:00
committed by GitHub
parent fe715ae40c
commit dd054d50ec
19 changed files with 642 additions and 464 deletions
-55
View File
@@ -1,55 +0,0 @@
apiVersion: v1
kind: Secret
metadata:
name: test
namespace: default
stringData:
SETUP_KEY: 50445ABC-8901-4050-8047-0A390658A79B # Replace with valid setup key
---
apiVersion: netbird.io/v1
kind: NBSetupKey
metadata:
name: test
namespace: default
spec:
secretKeyRef:
name: test
key: SETUP_KEY
---
apiVersion: batch/v1
kind: Job
metadata:
name: job
spec:
template:
metadata:
annotations:
netbird.io/setup-key: test
netbird.io/init-sidecar: "true"
spec:
containers:
- name: worker
image: curlimages/curl:latest
command: ["sh", "-c", "curl -s https://example.com && echo done && sleep 60"]
restartPolicy: Never
backoffLimit: 3
---
apiVersion: batch/v1
kind: CronJob
metadata:
name: cronjob
spec:
schedule: "*/30 * * * *"
jobTemplate:
spec:
template:
metadata:
annotations:
netbird.io/setup-key: test
netbird.io/init-sidecar: "true"
spec:
containers:
- name: worker
image: curlimages/curl:latest
command: ["sh", "-c", "curl -s https://example.com && echo done"]
restartPolicy: Never
+12
View File
@@ -0,0 +1,12 @@
apiVersion: v1
kind: Pod
metadata:
name: ubuntu
namespace: default
labels:
app: ubuntu
spec:
containers:
- name: ubuntu
image: ubuntu:latest
command: ["sleep", "infinity"]
+20
View File
@@ -0,0 +1,20 @@
apiVersion: netbird.io/v1alpha1
kind: SetupKey
metadata:
name: sidecar
namespace: default
spec:
name: sidecar
ephemeral: true
---
apiVersion: netbird.io/v1alpha1
kind: SidecarProfile
metadata:
name: test
namespace: default
spec:
setupKeyRef:
name: sidecar
podSelector:
matchLabels:
app: ubuntu