Skip to content

Add init sidecar mode for k8s operator #622

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bcmmbaga merged 1 commit into from
Feb 18, 2026
Merged

Add init sidecar mode for k8s operator #622

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions src/pages/manage/integrations/kubernetes/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,35 @@ spec:
...
```

### Init Sidecar Mode
By default, the NetBird container is injected as a regular sidecar container. For workloads like Jobs and CronJobs where the pod
should terminate after the main container completes, you can use init sidecar mode. This injects NetBird as an init container
with `restartPolicy: Always`.

To enable init sidecar mode, add the following annotation:

```yaml
netbird.io/init-sidecar: "true"
```

Below is an example of a Job using init sidecar mode:

```yaml
kind: Job
...
spec:
...
template:
metadata:
annotations:
netbird.io/setup-key: app-setup-key # Must match the name of an NBSetupKey object in the same namespace
netbird.io/init-sidecar: "true"
...
spec:
containers:
...
```

### Using Extra Labels to Access Multiple Pods Using the Same Name
Starting with `v0.27.0`, NetBird supports extra DNS labels, allowing you to define extended DNS names for peers. This enables grouping peers under a shared DNS name and distributing traffic using DNS round-robin load balancing.

Expand Down