cleanup: lint all files with obsidian linter

redbrick · Jan 31, 2024 · 82cedf4 · 82cedf4
1 parent c6b16ff
commit 82cedf4
Show file tree

Hide file tree

Showing 40 changed files with 243 additions and 204 deletions.
diff --git a/docs/aperture/about.md b/docs/aperture/about.md
@@ -1,4 +1,3 @@
-
 # About Aperture
 
 Aperture is Redbrick's fleet of hardware that was installed in May 2022 by `distro`, `pints`, `skins`, `cawnj`, `ymacomp` and `arkues`.

diff --git a/docs/aperture/ansible.md b/docs/aperture/ansible.md
@@ -2,21 +2,21 @@
 
 Redbrick uses ansible to manage its infrastructure. This document describes the procedures and some tips to get the most out of it.
 
-## Getting started
+## Getting Started
 
-### Installing ansible
+### Installing Ansible
 
 Ansible is a python package, so you'll need to install python first. On Debian/Ubuntu, you can do this with:
 
 ```bash
 pip install ansible
 ```
 
-### Add an SSH key
+### Add an SSH Key
 
 Ansible uses ssh to connect to the remote hosts. You'll need to set up your ssh key so that you can connect to the hosts without constant prompts for passwords.
 
-### Create a hosts file
+### Create a Hosts File
 
 This is used a phonebook of sorts for ansible. It tells ansible which hosts to connect to, and what user to use.
 
@@ -44,7 +44,7 @@ This should connect to all the hosts in the `aperture` group, and run the `ping`
 
 Ansible playbooks are a set of instructions for ansible to run. They're written in YAML, and are usually stored in a file called `playbook.yml`.
 
-### Writing a playbook
+### Writing a Playbook
 
 Ansible playbooks are written in YAML. The basic structure is:
 
@@ -69,7 +69,7 @@ Ansible playbooks are written in YAML. The basic structure is:
 
 This playbook will connect to all the hosts in the `aperture` group, and run the `apt` module with the `name` and `state` options.
 
-### Running a playbook
+### Running a Playbook
 
 ```bash
 ansible-playbook playbook.yml -i hosts

diff --git a/docs/aperture/bastion-vm.md b/docs/aperture/bastion-vm.md
@@ -17,4 +17,3 @@ You'll need a webserver to serve the `cloud-init` configs. There may be another
 Plan the Nomad job and wait for the allocation to be created. If you used the correct image (for example a backup of the qcow file) the virtual machine should be configured and should connect as normal to the Consul and Nomad clusters and become eligible for allocations. If you started from scratch, then use the `ansible/redbrick-ansible.yml` playbook in the [`redbrick/nomad`](https://github.com/redbrick/nomad) repo and ensure that the `hosts` file is up to date.
 
 For security's sake, there is no root login and no user accounts on the bastion VM. This is an attempt to make the node more secure. If you need to make changes, you should change the base image and apply that. The less vulnerabilities that are discovered on the bastion VM, the happier we can keep ISS and the safer Redbrick will be.
-
diff --git a/docs/aperture/firewall.md b/docs/aperture/firewall.md
@@ -28,7 +28,6 @@ There is a "super admin" account that can be used for **local access only**, det
 
 The UDM Pro should be kept up to date at all times using the web interface. Please ensure there are no breaking changes before updating.
 
-
 > [!ERROR] AUTO UPDATES SHOULD NEVER BE ENABLED!
 > This is to prevent a bad update from breaking the UDM Pro and thus the entire network. 
 > If you are confident that Unifi can produce stable updates, you may turn it on, however please let the next admins know that you have done this (and update these docs with a comment!).
@@ -46,6 +45,7 @@ Backups are configured to run every week at 1am on a Sunday. 20 backups are stor
 ## External Addresses
 
 `Mordor` is NATted when it accesses the Internet. This is because the link address between it and DCU is on a private address.
+
 This NATting is used *only* for the UDM pro device itself, not for the `136.206.16.0/24` network, and is to allow the UDM box itself to access the Internet.
 
 The `136.206.16.0/24` network is routed down to the UDM pro box, within the DCU network. Essentially there is a route in DCU's network that says "if you want to access `136.206.16.0/24` go to `mordor`".
diff --git a/docs/aperture/icecast.md b/docs/aperture/icecast.md
@@ -10,7 +10,6 @@ The configuration file for icecast is located in the [nomad config repo](https:/
 
 It should just be a case of running `nomad job plan clubs-socs/dcufm.hcl` to plan and run the job.
 
-
 > [!NOTE] Note
 > The job may bind to either the internal or external address. Ensure that if you make a change to the config, you inform DCUfm that they may need to switch which server they use.
 
@@ -19,9 +18,11 @@ It should just be a case of running `nomad job plan clubs-socs/dcufm.hcl` to pla
 DCUfm use [butt](https://danielnoethen.de/butt/) on a desktop in their studio to stream to Icecast.
 
 The desktop must be connected to the VPN to ensure the stream stays up, and traefik doesn't reset the connection every 10 seconds. The current icecast configuration for the server is `10.10.0.5:2333` or `136.206.16.5:2333` (see above note).
+
 Read more about it in [this issue](https://github.com/redbrick/issue-tracker/issues/4).
 
 A shortcut to the VPN is available on the desktop (change a shortcut to the binary to include `--connect profile.ovpn`.
+
 See [here](https://munkjensen.net/wiki/index.php/Connect_OpenVPN_on_Windows_startup)).
 
 ## DCUfm Cheat Sheet
@@ -33,12 +34,15 @@ This is a cheat sheet for DCUfm to help them stream to `icecast`.
 You'll need to connect to the Redbrick VPN to stream to `icecast`. You can do this by double clicking the shortcut on the desktop.
 
 You'll then need to go to bottom right corner of the screen and right click this icon:
+
 ![Disconnected OpenVPN icon](https://i.dbyte.xyz/2022-11-I9.png)
 
 A popup will appear, click connect. This will connect you to the VPN. It may take a second, but a window will pop up with a lot of text. The VPN will connect and then it'll close.
+
 ![Connect to OpenVPN](https://i.dbyte.xyz/2022-11-AV.png)
 
 You should end up with an icon like this:
+
 ![Connected OpenVPN icon](https://i.dbyte.xyz/2022-11-16.png)
 
 You're now connected to the VPN.
@@ -49,11 +53,10 @@ You'll need to connect to `icecast` to stream to it. BUTT is the software we use
 
 The username and password should already be configured in the software. If not, ask a [redbrick sysadmin](../contact.md) for the login details.
 
-
 > [!WARNING] Warning!
 > If you find that butt is not connecting, then you may need to switch which server you're connecting to. To do this, go to settings, and then the "Main" tab. In the dropdown, select either DCUfm 1 or DCUfm 2 (try both, one will definitely work).
 
-### Saving your stream
+### Saving Your Stream
 
 Your stream will be saved automatically onto the desktop into a folder called `Recordings YYYY` (where `YYYY` is the current year), with the date and time of the recording, and the format `.mp3`. Take this file with you (via a USB or similar) if you want to keep it for later, it will not be kept on the desktop for long!
 

diff --git a/docs/aperture/images.md b/docs/aperture/images.md
@@ -3,15 +3,21 @@
 ## Servers
 
 ![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](../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
@@ -1,12 +1,12 @@
 # Aperture
 
-## What is aperture?
+## What is Aperture?
+
 It's nothing to do with cameras. See [about](about.md) for more information on the hardware.
 
 ## New Admins
 
-If you're a new admin, this is a cheat sheet for you. In order to get broadly up to speed and understand the content of
-these pages, I suggest you read the following:
+If you're a new admin, this is a cheat sheet for you. In order to get broadly up to speed and understand the content of 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.

diff --git a/docs/aperture/nomad.md b/docs/aperture/nomad.md
@@ -1,14 +1,16 @@
 # Nomad on Aperture - `distro`, `wizzdom`
+
 > Adapted from the [redbrick/nomad repo's README](https://github.com/redbrick/nomad/README.md)
 
 ## What is Nomad?
+
 Good question!
 
 > Nomad is a simple and flexible scheduler and orchestrator to deploy and manage
 > containers and non-containerized applications
 > \- [Nomad Docs](https://developer.hashicorp.com/nomad)
 
-## Deploying a Nomad job
+## Deploying a Nomad Job
 
 All Nomad job related configurations are stored in the `nomad` directory.
 
@@ -38,8 +40,7 @@ nomad job plan path/to/file.hcl | grep path/to/file.hcl | bash
 
 This will plan and run the job file without the need for you to copy and paste the check index id. Only use this once you are comfortable with how Nomad places allocations.
 
-
-## Restart a Nomad job
+## Restart a Nomad Job
 
 ```bash
 nomad job stop -purge name-of-running-job

diff --git a/docs/aperture/vpn.md b/docs/aperture/vpn.md
@@ -8,7 +8,7 @@ If you just want to create a new client configuration, go here: [adding a new cl
 
 Installed OpenVPN using [this script](https://github.com/Nyr/openvpn-install) on [`glados`](../hardware/aperture/glados.md).
 
-## Adding a new client
+## Adding a New Client
 
 To add a new client, run the following command (as root) on Glados:
 
@@ -20,7 +20,7 @@ You will be prompted to add a new client, enter a name for the client and then t
 
 It will be saved in `/root/[client name].ovpn`.
 
-## Revoking a client
+## Revoking a Client
 
 To revoke a client, run the following command (as root) on Glados:
 
@@ -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](../hardware/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/contact.md b/docs/contact.md
@@ -1,7 +1,5 @@
 # Contact Us
 
-If you have any questions or comments, please contact us at
-[[email protected]](mailto:[email protected]). Or you can join the
-[Discord server](https://discord.gg/MttnTq9UyK)!
+If you have any questions or comments, please contact us at [[email protected]](mailto:[email protected]). Or you can join the [Discord server](https://discord.gg/MttnTq9UyK)!
 
-<iframe src="https://discord.com/widget?id=568403963595063307&theme=dark" width="350" height="500" allowtransparency="true" frameborder="0" sandbox="allow-popups allow-popups-to-escape-sandbox allow-same-origin allow-scripts"></iframe>
+<iframe src="https://discord.com/widget?id=568403963595063307&theme=dark" width="350" height="500" allowtransparency="true" frameborder="0" sandbox="allow-popups allow-popups-to-escape-sandbox allow-same-origin allow-scripts"></iframe>
diff --git a/docs/hardware.md b/docs/hardware.md
diff --git a/docs/hardware/aperture/chell.md b/docs/hardware/aperture/chell.md
@@ -1,6 +1,7 @@
 # Chell
 
 ## Details
+
 - **Type**: Dell R6515
 - **OS**: Debian 11
 - **CPU**: AMD 7302P 3GHz, 16C/32T, 128M, 155W
@@ -9,13 +10,13 @@
 
 Part of [aperture](../../aperture/index.md)
 
-## Where to find
+## Where to Find
+
 - **Internal**:
 	- `10.10.0.6`
 - **External**:
 	- `136.206.16.6`
 	- `chell.redbrick.dcu.ie`
 	- `chell.aperture.redbrick.dcu.ie`
 
-
-![](../../res/chell.png)
+![](../../res/chell.png)
diff --git a/docs/hardware/aperture/glados.md b/docs/hardware/aperture/glados.md
@@ -1,6 +1,7 @@
 # Glados
 
 ## Details
+
 - **Type**: Dell R6515
 - **OS**: Debian 11
 - **CPU**: AMD 7302P 3GHz, 16C/32T, 128M, 155W
@@ -9,13 +10,13 @@
 
 Part of [aperture](../../aperture/index.md)
 
-## Where to find
+## Where to Find
+
 - **Internal**:
 	- `10.10.0.4`
 - **External**:
 	- `136.206.16.4`
 	- `glados.redbrick.dcu.ie`
 	- `glados.aperture.redbrick.dcu.ie`
 
-
-![](../../res/glados.png)
+![](../../res/glados.png)
diff --git a/docs/hardware/aperture/johnson.md b/docs/hardware/aperture/johnson.md
@@ -1,6 +1,7 @@
 # Johnson
 
 ## Details
+
 Formerly `albus` (in a different life)
 
 - **Type**: Dell PowerEdge R515
@@ -15,12 +16,14 @@ Formerly `albus` (in a different life)
 
 Part of [aperture](../../aperture/index.md)
 
-## Where to find
+## Where to Find
+
 - **Internal**:
 	- `10.10.0.7`
 - 2nd NIC is currently unused, would be a good idea to make a bond for more throughput and redundancy on the same ip
+
 ## Services
-- `NFS` for [aperture](../../aperture/index.md)
 
+- `NFS` for [aperture](../../aperture/index.md)
 
-![](../../res/johnson.png)
+![](../../res/johnson.png)
diff --git a/docs/hardware/aperture/wheatley.md b/docs/hardware/aperture/wheatley.md
@@ -1,6 +1,7 @@
 # Wheatley
 
 ## Details
+
 - **Type**: Dell R6515
 - **OS**: Debian 11
 - **CPU**: AMD 7302P 3GHz, 16C/32T, 128M, 155W
@@ -9,13 +10,13 @@
 
 Part of [aperture](../../aperture/index.md)
 
-## Where to find
+## Where to Find
+
 - **Internal**:
 	- `10.10.0.5`
 - **External**:
 	- `136.206.16.5`
 	- `wheatley.redbrick.dcu.ie`
 	- `wheatley.aperture.redbrick.dcu.ie`
 
-
-![](../../res/wheatley.png)
+![](../../res/wheatley.png)
diff --git a/docs/hardware/azazel.md b/docs/hardware/azazel.md
@@ -1,6 +1,7 @@
 # Azazel
 
 ## Details
+
 - **Type**: Dell PowerEdge R515
 - **OS**: Debian 10
 - **CPU**: 2 x AMD Opteron 4180 @ 2.6Ghz
@@ -11,12 +12,14 @@
 - **Drives**: Internal SATA DVD±RW
 - **Network**: 2x Onboard Ethernet
 
-## Where to find
+## Where to Find
+
 - **Internal**:
 	- `10.5.0.1`
 - **External**:
 	- `136.206.15.24`
 
 ## Services
+
 - primary ssh login box for users (see [Logging in](../services/servers.md#Logging%20in))
-- jump-box for admins
+- jump-box for admins
diff --git a/docs/hardware/index.md b/docs/hardware/index.md
@@ -1,10 +1,14 @@
 # Hardware
 
+Here is a list of current hardware in Redbrick's suite of servers, switches and other bits.
+
 ## [Login](../services/servers.md#Logging%20in) Boxes
+
 - [**azazel**](azazel.md)
 - [**pygmalion**](pygmalion.md)
 
 ## [NixOS](../procedures/nixos.md) Boxes
+
 - [**hardcase**](nix/hardcase.md)
 - [**motherlode**](nix/motherlode.md)
 - [**icarus**](nix/icarus.md)
@@ -13,7 +17,8 @@
 - [**zeus**](zeus.md)
 
 ## [Aperture](../aperture/index.md)
+
 - [**glados**](aperture/glados.md)
 - [**wheatley**](aperture/wheatley.md)
 - [**chell**](aperture/chell.md)
-- [**johnson**](aperture/johnson.md)
+- [**johnson**](aperture/johnson.md)
Original file line number	Diff line number	Diff line change
		@@ -1,4 +1,3 @@

		# About Aperture

		Aperture is Redbrick's fleet of hardware that was installed in May 2022 by `distro`, `pints`, `skins`, `cawnj`, `ymacomp` and `arkues`.
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -17,4 +17,3 @@ You'll need a webserver to serve the `cloud-init` configs. There may be another
		Plan the Nomad job and wait for the allocation to be created. If you used the correct image (for example a backup of the qcow file) the virtual machine should be configured and should connect as normal to the Consul and Nomad clusters and become eligible for allocations. If you started from scratch, then use the `ansible/redbrick-ansible.yml` playbook in the [`redbrick/nomad`](https://github.com/redbrick/nomad) repo and ensure that the `hosts` file is up to date.

		For security's sake, there is no root login and no user accounts on the bastion VM. This is an attempt to make the node more secure. If you need to make changes, you should change the base image and apply that. The less vulnerabilities that are discovered on the bastion VM, the happier we can keep ISS and the safer Redbrick will be.