Merge branch 'main' into factorio-rcon-api

Author: Kariton

CHANGELOG.md

@@ -1,11 +1,29 @@
 ## Changelog
 
-### V2.0.3
+### V2.1.1
 
 #### Non-Breaking Changes
 
 - Added support for [nekomeowww/factorio-rcon-api](https://github.com/nekomeowww/factorio-rcon-api) including corresponding fields for values.yaml
 
+### V2.1.0
+
+#### Non-Breaking Changes
+
+- Added support for [ZCube/factorio-port-fixer](https://github.com/ZCube/factorio-port-fixer) including corresponding fields for values.yaml
+
+### V2.0.4
+
+#### Non-Breaking Changes
+
+- Added new PVC labels - Thank you ohnoitsyou 
+
+### V2.0.3
+
+#### Non-Breaking Changes
+
+- Updated Chart test to wait for the service to become available before testing rcon port
+
 ### V2.0.2
 
 #### Non-Breaking Changes

charts/factorio-server-charts/Chart.yaml

@@ -20,7 +20,7 @@ sources:
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 2.0.3
+version: 2.1.1
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

charts/factorio-server-charts/README.md

@@ -236,6 +236,7 @@ If you do run into any issues with mods, I will try to work with you on finding
 | `persistence.dataDir.existingClaim` | The name of an existing PVC to use for persistence |        |
 | `persistence.storageClassName`      | Persistent Volume storage class                    | `""`   |
 | `persistence.annotations`           | Persistent Volume Claim annotations                | `{}`   |
+| `persistence.lables`                | Persistent Volume Claim labels                     | `{}`   |
 
 ### Factorio Parameters
 

charts/factorio-server-charts/templates/datadir-pvc.yaml

@@ -6,6 +6,9 @@ metadata:
   name: {{ template "factorio-server-charts.fullname" . }}-datadir
   labels:
     app: "{{ template "factorio-server-charts.fullname" . }}-{{ .Chart.Version }}"
+    {{- range $key, $val := .Values.persistence.labels }}
+    {{ $key }}: {{ $val | quote }}
+    {{- end}}
 {{- if .Values.persistence.annotations }}
   annotations:
 {{ toYaml .Values.persistence.annotations | indent 4 }}

charts/factorio-server-charts/templates/deployment.yaml

@@ -141,7 +141,7 @@ spec:
           failureThreshold: 3
         ports:
         - name: factorio
-          containerPort: 34197
+          containerPort: {{ .Values.factorioServer.port }}
           protocol: UDP
         - containerPort: {{ .Values.factorioServer.rcon_port }}
           protocol: TCP
@@ -171,24 +171,50 @@ spec:
           value: {{ .Values.factorioServer.enable_space_age | quote }}
         - name: CONFIG
           value: /factorio/configs
+        - name: PORT
+          value: {{ .Values.factorioServer.port | quote }}
         - name: RCON_PORT
           value: {{ .Values.factorioServer.rcon_port | quote }}
-{{- if .Values.rcon_api.enabled }}
-      - name: {{ template "factorio-server-charts.fullname" . }}-rcon-api
-        image: "{{ .Values.rcon_api.image.repository }}:{{ .Values.rcon_api.image.tag }}"
-        imagePullPolicy: {{ .Values.rcon_api.image.pullPolicy }}
+{{- if .Values.port_fixer.enabled }}
+      - name: {{ template "factorio-server-charts.fullname" . }}-port-fixer
+        image: "{{ .Values.port_fixer.image.repository }}:{{ .Values.port_fixer.image.tag }}"
+        imagePullPolicy: {{ .Values.port_fixer.image.pullPolicy }}
         {{- with .Values.securityContext }}
         securityContext:
           {{- toYaml . | nindent 10 }}
         {{- end }}
+        command: ["/factorio-port-fixer"]
+        args:
+        - local
+        - --ip=127.0.0.1
+        - --port=34197
+        - --remotePort={{ .Values.port_fixer.port | default .Values.service.port }}
         livenessProbe:
           httpGet:
-            path: /healthz
-            port: rcon-api
+            path: /health
+            port: port-fixer
           periodSeconds: 10
           initialDelaySeconds: 5
           failureThreshold: 3
         ports:
+        - name: port-fixer
+          containerPort: 34197
+          protocol: TCP
+      hostAliases:
+      - ip: "127.0.0.1"
+        hostnames:
+        - pingpong1.factorio.com
+        - pingpong2.factorio.com
+        - pingpong3.factorio.com
+        - pingpong4.factorio.com
+{{- if .Values.rcon_api.enabled }}
+      - name: {{ template "factorio-server-charts.fullname" . }}-rcon-api
+        image: "{{ .Values.rcon_api.image.repository }}:{{ .Values.rcon_api.image.tag }}"
+        imagePullPolicy: {{ .Values.rcon_api.image.pullPolicy }}
+        livenessProbe:
+          httpGet:
+            path: /healthz
+            port: rcon-api
         - name: rcon-api
           containerPort: 24180
           protocol: TCP

charts/factorio-server-charts/templates/service.yaml

@@ -20,7 +20,7 @@ spec:
   {{- end }}
   ports:
     - name: factorio
-      targetPort: 34197
+      targetPort: {{ .Values.factorioServer.port }}
       port: {{ .Values.service.port }}
       protocol: UDP
       {{- if eq .Values.service.type "NodePort" }}

charts/factorio-server-charts/templates/tests/test-connection.yaml

@@ -12,10 +12,19 @@ spec:
       image: outdead/rcon
       command:
         - /bin/sh
-        - -ec
+        - -xec
         - |
+          until nc -z {{ include "factorio-server-charts.fullname" . }}-rcon {{ .Values.rcon.port }}; do
+            echo "Waiting for main service to be ready..." >&2
+            sleep 5
+          done
+          echo "Main service is ready, proceeding with connection test."
           RCONPW="$(cat /rconpw/rconpw)"
-          ./rcon -a {{ include "factorio-server-charts.fullname" . }}-rcon:{{ .Values.rcon.port }} -p $RCONPW -t rcon -T 180s /s Test
+          if ./rcon -a {{ include "factorio-server-charts.fullname" . }}-rcon:{{ .Values.rcon.port }} -p $RCONPW -t rcon -T 180s /s Test; then
+            echo "RCON test command completed successfully."
+          else
+            echo "RCON test failed." >&2
+          fi
       volumeMounts:
         - mountPath: /rconpw
           name: rconpw

charts/factorio-server-charts/values.yaml

@@ -106,6 +106,7 @@ affinity: {}
 ## @extra persistence.dataDir.existingClaim The name of an existing PVC to use for persistence
 ## @param persistence.storageClassName Persistent Volume storage class
 ## @param persistence.annotations Persistent Volume Claim annotations
+## @param persistence.labels Persistent Volume Claim labels
 ## Sets the data persistence volume configuration
 ## IMPORTANT: If you do not setup a PV all your savegames will be lost on pod recreation or helm upgrade
 persistence:
@@ -118,6 +119,8 @@ persistence:
   storageClassName: ""
   ## If you have annotations to spin up a PV i.e. the location. Remove the curly braces
   annotations: {}
+  ## If you have additional labels to apply to the volume
+  labels: {}
 
 
 #### Factorio application configuration ####
@@ -145,6 +148,7 @@ mods:
 ## @param factorioServer.generate_new_save Generate a new save if `save_name` is not found
 ## @param factorioServer.update_mods_on_start Update mods on server start
 ## @param factorioServer.load_latest_save Lets the game know if you want to load the latest save
+## @param factorioServer.port Factorio Game Server port
 ## @param factorioServer.rcon_port Factorio Server RCON port
 factorioServer:
   # name to use for the save file
@@ -157,6 +161,11 @@ factorioServer:
   load_latest_save: true
   # enables or disables the mods for DLC Space Age in mod-list.json
   enable_space_age: true
+  # factorio game server port
+  # the default game port (34197) has been changed to 31497 to resolve issues when using the port-fixer.
+  # this port setting is typically for internal Kubernetes configuration only, and in most cases, it does not need to be modified.
+  # if it is necessary to change the game server port where you connect to the game, update the "service.port" value accordingly.
+  port: 31497
   # factorio game rcon port
   # this port setting is typically for internal Kubernetes configuration only, and in most cases, it does not need to be modified.
   # if it is necessary to change the rcon server port where you connect to it, update the "rcon.port" value accordingly.
@@ -292,6 +301,29 @@ server_settings:
   maximum_segment_size: 100
   maximum_segment_size_peer_count: 10
 
+## @section Port-Fixer Parameters
+## @param port_fixer.enabled Enable the Factorio Port Fixer
+## @param image.repository Factorio port-fixer image repository
+## @param image.tag Factorio port fixer image tag (immutable tags are recommended)
+## @param image.pullPolicy Factorio port fixer image pull policy
+## @param image.port Factorio port to announce via port-fixer, defaults to service.port
+port_fixer:
+  # Adds an extra container that tries to help with connection issues via the public server browser.
+  # This is especially useful when you can’t set up outgoing static port mappings and see log messages like these:
+  # > Warning ServerRouter.cpp:541: Received own address message reply with conflicting address (got IP ADDR:({<ip>:19296}), expected IP ADDR:({<ip>:58037}))
+  # > Warning ServerMultiplayerManager.cpp:651: Determining own address has failed. Best guess: IP ADDR:({<ip>:58037})
+  # > Warning ServerRouter.cpp:541: Received own address message reply with conflicting address (got IP ADDR:({<ip>:19297}), expected IP ADDR:({<ip>:58037}))
+  # > Warning ServerRouter.cpp:541: Received own address message reply with conflicting address (got IP ADDR:({<ip>:24105}), expected IP ADDR:({<ip>:58037}))
+  # Note: Port forwarding for incoming traffic still needs to be set up properly for this to work.
+  # For more info, check out:
+  #   - https://github.com/SQLJames/factorio-server-charts/issues/15
+  enabled: false
+  image:
+    repository: "ghcr.io/zcube/factorio-port-fixer"
+    pullPolicy: Always
+    tag: latest
+  port: ''
+
 ## @param rcon.external Enable RCON external access (deploy RCON service)
 ## @param rcon.type RCON service type
 ## @param rcon.serviceAnnotations RCON service annotations