Merge remote-tracking branch 'origin' into bug/modencoding

Author: SQLJames

CHANGELOG.md

@@ -1,12 +1,48 @@
 ## Changelog
 
-### V2.2.1
+### V2.4.1
 
 #### Non-Breaking Changes
-
 - Fixing mod download script to encode spaces properly, fixes [Issue 42](https://github.com/SQLJames/factorio-server-charts/issues/42)
 - Adding update mod check on mod script to avoid it always updating mods, fixes part of[Issue 45](https://github.com/SQLJames/factorio-server-charts/issues/45)
 
+### V2.4.0
+
+#### Potentially Breaking Changes
+
+- Removing the chown of the data directory initialization and instead switching the security context to use the factorio user specified in [factorio docker](https://github.com/factoriotools/factorio-docker/blob/master/docker/Dockerfile). This will fix the nfs permissions but could potentially cause issues elsewhere if you were setting the security context. 
+
+### V2.3.0
+
+#### Non-Breaking Changes
+
+- Decoupling hostNetworking from the nodePort service. Introduces hostNetworkEnabled in the base of the values. By default this will still enabled with a standard set of values, but can be individually disabled if needed. [Issue 38](https://github.com/SQLJames/factorio-server-charts/issues/38)
+
+### V2.2.4
+
+#### Non-Breaking Changes
+
+- Adding the option to append ENV variables to the factorio server container, fixes  [Issue 66](https://github.com/SQLJames/factorio-server-charts/issues/66) and [Issue 37](https://github.com/SQLJames/factorio-server-charts/issues/37)
+
+### V2.2.3
+
+#### Non-Breaking Changes
+
+- Adding support for ipFamilyPolicy, fixing [Issue 63](https://github.com/SQLJames/factorio-server-charts/issues/63)
+
+### V2.2.2
+
+#### Non-Breaking Changes
+
+- Disabled port-fixer livenessProbe due to reliability issues
+
+### V2.2.1
+
+#### Non-Breaking Changes
+
+- Correct issues in deployment when `rconAPI` and `port_fixer` are used simultaniously.
+- Add missing `ports` key to rconAPI container
+
 ### V2.2.0
 
 #### 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.2.1
+version: 2.4.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/templates/deployment.yaml

@@ -19,14 +19,16 @@ spec:
       labels:
         app: {{ template "factorio-server-charts.fullname" . }}
     spec:
+      {{- with .Values.securityContext }}
+      securityContext:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
       dnsConfig:
         options:
           - name: ndots
             value: '1'
-      {{- if eq .Values.service.type "NodePort" }}
+      {{- if .Values.hostNetworkEnabled }}
       hostNetwork: true
-      {{- else }}
-      hostNetwork: false
       {{- end }}
       initContainers:
         - name: volume-permissions-serversettingsconfig
@@ -55,10 +57,9 @@ spec:
                 jq -M --rawfile game_password /gamePassword/game_password '.game_password=($game_password|gsub("[\\n\\t]"; ""))' /factorio/configs/server-settings.json > /tmp/server-settings.json && mv /tmp/server-settings.json /factorio/configs/server-settings.json
               fi
               #sleep 100
-              chown -vR factorio:factorio /factorio
               chmod -vR 777 /factorio/configs
               ls -alth /factorio
-          {{- with .Values.securityContext }}
+          {{- with .Values.podSecurityContext }}
           securityContext:
             {{- toYaml . | nindent 12 }}
           {{- end }}
@@ -93,7 +94,7 @@ spec:
               bash /scripts/mod-downloader.sh
               echo "Finished mod-downloader.sh script"
               ls -althR /factorio/mods
-          {{- with .Values.securityContext }}
+          {{- with .Values.podSecurityContext }}
           securityContext:
             {{- toYaml . | nindent 12 }}
           {{- end }}
@@ -119,7 +120,7 @@ spec:
             - -ec
             - |
               bash /scripts/save-importer.sh
-          {{- with .Values.securityContext }}
+          {{- with .Values.podSecurityContext }}
           securityContext:
             {{- toYaml . | nindent 12 }}
           {{- end }}
@@ -133,7 +134,7 @@ spec:
       - name: {{ template "factorio-server-charts.fullname" . }}
         image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
         imagePullPolicy: {{ .Values.image.pullPolicy }}
-        {{- with .Values.securityContext }}
+        {{- with .Values.podSecurityContext }}
         securityContext:
           {{- toYaml . | nindent 10 }}
         {{- end }}
@@ -182,39 +183,10 @@ spec:
           value: {{ .Values.factorioServer.port | quote }}
         - name: RCON_PORT
           value: {{ .Values.factorioServer.rcon_port | quote }}
-{{- 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 }}
+        {{- range .Values.factorioServer.env }}
+        - name: {{ .name }}
+          value: {{ .value | quote }}
         {{- 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: /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
-{{- end }}
 {{- if .Values.rconAPI.enabled }}
       - name: {{ template "factorio-server-charts.fullname" . }}-rcon-api
         image: "{{ .Values.rconAPI.image.repository }}:{{ .Values.rconAPI.image.tag }}"
@@ -223,6 +195,7 @@ spec:
           httpGet:
             path: /healthz
             port: rcon-api
+        ports:
         - name: rcon-api
           containerPort: 24180
           protocol: TCP
@@ -243,6 +216,42 @@ spec:
           value: {{ .Values.rcon.password | quote }}
           {{- end }}
 {{- end }}
+{{- 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.podSecurityContext }}
+        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 }}
+        #
+        # Disabled due to reliability issues: https://github.com/ZCube/factorio-port-fixer/issues/1
+        #
+        # livenessProbe:
+        #   httpGet:
+        #     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
+{{- end }}
 {{- if .Values.nodeSelector }}
       nodeSelector:
 {{ toYaml .Values.nodeSelector | indent 8 }}

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

@@ -13,6 +13,16 @@ metadata:
     {{ $key }}: {{ $value | quote }}
   {{- end }}
 spec:
+  {{- if semverCompare ">=1.20.0-0" .Capabilities.KubeVersion.Version -}}
+  {{- if .Values.rconAPI.ipFamilyPolicy }}
+  ipFamilyPolicy: {{ .Values.rconAPI.ipFamilyPolicy }}
+  {{- end }}
+  {{- end }}
+  {{- if semverCompare ">=1.20.0-0" .Capabilities.KubeVersion.Version -}}
+  {{- if .Values.rconAPI.ipFamilies }}
+  ipFamilies: {{ toYaml .Values.rconAPI.ipFamilies | nindent 4 }}
+  {{- end }}
+  {{- end }}
   type: {{ .Values.rconAPI.type }}
   ports:
     - name: http

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

@@ -13,6 +13,16 @@ metadata:
     {{ $key }}: {{ $value | quote }}
   {{- end }}
 spec:
+  {{- if semverCompare ">=1.20.0-0" .Capabilities.KubeVersion.Version -}}
+  {{- if .Values.rcon.ipFamilyPolicy }}
+  ipFamilyPolicy: {{ .Values.rcon.ipFamilyPolicy }}
+  {{- end }}
+  {{- end }}
+  {{- if semverCompare ">=1.20.0-0" .Capabilities.KubeVersion.Version -}}
+  {{- if .Values.rcon.ipFamilies }}
+  ipFamilies: {{ toYaml .Values.rcon.ipFamilies | nindent 4 }}
+  {{- end }}
+  {{- end }}
   type: {{ .Values.rcon.type }}
   ports:
     - name: rcon

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

@@ -14,6 +14,16 @@ metadata:
   {{- end }}
   {{- end }}
 spec:
+  {{- if semverCompare ">=1.20.0-0" .Capabilities.KubeVersion.Version -}}
+  {{- if .Values.service.ipFamilyPolicy }}
+  ipFamilyPolicy: {{ .Values.service.ipFamilyPolicy }}
+  {{- end }}
+  {{- end }}
+  {{- if semverCompare ">=1.20.0-0" .Capabilities.KubeVersion.Version -}}
+  {{- if .Values.service.ipFamilies }}
+  ipFamilies: {{ toYaml .Values.service.ipFamilies | nindent 4 }}
+  {{- end }}
+  {{- end }}
   type: {{ .Values.service.type }}
   {{- if .Values.service.externalTrafficPolicy}}
   externalTrafficPolicy: {{ .Values.service.externalTrafficPolicy }}

charts/factorio-server-charts/values.yaml

@@ -12,8 +12,15 @@
 
 replicaCount: 1
 
+hostNetworkEnabled: true
+
+# https://github.com/factoriotools/factorio-docker/blob/master/docker/Dockerfile
 securityContext:
-  runAsUser: 0
+  fsGroup: 845
+
+podSecurityContext:
+  runAsUser: 845
+  runAsGroup: 845
 
 #### Image Configuration ####
 ## @section Image Parameters
@@ -48,6 +55,17 @@ nodeSelector: {}
 ## The best way ist to define a ClusterIP service and define one or more externalIPs. Of course this IPs must be available on the node the factorio pod runs on!
 service:
   type: NodePort
+  ## Represents the dual-stack-ness requested or required by this Service. Possible values are
+  ## SingleStack, PreferDualStack or RequireDualStack.
+  ## The ipFamilies and clusterIPs fields depend on the value of this field.
+  ## Ref: https://kubernetes.io/docs/concepts/services-networking/dual-stack/
+  ipFamilyPolicy: "SingleStack"
+
+  ## List of IP families (e.g. IPv4, IPv6) assigned to the service. This field is usually assigned automatically
+  ## based on cluster configuration and the ipFamilyPolicy field.
+  ## Ref: https://kubernetes.io/docs/concepts/services-networking/dual-stack/
+  ipFamilies:
+    - IPv4
   port: 31497
   ## If you are able to map an external IP, set it here
   # externalIPs:
@@ -150,6 +168,7 @@ mods:
 ## @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
+## @param factorioServer.env Additional environment values for the Factorio Server container
 factorioServer:
   # name to use for the save file
   save_name: "replaceMe"
@@ -170,6 +189,10 @@ factorioServer:
   # 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.
   rcon_port: 27015
+  # adding addtional environment variables to the factorio server container
+  env: {}
+    # - name: MY_VAR
+    #   value: "my_value"
 
 import_save:
   # enable save importer
@@ -332,6 +355,17 @@ port_fixer:
 ## @param rcon.port RCON service external port
 # Password and port for the rcon service
 rcon:
+  ## Represents the dual-stack-ness requested or required by this Service. Possible values are
+  ## SingleStack, PreferDualStack or RequireDualStack.
+  ## The ipFamilies and clusterIPs fields depend on the value of this field.
+  ## Ref: https://kubernetes.io/docs/concepts/services-networking/dual-stack/
+  ipFamilyPolicy: "SingleStack"
+
+  ## List of IP families (e.g. IPv4, IPv6) assigned to the service. This field is usually assigned automatically
+  ## based on cluster configuration and the ipFamilyPolicy field.
+  ## Ref: https://kubernetes.io/docs/concepts/services-networking/dual-stack/
+  ipFamilies:
+    - IPv4
   external: true
   type: LoadBalancer
   serviceAnnotations: {}
@@ -359,6 +393,17 @@ rcon:
 ## @param rconAPI.ingress.tls.enabled Enable or disable TLS for the Ingress
 ## @param rconAPI.ingress.tls.secretName Kubernetes Secret name for TLS certificates used by the Ingress
 rconAPI:
+  ## Represents the dual-stack-ness requested or required by this Service. Possible values are
+  ## SingleStack, PreferDualStack or RequireDualStack.
+  ## The ipFamilies and clusterIPs fields depend on the value of this field.
+  ## Ref: https://kubernetes.io/docs/concepts/services-networking/dual-stack/
+  ipFamilyPolicy: "SingleStack"
+
+  ## List of IP families (e.g. IPv4, IPv6) assigned to the service. This field is usually assigned automatically
+  ## based on cluster configuration and the ipFamilyPolicy field.
+  ## Ref: https://kubernetes.io/docs/concepts/services-networking/dual-stack/
+  ipFamilies:
+    - IPv4
   enabled: false
   image:
     repository: "ghcr.io/nekomeowww/factorio-rcon-api"