Skip to content

Commit b2d4c4c

Browse files
committed
doc: Add DEPLOYING.md, prepare_a_client.md, prepare_a_ronny.md.
1 parent 9d7713e commit b2d4c4c

8 files changed

Lines changed: 166 additions & 5 deletions

File tree

CONTACTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Contacts
3-
nav_order: 94
3+
nav_order: 95
44
---
55

66
# List of contacts

DEPLOYING.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
---
2+
title: Deploying
3+
nav_order: 91
4+
has_children: true
5+
---
6+
7+
# Deploying the (12)urenloop stack
8+
9+
# Requirements
10+
11+
## Inventory
12+
13+
Gather the following:
14+
15+
- [ ] 1 Flight case with router/switch:
16+
- See the [Network documentation](./NETWORK)
17+
18+
- [ ] 2 clients:
19+
- Dell thin clients
20+
- `snowball` & `meeseeks` from Zeus
21+
- These will be wiped!
22+
23+
- [ ] 8 ronnys:
24+
- Also known as stations
25+
- Raspberry Pi 4's
26+
- These will be wiped!
27+
28+
- [ ] 1 laptop with `uv` installed
29+
30+
Make everything is labelled:
31+
- [ ] `client1-2`
32+
- [ ] `ronny01-08`
33+
- [ ] What ports on the switch are to be used for the `telnet` (tel-network).
34+
35+
## Static DHCP leases
36+
37+
The router should automatically assign IP addresses based on MAC address via DHCP as follows:
38+
39+
| Host | IP | MAC |
40+
|---------|---------------|-------------------|
41+
| client1 | 172.12.50.21 | 90:8D:6E:8C:8A:01 |
42+
| client2 | 172.12.50.22 | 90:8D:6E:8C:8A:9B |
43+
| ronny01 | 172.12.50.101 | DC:A6:32:49:97:00 |
44+
| ronny02 | 172.12.50.102 | DC:A6:32:49:9A:90 |
45+
| ronny03 | 172.12.50.103 | E4:5F:01:4A:42:DE |
46+
| ronny04 | 172.12.50.104 | DC:A6:32:49:62:B4 |
47+
| ronny05 | 172.12.50.105 | DC:A6:32:49:65:33 |
48+
| ronny06 | 172.12.50.106 | E4:5F:01:4A:40:E2 |
49+
| ronny07 | 172.12.50.107 | DC:A6:32:49:97:E7 |
50+
| ronny08 | 172.12.50.108 | DC:A6:32:49:98:CD |
51+
52+
> If you replace any hardware, make sure to update the MAC in the router config, this table and the [Network documentation](./NETWORK)
53+
54+
## Preparing devices for ansible
55+
56+
### Clients
57+
58+
Wipe and install Debian on the clients as described in [Preparing a client for the ansible-config](deploying/prepare_a_client):
59+
- [ ] `client1`
60+
- [ ] `client2`
61+
62+
### Ronnys
63+
64+
Flash the ronnys and set a password as described in [Preparing a ronny for the ansible-config](deploying/prepare_a_ronny):
65+
- [ ] `ronny01`
66+
- [ ] `ronny02`
67+
- [ ] `ronny03`
68+
- [ ] `ronny04`
69+
- [ ] `ronny05`
70+
- [ ] `ronny06`
71+
- [ ] `ronny07`
72+
- [ ] `ronny08`
73+
74+
### Laptop
75+
76+
- [ ] Clone the [ansible-config](https://github.com/12urenloop/ansible-config/) repository on the laptop and follow the install instructions for dependencies in the `README.md`.
77+
78+
## Deploying
79+
80+
Ensure your `hosts.yml` is accurate.
81+
82+
Then, execute all relevant ansible playbooks:
83+
84+
```sh
85+
ansible-playbook -kK playbook-01-common-init.yml
86+
ansible-playbook -kK playbook-02-clients-init.yml
87+
ansible-playbook -kK playbook-03-stations-init.yml
88+
```
89+
90+
```sh
91+
ansible-playbook -kK playbook-10-stations-ronny.yml
92+
# ansible-playbook -kK playbook-11-stations-uwb.yml # prototype
93+
```
94+
95+
```sh
96+
ansible-playbook -kK playbook-20-client1-telraam.yml
97+
...
98+
```
99+
100+
```sh
101+
ansible-playbook -kK playbook-30-client2-monitoring.yml
102+
...
103+
```

HARDWARE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Hardware
3-
nav_order: 91
3+
nav_order: 92
44
---
55

66
# Hardware
@@ -44,4 +44,4 @@ The voltage converters are connected via JST XH connectors to the battery: one c
4444
the polarity wrong. The lead of the connector connected to the battery is glued to the battery, to prevent stain
4545
on the wire connected to the terminal.
4646

47-
TODO - insert pictures
47+
TODO - insert pictures

MATERIAAL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Materiaal
3-
nav_order: 93
3+
nav_order: 94
44
---
55

66
Page is out of date and needs maintenance

NETWERK.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Network
3-
nav_order: 92
3+
nav_order: 93
44
---
55

66
# Netwerk

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This repo should help you give an overview of things that exist in relation to o
77
There are some **must reads** here:
88

99
- [APPLICATIONS](./APPLICATIONS)
10+
- [DEPLOYING](./DEPLOYING)
1011
- [HARDWARE](./HARDWARE)
1112
- [NETWORK](./NETWERK)
1213
- [MATERIAAL](./MATERIAAL)

deploying/prepare_a_client.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
parent: Deploying
3+
title: Preparing a client for the ansible-config
4+
---
5+
6+
# Preparing a client for the ansible-config
7+
8+
1. Download the Debian netinst image `debian-x.y.z-amd64-netinst.iso` from: <https://ftp.belnet.be/debian-cd/current/amd64/iso-cd/>
9+
10+
2. Flash it to a (Zeus) usb stick with e.g.: `dd if=debian-x.y.z-amd64-netinst.iso of=/dev/sdX bs=1M oflag=sync status=progress` , substitute `/dev/sdX` for the usb stick as reported by `lsblk -f` and triple check this.
11+
12+
3. Boot from the installer usb by mashing `F12` on boot.
13+
14+
4. Proceed through the installer:
15+
16+
- Connect it to the kelder network during installation.
17+
- Set the language to `English`.
18+
- Set the location to `Belgium` or `Brussels`.
19+
- Set the locale to `en_GB.UTF-8`.
20+
- Set the keymap to `Belgian`.
21+
- Use **ethernet** for networking.
22+
- Set the **hostname to `client1` or `client2`**.
23+
- Leave the domain empty.
24+
- **Use `zeus` as the default username**.
25+
- Overwrite the **entire disk** with `Guided - use entire disk`.
26+
- Use the recommended mirror, without proxy.
27+
- Select any desktop environment, and **enable ssh**.
28+
29+
5. Wait for the installer to finish, **unplug the ethernet cable**, then configure the following:
30+
31+
- Disable shutdown on power button press.
32+
- **Disable auto-suspend**.
33+
- Disable screensaver / display auto power off.
34+
35+
Repeat steps 3 through 5 for the other client as well.

deploying/prepare_a_ronny.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
parent: Deploying
3+
title: Preparing a ronny for the ansible-config
4+
---
5+
6+
# Preparing a ronny for the ansible-config
7+
8+
1. Download the latest Armbian (Debian 13 minimal) image from <https://armbian.com/boards/rpi4b>
9+
10+
2. Uncompress it: `unxz Armbian_x.y.z_Rpi4b_trixie_current_x.y.z_minimal.img.xz`
11+
12+
3. Flash it to the µSD card with e.g.: `dd if=Armbian_x.y.z_Rpi4b_trixie_current_x.y.z_minimal.img of=/dev/sdX bs=1M oflag=sync status=progress` , substitute `/dev/sdX` for the µSD card as reported by `lsblk -f` and triple check this.
13+
14+
4. Attach the ronny to the Telnet switch.
15+
16+
5. Power up the ronny.
17+
18+
6. Ssh to `root@172.12.50.10X`, where `X` is the ronny's number:
19+
- Set the root password.
20+
- Create the `zeus` user, with the same password as root.
21+
- **Now close your terminal**
22+
- That's it!

0 commit comments

Comments
 (0)