|
1 |
| -# Minecraft Proxy |
2 |
| - |
3 |
| -[Minecraft](https://minecraft.net/en/) proxies allows for a single server to become a network of seamlessly integrated servers. |
4 |
| - |
5 |
| -[BungeeCord](https://www.spigotmc.org/wiki/about-bungeecord/) is the most well known solution in this arena, but [several](https://github.com/PaperMC/Waterfall) [other](https://github.com/PaperMC/Travertine) forks of BungeeCord and new projects such as [Velocity](https://velocitypowered.com/) have become popular choices. |
6 |
| - |
7 |
| -This chart relies on the [itzg/bungeecord](https://hub.docker.com/r/itzg/bungeecord) container which supports BungeeCord, Waterfall, and Velocity out of the box. It is also designed to allow the use of any other custom proxies with some additional configuration. |
8 |
| - |
9 |
| -## Introduction |
10 |
| - |
11 |
| -This chart creates a single Proxy Pod, Services for the BungeeCord, server and RCON. |
12 |
| - |
13 |
| -## Prerequisites |
14 |
| - |
15 |
| -- 512 MB of RAM |
16 |
| -- Kubernetes 1.4+ with Beta APIs enabled |
17 |
| -- PV provisioner support in the underlying infrastructure |
18 |
| - |
19 |
| -## Configuration |
20 |
| - |
21 |
| -Refer to [values.yaml](values.yaml) for the full run-down on defaults. These are a mixture of Kubernetes and BungeeCord-related directives that map to environment variables in the [itzg/bungeecord](https://hub.docker.com/r/itzg/bungeecord/) Docker image. |
22 |
| - |
23 |
| -Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. |
24 |
| - |
25 |
| -Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. |
26 |
| - |
27 |
| -> **Tip**: You can use the default [values.yaml](values.yaml) |
28 |
| -
|
29 |
| -## Persistence |
30 |
| - |
31 |
| -The [itzg/bungeecord](https://hub.docker.com/r/itzg/bungeecord/) image stores config and state under `/server`. |
32 |
| - |
33 |
| -When [persistence.dataDir.enabled in values.yaml](https://github.com/ArchitectSMP/charts/blob/main/bungee/values.yaml#L180) is set to true PersistentVolumeClaim is created and mounted. In order to enable this functionality |
34 |
| -you can change the values.yaml to enable persistence under the sub-sections under `persistence`. |
35 |
| -The config file for the server can be added to the persistent volume manually, or optionally, you can set it by amending the config file path (if your proxy type has a different config path) and pasting your config under [bungeecord.configFilePath and bungeeCord.config in values.yaml](https://github.com/ArchitectSMP/charts/blob/main/bungee/values.yaml#L103). |
36 |
| - |
37 |
| -> *"If persistence is not enabled, an emptyDir volume is first created when a Pod is assigned to a Node, and exists as long as that Pod is running on that node. When a Pod is removed from a node for any reason, the data in the emptyDir is deleted forever."* |
| 1 | +# minecraft-proxy |
| 2 | + |
| 3 | +  |
| 4 | + |
| 5 | +Minecraft proxy server (BungeeCord, Waterfall, Velocity, etc.) |
| 6 | + |
| 7 | +**Homepage:** <https://github.com/itzg/minecraft-server-charts> |
| 8 | + |
| 9 | +## Maintainers |
| 10 | + |
| 11 | +| Name | Email | Url | |
| 12 | +| ---- | ------ | --- | |
| 13 | +| chipwolf | [email protected] | | |
| 14 | + |
| 15 | +| billimek | [email protected] | | |
| 16 | + |
| 17 | + |
| 18 | +## Source Code |
| 19 | + |
| 20 | +* <https://github.com/itzg/minecraft-server-charts> |
| 21 | + |
| 22 | +## Values |
| 23 | + |
| 24 | +| Key | Type | Default | Description | |
| 25 | +|-----|------|---------|-------------| |
| 26 | +| deploymentAnnotations | object | `{}` | | |
| 27 | +| extraEnv | object | `{}` | | |
| 28 | +| extraVolumes | list | `[]` | | |
| 29 | +| image | string | `"itzg/bungeecord"` | | |
| 30 | +| imagePullSecret | string | `""` | | |
| 31 | +| imageTag | string | `"latest"` | | |
| 32 | +| initContainers | list | `[]` | | |
| 33 | +| livenessProbe.failureThreshold | int | `10` | | |
| 34 | +| livenessProbe.initialDelaySeconds | int | `30` | | |
| 35 | +| livenessProbe.periodSeconds | int | `5` | | |
| 36 | +| livenessProbe.successThreshold | int | `1` | | |
| 37 | +| livenessProbe.timeoutSeconds | int | `1` | | |
| 38 | +| minecraftProxy.configFilePath | string | `"/server/config.yml"` | | |
| 39 | +| minecraftProxy.externalIPs | string | `nil` | | |
| 40 | +| minecraftProxy.jarFile | string | `nil` | | |
| 41 | +| minecraftProxy.jarRevision | string | `nil` | | |
| 42 | +| minecraftProxy.jarUrl | string | `nil` | | |
| 43 | +| minecraftProxy.jenkinsBaseUrl | string | `nil` | | |
| 44 | +| minecraftProxy.jenkinsJobId | string | `"lastStableBuild"` | | |
| 45 | +| minecraftProxy.jvmOpts | string | `""` | | |
| 46 | +| minecraftProxy.jvmXXOpts | string | `""` | | |
| 47 | +| minecraftProxy.loadBalancerIP | string | `nil` | | |
| 48 | +| minecraftProxy.memory | string | `"512M"` | | |
| 49 | +| minecraftProxy.onlineMode | bool | `true` | | |
| 50 | +| minecraftProxy.plugins | list | `[]` | | |
| 51 | +| minecraftProxy.rcon.enabled | bool | `false` | | |
| 52 | +| minecraftProxy.rcon.loadBalancerIP | string | `nil` | | |
| 53 | +| minecraftProxy.rcon.password | string | `"CHANGEME!"` | | |
| 54 | +| minecraftProxy.rcon.port | int | `25575` | | |
| 55 | +| minecraftProxy.rcon.serviceType | string | `"LoadBalancer"` | | |
| 56 | +| minecraftProxy.serviceAnnotations | object | `{}` | | |
| 57 | +| minecraftProxy.serviceType | string | `"ClusterIP"` | | |
| 58 | +| minecraftProxy.type | string | `"BUNGEECORD"` | | |
| 59 | +| minecraftProxy.velocityVersion | string | `"1.1.0"` | | |
| 60 | +| minecraftProxy.waterfallBuildId | string | `"latest"` | | |
| 61 | +| minecraftProxy.waterfallVersion | string | `"latest"` | | |
| 62 | +| persistence.dataDir.Size | string | `"1Gi"` | | |
| 63 | +| persistence.dataDir.enabled | bool | `false` | | |
| 64 | +| podAnnotations | object | `{}` | | |
| 65 | +| rconServiceAnnotations | object | `{}` | | |
| 66 | +| readinessProbe.failureThreshold | int | `10` | | |
| 67 | +| readinessProbe.initialDelaySeconds | int | `30` | | |
| 68 | +| readinessProbe.periodSeconds | int | `5` | | |
| 69 | +| readinessProbe.successThreshold | int | `1` | | |
| 70 | +| readinessProbe.timeoutSeconds | int | `1` | | |
| 71 | +| resources.requests.cpu | string | `"500m"` | | |
| 72 | +| resources.requests.memory | string | `"512Mi"` | | |
| 73 | +| securityContext.fsGroup | int | `2000` | | |
| 74 | +| securityContext.runAsGroup | int | `1000` | | |
| 75 | +| securityContext.runAsUser | int | `1000` | | |
| 76 | +| serviceAnnotations | object | `{}` | | |
| 77 | +| startupProbe.enabled | bool | `false` | | |
| 78 | +| startupProbe.failureThreshold | int | `30` | | |
| 79 | +| startupProbe.periodSeconds | int | `10` | | |
| 80 | + |
| 81 | +---------------------------------------------- |
| 82 | +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) |
0 commit comments