diff --git a/docs/.pages b/docs/.pages index dbe7de5a..b5ce5f03 100644 --- 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 index 9833fa5b..9d09c9ab 100644 --- 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 index 7062e331..dd75a57e 100644 --- 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: elected-admins@redbrick.dcu.ie) with the password stored in pwsafe under `unifi`. +The owner account of the unifi equipment is `rbadmins` (email: elected-admins@redbrick.dcu.ie) 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 index 92135457..d22cbefe 100644 --- 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 index b4ec217e..d7ecfda9 100644 --- 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 index 5e15aa0b..5afb37d4 100644 --- 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. \ No newline at end of file +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. \ No newline at end of file diff --git a/docs/hosts/aperture/chell.md b/docs/hardware/aperture/chell.md similarity index 93% rename from docs/hosts/aperture/chell.md rename to docs/hardware/aperture/chell.md index 777d39e5..9d0c6cce 100644 --- a/docs/hosts/aperture/chell.md +++ b/docs/hardware/aperture/chell.md @@ -18,4 +18,4 @@ Part of [aperture](../../aperture/index.md) - `chell.aperture.redbrick.dcu.ie` -![](../../assets/chell.png) \ No newline at end of file +![](../../res/chell.png) \ No newline at end of file diff --git a/docs/hosts/aperture/glados.md b/docs/hardware/aperture/glados.md similarity index 93% rename from docs/hosts/aperture/glados.md rename to docs/hardware/aperture/glados.md index 9e63be2f..16af0d63 100644 --- a/docs/hosts/aperture/glados.md +++ b/docs/hardware/aperture/glados.md @@ -18,4 +18,4 @@ Part of [aperture](../../aperture/index.md) - `glados.aperture.redbrick.dcu.ie` -![](../../assets/glados.png) \ No newline at end of file +![](../../res/glados.png) \ No newline at end of file diff --git a/docs/hosts/aperture/johnson.md b/docs/hardware/aperture/johnson.md similarity index 95% rename from docs/hosts/aperture/johnson.md rename to docs/hardware/aperture/johnson.md index 637c289f..b03fe674 100644 --- a/docs/hosts/aperture/johnson.md +++ b/docs/hardware/aperture/johnson.md @@ -23,4 +23,4 @@ Part of [aperture](../../aperture/index.md) - `NFS` for [aperture](../../aperture/index.md) -![](../../assets/johnson.png) \ No newline at end of file +![](../../res/johnson.png) \ No newline at end of file diff --git a/docs/hosts/aperture/wheatley.md b/docs/hardware/aperture/wheatley.md similarity index 93% rename from docs/hosts/aperture/wheatley.md rename to docs/hardware/aperture/wheatley.md index 72c0b2bc..36d00b80 100644 --- a/docs/hosts/aperture/wheatley.md +++ b/docs/hardware/aperture/wheatley.md @@ -18,4 +18,4 @@ Part of [aperture](../../aperture/index.md) - `wheatley.aperture.redbrick.dcu.ie` -![](../../assets/wheatley.png) \ No newline at end of file +![](../../res/wheatley.png) \ No newline at end of file diff --git a/docs/hosts/azazel.md b/docs/hardware/azazel.md similarity index 100% rename from docs/hosts/azazel.md rename to docs/hardware/azazel.md diff --git a/docs/hosts/index.md b/docs/hardware/index.md similarity index 97% rename from docs/hosts/index.md rename to docs/hardware/index.md index 6cebd4a7..29a1bd05 100644 --- a/docs/hosts/index.md +++ b/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 b/docs/hardware/nix/hardcase.md similarity index 100% rename from docs/hosts/nix/hardcase.md rename to docs/hardware/nix/hardcase.md diff --git a/docs/hosts/nix/icarus.md b/docs/hardware/nix/icarus.md similarity index 100% rename from docs/hosts/nix/icarus.md rename to docs/hardware/nix/icarus.md diff --git a/docs/hosts/nix/motherlode.md b/docs/hardware/nix/motherlode.md similarity index 100% rename from docs/hosts/nix/motherlode.md rename to docs/hardware/nix/motherlode.md diff --git a/docs/hosts/paphos.md b/docs/hardware/paphos.md similarity index 100% rename from docs/hosts/paphos.md rename to docs/hardware/paphos.md diff --git a/docs/hosts/pygmalion.md b/docs/hardware/pygmalion.md similarity index 100% rename from docs/hosts/pygmalion.md rename to docs/hardware/pygmalion.md diff --git a/docs/hosts/zeus.md b/docs/hardware/zeus.md similarity index 100% rename from docs/hosts/zeus.md rename to docs/hardware/zeus.md diff --git a/docs/procedures/post-powercut.md b/docs/procedures/post-powercut.md index 91495038..33add053 100644 --- 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 b/docs/res/cables-glados-wheatley-chell.jpg similarity index 100% rename from docs/assets/cables-glados-wheatley-chell.jpg rename to docs/res/cables-glados-wheatley-chell.jpg diff --git a/docs/assets/chell.png b/docs/res/chell.png similarity index 100% rename from docs/assets/chell.png rename to docs/res/chell.png diff --git a/docs/res/chell.txt b/docs/res/chell.txt new file mode 100644 index 00000000..c51b0360 --- /dev/null +++ b/docs/res/chell.txt @@ -0,0 +1,62 @@ + . .. + :-+*+:..:. + :-+@%#=...:. + :#+*%+=- .. . + +%%##%%+=-:- + =#***#***+++ + .=++-. .*******+::.... + +%%%%%%****++++=..:::... . .. + -%%%%##%%%*####**: .:-====-= ..:-==-. . + =#%%###*+*%%*%#####%+.-*%@@@@@@@@=:-==+:-%@@@@@*: + :#%%###*===+##%@%%###%@@@@@@@@@@@@@=--::.:@@%@#*%@@*: + =%%###*+=-=+*##@@%%%@@@@@@@@@@@@@@@= ... :%@%#*-=*#+-. + .*%%%%%#######%@@@@@%@@@@@@@@@@@@@##- .....+*++****+- + *####%%%%#####%@@@@@%*#%@@@@@@@%#+. :+==++=-. + -+++***++++++=+**####==--===-::...:-++=:.=+*==-. + ..:+++=====+**#%@##*=* .-+**####**+. + ****#******#%%@%@@= :-+***+- + #*****###**######- ::: + .+#*++++**#######= + :=+=====+******###* + =**+===---==++++***+ + +#***++++======+**+ + *#****+=++++=-====- + =#****++=-:::::-=++==-:. + #****++-::-==+++++++++**=-.::-==: + :*++++=::-=+++++++++++++++++*+=--. + .++=-::-========++++++++++===++==: + ==:.::::------=============++===+=: + : ..::::-----+###*+::====== + ....::::.. .=**+=-==:.::----: + .. ..::::.. :=++*===--==:..::::. + . .:::=*#*:.=#==--:--. + :+#@#*#+:.=+=-: + .:+%%%#+#**-..--=+ + -++*#%@%#%#%+===:::::--== + :%@@@@%%%%###*-:-:::::::-=+= + +@%*%%#####*=: .-:::::::-=+. + -@@*#%%%%##*: :-:::::::-=- + =@@*#%%###+. :-:::::---= + -#@@@%%#+. --::::----- + .=+#%@* .-:::--===: + .=: .==-:---== + *@%*:::-=: + #%%@*--==+. + .#%%%%+:-=++ + *%%%%+=++*- + =*###+----. + -*##+--+* + =#%%#**+ + :#%%%%%*: + .#%%%@@@: + .-+##%@%- + ..#%%%@*: + ..=@%%%@@%= + ::%%%#%%@@%*++#-.. + ..+@%##%%%%@@%+. + :***++*#%*-. + :- + + + + diff --git a/docs/assets/distro-hanging-cables.jpg b/docs/res/distro-hanging-cables.jpg similarity index 100% rename from docs/assets/distro-hanging-cables.jpg rename to docs/res/distro-hanging-cables.jpg diff --git a/docs/assets/favicon.png b/docs/res/favicon.png similarity index 100% rename from docs/assets/favicon.png rename to docs/res/favicon.png diff --git a/docs/assets/glados.png b/docs/res/glados.png similarity index 100% rename from docs/assets/glados.png rename to docs/res/glados.png diff --git a/docs/res/glados.txt b/docs/res/glados.txt new file mode 100644 index 00000000..ec91dde9 --- /dev/null +++ b/docs/res/glados.txt @@ -0,0 +1,62 @@ + .:.. . .. + .::. .. .. . + .... . :. + .. . .:. + .:. + .:. + . :: + .. :: + . :: . + :. + :. . . + :. . .-*%*==*#####**=-:. + .. . =##%%###%%#%%%%%%%%%#*=:. + .. .. . :###%##########%##%%%%%%%%*. + .. . +*#######################%%+ + . .. . .*++###%####################+- + ... .. ===#%%%@%%#############*****=-. + .. .. .*+*###%%%%%###**************=-: + ... ..:. .. . =*+*******+++++*#***********+--. + .. ..-: ... . :-+***+-:. ......:-+**+++++++=--. + .. -.... .:+++++: .. . :++++++++-:: + . . ...:. .++++-. .==++++=-:: + .. =*++=: .-=-: .-=====-::. + .. ..... .......... .. .:++++-. . -%%%#- . :-=====-:: + .. . ..: .... ... .:. .:-*++=: . .=##*-. .:----=-::. + .. :. .. .. . ::++++-. .------::: + ... .. .::--=++++: ... .. .:.-+++=: . :------::: + ....... -##******+= ... .: .:.==+=:. .:::---:::. + .::..... .**++++++++. ... . :===-. ...... .::::::::: + .......=++++++===: ... -===: .:::::::::. + . :+========- .. . :===-. .::::::::. + .. =========-:........ . --=-: ... ..::::::::. + -++=====---. ...... .. .=--:. . ..:::::::. + . :++++++===- ..... ----:. ...:::::: + . .----::::-----: . .---:::.. ....:::... + .. ..++++=--::::::...... ............ ::-::::::... . ...::::.. + .. ...:==++====--------::::.....::::::.:.....:::::::::::....... .....::::.. + ... .====++++========:::::..:::::---::::::.:::..:::::::::::::...:...:::... + . ... :===============--::::.::::----------:..:........:::::::...:.....:... + .. . :===============---:::::::----:::::::::.............:............... + .. :===========-------:::::::. ........................... + ... --------------------::::: :::..................... + .. --------------------:::: .:::::::::............. + . .::::::::::::::::::::::::. ::::::::::::::. + .. .. .:::::::::::::::::::::::::. .:::::::::::::. + :::::::::::::::::::::..:::::. .::.:::::::::::. + .:::::::::::::::::::::..-::::::::::::::::..:::::::::.. + ..:::::::::::::::::::.:::::::::::::::::...:::.:.... + ...:::::::::::.::::...:::::::::::::::::.......... + .........:::..:.....:::::::::::::::::......... + ...................:::::::::::::::......... + ................::::::::::::::::...... + ............::::::::::::::.... + .......:::::::::...... + ........:......... + .............. + ....... + + + + + diff --git a/docs/assets/ingress-topology.png b/docs/res/ingress-topology.png similarity index 100% rename from docs/assets/ingress-topology.png rename to docs/res/ingress-topology.png diff --git a/docs/assets/inside-of-server.jpg b/docs/res/inside-of-server.jpg similarity index 100% rename from docs/assets/inside-of-server.jpg rename to docs/res/inside-of-server.jpg diff --git a/docs/assets/isengard.jpg b/docs/res/isengard.jpg similarity index 100% rename from docs/assets/isengard.jpg rename to docs/res/isengard.jpg diff --git a/docs/assets/johnson.png b/docs/res/johnson.png similarity index 100% rename from docs/assets/johnson.png rename to docs/res/johnson.png diff --git a/docs/assets/labelled-cables-for-isengard.jpg b/docs/res/labelled-cables-for-isengard.jpg similarity index 100% rename from docs/assets/labelled-cables-for-isengard.jpg rename to docs/res/labelled-cables-for-isengard.jpg diff --git a/docs/assets/labelled-cables-for-mordor-and-rivendell.jpg b/docs/res/labelled-cables-for-mordor-and-rivendell.jpg similarity index 100% rename from docs/assets/labelled-cables-for-mordor-and-rivendell.jpg rename to docs/res/labelled-cables-for-mordor-and-rivendell.jpg diff --git a/docs/assets/logo.png b/docs/res/logo.png similarity index 100% rename from docs/assets/logo.png rename to docs/res/logo.png diff --git a/docs/assets/mordor-and-rivendell.jpg b/docs/res/mordor-and-rivendell.jpg similarity index 100% rename from docs/assets/mordor-and-rivendell.jpg rename to docs/res/mordor-and-rivendell.jpg diff --git a/docs/assets/network-divorce.png b/docs/res/network-divorce.png similarity index 100% rename from docs/assets/network-divorce.png rename to docs/res/network-divorce.png diff --git a/docs/assets/new-installed-servers.jpg b/docs/res/new-installed-servers.jpg similarity index 100% rename from docs/assets/new-installed-servers.jpg rename to docs/res/new-installed-servers.jpg diff --git a/docs/assets/wheatley.png b/docs/res/wheatley.png similarity index 100% rename from docs/assets/wheatley.png rename to docs/res/wheatley.png diff --git a/docs/res/wheatley.txt b/docs/res/wheatley.txt new file mode 100644 index 00000000..707570fb --- /dev/null +++ b/docs/res/wheatley.txt @@ -0,0 +1,63 @@ + ....... .:. + ...:..:.:.::..:::::::..:=--:-::... ...::=::- + ..::-----:.:::...................=++++++++++++***-::=::=. + .:--==---::::........ .. . .... .... .. ..:::--=-=---:...:.:. + .-===--::...... :.::.: + :=*#=:.... .:.:.. + .... ..-+#*++-:. :..:.: + -.-=-+****+=:. .:.:.:. + ..-:.--::. ....... :.:... + :. .. ....:.:----=********+++==-::........ .:::.:. + :. ... :=+***+-:+*########*****+++==--==-...:-===-:::.:..: + : .. .-+*#%##**+==+**************++==-:-+=-============::=..-. + .: . ::::-*%%##*++=::-==========+========-::-*+=======----=:-=++::-= + :. .. .-=:-+*#*+=:::.:-==-===++++==--=====---:-=*+-==--===-:.-*=====::-=: + :. ::. :==::=*+=:...-=+***#+-###*##*#****-==+++=--**=============-=-::.::--==: + : .:.. .=+-:=+=:..:=+#%%%%##*:*%####***###+-+=++=++=*===+============---:...-====: + .: ...:.-*#++==-..-+###%%%%%**#=-%%#########*--+*+++++*#====================---=======: + :.::-=#%#++=:..=*##%#%%%%%%##*.+#####%%####=:+**+++**+*+-+=+=======================--=- + :.. *@%+=:.:+#%%%%%%%%#*+====:=====+++*###+-=++*****++==#*============++++========--:::. + ..*@@#=..+%%%%%%%%*+=--=+*#%%%%%###***++***+====++=====-*#+=========++++++=======--:::::. + .%@@#- :*@%%%@@%+-:=*#%@@@@%%%%%%%######****#***+++++++==+#+=======+++++++======--::::..:: + :-*@@+. +%#%@@@%+::+%@@@@@@@%%%%%%%#########*+*#*+++++++++==+#+=======+++++++=====-:::: ..:: + .-+@@+..#@@@@@@*-:+%@@%%@@@@@%%%%%###########****##++++++++++=+#+=======++++++=====-:::. ..:. + .++@@+..*@@@@@%=.-%@@@@@@@@@@%%%%####**************##+++++++++==+#+=++++++++++======-:::. ..:: + -@@@+.=%%@@@@%-.+@@@@%%##**+==-------::::::::::::::-##+++++=====++#+++++++++========-::: ..: + .%@@*.-@@@@@@%=.-*++=-::::: ...:::::---::::::.. .=%+=++=======-**=++++++++======--::. ..:. + #@@%-.#@@@@@@+:::..::...::. ..:::--==++++==--::::...:#*=+++=====-:=#+++++++++=======-::. ...: + %@@+.:#@@@@@%:::.:--..:::. ..:::-=+++****+++=-::::...+#+++++====---#+++++++++=======-::.. ..:. + -@@@:.-#@@@@@*:::::-:.:::: .:::-=++**###**+++=-:::.. =#+++++===--::**+++++++=======-:::. ..:. + =@@#=:-%@@@@@=::.::-..:::. ..::--=+**#%%##**++=-::....+*+++++=====-:+#+++++++======--:::. :::: + *@@*::+@@@@@@+::.:--.::::. ..::--=++**##***+++=-::....**++++++==+=-.=#++++++++++===--:::. .::: + .#@@*:.=%@@@@@*:::::-.-:::: ..::--==++****+++==-::... -#*+++++++++-- +#++++++++++====-:::: ..--- + :#@@#-:-#%@@@@%:::.:-::-.::. .::::--==+++++==-::::.. :#*+*+++++++=:: +#+++++++++++====-::: . :==: + .*@@#-:.*@@%@%#=:::::-. ::::. .:::::-------:::::.....*#+**+++++++-: #*+++++++++++====-::: . .==- + =@@#+:-*##%@+-*=::::--..::::. ..:::::::::::::.....-*#***+++++++--. :%++++++++++++====-:::. .===. + =@@@#-:##%%@%*+*=::::::. ...::. ..............::=#*****++++++--. +#++++++++++++====-:::. :---. + .%@@@*:=%###%#=*%+-::=++=-=======--========++++++*#***++++++++--. -#++++++++++++++===--:::. .::: + *@@@@+:***%%%@#-+%=-=*%@%%%%%%#######**#*******#******++++++--. .**=+++++++++++++====-:::. .::: + -@@@%%+-*##%%%%%%@@%+--+*#%%%%%%%%%##****+++*#********++++=-: +#=++++++++++++++====-:::. .::: + *@@@%@+-+*%##%@@@@@@%#*+==+****#*#**+++++*************++=-: .+#++++++++++++++++====-:::: .::: + %%@@@@*==+*%%@@@@@@@@@%%##****-:*******************++=-:. .. +#+++++++++++++++++=====-:::. .::. + -@%@@%@++==+#%%*%@@@%%%%%%%%%%*.*#+===+**********++=-:::.. .*#+=+++++++++++++++++=====::::. .::: + =@%%%#--*+==***%@%%%%%%%%%%%%%:-+:+*=:+*******+==--:-*- -**==++++++++++++++++++=====-::::.::-. + +%%%@=.-=++==+*#%%%%%%%%%%%#%=.+=-===****++==----::--:.+#+===+++++++=====+++=========-::::::. + +%%%##-.-=+++==+++**######%%#:+*+++*+++==--------::::++=====+++++++================---:::: + =%%%#*-.==****++++=+=+++=*#*==+=====----======---:-:==-=====++++++=========--=======---. + . -#%%#+-:-+*#####**++++=--=-========++++++++++==-::::*========+++=====--:::::-=======-. + :.. .*##*+::=+###%%%####****:.-+*********++++++++==-:::=+-============---::.::--======- + .-.:-=***#*=::-+##%%%######*#=:=-+*************++++==-:::+=-==========-=+====-:--===+=. + .- .::::-=**+::=*###%#######**==--*************++++===-:--+--==========+-:--=:.:-===- + :. ::.. :+*+:.-*#########****==:-****+*****+++++=====--:-+---=----====--::.:..-=-. + -. .... .=*-.:=*#######*---:...::...:+*++++++++=====-::-+--=====--====-.::..:. + :. .:. .-=:.:+#######*=-:: . .:+++++++++======--:-+=-==========::-..: + -. .:. .:..:=+*##***=--: .. .:=+++++++++======---==-=========:+:..: + :. ..:. .:-=****+=--: :====+++++++======-=----===-::+*..:. + -. . :-=+++==-:....:..:=+=+++++++++==--:. :#-..: + :::::-=:::. ..::---::. .:-----::.. .=#:... + :-.=--***###**=-:. ..::-====-::==.:: + :... ....:=+*###*=--:::...... .. . ... . .....::--=+++++++++***=::=::=- + :----======---------::.::.:.....::::::.:......-+++++==--::.:::::...:.:. + ...::::::-::--:::.::::::::::.............::.. + .. .... .. . + diff --git a/docs/services/bind.md b/docs/services/bind.md index 9e6c07ca..87f1679a 100644 --- a/docs/services/bind.md +++ b/docs/services/bind.md @@ -1,6 +1,6 @@ # Bind9 - `distro`, `ylmcc` -Bind9 is our DNS provider. Currently it runs on [`paphos`](../hosts/paphos.md), but this may change in the near future. +Bind9 is our DNS provider. Currently it runs on [`paphos`](../hardware/paphos.md), but this may change in the near future. ## Configuration diff --git a/docs/services/cheatsheet.md b/docs/services/cheatsheet.md index 9074d238..d5932e2f 100644 --- a/docs/services/cheatsheet.md +++ b/docs/services/cheatsheet.md @@ -83,7 +83,7 @@ Brickbot runs in `tmux a -t 0` and can be restarted by pressing ctrl+c and runni ## Minecraft Servers -The Redbrick Minecraft server's are dockerized applications running on [`zeus`](../hosts/zeus.md) on a server-per-container basis, using the tools on this GitHub Repo: https://github.com/itzg/docker-minecraft-server#interacting-with-the-server +The Redbrick Minecraft server's are dockerized applications running on [`zeus`](../hardware/zeus.md) on a server-per-container basis, using the tools on this GitHub Repo: https://github.com/itzg/docker-minecraft-server#interacting-with-the-server Repo is very well documented so have a look at the README but here's the basics: diff --git a/docs/services/codimd.md b/docs/services/codimd.md index b6992b07..46f39209 100644 --- a/docs/services/codimd.md +++ b/docs/services/codimd.md @@ -1,10 +1,10 @@ # CodiMD - `distro` -CodiMD lives on [`zeus`](../hosts/zeus.md) as a docker container. It is accessible through [md.redbrick.dcu.ie](https://md.redbrick.dcu.ie). +CodiMD lives on [`zeus`](../hardware/zeus.md) as a docker container. It is accessible through [md.redbrick.dcu.ie](https://md.redbrick.dcu.ie). CodiMD is built locally and is based on [codimd](https://github.com/hackmdio/CodiMD), the docs for which are [here](https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-docker-deployment). -Hackmd auths against LDAP and its configuration is controlled from docker-compose. Go to `/etc/docker-compose/services/hackmd` on [`zeus`](../hosts/zeus.md) to find the configuration. +Hackmd auths against LDAP and its configuration is controlled from docker-compose. Go to `/etc/docker-compose/services/hackmd` on [`zeus`](../hardware/zeus.md) to find the configuration. See [CodiMD github](https://github.com/hackmdio/hackmd/#environment-variables-will-overwrite-other-server-configs) for more info on configuration. The important points are disabling anonymous users and the LDAP settings. diff --git a/docs/services/exposed.md b/docs/services/exposed.md index fe82a82f..49678648 100644 --- a/docs/services/exposed.md +++ b/docs/services/exposed.md @@ -6,21 +6,21 @@ Firstly, it's important to mention that Redbrick is currently split in 2 parts: - [Aperture](../aperture/index.md) *a.k.a. "new redbrick"* (on `136.206.16.0/24`) ## Old Redbrick -- [**azazel**](../hosts/azazel.md) - `136.206.15.24` +- [**azazel**](../hardware/azazel.md) - `136.206.15.24` - **OS**: Debian 10 - **Services**: - primary ssh login box for users (see [Logging in](servers.md#Logging%20in)) - jump-box for admins -- [**pygmalion**](../hosts/pygmalion.md) - `136.206.15.25` +- [**pygmalion**](../hardware/pygmalion.md) - `136.206.15.25` - **OS**: Ubuntu 18.04 LTS - **Services**: - secondary ssh login box for users (see [Logging in](servers.md#Logging%20in)) - jump-box for admins -- [**motherlode**](../hosts/nix/motherlode.md) - `136.206.15.250` +- [**motherlode**](../hardware/nix/motherlode.md) - `136.206.15.250` - **OS**: NixOS 22.05 - **Services**: - VM for [dcuclubsandsocs.ie](https://dcuclubsandsocs.ie) -- [**hardcase**](../hosts/nix/hardcase.md) - `136.206.15.3` +- [**hardcase**](../hardware/nix/hardcase.md) - `136.206.15.3` - **OS**: NixOS 22.05 - **Services**: - `apache httpd`: @@ -32,7 +32,7 @@ Firstly, it's important to mention that Redbrick is currently split in 2 parts: - email (`postfix` and `dovecot`) - mailing [lists](https://lists.redbrick.dcu.ie) (`mailman`) - `*.redbrick.dcu.ie` also points here -- [**zeus**](../hosts/zeus.md) - `136.206.15.31` +- [**zeus**](../hardware/zeus.md) - `136.206.15.31` - **OS**: Ubuntu 18.04 LTS - **Note**: this is a docker host, everything on here is in a container - **Services**: @@ -41,7 +41,7 @@ Firstly, it's important to mention that Redbrick is currently split in 2 parts: - Secretary's email generator at: [generator.redbrick.dcu.ie](https://generator.redbrick.dcu.ie) - [CodiMD](codimd.md) at: [md.redbrick.dcu.ie](https://md.redbrick.dcu.ie) - all of this is routed through [traefik](traefik.md) as a reverse proxy -- [paphos](../hosts/paphos.md) - `136.206.15.53` +- [paphos](../hardware/paphos.md) - `136.206.15.53` - **OS**: Ubuntu 14.04 LTS - **Services**: - DNS ([bind](bind.md)) @@ -49,9 +49,9 @@ Firstly, it's important to mention that Redbrick is currently split in 2 parts: ## [Aperture](../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). -- [glados](../hosts/aperture/glados.md) - `136.206.16.4` -- [wheatley](../hosts/aperture/wheatley.md) - `136.206.16.5` -- [chell](../hosts/aperture/chell.md) - `136.206.16.6` +- [glados](../hardware/aperture/glados.md) - `136.206.16.4` +- [wheatley](../hardware/aperture/wheatley.md) - `136.206.16.5` +- [chell](../hardware/aperture/chell.md) - `136.206.16.6` - all 3 boxes are identical - **OS**: Debian 11 - **Services**: diff --git a/docs/services/gitea.md b/docs/services/gitea.md index 76c6c07f..bc46acde 100644 --- a/docs/services/gitea.md +++ b/docs/services/gitea.md @@ -8,7 +8,7 @@ Redbrick uses [Gitea](https://gitea.io/en-US/) as an open source git host. ## Deployment -Gitea and its database are deployed to [Hardcase](../hosts/nix/hardcase.md) which runs [NixOS](../procedures/nixos.md) +Gitea and its database are deployed to [Hardcase](../hardware/nix/hardcase.md) which runs [NixOS](../procedures/nixos.md) - The actual repositories are stored in `/zroot/git` and most other data is stored in `/var/lib/gitea` - The `SECRET_KEY` and `INTERNAL_TOKEN_URI` are stored in `/var/secrets`. They are not automatically created and must be diff --git a/docs/services/nfs.md b/docs/services/nfs.md index 9afd1838..922a68fa 100644 --- a/docs/services/nfs.md +++ b/docs/services/nfs.md @@ -5,7 +5,7 @@ NFS is used to serve the notorious `/storage` directory on Icarus to all of Redb ## Deployment -- NFS is deployed with Nix on [Icarus](../hosts/nix/icarus.md) +- NFS is deployed with Nix on [Icarus](../hardware/nix/icarus.md) - It is backed onto the PowerVault MD1200 with all its disk passed through single-drive RAID 0s toallow for setup of ZFS: - 1 mirror of 2x 500GB drives - 1 mirror of 2x 750GB drives diff --git a/docs/services/servers.md b/docs/services/servers.md index bcf3100c..79688519 100644 --- a/docs/services/servers.md +++ b/docs/services/servers.md @@ -1,10 +1,10 @@ # Servers -Redbrick provides two main servers ([Azazel](../hosts/azazel.md) and [Pygmalion](../hosts/pygmalion.md)) for it's members to use for various use cases, for example running applications or user programs. +Redbrick provides two main servers ([Azazel](../hardware/azazel.md) and [Pygmalion](../hardware/pygmalion.md)) for it's members to use for various use cases, for example running applications or user programs. ## Entrypoints -The main login server used in Redbrick is [Azazel](../hosts/azazel.md). You may also log in to [Pygmalion](../hosts/pygmalion.md) if you wish at `pyg.redbrick.dcu.ie` +The main login server used in Redbrick is [Azazel](../hardware/azazel.md). You may also log in to [Pygmalion](../hardware/pygmalion.md) if you wish at `pyg.redbrick.dcu.ie` **2 Factor Authentication is required to log in to Redbrick servers.** This is done via an SSH key and your Redbrick username/password combination. For more information on how to create an SSH key, and configure your account for 2FA, please read below. @@ -27,7 +27,7 @@ If you are an unbothered king/queen that simply does not mind using a web interf ### Logging in to other servers -Your home directory is synced (i.e the same) on all public Redbrick servers. Thus the `authorized_keys` file will be the same on [Azazel](../hosts/azazel.md) as it is on [Pygmalion](../hosts/pygmalion.md), meaning you can log in to `pyg.redbrick.dcu.ie` too, and so on. +Your home directory is synced (i.e the same) on all public Redbrick servers. Thus the `authorized_keys` file will be the same on [Azazel](../hardware/azazel.md) as it is on [Pygmalion](../hardware/pygmalion.md), meaning you can log in to `pyg.redbrick.dcu.ie` too, and so on. ## Setting up an SSH Key @@ -74,11 +74,11 @@ This key is saved under .ssh under your User directory. (i.e `C:\Users\Bob\.ssh\ In this step we store our **public** key on the server we intend to log in to. This key will be used against our secret private key to authenticate our login. -For the purposes of this tutorial we will be using [Pygmalion](../hosts/pygmalion.md) (`pyg.redbrick.dcu.ie`) as our server. +For the purposes of this tutorial we will be using [Pygmalion](../hardware/pygmalion.md) (`pyg.redbrick.dcu.ie`) as our server. #### Logging in to Wetty -In order to access the server to actually place our keys in it, we need to log in via Wetty - a shell interface for [Pygmalion](../hosts/pygmalion.md) on the web. +In order to access the server to actually place our keys in it, we need to log in via Wetty - a shell interface for [Pygmalion](../hardware/pygmalion.md) on the web. - Head to wetty.redbrick.dcu.ie. diff --git a/mkdocs.yml b/mkdocs.yml index a0773597..d17d3bd4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,8 +6,8 @@ use_directory_urls: true theme: name: material - logo: assets/logo.png - favicon: assets/favicon.png + logo: res/logo.png + favicon: res/favicon.png icon: repo: fontawesome/brands/github features: