Update readme (#68)

* Clean up

* Added readme for gryffindor

* Added readme and updated the directory structure

Author: digidaniel-dev

README.md

@@ -16,16 +16,16 @@ I am a strong advocate for GitOps and using automations as much as possible,
 to be clear, not everything should be automated but everything that can remove
 waste (waste as an wasted time) should be automated as long as it is secure.
 
-This repository is my Homelab in code, this repo is an repetentation on what I am
-running in my Homelab and how my Homelab is currently configured. This is both for
-my own documentation but also to help and inspire others that want to do the
-same.
+This repository is my Homelab in code, this repo is an repetentation on what I
+am running in my Homelab and how my Homelab is currently configured. This is
+both for my own documentation but also to help and inspire others that want to
+do the same.
 
 > [!IMPORTANT]
-> Things will change and I am always trying out new things, so I have another repo
-> called homelab-archive where I move everything that I am no longer using but have
-> been running, so if there is something that you have seen here but doesn't exists
-> anymore then check in that repo, it should be there.
+> Things will change and I am always trying out new things, so I have another
+> repo called homelab-archive where I move everything that I am no longer using
+> but have been running, so if there is something that you have seen here but
+> doesn't exists anymore then check in that repo, it should be there.
 
 ## Background
 
@@ -45,8 +45,8 @@ quick way out sometime)
 
 ## My Homelab
 
-My Homelab is running Proxmox VE, I have run Proxmox pretty much since I decided to
-setup my Homelab and I love it!
+My Homelab is running Proxmox VE, I have run Proxmox pretty much since I
+decided to setup my Homelab and I love it!
 
 > [!NOTE]
 > I hope to be able to setup more servers with Proxmox so I can experiment with
@@ -82,8 +82,8 @@ that Proxmox has to offer.
 
 ### Folder structure
 
-I have built the structure in a way so I can easily find what I am searching for
-so first level is the project or application I am interested in, the second 
+I have built the structure in a way so I can easily find what I am searching
+for so first level is the project or application I am interested in, the second 
 level is the tools I have been using to setup the project/application for
 instance Terraform, Ansible or maybe Docker compose file.
 
@@ -134,14 +134,14 @@ tutorial, and man I can say it has been an experiance.
 
 ### Some projects/applications looks out of date
 
-Yes as times go I will try different applications and projects and might replace
-stuff I have run before for something else that I liked, but as this is
+Yes as times go I will try different applications and projects and might
+replace stuff I have run before for something else that I liked, but as this is
 documentation and history for me there will exists things that is outdated so
 I can go back and check how I did something if I ever want to set it up again.
 
 ## Contribute
 
-Even if this is my own Homelab and I won't accept contribution dont heasitate to
-create a PR if there is something I could have done differently or if there is
-something that looks really wrong, I am still learning and all help is
+Even if this is my own Homelab and I won't accept contribution dont heasitate
+to create a PR if there is something I could have done differently or if there
+is something that looks really wrong, I am still learning and all help is
 appreciated.

gryffindor/1000-truenas/README.md

@@ -0,0 +1,43 @@
+# 1000-truenas - Main NAS
+
+## Background
+
+This VM is my main NAS that runs TrueNAS Scale.. YES, I am virtualizing my NAS
+and the reason for this is because I have tried running TrueNAS a the host VM
+before and then used the internal VM support for when I needed to run VM's for
+testing but due to the limitations that TrueNAS has for more advanced settings
+of VM's it is easier to runt Proxmox as the host OS and then virtualize TrueNAS
+with a lot of passthrough and it has worked great!
+
+## VM setup
+
+The entire VM setup is made using Terraform so look through the terraform 
+directory to se the setup in more detail, but everything is configured to give
+as much realtime performance as possible like setting the CPU Type as host and
+passthrough hardware that is dedicated to the NAS like HBA and NIC to remove as
+much bottlenecks as possible that can occure when virtualizing a NAS.
+
+## Structure
+
+### Infrastructure
+
+Here I store the IaC code that setups the infrastructure of the VM using
+Terraform, the provider I have used is linked below.
+
+[bpg/proxmox provider](https://registry.terraform.io/providers/bpg/proxmox/0.73.1)
+
+### Configuration
+
+Currently TrueNAS Scale is so new that no good tool has yet been released to
+manage the configuration of TrueNAS so currently everything is managed manually
+from the GUI, as soon as I find a stable and reliable tool that I can use I 
+will add it to this directory.
+
+## Future plans
+
+My end goal is to build a smaller server that can focus on only running the NAS
+because even if running the NAS as a VM has worked great, I want to separate
+it to another machine to reduce the risk of single point of failure if
+something happens when doing my testing of other things and because my family
+is also using the NAS for things like watching movies or storing personal
+backups of images and files I want to reduce the risk of downtime for the NAS.

gryffindor/1000-truenas/configuration/.keep

@@ -0,0 +1,50 @@
+# Gryffindor - NAS/HomeLab
+
+## Background
+
+Gryffindor is my main server that I have built my entire homelab infrastructure
+around. It currently works as a dual purpose server to both run as a NAS and as
+a HomeLab. In the long run I want to separate the NAS to a dedicated machine,
+but for now this has to do.
+
+The server runs Proxmox as it's OS and everything that can be managed using
+IaC tools is managed by code so it is easy to reproduce and also keeps an
+history of what is been changed over the time.
+Some support is still missing in Proxmox or in the tools to be managed using
+IaC tools but once it is added I will update the code with the support, one
+example is to setup ACME Certification using ACME plugins ex. Cloudflare. It
+is possible to setup self-signed certificates but not when using ACME Plugins
+(or I have not just yet figured out how to do it).
+
+## Structure
+
+In this folder I have separated each VM with it's own directory, so if you want
+to know more about a specific VM then go into that directory for the specific
+VM and read the README.md file for the specific VM.
+
+## Hardware
+
+Here is a list of what hardware the server is running. Some hardware is
+salvaged parts from my main PC and will be replaced over time.
+
+* Asrock X99 WD
+* Intel Xeon E5-2699v3 18 Core's 36 Threads
+* Hyper 212 EVO CPU Cooler
+* 88GB non-ecc RAM
+* LSI 9207-8i IT P20 HBA (passthrough to NAS VM)
+* 6x3TB WD Red (connected to HBA)
+* 2x120GB Samsung SSD (Running in RAID-z1 for the OS)
+* TP-Link gigabit NIC
+* Asus Strix GTX980
+* Corsair 750W PSU
+* Fractal Define R5
+
+Some future plans for this machine is:
+
+* Replace the PSU to a more reliable PSU.
+* Replace the non-ecc RAM with ECC ram for better stability.
+* Add another GPU that can act as a main GPU for Proxmox due to the CPU is 
+missing iGPU support.
+* Move everything to an rack mountable case.
+* Replace the GTX980 with something bigger so I can test AI services.
+