feature: implement create/restore backups (#113)

* feature: implement create/restore backups

* create shutdown service

* create shutdown andible role

Author: dhenkel92

async-server-provisioner/config/default.yml

@@ -11,14 +11,14 @@ hetzner:
 
 hcloudServer:
   type: cx31
-  image: '162606073'
+  image: '162785630'
   location: nbg1
 
 datadog:
   enabled: false
   api_key: placeholder
 
 cloudGame:
-  ansibleBranch: main
+  ansibleBranch: create-restore-backups
   apiUrl: http://host.docker.internal:1337
   apiToken: placeholder

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

@@ -1,4 +1,5 @@
 export interface GameInstance {
+  id: number;
   name: string;
   dockerImage: string;
   ports: GameInstancePort[];
@@ -24,6 +25,7 @@ export interface GameInstanceBackupPath {
 export function gameInstanceFactory(row: any): GameInstance {
   const gameVersion = row.data.attributes.game_version;
   return {
+    id: row.data.id,
     name: row.data.attributes.name,
     dockerImage: gameVersion.data.attributes.docker_image,
     ports: gameVersion.data.attributes.ports.map(parseGameInstancePort),

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

@@ -5,6 +5,9 @@ export interface MinecraftTFConfig {
   metadata: {
     name: string;
     location: string;
+    game_instance: {
+      id: number;
+    };
   };
   server: {
     type: string;
@@ -36,6 +39,9 @@ export function createMinecraftTFConfigFromGameConfig(mfConfig: GameDeployment):
     metadata: {
       name: generateTFWorkspaceName(mfConfig),
       location: mfConfig.cloudInstance.region,
+      game_instance: {
+        id: mfConfig.gameInstance.id,
+      },
     },
     server: {
       type: mfConfig.cloudInstance.apiName,

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

@@ -23,6 +23,7 @@ query($id: ID) {
         }
         game_instance {
           data {
+            id
             attributes {
               name
               game_version {

infrastructure/ansible/generic/bucket.yaml

@@ -0,0 +1,7 @@
+---
+- name: Generate bucket path
+  shell: echo "game_instances/{{ game_instance.id }}/backups/"
+  register: backup_folder_path
+- name: Generate Backup name
+  shell: echo "backup-$(date +"%Y-%m-%d_%H_%M_%S").tar.gz"
+  register: backup_name

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

@@ -11,3 +11,7 @@
   service:
     name: game-server-watcher
     state: started
+- name: Start Game Shutdown Service
+  service:
+    name: game-shutdown
+    state: started

infrastructure/ansible/roles/game-server-start/tasks/create-server-shutdown-service.yaml

@@ -0,0 +1,12 @@
+---
+- name: Create server shutdown systemd service
+  template:
+    src: game-shutdown.service
+    dest: /etc/systemd/system/game-shutdown.service
+    owner: root
+    group: root
+  notify: Start Game Shutdown Service
+
+- name: Reload Systmed
+  systemd:
+    daemon_reload: yes

infrastructure/ansible/roles/game-server-start/tasks/fetch-backup.yml

@@ -0,0 +1,25 @@
+---
+- include_tasks: ../../../generic/bucket.yaml
+- name: List all backups
+  amazon.aws.aws_s3:
+    bucket: cloud-game
+    mode: list
+    prefix: "{{ backup_folder_path.stdout }}"
+  register: all_backups
+- set_fact:
+    backup_path: "{{ all_backups.s3_keys[0] if all_backups.s3_keys | length > 0 else '' }}"
+- name: "Debug print backup path"
+  debug:
+    msg: "{{ backup_path }}"
+- name: Download backup
+  amazon.aws.s3_object:
+    bucket: cloud-game
+    object: "{{ backup_path }}"
+    dest: /root/backup.tar.gz
+    mode: get
+  when: backup_path != ""
+- name: Unzip archive
+  unarchive:
+    src: /root/backup.tar.gz
+    dest: /mnt/backup/
+  when: backup_path != ""

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

@@ -3,11 +3,18 @@
   when: datadog.enabled
 - include_tasks: game-server-watcher.yml
 
+- name: Create mount path
+  file:
+    path: "/mnt/backup/"
+    state: directory
+    mode: "0777"
+- include_tasks: fetch-backup.yml
+
 - name: Fetch docker image
   shell: /usr/bin/docker pull {{ server.docker_image }}
 - name: Create mount paths
   file:
-    path: "/mnt/bakup/{{ item.path }}"
+    path: "/mnt/backup/{{ item.path }}"
     state: directory
     mode: "0777"
   loop: "{{ server.backup_paths }}"
@@ -19,6 +26,8 @@
     group: root
   notify: Start Game Server
 
+- include_tasks: create-server-shutdown-service.yaml
+
 - name: Reload Systmed
   systemd:
     daemon_reload: yes

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

@@ -10,7 +10,7 @@ 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}} \
+          -v /mnt/backup/{{ p.path }}:{{p.path}} \
           {% endfor %}
          {{ server.docker_image }}
 TimeoutStopSec=300

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

@@ -0,0 +1,14 @@
+[Unit]
+Description=Game Shutdown
+After=network-online.target
+Before=game-server.service
+Requires=docker.service network-online.target game-server.service
+
+[Service]
+User=root
+RemainAfterExit=true
+ExecStop=/usr/local/bin/ansible-playbook /tmp/cloud-gameserver/infrastructure/ansible/shutdown-server.yml --extra-vars "@/root/ansible/vars/game-server.yaml"
+TimeoutStopSec=600
+
+[Install]
+WantedBy=multi-user.target

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

@@ -1,4 +1,6 @@
 ---
+game_instance:
+  id: placeholder
 server:
   docker_image: placeholder
   backup_paths:

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

@@ -1,17 +1,10 @@
 ---
-- name: Generate Backup name
-  shell: echo "backup-$(date +"%Y-%m-%d_%H_%M_%S").tar.gz"
-  register: backup_name
-
-- name: Archive Game Files
-  archive:
-    format: gz
-    path: /root/game-server/
-    dest: /tmp/{{ backup_name.stdout }}
-
+- include_tasks: ../../../generic/bucket.yaml
+- name: Create a tar.gz archive of a single file.
+  shell: tar -czf /root/backup.tar.gz -C /mnt/backup .
 - name: Upload Backup File to S3
-  amazon.aws.aws_s3:
-    bucket: "{{ bucket_name }}"
-    object: /{{base_path}}/{{ backup_name.stdout }}
-    src: /tmp/{{ backup_name.stdout }}
+  amazon.aws.s3_object:
+    bucket: cloud-game
+    object: "{{ backup_folder_path.stdout }}{{ backup_name.stdout }}"
+    src: /root/backup.tar.gz
     mode: put

infrastructure/ansible/roles/shutdown-server/tasks/main.yml

@@ -1 +1,3 @@
 ---
+game_instance:
+  id: placeholder

infrastructure/ansible/roles/shutdown-server/vars/main.yml

@@ -5,7 +5,10 @@ set -ex
 # Install ansible
 apt-get update
 apt-get install -y python3 python3-pip
-pip3 install -I ansible==5.6.0
+pip3 install -I ansible==8.7.0 boto3
+
+# Install ansible dependencies
+ansible-galaxy collection install amazon.aws
 
 # Move ansible files from temp to proper folder
 mv /tmp/ansible /root

infrastructure/packer/provisioners/common/install-ansible.sh

@@ -1,19 +1,17 @@
 {
-    "Version": "2012-10-17",
-    "Statement": [
-        {
-            "Sid": "VisualEditor0",
-            "Effect": "Allow",
-            "Action": [
-                "s3:PutObject",
-                "s3:GetObject",
-                "s3:PutObjectAcl",
-                "s3:ListBucket"
-            ],
-            "Resource": [
-                "arn:aws:s3:::cloud-game/*",
-                "arn:aws:s3:::cloud-game"
-            ]
-        }
-    ]
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Sid": "VisualEditor0",
+      "Effect": "Allow",
+      "Action": [
+        "s3:PutObject",
+        "s3:GetObject",
+        "s3:PutObjectAcl",
+        "s3:ListBucket",
+        "s3:GetObjectTagging"
+      ],
+      "Resource": ["arn:aws:s3:::cloud-game/*", "arn:aws:s3:::cloud-game"]
+    }
+  ]
 }

infrastructure/terraform/00-aws-platform/identity/files/backup.json

@@ -7,6 +7,8 @@ aws:
   aws_secret_access_key: ${aws_secret_access_key}
   aws_default_region: eu-central-1
 
+game_instance:
+  id: ${game_instance_id}
 # game server start varibales
 server:
   docker_image: ${game_server_image}

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

@@ -77,6 +77,7 @@ 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
+      game_instance_id      = var.metadata.game_instance.id
 
       backup_paths = [for path in var.server.backup_paths : { path = path.path }]
     }

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

@@ -2,6 +2,9 @@ variable "metadata" {
   type = object({
     name     = string
     location = string
+    game_instance = object({
+      id = number
+    })
   })
 }
 

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

@@ -1,6 +1,9 @@
 metadata = {
   name     = "minecraft-test"
   location = "nbg1"
+  game_instance = {
+    id = 2
+  }
 }
 
 server = {