Skip to content

Commit 1e10edb

Browse files
matzfmatzf
authored
doc: update deploy tutorial to release v0.11.0 (scionproto#4557)
Update link to download v0.11.0 packages. Update topology.json files: - Use simpler "local" address configuration without explicitly binding to a specific local IP. - Use hostnames for remote hosts to avoid having to explicitly patch the placeholder IP addresses in the topology files.
1 parent eacdeef commit 1e10edb

File tree

6 files changed

+32
-43
lines changed

6 files changed

+32
-43
lines changed

‎doc/tutorials/deploy.rst‎

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,8 @@ Execute the following commands on each VM:
106106
.. code-block:: sh
107107
108108
cd /tmp/
109-
wget https://github.com/scionproto/scion/releases/download/v0.10.0/scion_v0.10.0_deb_amd64.tar.gz
110-
tar xfz scion_v0.10.0_deb_amd64.tar.gz
109+
wget https://github.com/scionproto/scion/releases/download/v0.11.0/scion_v0.11.0_deb_amd64.tar.gz
110+
tar xfz scion_v0.11.0_deb_amd64.tar.gz
111111
112112
sudo apt install ./scion*.deb
113113
@@ -142,19 +142,8 @@ On scion01, download the topology1.json file. On scion02, download topology2.jso
142142
143143
wget LINK_TO_TOPOLOGY.JSON_FILE -O /etc/scion/topology.json
144144
145-
146-
The downloaded AS topology file is configured with generic IP address (10.0.0.1-5) as placeholder for the hosts scion01-05. These IP addresses will need to be changed to the VM IP specific addresses.
147-
148-
.. code-block:: sh
149-
150-
sed -i 's/10.0.0.1/YOUR_SCION01_IP/g' /etc/scion/topology.json
151-
sed -i 's/10.0.0.2/YOUR_SCION02_IP/g' /etc/scion/topology.json
152-
sed -i 's/10.0.0.3/YOUR_SCION03_IP/g' /etc/scion/topology.json
153-
sed -i 's/10.0.0.4/YOUR_SCION04_IP/g' /etc/scion/topology.json
154-
sed -i 's/10.0.0.5/YOUR_SCION05_IP/g' /etc/scion/topology.json
155-
156-
Replace ``YOUR_SCIONXX_IP`` with the VM specific IP address and apply on each scion host.
157-
145+
The AS topology files reference the hosts scion01-05 by host name.
146+
Ensure that you have set up the ``/etc/hosts`` file (:ref:`see above <step0>`) or replace the hostnames with IP addresses.
158147

159148
Step 2 - Generate the Required Certificates
160149
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

‎doc/tutorials/deploy/topology1.json‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,26 +20,26 @@
2020
"interfaces": {
2121
"1": {
2222
"underlay": {
23-
"public": "10.0.0.1:50014",
24-
"remote": "10.0.0.4:50014"
23+
"local": ":50014",
24+
"remote": "scion04:50014"
2525
},
2626
"isd_as": "42-ffaa:1:4",
2727
"link_to": "child",
2828
"mtu": 1472
2929
},
3030
"2": {
3131
"underlay": {
32-
"public": "10.0.0.1:50012",
33-
"remote": "10.0.0.2:50012"
32+
"local": ":50012",
33+
"remote": "scion02:50012"
3434
},
3535
"isd_as": "42-ffaa:1:2",
3636
"link_to": "core",
3737
"mtu": 1472
3838
},
3939
"3": {
4040
"underlay": {
41-
"public": "10.0.0.1:50013",
42-
"remote": "10.0.0.3:50013"
41+
"local": ":50013",
42+
"remote": "scion03:50013"
4343
},
4444
"isd_as": "42-ffaa:1:3",
4545
"link_to": "core",

‎doc/tutorials/deploy/topology2.json‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,26 +20,26 @@
2020
"interfaces": {
2121
"1": {
2222
"underlay": {
23-
"public": "10.0.0.2:50012",
24-
"remote": "10.0.0.1:50012"
23+
"local": ":50012",
24+
"remote": "scion01:50012"
2525
},
2626
"isd_as": "42-ffaa:1:1",
2727
"link_to": "core",
2828
"mtu": 1472
2929
},
3030
"2": {
3131
"underlay": {
32-
"public": "10.0.0.2:50023",
33-
"remote": "10.0.0.3:50023"
32+
"local": ":50023",
33+
"remote": "scion03:50023"
3434
},
3535
"isd_as": "42-ffaa:1:3",
3636
"link_to": "core",
3737
"mtu": 1472
3838
},
3939
"3": {
4040
"underlay": {
41-
"public": "10.0.0.2:50025",
42-
"remote": "10.0.0.5:50025"
41+
"local": ":50025",
42+
"remote": "scion05:50025"
4343
},
4444
"isd_as": "42-ffaa:1:5",
4545
"link_to": "child",

‎doc/tutorials/deploy/topology3.json‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,35 +20,35 @@
2020
"interfaces": {
2121
"1": {
2222
"underlay": {
23-
"public": "10.0.0.3:50013",
24-
"remote": "10.0.0.1:50013"
23+
"local": ":50013",
24+
"remote": "scion01:50013"
2525
},
2626
"isd_as": "42-ffaa:1:1",
2727
"link_to": "core",
2828
"mtu": 1472
2929
},
3030
"2": {
3131
"underlay": {
32-
"public": "10.0.0.3:50023",
33-
"remote": "10.0.0.2:50023"
32+
"local": ":50023",
33+
"remote": "scion02:50023"
3434
},
3535
"isd_as": "42-ffaa:1:2",
3636
"link_to": "core",
3737
"mtu": 1472
3838
},
3939
"3": {
4040
"underlay": {
41-
"public": "10.0.0.3:50034",
42-
"remote": "10.0.0.4:50034"
41+
"local": ":50034",
42+
"remote": "scion04:50034"
4343
},
4444
"isd_as": "42-ffaa:1:4",
4545
"link_to": "child",
4646
"mtu": 1472
4747
},
4848
"4": {
4949
"underlay": {
50-
"public": "10.0.0.3:50035",
51-
"remote": "10.0.0.5:50035"
50+
"local": ":50035",
51+
"remote": "scion05:50035"
5252
},
5353
"isd_as": "42-ffaa:1:5",
5454
"link_to": "child",

‎doc/tutorials/deploy/topology4.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,17 @@
1818
"interfaces": {
1919
"1": {
2020
"underlay": {
21-
"public": "10.0.0.4:50014",
22-
"remote": "10.0.0.1:50014"
21+
"local": ":50014",
22+
"remote": "scion01:50014"
2323
},
2424
"isd_as": "42-ffaa:1:1",
2525
"link_to": "parent",
2626
"mtu": 1472
2727
},
2828
"2": {
2929
"underlay": {
30-
"public": "10.0.0.4:50034",
31-
"remote": "10.0.0.3:50034"
30+
"local": ":50034",
31+
"remote": "scion03:50034"
3232
},
3333
"isd_as": "42-ffaa:1:3",
3434
"link_to": "parent",

‎doc/tutorials/deploy/topology5.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,17 @@
1818
"interfaces": {
1919
"1": {
2020
"underlay": {
21-
"public": "10.0.0.5:50025",
22-
"remote": "10.0.0.2:50025"
21+
"local": ":50025",
22+
"remote": "scion02:50025"
2323
},
2424
"isd_as": "42-ffaa:1:2",
2525
"link_to": "parent",
2626
"mtu": 1472
2727
},
2828
"2": {
2929
"underlay": {
30-
"public": "10.0.0.5:50035",
31-
"remote": "10.0.0.3:50035"
30+
"local": ":50035",
31+
"remote": "scion03:50035"
3232
},
3333
"isd_as": "42-ffaa:1:3",
3434
"link_to": "parent",

0 commit comments

Comments
 (0)