feature: use backup path on game server (#112)

Author: dhenkel92

async-server-provisioner/config/custom-environment-variables.yml

@@ -17,5 +17,6 @@ datadog:
   api_key: DD_API_KEY
 
 cloudGame:
+  ansibleBranch: CLOUD_GAME_ANSIBLE_BRANCH
   apiUrl: CLOUD_GAME_API_URL
   apiToken: CLOUD_GAME_API_TOKEN

async-server-provisioner/config/default.yml

@@ -19,5 +19,6 @@ datadog:
   api_key: placeholder
 
 cloudGame:
+  ansibleBranch: main
   apiUrl: http://host.docker.internal:1337
   apiToken: placeholder

async-server-provisioner/src/entities/GameInstance.ts

@@ -2,6 +2,7 @@ export interface GameInstance {
   name: string;
   dockerImage: string;
   ports: GameInstancePort[];
+  backupPaths: GameInstanceBackupPath[];
 }
 
 export enum GameInstancePortType {
@@ -15,12 +16,18 @@ export interface GameInstancePort {
   type: GameInstancePortType;
 }
 
+export interface GameInstanceBackupPath {
+  name: string;
+  path: string;
+}
+
 export function gameInstanceFactory(row: any): GameInstance {
   const gameVersion = row.data.attributes.game_version;
   return {
     name: row.data.attributes.name,
     dockerImage: gameVersion.data.attributes.docker_image,
     ports: gameVersion.data.attributes.ports.map(parseGameInstancePort),
+    backupPaths: gameVersion.data.attributes.backup_paths.map(parseGameInstanceBackupPaths),
   };
 }
 
@@ -31,3 +38,10 @@ function parseGameInstancePort(raw: any): GameInstancePort {
     type: (GameInstancePortType as any)[raw.type],
   };
 }
+
+function parseGameInstanceBackupPaths(raw: any): GameInstanceBackupPath {
+  return {
+    name: raw.name,
+    path: raw.path,
+  };
+}

async-server-provisioner/src/entities/MinecraftTFConfig.ts

@@ -15,6 +15,9 @@ export interface MinecraftTFConfig {
       port: string;
       description: string;
     }[];
+    backup_paths: {
+      path: string;
+    }[];
   };
   datadog: {
     enabled: boolean;
@@ -25,7 +28,7 @@ export interface MinecraftTFConfig {
 export function mcTFConfToTFArgs(mfConfig: MinecraftTFConfig): string {
   return `-var='metadata=${JSON.stringify(mfConfig.metadata)}' -var='server=${JSON.stringify(
     mfConfig.server
-  )}' -var='datadog=${JSON.stringify(mfConfig.datadog)}'`;
+  )}' -var='datadog=${JSON.stringify(mfConfig.datadog)}' -var='ansible_branch=${config.get('cloudGame.ansibleBranch')}'`;
 }
 
 export function createMinecraftTFConfigFromGameConfig(mfConfig: GameDeployment): MinecraftTFConfig {
@@ -43,6 +46,9 @@ export function createMinecraftTFConfigFromGameConfig(mfConfig: GameDeployment):
         port: `${port.port}`,
         description: port.name,
       })),
+      backup_paths: mfConfig.gameInstance.backupPaths.map((p) => ({
+        path: p.path,
+      })),
     },
     datadog: {
       enabled: config.get('datadog.enabled'),

async-server-provisioner/src/repositories/GameDeploymentRepository.ts

@@ -34,6 +34,10 @@ query($id: ID) {
                       port
                       type
                     }
+                    backup_paths {
+                      name
+                      path
+                    }
                   }
                 }
               }

infrastructure/ansible/roles/game-server-start/tasks/main.yml

@@ -3,6 +3,14 @@
   when: datadog.enabled
 - include_tasks: game-server-watcher.yml
 
+- name: Fetch docker image
+  shell: /usr/bin/docker pull {{ server.docker_image }}
+- name: Create mount paths
+  file:
+    path: "/mnt/bakup/{{ item.path }}"
+    state: directory
+    mode: "0777"
+  loop: "{{ server.backup_paths }}"
 - name: Create game-server systemd service
   template:
     src: game-server.service

infrastructure/ansible/roles/game-server-start/templates/game-server.service

@@ -9,6 +9,9 @@ RemainAfterExit=true
 ExecStartPre=-/usr/bin/docker rm -f game-server
 ExecStart=/usr/bin/docker run -i --name game-server \
           --net host \
+          {% for p in server.backup_paths %}
+          -v /mnt/bakup/{{ p.path }}:{{p.path}} \
+          {% endfor %}
          {{ server.docker_image }}
 TimeoutStopSec=300
 

infrastructure/ansible/roles/game-server-start/vars/main.yml

@@ -1,6 +1,8 @@
 ---
 server:
   docker_image: placeholder
+  backup_paths:
+    - path: placeholder
 datadog:
   enabled: true
   api_key: placeholder

infrastructure/docker/satisfactory/Dockerfile

@@ -1,13 +1,16 @@
 FROM steamcmd/steamcmd:latest
 
-RUN useradd steamuser -d /home/steamuser
+RUN addgroup steamuser \
+    && useradd --create-home --shell /bin/bash -g steamuser steamuser
 
 WORKDIR /home/steamuser
 
 RUN steamcmd +force_install_dir /home/steamuser/SatisfactoryDedicatedServer +login anonymous +app_update 1690800 -beta public validate +quit \
     && chown -R steamuser /home/steamuser/SatisfactoryDedicatedServer
 
 USER steamuser
+ENV HOME=/home/steamuser
+ENV USER=steamuser
 
 ENTRYPOINT ["/bin/bash"]
-CMD ["./SatisfactoryDedicatedServer/FactoryServer.sh"]
+CMD ["/home/steamuser/SatisfactoryDedicatedServer/FactoryServer.sh", "-Port=7777", "-BeaconPort=15000", "-ServerQueryPort=15777", "-multihome=\"0.0.0.0\""]

infrastructure/terraform/02-game-server/files/startup.sh

@@ -10,6 +10,10 @@ aws:
 # game server start varibales
 server:
   docker_image: ${game_server_image}
+  backup_paths:
+  %{ for p in backup_paths }
+  - path: ${p.path}
+  %{ endfor }
 datadog:
   enabled: ${datadog_enabled}
   api_key: ${datadog_api_key}

infrastructure/terraform/02-game-server/main.tf

@@ -77,6 +77,8 @@ module "game_server" {
       aws_access_key_id     = data.terraform_remote_state.aws_platform.outputs.access_keys["game_user.cloud-game"].access_key_id
       aws_secret_access_key = data.terraform_remote_state.aws_platform.outputs.access_keys["game_user.cloud-game"].secret_access_key
       ansible_branch        = var.ansible_branch
+
+      backup_paths = [for path in var.server.backup_paths : { path = path.path }]
     }
   }
 }

infrastructure/terraform/02-game-server/variables.tf

@@ -16,6 +16,10 @@ variable "server" {
       port        = string
       description = string
     }))
+
+    backup_paths = list(object({
+      path = string
+    }))
   })
 }
 

infrastructure/terraform/02-game-server/vars/test.tfvars

@@ -8,6 +8,7 @@ server = {
   image        = "68074861"
   docker_image = "cloudgame/minecraft:vanilla-1.18.2"
   ports        = []
+  backup_paths = [{ path = "isso" }]
 }
 
 datadog = {

infrastructure/terraform/modules/server/.terraform.lock.hcl

@@ -47,7 +47,7 @@ variable "network" {
 variable "user_data" {
   type = object({
     path = string
-    vars = map(string)
+    vars = any
   })
   default = {
     path = ""