refactor: split aperture section, styling changes (#26)

* refactor: split aperture section, styling changes * mkdocs: update footer, fix codeblocks, add glightbox * remove aperture section, split contents across all sections * move ansible to procedures/ * add redirects for aperture/* links * ci: update pipeline to use latest actions * make footer name bold, remove whitespace from logo * refactor: add links to corresponding index pages * add a proper dark redbrick theme
redbrick · Mar 1, 2024 · 7a91dee · 7a91dee
1 parent d8672ee
commit 7a91dee
Show file tree

Hide file tree

Showing 32 changed files with 185 additions and 85 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -4,13 +4,26 @@ on:
     branches:
       - master
       - main
+permissions:
+  contents: write
 jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
         with:
           python-version: 3.x
-      - run: pip install mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-awesome-pages-plugin mkdocs-callouts material-plausible-plugin
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-awesome-pages-plugin mkdocs-callouts material-plausible-plugin mkdocs-glightbox mkdocs-redirects
       - run: mkdocs gh-deploy --force
diff --git a/docs/.pages b/docs/.pages
@@ -1,8 +1,7 @@
 nav:
 
 - index.md
-- contact.md
 - procedures
-- aperture
 - hardware
 - services
+- contact.md
diff --git a/docs/aperture/.pages b/docs/aperture/.pages
diff --git a/docs/aperture/images.md b/docs/aperture/images.md
diff --git a/docs/aperture/socs.md b/docs/aperture/socs.md
diff --git a/docs/aperture/about.md → docs/hardware/aperture/about.md b/docs/aperture/about.md → docs/hardware/aperture/about.md
@@ -4,7 +4,7 @@ Aperture is Redbrick's fleet of hardware that was installed in May 2022 by `dist
 
 It consists of:
 
-- 3x Dell R6515 - [`glados`](../hardware/aperture/glados.md), [`wheatley`](../hardware/aperture/wheatley.md), [`chell`](../hardware/aperture/chell.md)
+- 3x Dell R6515 - [`glados`](glados.md), [`wheatley`](wheatley.md), [`chell`](chell.md)
 
  |                    CPU                    |                RAM                |             Storage              |
  |:-----------------------------------------:|:---------------------------------:|:--------------------------------:|
@@ -15,11 +15,11 @@ It consists of:
 
 ## Servers
 
-The three servers are named [`glados`](../hardware/aperture/glados.md) , [`wheatley`](../hardware/aperture/wheatley.md) and [`chell`](../hardware/aperture/chell.md).
+The three servers are named [`glados`](glados.md) , [`wheatley`](wheatley.md) and [`chell`](chell.md).
 
 ## Networks
 
-The firewall is called [`mordor`](firewall.md), and the two 24-port switches are called [`rivendell` and `isengard`](switches.md).
+The firewall is called [`mordor`](../network/mordor.md), and the two 24-port switches are called [`rivendell` and `isengard`](../network/switches.md).
 
 ## Networking
 
@@ -41,7 +41,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`](../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.
+[`glados`](glados.md) is connected on port 1, [`wheatley`](wheatley.md) on port 2, and [`chell`](chell.md) on port 3.
 
 > [!WARNING] Note!
 > **Yellow** cables are used for **KVM network**.

diff --git a/docs/hardware/aperture/chell.md b/docs/hardware/aperture/chell.md
@@ -8,7 +8,7 @@
 - **RAM**: 2x 16GB RDIMM, 3200MT/s Dual Rank
 - **Storage**: 4x 2TB SATA HDDs (hardware RAID)
 
-Part of [aperture](../../aperture/index.md)
+Part of [aperture](index.md)
 
 ## Where to Find
 

diff --git a/docs/hardware/aperture/glados.md b/docs/hardware/aperture/glados.md
@@ -8,7 +8,7 @@
 - **RAM**: 2x 16GB RDIMM, 3200MT/s Dual Rank
 - **Storage**: 4x 2TB SATA HDDs (hardware RAID)
 
-Part of [aperture](../../aperture/index.md)
+Part of [aperture](index.md)
 
 ## Where to Find
 

diff --git a/docs/hardware/aperture/images.md b/docs/hardware/aperture/images.md
@@ -0,0 +1,25 @@
+# Images
+
+## 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
+
+[dancing.mp4](https://media.discordapp.net/attachments/846341782966632468/1004129108529254613/20220802_215014.mp4)
diff --git a/docs/aperture/index.md → docs/hardware/aperture/index.md b/docs/aperture/index.md → docs/hardware/aperture/index.md
@@ -17,5 +17,5 @@ If you're a new admin, this is a cheat sheet for you. In order to get broadly up
 
 So, you've hit a problem. Here's some quicklinks to some common problems:
 
-- [I can't connect to Aperture](vpn.md)
-- [Ansible is running into an error](ansible.md#common-errors)
+- [I can't connect to Aperture](../../procedures/vpn.md)
+- [Ansible is running into an error](../../procedures/ansible.md#common-errors)
diff --git a/docs/hardware/aperture/johnson.md b/docs/hardware/aperture/johnson.md
@@ -14,7 +14,7 @@ Formerly `albus` (in a different life)
 - **Network**: 4x Onboard Ethernet, 802.3ad bonding
 - **iDRAC NIC**: Shared on port 1
 
-Part of [aperture](../../aperture/index.md)
+Part of [aperture](index.md)
 
 ## Where to Find
 
@@ -24,6 +24,6 @@ Part of [aperture](../../aperture/index.md)
 
 ## Services
 
-- `NFS` for [aperture](../../aperture/index.md)
+- `NFS` for [aperture](index.md)
 
 ![](../../res/johnson.png)
diff --git a/docs/hardware/aperture/wheatley.md b/docs/hardware/aperture/wheatley.md
@@ -8,7 +8,7 @@
 - **RAM**: 2x 16GB RDIMM, 3200MT/s Dual Rank
 - **Storage**: 4x 2TB SATA HDDs (hardware RAID)
 
-Part of [aperture](../../aperture/index.md)
+Part of [aperture](index.md)
 
 ## Where to Find
 

diff --git a/docs/hardware/index.md b/docs/hardware/index.md
@@ -4,21 +4,29 @@ Here is a list of current hardware in Redbrick's suite of servers, switches and
 
 ## [Login](../services/servers.md#Logging%20in) Boxes
 
-- [**azazel**](azazel.md)
-- [**pygmalion**](pygmalion.md)
+- [**`azazel`**](azazel.md)
+- [**`pygmalion`**](pygmalion.md)
 
 ## [NixOS](../procedures/nixos.md) Boxes
 
-- [**hardcase**](nix/hardcase.md)
-- [**motherlode**](nix/motherlode.md)
-- [**icarus**](nix/icarus.md)
+- [**`hardcase`**](nix/hardcase.md)
+- [**`motherlode`**](nix/motherlode.md)
+- [**`icarus`**](nix/icarus.md)
 
-- [**paphos**](paphos.md)
-- [**zeus**](zeus.md)
+- [**`paphos`**](paphos.md)
+- [**`zeus`**](zeus.md)
 
-## [Aperture](../aperture/index.md)
+## [Aperture](aperture/index.md)
 
-- [**glados**](aperture/glados.md)
-- [**wheatley**](aperture/wheatley.md)
-- [**chell**](aperture/chell.md)
-- [**johnson**](aperture/johnson.md)
+- [**`glados`**](aperture/glados.md)
+- [**`wheatley`**](aperture/wheatley.md)
+- [**`chell`**](aperture/chell.md)
+- [**`johnson`**](aperture/johnson.md)
+- [**`bastion-vm`**](../services/bastion-vm.md)
+
+## Network Hardware
+
+- [**`arse`**](network/arse.md)
+- [**`cerberus`**](network/cerberus.md)
+- [**`mordor`**](network/mordor.md)
+- [**switches**](network/switches.md)
diff --git a/docs/hardware/network/arse.md b/docs/hardware/network/arse.md
@@ -0,0 +1 @@
+
diff --git a/docs/hardware/network/cerberus.md b/docs/hardware/network/cerberus.md
@@ -0,0 +1 @@
+
diff --git a/docs/aperture/firewall.md → docs/hardware/network/mordor.md b/docs/aperture/firewall.md → docs/hardware/network/mordor.md
@@ -1,4 +1,4 @@
-# Firewall
+# Mordor
 
 <!-- Access through 10.10.0.1 -->
 
@@ -36,7 +36,7 @@ The UDM Pro should be kept up to date at all times using the web interface. Plea
 
 SSH is enabled to allow for rollbacks in case of a bad update *(I warned you!)*.
 
-Remote access is disabled as it should not be needed, the admin [`VPN`](./vpn.md) should provide enough access for you. If it is enabled in future, please update these docs with your reasons.
+Remote access is disabled as it should not be needed, the admin [`VPN`](../../procedures/vpn.md) should provide enough access for you. If it is enabled in future, please update these docs with your reasons.
 
 ### Backups
 

diff --git a/docs/hardware/network/switches.md b/docs/hardware/network/switches.md
@@ -0,0 +1 @@
+
diff --git a/docs/index.md b/docs/index.md
@@ -11,6 +11,8 @@ This is mostly intended for admins, future admins, webmasters, and everybody els
 - [Redbrick Website](https://redbrick.dcu.ie)
 - [SSH help](https://docs.redbrick.dcu.ie/services/servers/#logging-in)
 
+## Webgroup
+
 ## New Admins
 
 So, you want to become an admin. Brave of you. Here's some stuff you should probably read:

diff --git a/docs/overrides/main.html b/docs/overrides/main.html
@@ -0,0 +1,11 @@
+{% extends "base.html" %}
+
+{% block footer %}
+<aside class="items-center grid-flow-col gap-2">
+    <img src="https://raw.githubusercontent.com/redbrick/design-system/main/assets/logos/redbrick.svg" class="w-10" />
+    <p>
+      <strong class="font-semibold text-xl">Redbrick</strong>
+      <br />DCU's Networking Society
+    </p>
+  </aside>
+{% endblock %}
diff --git a/docs/aperture/ansible.md → docs/procedures/ansible.md b/docs/aperture/ansible.md → docs/procedures/ansible.md
diff --git a/docs/procedures/index.md b/docs/procedures/index.md
@@ -4,6 +4,10 @@ Here you can find a list of various procedures useful for the day-to-day running
 
 ### [New elected admins](new-admins.md)
 
+### [Admin VPN](vpn.md)
+
+### [Ansible](ansible.md)
+
 ### [Post-powercut Todo List](post-powercut.md)
 
 ### [NixOS](nixos.md)

diff --git a/docs/aperture/vpn.md → docs/procedures/vpn.md b/docs/aperture/vpn.md → docs/procedures/vpn.md
diff --git a/docs/res/logo.png b/docs/res/logo.png
diff --git a/docs/aperture/bastion-vm.md → docs/services/bastion-vm.md b/docs/aperture/bastion-vm.md → docs/services/bastion-vm.md
@@ -2,7 +2,7 @@
 
 This VM is an ephemeral machine that can be placed on any nomad client that has the qemu driver enabled.
 
-It acts as the point of ingress for Aperture, with ISS and our [firewall](firewall.md) allowing traffic to reach it's IP address externally. The VM is configured as a Nomad client itself, in the `ingress` node pool to ensure that only ingress-type allocations are placed there (like [traefik](../services/traefik.md)). Those services can proxy requests from the Bastion VM to internal services using consul's service DNS resolution, it's service mesh, or by plain IP and port.
+It acts as the point of ingress for Aperture, with ISS and our [mordor](../hardware/network/mordor.md) allowing traffic to reach it's IP address externally. The VM is configured as a Nomad client itself, in the `ingress` node pool to ensure that only ingress-type allocations are placed there (like [traefik](./traefik.md)). Those services can proxy requests from the Bastion VM to internal services using consul's service DNS resolution, it's service mesh, or by plain IP and port.
 
 `cloud-init` is given a static address during the initialisation phase to configure the interface. This ensures that, even if it is replanned, it will be able to accept traffic.
 

diff --git a/docs/aperture/consul.md → docs/services/consul.md b/docs/aperture/consul.md → docs/services/consul.md
diff --git a/docs/services/exposed.md b/docs/services/exposed.md
@@ -3,7 +3,7 @@
 Firstly, it's important to mention that Redbrick is currently split in 2 parts:
 
 - Redbrick 2.0 *a.k.a. "old redbrick"* (on `136.206.15.0/24`)
-- [Aperture](../aperture/index.md) *a.k.a. "new redbrick"* (on `136.206.16.0/24`)
+- [Aperture](../hardware/aperture/index.md) *a.k.a. "new redbrick"* (on `136.206.16.0/24`)
 
 ## Old Redbrick
 
@@ -47,9 +47,9 @@ Firstly, it's important to mention that Redbrick is currently split in 2 parts:
 	- **Services**:
 		- DNS ([bind](bind.md))
 
-## [Aperture](../aperture/index.md)
+## [Aperture](../hardware/aperture/index.md)
 
-In aperture, things are done a little differently than on the other network. Instead of having  a single host per service, aperture is configured to allow services to be allocated dynamically across all 3 servers using [nomad](../aperture/nomad.md), [consul](../aperture/consul.md) and [traefik](traefik.md).
+In aperture, things are done a little differently than on the other network. Instead of having  a single host per service, aperture is configured to allow services to be allocated dynamically across all 3 servers using [nomad](nomad.md), [consul](consul.md) and [traefik](traefik.md).
 
 - [glados](../hardware/aperture/glados.md) - `136.206.16.4`
 - [wheatley](../hardware/aperture/wheatley.md) - `136.206.16.5`

diff --git a/docs/aperture/icecast.md → docs/services/icecast.md b/docs/aperture/icecast.md → docs/services/icecast.md
diff --git a/docs/services/index.md b/docs/services/index.md
@@ -1,15 +1,16 @@
 # Preface
 
-Here you will find a list of all the services Redbrick runs, along with some configs and some important information
-
-surrounding them.
+Here you will find a list of all the services Redbrick runs, along with some configs and some important information surrounding them.
 
 - [api](api.md)
+- [bastion-vm](bastion-vm.md)
 - [bind](bind.md)
 - [codimd](codimd.md)
+- [consul](consul.md)
 - [gitea](gitea.md)
 - [irc](irc.md)
 - [nfs](nfs.md)
+- [nomad](nomad.md)
 - [traefik](traefik.md)
 - [znapzend](znapzend.md)
 

diff --git a/docs/aperture/nomad.md → docs/services/nomad.md b/docs/aperture/nomad.md → docs/services/nomad.md
@@ -1,3 +1,13 @@
+---
+title: Nomad on Aperture
+author:
+- distro
+- wizzdom
+tags:
+- nomad
+- aperture
+---
+
 # Nomad on Aperture - `distro`, `wizzdom`
 
 > Adapted from [redbrick/nomad README](https://github.com/redbrick/nomad/README.md)
@@ -23,7 +33,7 @@ The terminology used here is explained [here](https://developer.hashicorp.com/no
 git clone [email protected]:redbrick/nomad.git
 ```
 
-- Connect to the [admin VPN](vpn.md)
+- Connect to the [admin VPN](../procedures/vpn.md)
 - Set the `NOMAD_ADDR` environment variable:
 
 ```bash

diff --git a/docs/services/socs.md b/docs/services/socs.md
@@ -0,0 +1,7 @@
+# Socs Using Redbrick Infrastructure
+
+- MPS/DCUfm - [`icecast`](icecast.md)
+- MPS/TheCollegeView - https://thecollegeview.ie - `wordpress`
+- DCU Style - https://thelookonline.dcu.ie - `wordpress`
+- DCU Solar Racing - https://solarracing.ie
+- 
diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css
@@ -5,3 +5,7 @@
   --md-text-font: "Myriad Pro", sans-serif;
   --md-code-font: "Fira Code", monospace;
 }
+
+[data-md-color-scheme="slate"] * {
+  --md-typeset-a-color: #d62e2e;
+}