feat(shulker-operator): add the possibility to use custom server jars (…

…jeremylvln#254) * feat(shulker-crds): add custom JAR to MincraftServer * feat(shulker-operator): set custom JAR on MinecraftServer if provided * docs: add custom server jar recipe * chore: add example for custom server jar
BridgeSplash · Dec 4, 2023 · 72844b1 · 72844b1
1 parent 0562a8d
commit 72844b1
Show file tree

Hide file tree

Showing 35 changed files with 705 additions and 206 deletions.
diff --git a/docs/src/next/guide/recipes/using-custom-server-jar.md b/docs/src/next/guide/recipes/using-custom-server-jar.md
@@ -0,0 +1,38 @@
+# Using custom server JAR
+
+You may want to use a custom server JAR to replace the default
+behavior which is to download the matching version from the
+channel.
+
+You have the ability to specify a resource reference to a custom
+server JAR in the `MinecraftServer` and `MinecraftServerFleet` CRDs:
+
+```yaml
+apiVersion: shulkermc.io/v1alpha1
+kind: MinecraftServerFleet
+metadata:
+  name: my-server
+spec:
+  clusterRef:
+    name: my-cluster
+  replicas: 1
+  template:
+    spec: // [!code focus]
+      version: // [!code focus]
+        channel: Paper // [!code focus]
+        name: 1.20.0 // [!code focus]
+        customJar: // [!code focus]
+          url: https://example.com/custom-jar.jar // [!code focus]
+```
+
+:::warning
+
+While this feature allows you to customize the server software to run,
+you can't use it to create servers with unsupported platforms. You
+still have to specify the version channel so Shulker is aware of which
+agent to inject into the server.
+
+You can, however, expect any standard fork of supported platforms to
+work as long as they do not introduce breaking changes.
+
+:::
diff --git a/docs/src/next/sidebar.mts b/docs/src/next/sidebar.mts
@@ -48,6 +48,10 @@ export default [
         text: 'Defining network administrators',
         link: link('/guide/recipes/defining-network-administrators'),
       },
+      {
+        text: 'Using custom server JAR',
+        link: link('/guide/recipes/using-custom-server-jar'),
+      },
     ],
   },
   {

diff --git a/examples/custom-server-jar/cluster.yaml b/examples/custom-server-jar/cluster.yaml
@@ -0,0 +1,5 @@
+apiVersion: shulkermc.io/v1alpha1
+kind: MinecraftCluster
+metadata:
+  name: getting-started
+spec: {}
diff --git a/examples/custom-server-jar/kustomization.yaml b/examples/custom-server-jar/kustomization.yaml
@@ -0,0 +1,3 @@
+resources:
+  - cluster.yaml
+  - minecraftserver.yaml
diff --git a/examples/custom-server-jar/minecraftserver.yaml b/examples/custom-server-jar/minecraftserver.yaml
@@ -0,0 +1,20 @@
+apiVersion: shulkermc.io/v1alpha1
+kind: MinecraftServerFleet
+metadata:
+  name: lobby
+spec:
+  clusterRef:
+    name: getting-started
+  replicas: 1
+  template:
+    spec:
+      clusterRef:
+        name: getting-started
+      tags:
+        - lobby
+      version:
+        channel: Paper
+        name: "1.20.2"
+        customJar:
+          url: https://api.infernalsuite.com/v1/projects/asp/5118810e-2397-48f2-a725-89372c6d3756/download/e2eab933-7e5c-4a1f-8776-89a6624283a0
+      config: {}
diff --git a/kube/helm/charts/shulker-addon-matchmaking/templates/director_deployment.yaml b/kube/helm/charts/shulker-addon-matchmaking/templates/director_deployment.yaml
@@ -9,7 +9,7 @@ spec:
   replicas: 1
   selector:
     matchLabels:
-      {{- include "shulker-addon-matchmaking.labels" . | nindent 6 }}
+      {{- include "shulker-addon-matchmaking.selectorLabels" . | nindent 6 }}
       app.kubernetes.io/component: shulker-addon-matchmaking-director
   template:
     metadata:

diff --git a/kube/helm/charts/shulker-addon-matchmaking/templates/director_metrics_service.yaml b/kube/helm/charts/shulker-addon-matchmaking/templates/director_metrics_service.yaml
@@ -18,6 +18,6 @@ spec:
       protocol: TCP
       targetPort: metrics
   selector:
-    {{- include "shulker-addon-matchmaking.labels" . | nindent 4 }}
+    {{- include "shulker-addon-matchmaking.selectorLabels" . | nindent 4 }}
     app.kubernetes.io/component: shulker-addon-matchmaking-director
 {{- end }}
diff --git a/kube/helm/charts/shulker-addon-matchmaking/templates/director_metrics_servicemonitor.yaml b/kube/helm/charts/shulker-addon-matchmaking/templates/director_metrics_servicemonitor.yaml
@@ -18,7 +18,7 @@ spec:
   jobLabel: {{ template "shulker-addon-matchmaking.fullname" . }}-director
   selector:
     matchLabels:
-      {{- include "shulker-addon-matchmaking.labels" . | nindent 6 }}
+      {{- include "shulker-addon-matchmaking.selectorLabels" . | nindent 6 }}
       app.kubernetes.io/component: shulker-addon-matchmaking-director-metrics
   endpoints:
     - targetPort: metrics

diff --git a/kube/helm/charts/shulker-addon-matchmaking/templates/mmf_deployment.yaml b/kube/helm/charts/shulker-addon-matchmaking/templates/mmf_deployment.yaml
@@ -9,7 +9,7 @@ spec:
   replicas: 1
   selector:
     matchLabels:
-      {{- include "shulker-addon-matchmaking.labels" . | nindent 6 }}
+      {{- include "shulker-addon-matchmaking.selectorLabels" . | nindent 6 }}
       app.kubernetes.io/component: shulker-addon-matchmaking-mmf
   template:
     metadata:

diff --git a/kube/helm/charts/shulker-addon-matchmaking/templates/mmf_service.yaml b/kube/helm/charts/shulker-addon-matchmaking/templates/mmf_service.yaml
@@ -17,5 +17,5 @@ spec:
       protocol: TCP
       targetPort: mmf-elo
   selector:
-    {{- include "shulker-addon-matchmaking.labels" . | nindent 4 }}
+    {{- include "shulker-addon-matchmaking.selectorLabels" . | nindent 4 }}
     app.kubernetes.io/component: shulker-addon-matchmaking-mmf
diff --git a/.../shulker-addon-matchmaking/templates/crds/matchmaking.shulkermc.io_matchmakingqueues.yaml b/.../shulker-addon-matchmaking/templates/crds/matchmaking.shulkermc.io_matchmakingqueues.yaml
@@ -0,0 +1,95 @@
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  name: matchmakingqueues.matchmaking.shulkermc.io
+spec:
+  group: matchmaking.shulkermc.io
+  names:
+    categories: []
+    kind: MatchmakingQueue
+    plural: matchmakingqueues
+    shortNames: []
+    singular: matchmakingqueue
+  scope: Namespaced
+  versions:
+    - additionalPrinterColumns:
+        - jsonPath: .metadata.creationTimestamp
+          name: Age
+          type: date
+      name: v1alpha1
+      schema:
+        openAPIV3Schema:
+          description: Auto-generated derived type for MatchmakingQueueSpec via `CustomResource`
+          properties:
+            spec:
+              properties:
+                maxPlayers:
+                  description: The maximum number of players a match can contain
+                  format: uint32
+                  minimum: 0.0
+                  type: integer
+                minPlayers:
+                  description: The minimum number of players required to create a match. If `None`, the matchmaking function will wait for the maximum number of players
+                  format: uint32
+                  minimum: 0.0
+                  nullable: true
+                  type: integer
+                mmf:
+                  description: The matchmaking function to use to create matches for this queue
+                  properties:
+                    builtIn:
+                      description: The matchmaking function to use is provided by Shulker
+                      nullable: true
+                      properties:
+                        type:
+                          description: The type of the matchmaking function to use
+                          enum:
+                            - Batch
+                            - Elo
+                          type: string
+                      required:
+                        - type
+                      type: object
+                    provided:
+                      description: The matchmaking function to use is provided by the user
+                      nullable: true
+                      properties:
+                        host:
+                          description: Host of the matchmaking function
+                          type: string
+                        port:
+                          description: GRPC port of the matchmaking function
+                          format: uint16
+                          minimum: 0.0
+                          type: integer
+                      required:
+                        - host
+                        - port
+                      type: object
+                  type: object
+                targetFleetRef:
+                  description: The `MinecraftServerFleet` to use as a target for this queue
+                  properties:
+                    name:
+                      description: Name of the Kubernetes `MinecraftServerFleet` owning this resource
+                      type: string
+                  required:
+                    - name
+                  type: object
+              required:
+                - maxPlayers
+                - mmf
+                - targetFleetRef
+              type: object
+            status:
+              description: The status object of `MatchmakingQueue`
+              nullable: true
+              type: object
+          required:
+            - spec
+          title: MatchmakingQueue
+          type: object
+      served: true
+      storage: true
+      subresources:
+        status: {}
diff --git a/kube/helm/templates/crds/shulkermc.io_minecraftserverfleets.yaml b/kube/helm/templates/crds/shulkermc.io_minecraftserverfleets.yaml
@@ -1068,6 +1068,41 @@ spec:
                             - Paper
                             - Folia
                             type: string
+                          customJar:
+                            description: Reference to a server JAR file to download and use instead of the built-in one
+                            nullable: true
+                            properties:
+                              url:
+                                nullable: true
+                                type: string
+                              urlFrom:
+                                nullable: true
+                                properties:
+                                  mavenRef:
+                                    nullable: true
+                                    properties:
+                                      artifactId:
+                                        type: string
+                                      classifier:
+                                        nullable: true
+                                        type: string
+                                      credentialsSecretName:
+                                        nullable: true
+                                        type: string
+                                      groupId:
+                                        type: string
+                                      repositoryUrl:
+                                        type: string
+                                      version:
+                                        type: string
+                                    required:
+                                    - artifactId
+                                    - groupId
+                                    - repositoryUrl
+                                    - version
+                                    type: object
+                                type: object
+                            type: object
                           name:
                             description: Name of the version to use
                             type: string

diff --git a/kube/helm/templates/crds/shulkermc.io_minecraftservers.yaml b/kube/helm/templates/crds/shulkermc.io_minecraftservers.yaml
@@ -838,6 +838,41 @@ spec:
                     - Paper
                     - Folia
                     type: string
+                  customJar:
+                    description: Reference to a server JAR file to download and use instead of the built-in one
+                    nullable: true
+                    properties:
+                      url:
+                        nullable: true
+                        type: string
+                      urlFrom:
+                        nullable: true
+                        properties:
+                          mavenRef:
+                            nullable: true
+                            properties:
+                              artifactId:
+                                type: string
+                              classifier:
+                                nullable: true
+                                type: string
+                              credentialsSecretName:
+                                nullable: true
+                                type: string
+                              groupId:
+                                type: string
+                              repositoryUrl:
+                                type: string
+                              version:
+                                type: string
+                            required:
+                            - artifactId
+                            - groupId
+                            - repositoryUrl
+                            - version
+                            type: object
+                        type: object
+                    type: object
                   name:
                     description: Name of the version to use
                     type: string

diff --git a/kube/helm/templates/deployment.yaml b/kube/helm/templates/deployment.yaml
@@ -9,7 +9,7 @@ spec:
   replicas: 1
   selector:
     matchLabels:
-      {{- include "shulker-operator.labels" . | nindent 6 }}
+      {{- include "shulker-operator.selectorLabels" . | nindent 6 }}
       app.kubernetes.io/component: shulker-operator
   template:
     metadata:

diff --git a/kube/helm/templates/metrics_service.yaml b/kube/helm/templates/metrics_service.yaml
@@ -18,6 +18,6 @@ spec:
       protocol: TCP
       targetPort: metrics
   selector:
-    {{- include "shulker-operator.labels" . | nindent 4 }}
+    {{- include "shulker-operator.selectorLabels" . | nindent 4 }}
     app.kubernetes.io/component: shulker-operator
 {{- end }}
diff --git a/kube/helm/templates/metrics_servicemonitor.yaml b/kube/helm/templates/metrics_servicemonitor.yaml
@@ -18,7 +18,7 @@ spec:
   jobLabel: {{ template "shulker-operator.fullname" . }}
   selector:
     matchLabels:
-      {{- include "shulker-operator.labels" . | nindent 6 }}
+      {{- include "shulker-operator.selectorLabels" . | nindent 6 }}
       app.kubernetes.io/component: shulker-operator-metrics
   endpoints:
     - targetPort: metrics

diff --git a/kube/helm/templates/service.yaml b/kube/helm/templates/service.yaml
@@ -17,5 +17,5 @@ spec:
       protocol: TCP
       targetPort: api-grpc
   selector:
-    {{- include "shulker-operator.labels" . | nindent 4 }}
+    {{- include "shulker-operator.selectorLabels" . | nindent 4 }}
     app.kubernetes.io/component: shulker-operator