From 8c6051aec73296b14ea7be69578d76c554693b71 Mon Sep 17 00:00:00 2001
From: Samuel Walker <sfxworks@gmail.com>
Date: Thu, 29 Jun 2023 15:49:57 +0000
Subject: [PATCH] k8s-inclusion

---
 docs/k8s-files/pvc.yaml         | 25 +++++++++
 docs/k8s-files/statefulset.yaml | 96 +++++++++++++++++++++++++++++++++
 docs/k8s.md                     | 16 ++++++
 3 files changed, 137 insertions(+)
 create mode 100644 docs/k8s-files/pvc.yaml
 create mode 100644 docs/k8s-files/statefulset.yaml
 create mode 100644 docs/k8s.md

diff --git a/docs/k8s-files/pvc.yaml b/docs/k8s-files/pvc.yaml
new file mode 100644
index 0000000..1a4a4d6
--- /dev/null
+++ b/docs/k8s-files/pvc.yaml
@@ -0,0 +1,25 @@
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: games
+spec:
+  storageClassName: ssd #Adjust your storageclass as needed
+  volumeMode: Filesystem
+  resources:
+    requests:
+      storage: 400Gi
+  accessModes:
+    - ReadWriteOnce
+---
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: home        
+spec:
+  volumeMode: Filesystem
+  storageClassName: nvme-replicated #Adjust your storageclass as needed
+  resources:
+    requests:
+      storage: 50Gi
+  accessModes:
+    - ReadWriteOnce
diff --git a/docs/k8s-files/statefulset.yaml b/docs/k8s-files/statefulset.yaml
new file mode 100644
index 0000000..cda8c57
--- /dev/null
+++ b/docs/k8s-files/statefulset.yaml
@@ -0,0 +1,96 @@
+apiVersion: apps/v1
+kind: StatefulSet
+metadata:
+  name: steam-headless
+spec:
+  serviceName: "steam-headless"
+  replicas: 1
+  selector:
+    matchLabels:
+      app: steam-headless
+  template:
+    metadata:
+      labels:
+        app: steam-headless
+    spec:
+      hostNetwork: true
+      securityContext:
+        fsGroup: 1000
+      containers:
+      - name: steam-headless
+        securityContext:
+          privileged: true
+        image: josh5/steam-headless:latest
+        resources: #Change CPU and Memory below
+          requests:
+            memory: "24G"
+            cpu: "6"
+          limits:
+            memory: "24G"
+            cpu: "6"
+            nvidia.com/gpu: 1 #If you're using a nvidia GPU, add it here
+        volumeMounts:
+        - name: home-dir
+          mountPath: /home/default/
+        - name: games-dir
+          mountPath: /mnt/games/
+        - name: input-devices
+          mountPath: /dev/input/
+        - name: dshm
+          mountPath: /dev/shm
+        env: #Environmental Vars
+        - name: NAME
+          value: 'SteamHeadless'
+        - name: TZ
+          value: 'America/New_York'
+        - name: USER_LOCALES
+          value: 'en_US.UTF-8 UTF-8'
+        - name: DISPLAY
+          value: ':55'
+        - name: SHM_SIZE
+          value: '2G'
+        - name: DOCKER_RUNTIME
+          value: 'nvidia'
+        - name: PUID
+          value: '1000'
+        - name: PGID
+          value: '1000'
+        - name: UMASK
+          value: '000'
+        - name: USER_PASSWORD
+          value: 'password' #changeme
+        - name: MODE
+          value: 'primary'
+        - name: WEB_UI_MODE
+          value: 'none'
+        - name: ENABLE_VNC_AUDIO
+          value: 'false'
+        - name: PORT_NOVNC_WEB
+          value: '8083'
+        - name: NEKO_NAT1TO1
+          value: ''
+        - name: ENABLE_SUNSHINE
+          value: 'true'
+        - name: SUNSHINE_USER
+          value: 'sam'
+        - name: SUNSHINE_PASS
+          value: 'password'
+        - name: ENABLE_EVDEV_INPUTS
+          value: 'true'
+        - name: NVIDIA_DRIVER_CAPABILITIES
+          value: 'all'
+        - name: NVIDIA_VISIBLE_DEVICES
+          value: 'all'
+      volumes:
+      - name: home-dir
+        persistentVolumeClaim:
+          claimName: home
+      - name: games-dir
+        persistentVolumeClaim:
+          claimName: games
+      - name: input-devices
+        hostPath:
+          path: /dev/input/
+      - name: dshm
+        emptyDir:
+          medium: Memory
diff --git a/docs/k8s.md b/docs/k8s.md
new file mode 100644
index 0000000..5338587
--- /dev/null
+++ b/docs/k8s.md
@@ -0,0 +1,16 @@
+# Kubernetes
+
+Have a cluster at home and want to add steam headless to it?
+
+Requirements
+- NVIDIA Device plugin (if using nvidia GPU) https://github.com/NVIDIA/k8s-device-plugin 
+- A storageclass
+
+Tasks
+1. Configure the statefulset to your liking. Things to note:
+    - CPU & Memory
+    - Env vars (see compose-files/.env for documentation)
+2. Change the PVC to your liking. Things to note:
+    - Storage Class
+    - Size
+3. Deploy it: `kubectl create -f k8s-files/*`