Skip to content

Commit b1971bc

Browse files
olethanholethanh
committed
Documment supported provider for ipv6, improve ipv6 setup guide
1 parent e135da1 commit b1971bc

File tree

4 files changed

+44
-21
lines changed

4 files changed

+44
-21
lines changed

‎docs/nodes/compute/installation/debian-12.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -64,25 +64,27 @@ ALEPH_VM_DOMAIN_NAME=vm.example.org
6464

6565
#### IPv6 address pool
6666

67-
The range of IPv6 addresses usable by the virtual machines must be specified manually.
67+
The range of IPv6 addresses usable by the virtual machines must be specified manually. This is required to enable IPv6
68+
egress.
6869

6970
According to the IPv6 specifications, a system is expected to receive an IPv6 with a /64
7071
mask and all addresses inside that mask should simply be routed to the host.
7172

7273
The option takes the form of:
74+
7375
```
7476
ALEPH_VM_IPV6_ADDRESS_POOL="2a01:4f8:171:787::/64"
7577
```
7678

7779
Assuming hosting provider follows the specification, the procedure is the following:
7880

79-
1. Obtain the IPv6 address of your node.
80-
2. Remove the trailing number after `::` if present, for example `2a01:4f8:171:787::2/64` becomes `2a01:4f8:171:787::/64`.
81+
1. Obtain the IPv6 address of your node, the one used by the ALEPH_VM_NETWORK_INTERFACE setting below. You can find it
82+
via the `ip a` command.
83+
2. Remove the trailing number after `::` if present, for example `2a01:4f8:171:787::2/64` becomes
84+
`2a01:4f8:171:787::/64`.
8185
3. Add the IPv6 range you obtained under the setting `ALEPH_VM_IPV6_ADDRESS_POOL` in the configuration.
8286

83-
84-
85-
#### Network Interface
87+
#### Network Interface (optional)
8688

8789
The default network interface is detected automatically from the IP routes.
8890
You can configure the default interface manually instead by adding:
@@ -94,9 +96,12 @@ ALEPH_VM_NETWORK_INTERFACE=enp0s1
9496
(don't forget to replace `enp0s1` with the name of your default network interface).
9597

9698

97-
#### Domain Name Servers
9899

99-
You can configure the DNS resolver manually by using one of the following options:
100+
#### Domain Name Servers (optional)
101+
102+
The DNS server used by the VM are detected automatically and doesn't need to be set manually.
103+
104+
But you can set the DNS resolver used for automatic detection manually by using one of the following options:
100105

101106
```
102107
ALEPH_VM_DNS_RESOLUTION=resolvectl
@@ -139,7 +144,7 @@ This is a simple configuration. For more options, check [CONFIGURE_CADDY](config
139144
Again, run these commands as `root`:
140145

141146
```shell
142-
apt install -y debian-keyring debian-archive-keyring apt-transport-https
147+
apt install -y debian-keyring debian-archive-keyring apt-transport-https
143148
curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/gpg.key' | gpg --dearmor -o /usr/share/keyrings/caddy-stable-archive-keyring.gpg
144149
curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/debian.deb.txt' | tee /etc/apt/sources.list.d/caddy-stable.list
145150
apt update

‎docs/nodes/compute/installation/ubuntu-22.04.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,25 +64,27 @@ ALEPH_VM_DOMAIN_NAME=vm.example.org
6464

6565
#### IPv6 address pool
6666

67-
The range of IPv6 addresses usable by the virtual machines must be specified manually.
67+
The range of IPv6 addresses usable by the virtual machines must be specified manually. This is required to enable IPv6
68+
egress.
6869

6970
According to the IPv6 specifications, a system is expected to receive an IPv6 with a /64
7071
mask and all addresses inside that mask should simply be routed to the host.
7172

7273
The option takes the form of:
74+
7375
```
7476
ALEPH_VM_IPV6_ADDRESS_POOL="2a01:4f8:171:787::/64"
7577
```
7678

7779
Assuming hosting provider follows the specification, the procedure is the following:
7880

79-
1. Obtain the IPv6 address of your node.
80-
2. Remove the trailing number after `::` if present, for example `2a01:4f8:171:787::2/64` becomes `2a01:4f8:171:787::/64`.
81+
1. Obtain the IPv6 address of your node, the one used by the ALEPH_VM_NETWORK_INTERFACE setting below. You can find it
82+
via the `ip a` command.
83+
2. Remove the trailing number after `::` if present, for example `2a01:4f8:171:787::2/64` becomes
84+
`2a01:4f8:171:787::/64`.
8185
3. Add the IPv6 range you obtained under the setting `ALEPH_VM_IPV6_ADDRESS_POOL` in the configuration.
8286

83-
84-
85-
#### Network Interface
87+
#### Network Interface (optional)
8688

8789
The default network interface is detected automatically from the IP routes.
8890
You can configure the default interface manually instead by adding:

‎docs/nodes/compute/installation/ubuntu-24.04.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,25 +64,29 @@ ALEPH_VM_DOMAIN_NAME=vm.example.org
6464

6565
#### IPv6 address pool
6666

67-
The range of IPv6 addresses usable by the virtual machines must be specified manually.
67+
#### IPv6 address pool
68+
69+
The range of IPv6 addresses usable by the virtual machines must be specified manually. This is required to enable IPv6
70+
egress.
6871

6972
According to the IPv6 specifications, a system is expected to receive an IPv6 with a /64
7073
mask and all addresses inside that mask should simply be routed to the host.
7174

7275
The option takes the form of:
76+
7377
```
7478
ALEPH_VM_IPV6_ADDRESS_POOL="2a01:4f8:171:787::/64"
7579
```
7680

7781
Assuming hosting provider follows the specification, the procedure is the following:
7882

79-
1. Obtain the IPv6 address of your node.
80-
2. Remove the trailing number after `::` if present, for example `2a01:4f8:171:787::2/64` becomes `2a01:4f8:171:787::/64`.
83+
1. Obtain the IPv6 address of your node, the one used by the ALEPH_VM_NETWORK_INTERFACE setting below. You can find it
84+
via the `ip a` command.
85+
2. Remove the trailing number after `::` if present, for example `2a01:4f8:171:787::2/64` becomes
86+
`2a01:4f8:171:787::/64`.
8187
3. Add the IPv6 range you obtained under the setting `ALEPH_VM_IPV6_ADDRESS_POOL` in the configuration.
8288

83-
84-
85-
#### Network Interface
89+
#### Network Interface (optional)
8690

8791
The default network interface is detected automatically from the IP routes.
8892
You can configure the default interface manually instead by adding:

‎docs/nodes/compute/troubleshooting.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,18 @@ When a diagnostic virtual machine happens to be stopped while writing data to th
241241
https://$YOUR_CRN_HOSTNAME/vm/$CHECK_FASTAPI_VM_ID/state/increment
242242
```
243243
244+
## IPv6 egress not working
245+
Be sure you have set the `ALEPH_VM_IPV6_ADDRESS_POOL` configuration setting properly, check the IPv6 address pool section of your distribution installation guide.
246+
247+
Be aware that IPv6 egress is not working everywhere and we are currently improving the IPv6 support to be compatible with more Hosting providers
248+
249+
The following infra providers are known to works:
250+
* Hetzner
251+
* OVH
252+
253+
The following infra providers are known not to works:
254+
* Scaleway
255+
244256
## Found an issue?
245257
246258
If the documentation didn't help, you can [report an issue](https://github.com/aleph-im/support/issues).

0 commit comments

Comments
 (0)