Skip to content

Commit 4cd2ee0

Browse files
authored
Update Nebula docs with new settings (#350)
1 parent 6d42351 commit 4cd2ee0

File tree

10 files changed

+63
-7
lines changed

10 files changed

+63
-7
lines changed

docs/config/firewall.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 13
2+
sidebar_position: 14
33
description: Configure inbound and outbound firewall rules for a Nebula host
44
---
55

docs/config/handshake.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 16
2+
sidebar_position: 17
33
description: Configuration of the Nebula handshake manager subsystem.
44
---
55

docs/config/listen.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,17 @@ packets `always`, `never`, or only to `private` network remotes.
5656

5757
Valid values: `always`, `never`, `private`
5858

59+
## listen.accept_recv_error
60+
61+
<Pill className="mb-24">Reloadable</Pill> <Pill className="mb-24">Default: `always`</Pill>
62+
<Pill className="mb-24">Added in v1.10.1</Pill>
63+
64+
Controls whether Nebula accepts `recv_error` packets from remote hosts. This is the counterpart to
65+
[`send_recv_error`](#listensend_recv_error) — while `send_recv_error` controls whether your node _sends_ these packets,
66+
`accept_recv_error` controls whether your node _acts on_ them when received.
67+
68+
Valid values: `always`, `never`, `private`
69+
5970
## listen.so_mark
6071

6172
<Pill className="mb-24">Added in v1.10.0</Pill>

docs/config/local-range.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 17
2+
sidebar_position: 18
33
description: local_ranges has been deprecated in favor of preferred_ranges
44
---
55

docs/config/logging.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 12
2+
sidebar_position: 13
33
description: Logging configuration reference for Nebula mesh networking.
44
---
55

docs/config/routines.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 14
2+
sidebar_position: 15
33
description: Routines configuration reference for Nebula mesh networking.
44
---
55

docs/config/sshd.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 11
2+
sidebar_position: 12
33
description: Enable Nebula's built-in debugging console, accessible via SSH.
44
---
55

docs/config/stats.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 15
2+
sidebar_position: 16
33
description: Configure Prometheus or Graphite stats reporting in the Nebula client.
44
---
55

docs/config/tun.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,8 +136,20 @@ remaining available gateways, though load balancing may become uneven until the
136136
## tun.use_system_route_table
137137

138138
<Pill className="mb-24">Default: False</Pill>
139+
<Pill className="mb-24">Added in v1.7.0</Pill>
139140

140141
This option is only supported on Linux.
141142

142143
Set to true to manage unsafe routes directly on the system route table with gateway routes instead of in nebula
143144
configuration files.
145+
146+
## tun.use_system_route_table_buffer_size
147+
148+
<Pill className="mb-24">Default: 0</Pill>
149+
<Pill className="mb-24">Added in v1.10.0</Pill>
150+
151+
This option is only supported on Linux.
152+
153+
Buffer size for reading route updates. `0` means the system default buffer size is used
154+
(`/proc/sys/net/core/rmem_default`). If using massive route updates, for example BGP, you may need to increase this
155+
value to avoid packet loss. `SO_RCVBUFFORCE` is used to avoid having to raise the system wide max.

docs/config/tunnels.mdx

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
sidebar_position: 11
3+
description: Configure tunnel lifecycle management for Nebula mesh networking.
4+
---
5+
6+
import { Pill } from '@components/Pill/Pill';
7+
8+
# tunnels
9+
10+
<Pill className="mb-24">Added in v1.9.6</Pill>
11+
12+
`tunnels` configures tunnel lifecycle management, allowing Nebula to automatically drop tunnels that have been inactive
13+
for a period of time.
14+
15+
```yml
16+
tunnels:
17+
drop_inactive: false
18+
inactivity_timeout: 10m
19+
```
20+
21+
## tunnels.drop_inactive
22+
23+
<Pill className="mb-24">Reloadable</Pill> <Pill className="mb-24">Default: false</Pill>
24+
25+
Controls whether inactive tunnels are maintained or dropped after the `inactivity_timeout` period has elapsed. In
26+
general, it is a good idea to enable this setting. It will be enabled by default in a future release.
27+
28+
## tunnels.inactivity_timeout
29+
30+
<Pill className="mb-24">Reloadable</Pill> <Pill className="mb-24">Default: 10m</Pill>
31+
32+
Controls how long a tunnel must not see any inbound or outbound traffic before being considered inactive and eligible to
33+
be dropped. Only applies when [`tunnels.drop_inactive`](#tunnelsdrop_inactive) is enabled.

0 commit comments

Comments
 (0)