-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.xml
More file actions
753 lines (747 loc) · 65 KB
/
Copy pathindex.xml
File metadata and controls
753 lines (747 loc) · 65 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Home on</title><link>https://openperouter.github.io/</link><description>Recent content in Home on</description><generator>Hugo</generator><language>en-us</language><lastBuildDate>Thu, 07 May 2026 09:00:00 +0200</lastBuildDate><atom:link href="https://openperouter.github.io/index.xml" rel="self" type="application/rss+xml"/><item><title>The development environment</title><link>https://openperouter.github.io/docs/contributing/devenv/</link><pubDate>Sun, 15 Jun 2025 15:03:22 +0200</pubDate><guid>https://openperouter.github.io/docs/contributing/devenv/</guid><description><p>In order to test and experiment with OpenPERouter, a
<a href="https://containerlab.dev/">containerlab</a> and
<a href="https://kind.sigs.k8s.io/">kind</a> based environment is available.</p>
<p>To start it, run</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>make deploy
</span></span></code></pre></div><p>The topology of the environment is as follows:</p>
<p><img src="https://openperouter.github.io/images/openpedevenv.svg" alt="" /></p>
<p>With:</p>
<ul>
<li>Two kind nodes connected to two leaves (leafkind1 and leafkind2),
running OpenPERouter</li>
<li>A spine container</li>
<li>Two EVPN enabled leaves, leafA and leafB</li>
<li>An SRv6 enabled leaf, leafSRV6, with IS-IS and SRv6 capabilities</li>
<li>For each EVPN leaf, two hosts connected to two different VRFs (red and
blue)</li>
<li>For the SRv6 leaf, two hosts (hostSRV6_red and hostSRV6_blue) connected
to two different VRFs (red and blue)</li>
<li>One host connected to the default VRF of leafA</li>
</ul>
<p>By default, the two VRFs are exposed as type 5 EVPN (VNI 100 and 200)
from leafA and leafB, and as SRv6 L3VPN from leafSRV6, to the rest of
the fabric.</p></description></item><item><title>Code of Conduct</title><link>https://openperouter.github.io/docs/contributing/code-of-conduct/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://openperouter.github.io/docs/contributing/code-of-conduct/</guid><description><h2 id="our-pledge">
Our Pledge
<a class="anchor" href="#our-pledge">#</a>
</h2>
<p>In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.</p>
<h2 id="our-standards">
Our Standards
<a class="anchor" href="#our-standards">#</a>
</h2>
<p>Examples of behavior that contributes to creating a positive environment
include:</p></description></item><item><title>AI Guidelines</title><link>https://openperouter.github.io/docs/contributing/ai-guidelines/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://openperouter.github.io/docs/contributing/ai-guidelines/</guid><description><h2 id="use-of-ai">
Use of AI
<a class="anchor" href="#use-of-ai">#</a>
</h2>
<p>Contributors are welcome to use AI tools (LLMs, code assistants, etc.) when
working on OpenPERouter.</p>
<h2 id="authorship-and-sign-off">
Authorship and Sign-off
<a class="anchor" href="#authorship-and-sign-off">#</a>
</h2>
<p>Every commit must carry a valid <code>Signed-off-by</code> line from a human author.
AI agents must not be listed as the commit author or sign off on commits.</p>
<p>Using AI tools does not exempt contributors from the
<a href="https://github.com/openperouter/openperouter/blob/main/DCO">Developer Certificate of Origin (DCO)</a>.
You must still certify that you have the right to submit the contribution.</p></description></item><item><title>EVPN - VXLan</title><link>https://openperouter.github.io/docs/concepts/evpn/</link><pubDate>Sun, 15 Jun 2025 15:03:22 +0200</pubDate><guid>https://openperouter.github.io/docs/concepts/evpn/</guid><description><p>OpenPERouter implements EVPN (Ethernet VPN) over VXLAN to provide scalable overlay networking. EVPN serves as the control plane protocol that enables the distribution of MAC and IP reachability information across the network fabric, while VXLAN provides the data plane encapsulation for overlay traffic.</p>
<p>The solution supports two main overlay types:</p>
<ul>
<li>
<p><strong>L3VNI (Layer 3 Virtual Network Identifier)</strong>: Creates routed overlay networks where IP connectivity is extended across the fabric. Each L3VNI corresponds to a VRF (Virtual Routing and Forwarding) instance that maintains separate routing tables and enables IP-based communication between endpoints.</p></description></item><item><title>MetalLB Integration</title><link>https://openperouter.github.io/docs/examples/evpnexamples/metallb/</link><pubDate>Sun, 15 Jun 2025 15:03:22 +0200</pubDate><guid>https://openperouter.github.io/docs/examples/evpnexamples/metallb/</guid><description><p>This example demonstrates how to integrate OpenPERouter with MetalLB to advertise LoadBalancer services across the EVPN fabric, enabling external access to Kubernetes services.</p>
<h2 id="overview">
Overview
<a class="anchor" href="#overview">#</a>
</h2>
<p>MetalLB provides load balancing for Kubernetes services by advertising service IPs via BGP. When integrated with OpenPERouter, these BGP routes are automatically converted to EVPN Type 5 routes, making the services reachable across the entire fabric.</p>
<h3 id="example-setup">
Example Setup
<a class="anchor" href="#example-setup">#</a>
</h3>
<p>The full example can be found in the <a href="https://github.com/openperouter/openperouter/examples/evpn/metallb">project repository</a> and can be deployed by running</p></description></item><item><title>MetalLB Integration</title><link>https://openperouter.github.io/docs/examples/passthroughexamples/metallb/</link><pubDate>Sun, 15 Jun 2025 15:03:22 +0200</pubDate><guid>https://openperouter.github.io/docs/examples/passthroughexamples/metallb/</guid><description><p>This example demonstrates how to integrate OpenPERouter with MetalLB in passthrough mode to advertise LoadBalancer services across the fabric, enabling external access to Kubernetes services.</p>
<h2 id="overview">
Overview
<a class="anchor" href="#overview">#</a>
</h2>
<p>MetalLB provides load balancing for Kubernetes services by advertising service IPs via BGP. When integrated with OpenPERouter in passthrough mode, these BGP routes are directly advertised to the fabric without EVPN encapsulation, providing a simpler networking model for basic connectivity scenarios.</p>
<h3 id="example-setup">
Example Setup
<a class="anchor" href="#example-setup">#</a>
</h3>
<p>The full example can be found in the <a href="https://github.com/openperouter/openperouter/examples/passthrough/metallb">project repository</a> and can be deployed by running</p></description></item><item><title>MetalLB Integration</title><link>https://openperouter.github.io/docs/examples/srv6examples/metallb/</link><pubDate>Sun, 15 Jun 2025 15:03:22 +0200</pubDate><guid>https://openperouter.github.io/docs/examples/srv6examples/metallb/</guid><description><p>This example demonstrates how to integrate OpenPERouter with MetalLB to
advertise LoadBalancer services across the SRv6 L3VPN fabric, enabling
external access to Kubernetes services.</p>
<h2 id="overview">
Overview
<a class="anchor" href="#overview">#</a>
</h2>
<p>MetalLB provides load balancing for Kubernetes services by advertising
service IPs via BGP. When integrated with OpenPERouter, these BGP routes
are automatically redistributed into the SRv6 L3VPN, making the services
reachable across the entire fabric.</p>
<h3 id="example-setup">
Example Setup
<a class="anchor" href="#example-setup">#</a>
</h3>
<p>The full example can be found in the
<a href="https://github.com/openperouter/openperouter/examples/l3vpn/metallb">project repository</a>
and can be deployed by running</p></description></item><item><title>Systemd Mode</title><link>https://openperouter.github.io/docs/installation/systemd-mode/</link><pubDate>Sun, 15 Jun 2025 15:03:22 +0200</pubDate><guid>https://openperouter.github.io/docs/installation/systemd-mode/</guid><description><p>OpenPERouter can run outside of Kubernetes as a systemd service using Podman Quadlets. This allows OpenPERouter to start at boot time and establish overlay network connectivity before the Kubernetes cluster is up. The overlay provided by OpenPERouter can then serve as the foundation for all node network connectivity, including the network used by Kubernetes itself.</p>
<h2 id="prerequisites">
Prerequisites
<a class="anchor" href="#prerequisites">#</a>
</h2>
<ul>
<li>Podman</li>
<li>systemd</li>
</ul>
<h2 id="setup">
Setup
<a class="anchor" href="#setup">#</a>
</h2>
<p>Deploy the Quadlet unit files to <code>/etc/containers/systemd/</code> and start the service:</p></description></item><item><title>SRv6 - L3VPN</title><link>https://openperouter.github.io/docs/concepts/srv6/</link><pubDate>Sun, 15 Jun 2025 15:03:22 +0200</pubDate><guid>https://openperouter.github.io/docs/concepts/srv6/</guid><description><p>OpenPERouter implements SRv6 (Segment Routing over IPv6) L3VPN to provide
scalable overlay networking. BGP VPNv4/VPNv6 serves as the control plane
protocol that enables the distribution of IP reachability information across
the network fabric, while SRv6 provides the data plane encapsulation for L3
overlay traffic. IS-IS is used as the IGP for underlay reachability.</p>
<p>The solution supports two main overlay types:</p>
<ul>
<li>
<p><strong>L3VPN (Layer 3 VPN)</strong>: Creates routed overlay networks where IP
connectivity is extended across the fabric using SRv6 encapsulation. Each
L3VPN corresponds to a VRF (Virtual Routing and Forwarding) instance that
maintains separate routing tables with explicit route distinguishers and
route targets.</p></description></item><item><title>Stretching a layer 2 overlay across multiple KubeVirt clusters</title><link>https://openperouter.github.io/docs/examples/evpnexamples/kubevirt-multi-cluster/</link><pubDate>Tue, 14 Oct 2025 15:45:48 +0100</pubDate><guid>https://openperouter.github.io/docs/examples/evpnexamples/kubevirt-multi-cluster/</guid><description><p>This example demonstrates how to connect KubeVirt virtual machines running in
different Kubernetes clusters to an L2 EVPN/VXLAN overlay using OpenPERouter,
extending the <a href="kubevirt.md">KubeVirt single cluster example</a>.</p>
<h2 id="overview">
Overview
<a class="anchor" href="#overview">#</a>
</h2>
<p>The setup creates both Layer 2 and Layer 3 VNIs, with OpenPERouter
automatically creating a Linux bridge on the host. Two KubeVirt virtual
machines are connected to this bridge via Multus secondary interfaces of type
<code>bridge</code>.</p>
<h3 id="architecture">
Architecture
<a class="anchor" href="#architecture">#</a>
</h3>
<ul>
<li><strong>L3VNI (VNI 100)</strong>: Provides routing capabilities and connects to external networks</li>
<li><strong>L2VNI (VNI 110)</strong>: Creates a Layer 2 domain for VM-to-VM communication</li>
<li><strong>Linux Bridge</strong>: Automatically created by OpenPERouter for VM connectivity</li>
<li><strong>VM Connectivity</strong>: VMs connect to the bridge using Multus network attachments</li>
</ul>
<p><img src="https://openperouter.github.io/images/evpn-openperouter-multicluster.svg" alt="KubeVirt Multi Cluster L2 Integration" /></p></description></item><item><title>Architecture</title><link>https://openperouter.github.io/docs/architecture/</link><pubDate>Sun, 15 Jun 2025 15:03:22 +0200</pubDate><guid>https://openperouter.github.io/docs/architecture/</guid><description><p>This document describes the internal architecture of OpenPERouter and how its components work together to provide VPN functionality on Kubernetes nodes.</p>
<h2 id="system-overview">
System Overview
<a class="anchor" href="#system-overview">#</a>
</h2>
<p>OpenPERouter consists of three main components:</p>
<ol>
<li><strong>Router Pod</strong>: Runs <a href="https://frrouting.org/">FRR</a> inside a persistent named network namespace that survives container restarts</li>
<li><strong>Controller Pod</strong>: Manages network configuration, namespace lifecycle, and orchestrates the router setup</li>
<li><strong>Labeler Pod</strong>: Assigns persistent node indices for resource allocation</li>
</ol>
<h2 id="component-architecture">
Component Architecture
<a class="anchor" href="#component-architecture">#</a>
</h2>
<h3 id="router-pod">
Router Pod
<a class="anchor" href="#router-pod">#</a>
</h3>
<p>The router pod is the core networking component that provides the actual VPN functionality.</p></description></item><item><title>Calico Integration</title><link>https://openperouter.github.io/docs/examples/evpnexamples/calico/</link><pubDate>Sun, 15 Jun 2025 15:03:22 +0200</pubDate><guid>https://openperouter.github.io/docs/examples/evpnexamples/calico/</guid><description><p>This example demonstrates how to integrate OpenPERouter with Calico to advertise the pod network via an L3 EVPN and to allow pod-to-pod traffic via a VXLAN overlay.</p>
<h2 id="overview">
Overview
<a class="anchor" href="#overview">#</a>
</h2>
<p>Calico allows each node to establish a BGP session with a router to advertise the pod network of each node and to allow pod-to-pod traffic to flow. Here we leverage OpenPERouter to provide a seamless integration with the EVPN fabric.</p></description></item><item><title>KubeVirt L2 Integration</title><link>https://openperouter.github.io/docs/examples/evpnexamples/kubevirt/</link><pubDate>Sun, 15 Jun 2025 15:03:22 +0200</pubDate><guid>https://openperouter.github.io/docs/examples/evpnexamples/kubevirt/</guid><description><p>This example demonstrates how to connect KubeVirt virtual machines to an L2 EVPN/VXLAN overlay using OpenPERouter, extending the <a href="layer2.md">Layer 2 integration example</a>.</p>
<h2 id="overview">
Overview
<a class="anchor" href="#overview">#</a>
</h2>
<p>The setup creates both Layer 2 and Layer 3 VNIs, with OpenPERouter automatically creating a Linux bridge on the host. Two KubeVirt virtual machines are connected to this bridge via Multus secondary interfaces of type <code>bridge</code>.</p>
<h3 id="architecture">
Architecture
<a class="anchor" href="#architecture">#</a>
</h3>
<ul>
<li><strong>L3VNI (VNI 100)</strong>: Provides routing capabilities and connects to external networks</li>
<li><strong>L2VNI (VNI 110)</strong>: Creates a Layer 2 domain for VM-to-VM communication</li>
<li><strong>Linux Bridge</strong>: Automatically created by OpenPERouter for VM connectivity</li>
<li><strong>VM Connectivity</strong>: VMs connect to the bridge using Multus network attachments</li>
</ul>
<p><img src="https://openperouter.github.io/images/openpel2kubevirt.svg" alt="KubeVirt L2 Integration" /></p></description></item><item><title>L3 Passthrough</title><link>https://openperouter.github.io/docs/concepts/passthrough/</link><pubDate>Mon, 27 Jan 2025 10:00:00 +0200</pubDate><guid>https://openperouter.github.io/docs/concepts/passthrough/</guid><description><h2 id="overview">
Overview
<a class="anchor" href="#overview">#</a>
</h2>
<p>L3 Passthrough is a networking mode in OpenPERouter that provides direct BGP connectivity between the host and the BGP fabric without encapsulation. Unlike EVPN mode which uses VXLAN tunnels, passthrough mode allows the host to participate directly in the BGP fabric as a peer.</p>
<h2 id="key-characteristics">
Key Characteristics
<a class="anchor" href="#key-characteristics">#</a>
</h2>
<h3 id="direct-bgp-participation">
Direct BGP Participation
<a class="anchor" href="#direct-bgp-participation">#</a>
</h3>
<p>In passthrough mode, OpenPERouter establishes a BGP session directly with BGP-speaking components on the host (such as MetalLB). This session operates in the same BGP domain as the fabric, allowing the host to:</p></description></item><item><title>Router Resiliency</title><link>https://openperouter.github.io/docs/concepts/resiliency/</link><pubDate>Mon, 04 May 2026 00:00:00 +0200</pubDate><guid>https://openperouter.github.io/docs/concepts/resiliency/</guid><description><p>This page explains how OpenPERouter keeps the data plane running when FRR crashes or restarts.</p>
<h2 id="overview">
Overview
<a class="anchor" href="#overview">#</a>
</h2>
<p>In a traditional container-based router deployment, the container runtime owns the network namespace. When FRR dies, the namespace is destroyed — tearing down all VXLAN tunnels, VRFs, bridges, veths, and routes. Every workload on the node loses VPN connectivity until the container restarts and the control plane reconverges.</p>
<p>OpenPERouter solves this by running FRR inside a <strong>persistent named network namespace</strong> (<code>/var/run/netns/perouter</code>). The namespace is created and owned by the controller, held open by a bind mount, and independent of any process. When FRR dies, the namespace stays — and so does the data plane.</p></description></item><item><title>How to release</title><link>https://openperouter.github.io/docs/contributing/how-to-release/</link><pubDate>Sun, 15 Jun 2025 15:03:22 +0200</pubDate><guid>https://openperouter.github.io/docs/contributing/how-to-release/</guid><description><h1 id="release-process">
Release process
<a class="anchor" href="#release-process">#</a>
</h1>
<h2 id="preparing-the-branch">
Preparing the branch
<a class="anchor" href="#preparing-the-branch">#</a>
</h2>
<p>Checkout the release branch and merge main or cherry pick the relevant commits:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>git checkout v0.9
</span></span><span style="display:flex;"><span>git merge main
</span></span><span style="display:flex;"><span>git push
</span></span></code></pre></div><h3 id="using-cherry-picks">
Using cherry picks
<a class="anchor" href="#using-cherry-picks">#</a>
</h3>
<p>In case only a subset of the changes are brought to the new release, cherry-pick
must be used.</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>git checkout v0.9
</span></span><span style="display:flex;"><span>git cherry-pick -x f1f86ed658c1e8a6f90f967ed94881d61476b4c0
</span></span><span style="display:flex;"><span>git push
</span></span></code></pre></div><h2 id="clean-the-working-directory">
Clean the working directory
<a class="anchor" href="#clean-the-working-directory">#</a>
</h2>
<p>The release script only works if the Git working directory is completely clean: no pending modifications, no untracked files, nothing. Make sure everything is clean, or run the release from a fresh checkout.</p></description></item><item><title>Layer 2 Integration</title><link>https://openperouter.github.io/docs/examples/evpnexamples/layer2/</link><pubDate>Sun, 15 Jun 2025 15:03:22 +0200</pubDate><guid>https://openperouter.github.io/docs/examples/evpnexamples/layer2/</guid><description><p>This example demonstrates how to integrate OpenPERouter with Multus to have a pod&rsquo;s secondary interface connected to a layer 2 overlay.</p>
<h2 id="overview">
Overview
<a class="anchor" href="#overview">#</a>
</h2>
<p>A layer 2 VNI is created, exposing a layer 2 domain on the host. On each node, a pod is created with a macvlan interface enslaved to that domain via a Linux bridge.</p>
<h3 id="example-setup">
Example Setup
<a class="anchor" href="#example-setup">#</a>
</h3>
<p>The full example can be found in the <a href="https://github.com/openperouter/openperouter/examples/evpn/layer2">project repository</a> and can be deployed by running:</p></description></item><item><title>Layer 2 Integration</title><link>https://openperouter.github.io/docs/examples/srv6examples/layer2/</link><pubDate>Sun, 15 Jun 2025 15:03:22 +0200</pubDate><guid>https://openperouter.github.io/docs/examples/srv6examples/layer2/</guid><description><p>This example demonstrates how to integrate OpenPERouter with Multus to
have a pod&rsquo;s secondary interface connected to a layer 2 overlay, using
SRv6 as the underlay.</p>
<h2 id="overview">
Overview
<a class="anchor" href="#overview">#</a>
</h2>
<p>A layer 2 VNI is created, exposing a layer 2 domain on the host. On each
node, a pod is created with a macvlan interface enslaved to that domain
via a Linux bridge.</p>
<h3 id="example-setup">
Example Setup
<a class="anchor" href="#example-setup">#</a>
</h3>
<p>The full example can be found in the
<a href="https://github.com/openperouter/openperouter/examples/l3vpn/layer2">project repository</a>
and can be deployed by running:</p></description></item><item><title>EVPN Configuration</title><link>https://openperouter.github.io/docs/configuration/evpn/</link><pubDate>Sun, 15 Jun 2025 15:03:22 +0200</pubDate><guid>https://openperouter.github.io/docs/configuration/evpn/</guid><description><h2 id="underlay-configuration">
Underlay Configuration
<a class="anchor" href="#underlay-configuration">#</a>
</h2>
<p>In addition to the configuration described in the <a href="https://openperouter.github.io/docs/configuration/#underlay-configuration">underlay configuration section</a>, the VTEP (Virtual Tunnel End Point) source must be configured via the <code>evpn.vtepCIDR</code> field.</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#f92672">apiVersion</span>: <span style="color:#ae81ff">openpe.openperouter.github.io/v1alpha1</span>
</span></span><span style="display:flex;"><span><span style="color:#f92672">kind</span>: <span style="color:#ae81ff">Underlay</span>
</span></span><span style="display:flex;"><span><span style="color:#f92672">metadata</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">name</span>: <span style="color:#ae81ff">underlay</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">namespace</span>: <span style="color:#ae81ff">openperouter-system</span>
</span></span><span style="display:flex;"><span><span style="color:#f92672">spec</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">asn</span>: <span style="color:#ae81ff">64514</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">tunnelEndpoint</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">cidrs</span>:
</span></span><span style="display:flex;"><span> - <span style="color:#ae81ff">100.65.0.0</span><span style="color:#ae81ff">/24</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">interfaces</span>:
</span></span><span style="display:flex;"><span> - <span style="color:#f92672">type</span>: <span style="color:#ae81ff">NetworkDevice</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">networkDevice</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">interfaceName</span>: <span style="color:#ae81ff">toswitch</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">neighbors</span>:
</span></span><span style="display:flex;"><span> - <span style="color:#f92672">asn</span>: <span style="color:#ae81ff">64512</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">address</span>: <span style="color:#ae81ff">192.168.11.2</span>
</span></span></code></pre></div><p>The <code>tunnelEndpoint.cidrs</code> field defines the IP range used for VTEP addresses. OpenPERouter automatically assigns a unique VTEP IP to each node from this range. At least one CIDR (IPv4 or IPv6) is required, and both may be specified for dual-stack operation. For example, with <code>100.65.0.0/24</code>:</p></description></item><item><title>SRv6 L3VPN Configuration</title><link>https://openperouter.github.io/docs/configuration/srv6/</link><pubDate>Sun, 15 Jun 2025 15:03:22 +0200</pubDate><guid>https://openperouter.github.io/docs/configuration/srv6/</guid><description><h2 id="underlay-configuration">
Underlay Configuration
<a class="anchor" href="#underlay-configuration">#</a>
</h2>
<p>In addition to the configuration described in the
<a href="https://openperouter.github.io/docs/configuration/#underlay-configuration">underlay configuration section</a>,
the SRv6 underlay requires IS-IS, an SRv6 locator, and at least one IPv6
tunnel endpoint CIDR.</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#f92672">apiVersion</span>: <span style="color:#ae81ff">openpe.openperouter.github.io/v1alpha1</span>
</span></span><span style="display:flex;"><span><span style="color:#f92672">kind</span>: <span style="color:#ae81ff">Underlay</span>
</span></span><span style="display:flex;"><span><span style="color:#f92672">metadata</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">name</span>: <span style="color:#ae81ff">underlay</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">namespace</span>: <span style="color:#ae81ff">openperouter-system</span>
</span></span><span style="display:flex;"><span><span style="color:#f92672">spec</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">asn</span>: <span style="color:#ae81ff">64514</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">neighbors</span>:
</span></span><span style="display:flex;"><span> - <span style="color:#f92672">address</span>: <span style="color:#ae81ff">2001</span>:<span style="color:#ae81ff">db8:1234::1</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">asn</span>: <span style="color:#ae81ff">64520</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">ebgpMultiHop</span>: <span style="color:#66d9ef">true</span>
</span></span><span style="display:flex;"><span> - <span style="color:#f92672">address</span>: <span style="color:#ae81ff">2001</span>:<span style="color:#ae81ff">db8:1234::2</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">asn</span>: <span style="color:#ae81ff">64520</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">ebgpMultiHop</span>: <span style="color:#66d9ef">true</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">interfaces</span>:
</span></span><span style="display:flex;"><span> - <span style="color:#f92672">type</span>: <span style="color:#ae81ff">NetworkDevice</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">networkDevice</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">interfaceName</span>: <span style="color:#ae81ff">toswitch1</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">routeridcidr</span>: <span style="color:#ae81ff">10.0.0.0</span><span style="color:#ae81ff">/24</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">tunnelEndpoint</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">cidrs</span>:
</span></span><span style="display:flex;"><span> - <span style="color:#ae81ff">2001</span>:<span style="color:#ae81ff">db8:1234:5678::/64</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">isis</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">baseNet</span>: <span style="color:#e6db74">&#34;49.0001.0002.0003.0004.00&#34;</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">level</span>: <span style="color:#ae81ff">1</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">features</span>:
</span></span><span style="display:flex;"><span> - <span style="color:#e6db74">&#34;advertisePassiveOnly&#34;</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">srv6</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">locator</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">basePrefix</span>: <span style="color:#e6db74">&#34;fd00:0:32::/48&#34;</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">format</span>: <span style="color:#e6db74">&#34;usid-f3216&#34;</span>
</span></span></code></pre></div><h3 id="tunnel-endpoint">
Tunnel Endpoint
<a class="anchor" href="#tunnel-endpoint">#</a>
</h3>
<p>The <code>tunnelEndpoint.cidrs</code> field must include at least one IPv6 CIDR when
using SRv6. OpenPERouter automatically assigns a unique tunnel endpoint IP
to each node from this range.</p></description></item><item><title>Graceful Restart</title><link>https://openperouter.github.io/docs/configuration/graceful-restart/</link><pubDate>Mon, 04 May 2026 00:00:00 +0200</pubDate><guid>https://openperouter.github.io/docs/configuration/graceful-restart/</guid><description><p>BGP Graceful Restart allows FRR to signal to peers that its forwarding state survives restarts. When enabled, peers preserve routes during the restart window instead of withdrawing them, bridging the control-plane gap with zero data-plane disruption.</p>
<p>For the conceptual explanation of how this fits into the resiliency architecture, see <a href="https://openperouter.github.io/docs/concepts/resiliency/">Router Resiliency</a>.</p>
<h2 id="enabling-graceful-restart">
Enabling Graceful Restart
<a class="anchor" href="#enabling-graceful-restart">#</a>
</h2>
<p>Add the <code>gracefulRestart</code> field to your Underlay CR. An empty object enables Graceful Restart with default values:</p></description></item><item><title>Running different configurations on different nodes</title><link>https://openperouter.github.io/docs/configuration/node-selector/</link><pubDate>Tue, 13 Jan 2026 10:00:00 +0200</pubDate><guid>https://openperouter.github.io/docs/configuration/node-selector/</guid><description><h2 id="overview">
Overview
<a class="anchor" href="#overview">#</a>
</h2>
<p>Node selectors enable you to target specific OpenPERouter configurations to specific nodes in your cluster. This allows you to support heterogeneous cluster topologies including multi-datacenter, multi-rack, and mixed-hardware environments.</p>
<p>All OpenPERouter Custom Resource Definitions (Underlay, L3VNI, L2VNI, L3Passthrough, and RawFRRConfig) support the optional <code>nodeSelector</code> field.</p>
<h3 id="when-to-use-node-selectors">
When to Use Node Selectors
<a class="anchor" href="#when-to-use-node-selectors">#</a>
</h3>
<p>Node selectors are useful in scenarios such as:</p>
<ul>
<li><strong>Multi-rack deployments</strong>: Different nodes connect to different Top-of-Rack (ToR) switches</li>
<li><strong>Multi-datacenter clusters</strong>: Nodes in different availability zones need location-specific BGP configurations</li>
<li><strong>Hardware heterogeneity</strong>: Different server models with different NIC naming conventions</li>
<li><strong>Per-rack VNI isolation</strong>: Different racks need separate VNI configurations</li>
<li><strong>Selective deployment</strong>: Only specific nodes should have certain configurations</li>
</ul>
<h2 id="node-selector-syntax">
Node Selector Syntax
<a class="anchor" href="#node-selector-syntax">#</a>
</h2>
<p>The <code>nodeSelector</code> field uses Kubernetes label selectors (<code>metav1.LabelSelector</code>), supporting both <code>matchLabels</code> and <code>matchExpressions</code>:</p></description></item><item><title>Raw FRR Configuration</title><link>https://openperouter.github.io/docs/configuration/raw-frr-config/</link><pubDate>Tue, 03 Mar 2026 10:00:00 +0200</pubDate><guid>https://openperouter.github.io/docs/configuration/raw-frr-config/</guid><description><blockquote class="book-hint warning">
**Experimental - Not Supported**: The `RawFRRConfig` CRD is provided for experimentation and advanced debugging purposes only. It is not supported and may be removed or changed without notice in future releases. Use at your own risk.
</blockquote>
<h2 id="overview">
Overview
<a class="anchor" href="#overview">#</a>
</h2>
<p>The <code>RawFRRConfig</code> CRD allows injecting arbitrary FRR configuration snippets into the rendered FRR configuration. The raw text is appended verbatim at the end of the generated configuration file.</p>
<p>This is useful for experimenting with FRR features that are not yet exposed through the OpenPERouter API.</p></description></item><item><title>Passthrough Configuration</title><link>https://openperouter.github.io/docs/configuration/passthrough/</link><pubDate>Mon, 27 Jan 2025 10:00:00 +0200</pubDate><guid>https://openperouter.github.io/docs/configuration/passthrough/</guid><description><h2 id="underlay-configuration">
Underlay Configuration
<a class="anchor" href="#underlay-configuration">#</a>
</h2>
<p>For passthrough mode, the underlay configuration is simpler than EVPN mode as it doesn&rsquo;t require VTEP IP allocation. The configuration focuses on establishing BGP sessions with external routers.</p>
<h3 id="basic-underlay-configuration">
Basic Underlay Configuration
<a class="anchor" href="#basic-underlay-configuration">#</a>
</h3>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#f92672">apiVersion</span>: <span style="color:#ae81ff">openpe.openperouter.github.io/v1alpha1</span>
</span></span><span style="display:flex;"><span><span style="color:#f92672">kind</span>: <span style="color:#ae81ff">Underlay</span>
</span></span><span style="display:flex;"><span><span style="color:#f92672">metadata</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">name</span>: <span style="color:#ae81ff">underlay</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">namespace</span>: <span style="color:#ae81ff">openperouter-system</span>
</span></span><span style="display:flex;"><span><span style="color:#f92672">spec</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">asn</span>: <span style="color:#ae81ff">64514</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">interfaces</span>:
</span></span><span style="display:flex;"><span> - <span style="color:#f92672">type</span>: <span style="color:#ae81ff">NetworkDevice</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">networkDevice</span>:
</span></span><span style="display:flex;"><span> <span style="color:#f92672">interfaceName</span>: <span style="color:#ae81ff">toswitch</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">neighbors</span>:
</span></span><span style="display:flex;"><span> - <span style="color:#f92672">asn</span>: <span style="color:#ae81ff">64512</span>
</span></span><span style="display:flex;"><span> <span style="color:#f92672">address</span>: <span style="color:#ae81ff">192.168.11.2</span>
</span></span></code></pre></div><h3 id="configuration-fields">
Configuration Fields
<a class="anchor" href="#configuration-fields">#</a>
</h3>
<table>
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>asn</code></td>
<td>integer</td>
<td>Local ASN for BGP sessions</td>
<td>Yes</td>
</tr>
<tr>
<td><code>interfaces</code></td>
<td>array</td>
<td>List of underlay interfaces to use for connectivity. Each entry is a discriminated union; today only the <code>NetworkDevice</code> type is supported, which moves an existing host network device into the router namespace</td>
<td>Yes</td>
</tr>
<tr>
<td><code>neighbors</code></td>
<td>array</td>
<td>List of BGP neighbors to peer with</td>
<td>Yes</td>
</tr>
<tr>
<td><code>nodeSelector</code></td>
<td>object</td>
<td>Label selector to target specific nodes (applies to all nodes if omitted)</td>
<td>No</td>
</tr>
</tbody>
</table>
<p><strong>Note</strong>: Unlike EVPN mode, passthrough mode does not require an <code>evpn</code> field in the underlay configuration since no VTEP IP allocation is needed.</p></description></item><item><title>Sysctl Configuration</title><link>https://openperouter.github.io/docs/configuration/sysctl/</link><pubDate>Mon, 16 Feb 2026 10:00:00 +0200</pubDate><guid>https://openperouter.github.io/docs/configuration/sysctl/</guid><description><p>OpenPERouter automatically configures several kernel sysctl settings inside
the router&rsquo;s network namespace. These settings are applied every time the
controller reconciles the network configuration and are required for
correct traffic forwarding and fast failover.</p>
<p>No manual intervention is needed — the controller sets them for you. This
page documents what each setting does, why it is required, and which
kernel versions are needed.</p>
<h2 id="common-sysctls">
Common Sysctls
<a class="anchor" href="#common-sysctls">#</a>
</h2>
<p>The following sysctls are always configured regardless of the overlay
technology in use.</p></description></item><item><title>Troubleshooting Resiliency</title><link>https://openperouter.github.io/docs/configuration/troubleshooting-resiliency/</link><pubDate>Mon, 04 May 2026 00:00:00 +0200</pubDate><guid>https://openperouter.github.io/docs/configuration/troubleshooting-resiliency/</guid><description><p>Most FRR failures are self-healing: the container restarts, re-enters the persistent named namespace, and BGP Graceful Restart bridges the control-plane gap. This page covers scenarios that require operator intervention.</p>
<h2 id="checking-the-named-namespace">
Checking the Named Namespace
<a class="anchor" href="#checking-the-named-namespace">#</a>
</h2>
<p>Verify that the named namespace exists and is healthy:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span><span style="color:#75715e"># Check if the namespace exists</span>
</span></span><span style="display:flex;"><span>ip netns list | grep perouter
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#75715e"># List interfaces inside the namespace</span>
</span></span><span style="display:flex;"><span>ip netns exec perouter ip link show
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#75715e"># Check routes inside the namespace</span>
</span></span><span style="display:flex;"><span>ip netns exec perouter ip route show
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#75715e"># Check FRR BGP session status</span>
</span></span><span style="display:flex;"><span>kubectl exec -n openperouter-system &lt;router-pod&gt; -c frr -- <span style="color:#ae81ff">\
</span></span></span><span style="display:flex;"><span><span style="color:#ae81ff"></span> vtysh -c <span style="color:#e6db74">&#34;show bgp summary&#34;</span>
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span><span style="color:#75715e"># Check EVPN route exchange</span>
</span></span><span style="display:flex;"><span>kubectl exec -n openperouter-system &lt;router-pod&gt; -c frr -- <span style="color:#ae81ff">\
</span></span></span><span style="display:flex;"><span><span style="color:#ae81ff"></span> vtysh -c <span style="color:#e6db74">&#34;show bgp l2vpn evpn summary&#34;</span>
</span></span></code></pre></div><h2 id="recovery-full-namespace-rebuild">
Recovery: Full Namespace Rebuild
<a class="anchor" href="#recovery-full-namespace-rebuild">#</a>
</h2>
<p><strong>When to use</strong>: The node&rsquo;s networking state is out of sync — stale interfaces, wrong IPs, partial failure, or manual interference.</p></description></item><item><title>API Reference</title><link>https://openperouter.github.io/docs/api-reference/</link><pubDate>Sun, 15 Jun 2025 15:03:22 +0200</pubDate><guid>https://openperouter.github.io/docs/api-reference/</guid><description><h1 id="api-reference">
API Reference
<a class="anchor" href="#api-reference">#</a>
</h1>
<h2 id="packages">
Packages
<a class="anchor" href="#packages">#</a>
</h2>
<ul>
<li><a href="#openpeopenperoutergithubiov1alpha1">openpe.openperouter.github.io/v1alpha1</a></li>
</ul>
<h2 id="openpeopenperoutergithubiov1alpha1">
openpe.openperouter.github.io/v1alpha1
<a class="anchor" href="#openpeopenperoutergithubiov1alpha1">#</a>
</h2>
<p>Package v1alpha1 contains API Schema definitions for the openpe v1alpha1 API group.</p>
<h3 id="resource-types">
Resource Types
<a class="anchor" href="#resource-types">#</a>
</h3>
<ul>
<li><a href="#l2vni">L2VNI</a></li>
<li><a href="#l3passthrough">L3Passthrough</a></li>
<li><a href="#l3vni">L3VNI</a></li>
<li><a href="#l3vpn">L3VPN</a></li>
<li><a href="#rawfrrconfig">RawFRRConfig</a></li>
<li><a href="#routernodeconfigurationstatus">RouterNodeConfigurationStatus</a></li>
<li><a href="#underlay">Underlay</a></li>
</ul>
<h4 id="bfdsettings">
BFDSettings
<a class="anchor" href="#bfdsettings">#</a>
</h4>
<p>BFDSettings defines the BFD configuration for a BGP session.</p>
<p><em>Appears in:</em></p>
<ul>
<li><a href="#neighbor">Neighbor</a></li>
</ul>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
<th>Default</th>
<th>Validation</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>receiveInterval</code> <em>integer</em></td>
<td>receiveInterval is the minimum interval that this system is capable of<!-- raw HTML omitted -->receiving control packets in milliseconds.<!-- raw HTML omitted -->Defaults to 300ms.</td>
<td></td>
<td>Maximum: 60000 <!-- raw HTML omitted -->Minimum: 10 <!-- raw HTML omitted -->Optional: {} <!-- raw HTML omitted --></td>
</tr>
<tr>
<td><code>transmitInterval</code> <em>integer</em></td>
<td>transmitInterval is the minimum transmission interval (less jitter)<!-- raw HTML omitted -->that this system wants to use to send BFD control packets in<!-- raw HTML omitted -->milliseconds. Defaults to 300ms</td>
<td></td>
<td>Maximum: 60000 <!-- raw HTML omitted -->Minimum: 10 <!-- raw HTML omitted -->Optional: {} <!-- raw HTML omitted --></td>
</tr>
<tr>
<td><code>detectMultiplier</code> <em>integer</em></td>
<td>detectMultiplier configures the detection multiplier to determine<!-- raw HTML omitted -->packet loss. The remote transmission interval will be multiplied<!-- raw HTML omitted -->by this value to determine the connection loss detection timer.</td>
<td></td>
<td>Maximum: 255 <!-- raw HTML omitted -->Minimum: 2 <!-- raw HTML omitted -->Optional: {} <!-- raw HTML omitted --></td>
</tr>
<tr>
<td><code>echoInterval</code> <em>integer</em></td>
<td>echoInterval configures the minimal echo receive transmission<!-- raw HTML omitted -->interval that this system is capable of handling in milliseconds.<!-- raw HTML omitted -->Defaults to 50ms</td>
<td></td>
<td>Maximum: 60000 <!-- raw HTML omitted -->Minimum: 10 <!-- raw HTML omitted -->Optional: {} <!-- raw HTML omitted --></td>
</tr>
<tr>
<td><code>echoMode</code> <em>boolean</em></td>
<td>echoMode enables or disables the echo transmission mode.<!-- raw HTML omitted -->This mode is disabled by default, and not supported on multi<!-- raw HTML omitted -->hops setups.</td>
<td></td>
<td>Optional: {} <!-- raw HTML omitted --></td>
</tr>
<tr>
<td><code>passiveMode</code> <em>boolean</em></td>
<td>passiveMode marks session as passive: a passive session will not<!-- raw HTML omitted -->attempt to start the connection and will wait for control packets<!-- raw HTML omitted -->from peer before it begins replying.</td>
<td></td>
<td>Optional: {} <!-- raw HTML omitted --></td>
</tr>
<tr>
<td><code>minimumTTL</code> <em>integer</em></td>
<td>minimumTTL configures, for multi hop sessions only, the minimum<!-- raw HTML omitted -->expected TTL for an incoming BFD control packet.</td>
<td></td>
<td>Maximum: 254 <!-- raw HTML omitted -->Minimum: 1 <!-- raw HTML omitted -->Optional: {} <!-- raw HTML omitted --></td>
</tr>
</tbody>
</table>
<h4 id="failedresource">
FailedResource
<a class="anchor" href="#failedresource">#</a>
</h4>
<p>FailedResource describe failing router API resource</p></description></item><item><title>Systemd Mode</title><link>https://openperouter.github.io/docs/configuration/systemd-mode/</link><pubDate>Sun, 15 Jun 2025 15:03:22 +0200</pubDate><guid>https://openperouter.github.io/docs/configuration/systemd-mode/</guid><description><p>In systemd mode, OpenPERouter is configured via static files on the host instead of Kubernetes Custom Resources. See the <a href="https://openperouter.github.io/docs/installation/systemd-mode/">Systemd Mode installation guide</a> for deployment instructions.</p>
<h2 id="node-configuration">
Node Configuration
<a class="anchor" href="#node-configuration">#</a>
</h2>
<p>Each node requires a mandatory configuration file at <code>/var/lib/openperouter/node-config.yaml</code>. This file identifies the node and configures its unique index used for IPAM address allocation from the configured CIDRs.</p>
<p>The node index can be provided in two ways:</p>
<h4 id="static-node-index">
Static Node Index
<a class="anchor" href="#static-node-index">#</a>
</h4>
<p>Set <code>nodeIndex.index</code> to a unique integer per node:</p></description></item><item><title>Node Status</title><link>https://openperouter.github.io/docs/configuration/node-status/</link><pubDate>Sun, 15 Jun 2025 15:03:22 +0200</pubDate><guid>https://openperouter.github.io/docs/configuration/node-status/</guid><description><h2 id="node-status">
Node Status
<a class="anchor" href="#node-status">#</a>
</h2>
<blockquote class="book-hint warning">
**Work in progress**:
</blockquote>
<p>The node router configuration status can be viewed and monitored via the RouterNodeConfigurationStatus CRD.</p>
<p>Each node will have an associated RouterNodeConfigurationStatus CR resource indicate this node router configuration status.
It reports the outcome of all configuration resources (e.g.: Underlay, L3VNI, L2VNI) affecting the node.
In other words its the source of truth configuration health on that node.</p>
<p>Nodes:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>$ kubectl get no
</span></span><span style="display:flex;"><span>NAME STATUS ROLES AGE VERSION
</span></span><span style="display:flex;"><span>pe-kind-control-plane Ready control-plane 19h v1.34.7
</span></span><span style="display:flex;"><span>pe-kind-worker Ready worker 19h v1.34.7
</span></span></code></pre></div><p>Nodes router status:</p></description></item><item><title>Grout (DPDK Dataplane)</title><link>https://openperouter.github.io/docs/configuration/grout/</link><pubDate>Thu, 07 May 2026 09:00:00 +0200</pubDate><guid>https://openperouter.github.io/docs/configuration/grout/</guid><description><h2 id="overview">
Overview
<a class="anchor" href="#overview">#</a>
</h2>
<p><a href="https://github.com/DPDK/grout">Grout</a> is an optional, DPDK-accelerated data plane that can replace the Linux kernel&rsquo;s networking stack for packet forwarding in OpenPERouter. When enabled, grout handles VXLAN encapsulation/decapsulation and routing in user-space using poll-mode drivers, while <a href="https://frrouting.org/">FRR</a> continues to manage the control plane (BGP, EVPN, route exchange).</p>
<p>The integration is opt-in: grout is disabled by default and enabling it does not affect existing kernel-based deployments.</p>
<h2 id="architecture">
Architecture
<a class="anchor" href="#architecture">#</a>
</h2>
<p>When grout is enabled, it runs as a sidecar container in the router DaemonSet pod. It exposes a UNIX socket that serves two consumers:</p></description></item><item><title>Release Notes</title><link>https://openperouter.github.io/docs/release-notes/</link><pubDate>Sun, 15 Jun 2025 15:03:22 +0200</pubDate><guid>https://openperouter.github.io/docs/release-notes/</guid><description><h2 id="release-notes">
Release Notes
<a class="anchor" href="#release-notes">#</a>
</h2>
<h2 id="release-v020">
Release v0.2.0
<a class="anchor" href="#release-v020">#</a>
</h2>
<h3 id="new-features">
New Features
<a class="anchor" href="#new-features">#</a>
</h3>
<ul>
<li>SRv6 l3vpn overlay and isis underlay implementation (#485, @andreaskaris)</li>
<li>Add support for IPv6 and unnumbered BGP underlay sessions with ToR switches</li>
<li>Add configurable import / export route-targets to l3vni (#197, @k-akashi)</li>
<li>Add support for BGP <code>remote-as external</code>, <code>remote-as internal</code> and for iBGP with ASNs.</li>
<li>DPDK/grout support for Underlay and L3Passthrough with tap interfaces (#338, @zeeke)</li>
<li>Make the router resilient to data plane crashes. (#317, @maiqueb)</li>
<li>Introduce per-resource configuration resilience. All failures are reported via RouterNodeConfigurationStatus with detailed conditions. (#423, @RamLavi)</li>
<li>Api: Introduce node router status API. Enable inspecting router configuration status on a spesific node via NodeRouterConfigurationStatus CRD. (#355, @ormergi)</li>
<li>Allow moving multiple nics in the OpenPERouter network namespace and allow setting multiple neighbors for the underlay. (#307, @fedepaol)</li>
<li>Allow ipv6 vteps for evpn / vxlan. (#514, @fedepaol)</li>
<li>Add RouteTarget type for L3VNI route targets. Also uses for L3VPN route targets in the SRv6 PR. (#518, @andreaskaris)</li>
<li>Allow deriving the node index from a network interface address in systemd mode, enabling the same node-config.yaml to be deployed across all nodes. (#472, @yahlifried)</li>
<li>Automatically set veth MTU to underlay NIC MTU minus 50 bytes (#304, @qinqon)</li>
<li>Have configurable vtysh timeout, defined from the helm / operator config. (#189, @maiqueb)</li>
<li>Mirror configuration consumed by static files to k8s resources for better visibility. (#469, @fedepaol)</li>
<li>Add an optional knob to delay the start of the controller systemd quadlet to start the reconciliation loop after user provided conditions are satisfied. (#487, @fedepaol)</li>
<li>Allow L2VNIs without a VRF to operate as pure L2 east-west overlays. (#346, @RamLavi)</li>
</ul>
<h3 id="bug-fixes">
Bug fixes
<a class="anchor" href="#bug-fixes">#</a>
</h3>
<ul>
<li>Add liveness probe to FRR container to restart the pod when FRR daemons crash and cannot be recovered by watchfrr. (#455, @andreaskaris)</li>
<li>Bridge refresher: don&rsquo;t ping ipv6 lla neighbros, listen for neighbor events instead of polling for stale entries (#312, @fedepaol)</li>
<li>Correct the router component default container name (#319, @maiqueb)</li>
<li>Don&rsquo;t fail when only rawConfig is provided. (#311, @fedepaol)</li>
<li>Fix VRF route import failures caused by namespace loopback (lo) being down. The VTEP IP is now assigned directly to lo instead of a separate lound dummy interface. (#467, @andreaskaris)</li>
<li>Fix start race condition where k8s api is available already, the static controller dies but the health port is not free yet, causing the k8sapicontroller to die because the port is not ready. (#325, @fedepaol)</li>
<li>Fix underlay interface not being moved back to the default network namespace on underlay deletion. The interface is now restored with its original IP addresses and link-up state. (#442, @andreaskaris)</li>
<li>Fix vulnerability GO-2026-5026 (#460, @andreaskaris)</li>
<li>Fix: add unreachable routes to prevent VRF escape (#242, @fdomain)</li>
<li>Monitor the frr container in systemd mode, if it restarts we reconfigure it. (#479, @fedepaol)</li>
<li>Reject l2gatewayip on disconnected L2VNI (#332, @RamLavi)</li>
<li>Do not set AddrGenModeNone on L2 VNI bridges. (#351, @maiqueb)</li>
<li>Fix duplicate address-family blocks in FRR passthrough configuration by removing unused neighborenableipfamily template calls. Remove IPFamily from frr_test.go for l3vni and passthrough input as it is never set by production code. (#474, @andreaskaris)</li>
<li>Pre-delete all interfaces in the router netns as part of the recovery procedure. This will greatly reduce the time it take the kernel to async delete the network namespace via <code>cleanup_net()</code> (#463, @maiqueb)</li>
<li>Switch FRR logging from file to stdout, simplifying the container entrypoint and enabling native kubectl logs support. (#330, @qinqon)</li>
<li>Add exit after router bgp in FRR configuration (#302, @andreaskaris)</li>
</ul>
<h3 id="breaking-api-changes">
Breaking API Changes
<a class="anchor" href="#breaking-api-changes">#</a>
</h3>
<ul>
<li>API types updated to comply with Kubernetes API conventions via kube-api-linter. Breaking changes: integer fields use int32/int64 instead of uint, duration fields replaced with seconds integers, optional fields use pointers. (#313, @qinqon)</li>
<li>API: Rename <code>EVPNConfig</code> to <code>TunnelEndpointConfig</code> in the Underlay CRD to better reflect its purpose and in preparation for SRv6 implementation. (#471, @andreaskaris)</li>
<li>Remove vtepInterface field from EVPNConfig. vtepCIDR is now the only (required) way to configure the VTEP source. (#461, @qinqon)</li>
<li>The Underlay <code>spec.nics</code> field is replaced by <code>spec.interfaces</code>, a discriminated union. Use <code>interfaces: [{type: NetworkDevice, networkDevice: {interfaceName: &lt;nic&gt;}}]</code> instead of <code>nics: [&lt;nic&gt;]</code>. action required (#517, @qinqon)</li>
</ul>
<h2 id="release-v010">
Release v0.1.0
<a class="anchor" href="#release-v010">#</a>
</h2>
<h3 id="new-features-1">
New Features
<a class="anchor" href="#new-features-1">#</a>
</h3>
<ul>
<li>Add NodeSelector field to Underlay, L2VNI, L3VNI and L3Passthrough. (#164, @qinqon)</li>
<li>Add support for the <code>ovs-bridge</code> hostmaster type. (#108, @maiqueb)</li>
<li>Add vtepInterface field to EVPNConfig to allow using an existing interface as VTEP source instead of creating a loopback from vtepCIDR (#214, @qinqon)</li>
<li>Added a non supported - experimentation only way to inject custom frr configuration. This can be used both to quickly workaround issues and to prototype new features. (#247, @fedepaol)</li>
<li>Adds probes to the controller, nodemarker, and router components. (#149, @maiqueb)</li>
<li>Api: refactor L2VNI HostMaster to enable different configurations per bridge type (#176, @maiqueb)</li>
<li>Be more memory efficient, by only caching the required data for the controller operation (#200, @maiqueb)</li>
<li>Compatibility with OpenShift clusters (#168, @zeeke)</li>
<li>Fix SELinux volume write permission on router pods (#269, @zeeke)</li>
<li>Handle changes in the static configuration files when running in host mode. (#226, @fedepaol)</li>
<li>Have a way to consume a file based static configuration when running in systemd mode. This is useful to setup the basic connectivity required to the cluster to come up. Additional configuration created via the k8s api will be merged with the static configuration, allowing the creation of secondary network at day 2. (#201, @fedepaol)</li>
<li>Provide a mechanism to run OpenPERouter on the host as systemd unit via podman. (#158, @fedepaol)</li>
<li>Support dual stack for l2gatewayips field (#137, @qinqon)</li>
</ul>
<h3 id="bug-fixes-1">
Bug fixes
<a class="anchor" href="#bug-fixes-1">#</a>
</h3>
<ul>
<li>Api: rename l2vni hostmaster type from bridge to linux-bridge (#175, @maiqueb)</li>
<li>Bump go.opentelemetry.io/otel/sdk to 1.40 to address GO-2026-4394 (#241, @maiqueb)</li>
<li>Cleanup unamanged ovs bridge veths (#239, @maiqueb)</li>
<li>Enable the <code>accept_untracked_na</code> sysctl in the router network namespaces, to learn MAC mobility events from unsolicited NA messages. (#207, @maiqueb)</li>
<li>Enable the arp_accept sysctl in the router network namespaces, to learn MAC mobility events from GARPs. (#202, @maiqueb)</li>
<li>Fix VNI resource cleanup when underlay is deleted along with VNIs (#238, @maiqueb)</li>
<li>Fix controller container being killed by health check in systemd/host mode when transitioning to K8s API reconciler. (#249, @qinqon)</li>
<li>Fix ovs missing row errors by using generated code from ovs schema. (#237, @qinqon)</li>
<li>Fix the metallb example not starting for wrong common.sh path. (#208, @fedepaol)</li>
<li>Generate linux bridge and ovs bridge manifests with CEL expressions (#219, @qinqon)</li>
<li>Handle STALE neighbor entries by pinging the corresponding IPs. This still refreshes silent neighbors while forcing really STALE entries to get garbage collected. (#275, @fedepaol)</li>
<li>Idle workloads become unreachable due to EVPN Type-2 route withdrawal when neighbor entries expire; proactively keep neighbor entries alive via periodic ARP probes. (#211, @maiqueb)</li>
<li>Only set the L2VNI bridge MAC address when needed, thus preventing type 2 route withdrawal, in turn causing N/S traffic to break permanently (#232, @maiqueb)</li>
<li>Support L3VNI on CRI-O by enabling always ipv4 ip forwarding (#212, @qinqon)</li>
<li>Sysctl: accept_untracked_na is now skipped with a warning on kernels &lt; 5.18 instead of blocking host configuration. (#231, @qinqon)</li>
<li>Update Go from 1.24.0 to 1.24.9 and refresh dependency tree to resolve security vulnerabilities (#166, @qinqon)</li>
<li>It is now possible to attach multiple L2VNIs to the same IP-VRF for as long as their subnets do not overlap with the L3VNI and other L2VNIs in the same VRF. (#265, @andreaskaris)</li>
</ul>
<h3 id="other-cleanup-or-flake">
Other (Cleanup or Flake)
<a class="anchor" href="#other-cleanup-or-flake">#</a>
</h3>
<ul>
<li>Delete all unused bridges in a single OVSDB transaction. Do not dettach ports of managed bridges before deletion. (#240, @maiqueb)</li>
<li>Log non recoverable errors in underlay reconciler (#270, @zeeke)</li>
<li>Modernize golang code. (#268, @qinqon)</li>
</ul>
<h2 id="release-v005">
Release v0.0.5
<a class="anchor" href="#release-v005">#</a>
</h2>
<h3 id="bug-fixes-2">
Bug fixes
<a class="anchor" href="#bug-fixes-2">#</a>
</h3>
<ul>
<li>Fix flag <code>--metrics-bind-address</code> being ignored on controller and nodemarker binaries (#148, @fdomain)</li>
<li>Fix: allow omitting underlay NIC configuration when using Multus. (#155, @fdomain)</li>
<li>Re-introduce the &ldquo;redistribute-connected-from-default&rdquo; flag when generating FRR configurations for the KinD leaves (#151, @maiqueb)</li>
</ul>
<h2 id="release-v004">
Release v0.0.4
<a class="anchor" href="#release-v004">#</a>
</h2>
<h3 id="new-features-2">
New Features
<a class="anchor" href="#new-features-2">#</a>
</h3>
<ul>
<li>Add a multi-cluster demo setup (#126, @maiqueb)</li>
<li>Allow pods to run on master nodes or not. (#122, @fedepaol)</li>
<li>Allow the creation of a &ldquo;passthrough&rdquo; veth where the traffic is not being encapsulated but just re-routed by the router.
This might come handy for those scenarios where we want the host to reach the &ldquo;flat&rdquo; network without having to establish an additional bgp session. (#117, @fedepaol)</li>
<li>Api: make L3VNI VRF field mandatory (#135, @qinqon)</li>
<li>Enforce the session with the host / with the TOR to be ebgp. (#95, @fedepaol)</li>
<li>Optional hostsession in the L3VNI CRD, now it&rsquo;s not mandatory to setup a session if a l3vni serves as L3 wrapper of a L2 VNI. (#102, @fedepaol)</li>
</ul>
<h3 id="bug-fixes-3">
Bug fixes
<a class="anchor" href="#bug-fixes-3">#</a>
</h3>
<ul>
<li>Fix cr based validation of the nic name in the underlay crd. (#130, @fedepaol)</li>
<li>Make gateway ip and local cidrs immutable. (#94, @fedepaol)</li>
<li>Vlan sub-interfaces can now be selected as underlay NICs. (#128, @maiqueb)</li>
</ul>
<h2 id="release-v001">
Release v0.0.1
<a class="anchor" href="#release-v001">#</a>
</h2>
<p>Fix the website publish job!</p></description></item></channel></rss>