Merge pull request #23 from redbrick/refactor-layout

refactor file structure
redbrick · Jan 30, 2024 · c6b16ff · c6b16ff
2 parents 75523ae + 497d267
commit c6b16ff
Show file tree

Hide file tree

Showing 46 changed files with 234 additions and 48 deletions.
diff --git a/docs/.pages b/docs/.pages
@@ -4,5 +4,5 @@ nav:
 - contact.md
 - procedures
 - aperture
-- hosts
+- hardware
 - services
diff --git a/docs/aperture/about.md b/docs/aperture/about.md
@@ -5,7 +5,7 @@ Aperture is Redbrick's fleet of hardware that was installed in May 2022 by `dist
 
 It consists of:
 
-- 3x Dell R6515 - [`glados`](/hosts/aperture/glados), [`wheatley`](/hosts/aperture/wheatley), [`chell`](/hosts/aperture/chell)
+- 3x Dell R6515 - [`glados`](../hardware/aperture/glados.md), [`wheatley`](../hardware/aperture/wheatley.md), [`chell`](../hardware/aperture/chell.md)
 
  |                    CPU                    |                RAM                |             Storage              |
  |:-----------------------------------------:|:---------------------------------:|:--------------------------------:|
@@ -16,7 +16,7 @@ It consists of:
 
 ## Servers
 
-The three servers are named [`glados`](../hosts/aperture/glados.md) , [`wheatley`](../hosts/aperture/wheatley.md) and [`chell`](../hosts/aperture/chell.md).
+The three servers are named [`glados`](../hardware/aperture/glados.md) , [`wheatley`](../hardware/aperture/wheatley.md) and [`chell`](../hardware/aperture/chell.md).
 
 ## Networks
 
@@ -42,7 +42,7 @@ The IP address range for the [`aperture`](index.md) subnet is `10.10.0.0/24`, wi
 
 `nexus` is the name of the KVM switch. It's internal IP address is `10.10.0.10`.
 
-[`glados`](../hosts/aperture/glados.md) is connected on port 1, [`wheatley`](../hosts/aperture/wheatley.md) on port 2, and [`chell`](../hosts/aperture/chell.md) on port 3.
+[`glados`](../hardware/aperture/glados.md) is connected on port 1, [`wheatley`](../hardware/aperture/wheatley.md) on port 2, and [`chell`](../hardware/aperture/chell.md) on port 3.
 
 > [!WARNING] Note!
 > **Yellow** cables are used for **KVM network**.

diff --git a/docs/aperture/firewall.md b/docs/aperture/firewall.md
@@ -18,11 +18,11 @@ We have a 10 GB/s link to DCU's core.
 
 ### Users
 
-The current elected admins should all have access to the rbadmin account on the firewall. Rootholders **should not** have access to the firewall unless they are explicity granted access.
+The current elected admins should all have access to the rbadmin account on the firewall. Rootholders **should not** have access to the firewall unless they are explicitly granted access.
 
-The owner account of the unifi equipment is `rbadmins` (email: [email protected]) with the password stored in pwsafe under `unifi`.
+The owner account of the unifi equipment is `rbadmins` (email: [email protected]) with the password stored in `pwsafe` under `unifi`.
 
-There is a "super admin" account that can be used for **local access only**, details are stored in pwsafe under `udmpro-super-admin`.
+There is a "super admin" account that can be used for **local access only**, details are stored in `pwsafe` under `udmpro-super-admin`.
 
 ### Updates
 

diff --git a/docs/aperture/images.md b/docs/aperture/images.md
@@ -2,17 +2,17 @@
 
 ## Servers
 
-![distro hanging cables](../assets/distro-hanging-cables.jpg)
-![new installed servers](../assets/new-installed-servers.jpg)
-![inside of server](../assets/inside-of-server.jpg)
+![distro hanging cables](../res/distro-hanging-cables.jpg)
+![new installed servers](../res/new-installed-servers.jpg)
+![inside of server](../res/inside-of-server.jpg)
 
 ## Networking
 
-![isengard](../assets/isengard.jpg)
-![mordor and rivendell](../assets/mordor-and-rivendell.jpg)
-![labelled cables for mordor and rivendell](../assets/labelled-cables-for-mordor-and-rivendell.jpg)
-![labelled cables for isengard](../assets/labelled-cables-for-isengard.jpg)
-![tidy cables for glados, wheatley and chell](../assets/cables-glados-wheatley-chell.jpg)
+![isengard](../res/isengard.jpg)
+![mordor and rivendell](../res/mordor-and-rivendell.jpg)
+![labelled cables for mordor and rivendell](../res/labelled-cables-for-mordor-and-rivendell.jpg)
+![labelled cables for isengard](../res/labelled-cables-for-isengard.jpg)
+![tidy cables for glados, wheatley and chell](../res/cables-glados-wheatley-chell.jpg)
 
 ## Some Dancing for Good Measure
 

diff --git a/docs/aperture/index.md b/docs/aperture/index.md
@@ -9,8 +9,7 @@ If you're a new admin, this is a cheat sheet for you. In order to get broadly up
 these pages, I suggest you read the following:
 
 - [About](about.md)
-- [Nomad docs](https://www.nomadproject.io/docs/), specifically the [job specification](https://developer.hashicorp.com/nomad/docs/job-specification)
-and [managing nomad jobs](https://developer.hashicorp.com/nomad/tutorials/manage-jobs) pages.
+- [Nomad docs](https://www.nomadproject.io/docs/), specifically the [job specification](https://developer.hashicorp.com/nomad/docs/job-specification) and [managing nomad jobs](https://developer.hashicorp.com/nomad/tutorials/manage-jobs) pages.
 - [Consul docs](https://www.consul.io/docs), specifically how it can be used with Nomad.
 - [Ansible docs](https://docs.ansible.com/ansible/latest/index.html), specifically the [playbook](https://docs.ansible.com/ansible/latest/user_guide/playbooks.html)
 

diff --git a/docs/aperture/vpn.md b/docs/aperture/vpn.md
@@ -6,7 +6,7 @@ If you just want to create a new client configuration, go here: [adding a new cl
 
 ## Setup
 
-Installed OpenVPN using [this script](https://github.com/Nyr/openvpn-install) on [`glados`](../hosts/aperture/glados.md).
+Installed OpenVPN using [this script](https://github.com/Nyr/openvpn-install) on [`glados`](../hardware/aperture/glados.md).
 
 ## Adding a new client
 
@@ -32,4 +32,4 @@ You will be prompted to revoke a client, enter the name of the client you want t
 
 ## Connecting to the VPN
 
-To connect to the VPN, you will need to download the client configuration file from [glados](../hosts/aperture/glados.md) and then import it into your OpenVPN client.
+To connect to the VPN, you will need to download the client configuration file from [glados](../hardware/aperture/glados.md) and then import it into your OpenVPN client.
diff --git a/docs/hosts/aperture/chell.md → docs/hardware/aperture/chell.md b/docs/hosts/aperture/chell.md → docs/hardware/aperture/chell.md
@@ -18,4 +18,4 @@ Part of [aperture](../../aperture/index.md)
 	- `chell.aperture.redbrick.dcu.ie`
 
 
-![](../../assets/chell.png)
+![](../../res/chell.png)
diff --git a/docs/hosts/aperture/glados.md → docs/hardware/aperture/glados.md b/docs/hosts/aperture/glados.md → docs/hardware/aperture/glados.md
@@ -18,4 +18,4 @@ Part of [aperture](../../aperture/index.md)
 	- `glados.aperture.redbrick.dcu.ie`
 
 
-![](../../assets/glados.png)
+![](../../res/glados.png)
diff --git a/docs/hosts/aperture/johnson.md → docs/hardware/aperture/johnson.md b/docs/hosts/aperture/johnson.md → docs/hardware/aperture/johnson.md
@@ -23,4 +23,4 @@ Part of [aperture](../../aperture/index.md)
 - `NFS` for [aperture](../../aperture/index.md)
 
 
-![](../../assets/johnson.png)
+![](../../res/johnson.png)
diff --git a/docs/hosts/aperture/wheatley.md → docs/hardware/aperture/wheatley.md b/docs/hosts/aperture/wheatley.md → docs/hardware/aperture/wheatley.md
@@ -18,4 +18,4 @@ Part of [aperture](../../aperture/index.md)
 	- `wheatley.aperture.redbrick.dcu.ie`
 
 
-![](../../assets/wheatley.png)
+![](../../res/wheatley.png)
diff --git a/docs/hosts/azazel.md → docs/hardware/azazel.md b/docs/hosts/azazel.md → docs/hardware/azazel.md
diff --git a/docs/hosts/index.md → docs/hardware/index.md b/docs/hosts/index.md → docs/hardware/index.md
@@ -1,4 +1,4 @@
-# Hosts
+# Hardware
 
 ## [Login](../services/servers.md#Logging%20in) Boxes
 - [**azazel**](azazel.md)

diff --git a/docs/hosts/nix/hardcase.md → docs/hardware/nix/hardcase.md b/docs/hosts/nix/hardcase.md → docs/hardware/nix/hardcase.md
diff --git a/docs/hosts/nix/icarus.md → docs/hardware/nix/icarus.md b/docs/hosts/nix/icarus.md → docs/hardware/nix/icarus.md
diff --git a/docs/hosts/nix/motherlode.md → docs/hardware/nix/motherlode.md b/docs/hosts/nix/motherlode.md → docs/hardware/nix/motherlode.md
diff --git a/docs/hosts/paphos.md → docs/hardware/paphos.md b/docs/hosts/paphos.md → docs/hardware/paphos.md
diff --git a/docs/hosts/pygmalion.md → docs/hardware/pygmalion.md b/docs/hosts/pygmalion.md → docs/hardware/pygmalion.md
diff --git a/docs/hosts/zeus.md → docs/hardware/zeus.md b/docs/hosts/zeus.md → docs/hardware/zeus.md
diff --git a/docs/procedures/post-powercut.md b/docs/procedures/post-powercut.md
@@ -8,8 +8,8 @@ A list of things that should be done/checked immediately after a power cut:
 - Stop Exim on the mail server (Morpheus) until minerva (NFS) is online.
 - If LDAP is down, you'll need to use the ALOM to do the next step.
 - Check that ldapclient started (svcs -xv). If it didn't, run svcadm clear ldap/client to make it start. This usually happens because murphy comes back before morpheus does, and the LDAP client won't start due to lack of an LDAP server.
-- Apache on [hardcase](../hosts/nix/hardcase.md) sometimes tries to start before networking is finished starting. To fix it, disable/re-enable it a few times. This usually makes it turn on.
-- [paphos](../hosts/paphos.md) is old and sometimes its time will become out of sync. To make sure its time is accurate, run:
+- Apache on [hardcase](../hardware/nix/hardcase.md) sometimes tries to start before networking is finished starting. To fix it, disable/re-enable it a few times. This usually makes it turn on.
+- [paphos](../hardware/paphos.md) is old and sometimes its time will become out of sync. To make sure its time is accurate, run:
 ```bash
 sudo service ntp restart
 ```

diff --git a/docs/assets/cables-glados-wheatley-chell.jpg → docs/res/cables-glados-wheatley-chell.jpg b/docs/assets/cables-glados-wheatley-chell.jpg → docs/res/cables-glados-wheatley-chell.jpg
diff --git a/docs/assets/chell.png → docs/res/chell.png b/docs/assets/chell.png → docs/res/chell.png
diff --git a/docs/res/chell.txt b/docs/res/chell.txt
@@ -0,0 +1,62 @@
+                                                          . ..                                                               
+                                                       :-+*+:..:.                                                            
+                                                      :-+@%#=...:.                                                           
+                                                     :#+*%+=- .. .                                                           
+                                                     +%%##%%+=-:-                                                            
+                                                     =#***#***+++                                                            
+                                              .=++-. .*******+::....                                                         
+                                             +%%%%%%****++++=..:::...             .     ..                                   
+                                           -%%%%##%%%*####**:    .:-====-=      ..:-==-.  .                                  
+                                         =#%%###*+*%%*%#####%+.-*%@@@@@@@@=:-==+:-%@@@@@*:                                   
+                                       :#%%###*===+##%@%%###%@@@@@@@@@@@@@=--::.:@@%@#*%@@*:                                 
+                                      =%%###*+=-=+*##@@%%%@@@@@@@@@@@@@@@= ... :%@%#*-=*#+-.                                 
+                                    .*%%%%%#######%@@@@@%@@@@@@@@@@@@@##- .....+*++****+-                                    
+                                    *####%%%%#####%@@@@@%*#%@@@@@@@%#+.       :+==++=-.                                      
+                                    -+++***++++++=+**####==--===-::...:-++=:.=+*==-.                                         
+                                        ..:+++=====+**#%@##*=*       .-+**####**+.                                           
+                                           ****#******#%%@%@@=          :-+***+-                                             
+                                           #*****###**######-              :::                                               
+                                         .+#*++++**#######=                                                                  
+                                       :=+=====+******###*                                                                   
+                                     =**+===---==++++***+                                                                    
+                                    +#***++++======+**+                                                                      
+                                   *#****+=++++=-====-                                                                       
+                                  =#****++=-:::::-=++==-:.                                                                   
+                                  #****++-::-==+++++++++**=-.::-==:                                                          
+                                 :*++++=::-=+++++++++++++++++*+=--.                                                          
+                                 .++=-::-========++++++++++===++==:                                                          
+                                  ==:.::::------=============++===+=:                                                        
+                                   :        ..::::-----+###*+::======                                                        
+                                   ....::::..       .=**+=-==:.::----:                                                       
+                                  ..    ..::::..  :=++*===--==:..::::.                                                       
+                                  .         .:::=*#*:.=#==--:--.                                                             
+                                             :+#@#*#+:.=+=-:                                                                 
+                                          .:+%%%#+#**-..--=+                                                                 
+                                    -++*#%@%#%#%+===:::::--==                                                                
+                                  :%@@@@%%%%###*-:-:::::::-=+=                                                               
+                                 +@%*%%#####*=:   .-:::::::-=+.                                                              
+                               -@@*#%%%%##*:       :-:::::::-=-                                                              
+                              =@@*#%%###+.          :-:::::---=                                                              
+                              -#@@@%%#+.             --::::-----                                                             
+                               .=+#%@*                .-:::--===:                                                            
+                                   .=:                 .==-:---==                                                            
+                                                        *@%*:::-=:                                                           
+                                                        #%%@*--==+.                                                          
+                                                       .#%%%%+:-=++                                                          
+                                                         *%%%%+=++*-                                                         
+                                                          =*###+----.                                                        
+                                                            -*##+--+*                                                        
+                                                              =#%%#**+                                                       
+                                                               :#%%%%%*:                                                     
+                                                                .#%%%@@@:                                                    
+                                                                 .-+##%@%-                                                   
+                                                                   ..#%%%@*:                                                 
+                                                                   ..=@%%%@@%=                                               
+                                                                    ::%%%#%%@@%*++#-..                                       
+                                                                    ..+@%##%%%%@@%+.                                         
+                                                                      :***++*#%*-.                                           
+                                                                             :-                                              
+
+
+
+
diff --git a/docs/assets/distro-hanging-cables.jpg → docs/res/distro-hanging-cables.jpg b/docs/assets/distro-hanging-cables.jpg → docs/res/distro-hanging-cables.jpg
diff --git a/docs/assets/favicon.png → docs/res/favicon.png b/docs/assets/favicon.png → docs/res/favicon.png
diff --git a/docs/assets/glados.png → docs/res/glados.png b/docs/assets/glados.png → docs/res/glados.png
Original file line number	Diff line number	Diff line change
Expand Up		@@ -18,4 +18,4 @@ Part of [aperture](../../aperture/index.md)
		- `chell.aperture.redbrick.dcu.ie`


		![](../../assets/chell.png)
		![](../../res/chell.png)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -18,4 +18,4 @@ Part of [aperture](../../aperture/index.md)
		- `glados.aperture.redbrick.dcu.ie`


		![](../../assets/glados.png)
		![](../../res/glados.png)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -23,4 +23,4 @@ Part of [aperture](../../aperture/index.md)
		- `NFS` for [aperture](../../aperture/index.md)


		![](../../assets/johnson.png)
		![](../../res/johnson.png)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -18,4 +18,4 @@ Part of [aperture](../../aperture/index.md)
		- `wheatley.aperture.redbrick.dcu.ie`


		![](../../assets/wheatley.png)
		![](../../res/wheatley.png)