diff --git a/charts/incubator/minecraft-router/.helmignore b/charts/incubator/minecraft-router/.helmignore new file mode 100644 index 00000000000..feb7464da6f --- /dev/null +++ b/charts/incubator/minecraft-router/.helmignore @@ -0,0 +1,32 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ +# OWNERS file for Kubernetes +OWNERS +# helm-docs templates +*.gotmpl +# docs folder +/docs +# icon +icon.png +icon.webp +icon-small.webp diff --git a/charts/incubator/minecraft-router/CHANGELOG.md b/charts/incubator/minecraft-router/CHANGELOG.md new file mode 100644 index 00000000000..f3e8318aa10 --- /dev/null +++ b/charts/incubator/minecraft-router/CHANGELOG.md @@ -0,0 +1,4 @@ +--- +title: Changelog +pagefind: false +--- diff --git a/charts/incubator/minecraft-router/Chart.yaml b/charts/incubator/minecraft-router/Chart.yaml new file mode 100644 index 00000000000..4f44facca76 --- /dev/null +++ b/charts/incubator/minecraft-router/Chart.yaml @@ -0,0 +1,37 @@ +annotations: + max_scale_version: 24.04.1 + min_scale_version: 24.04.0 + truecharts.org/category: minecraft + truecharts.org/max_helm_version: "3.15" + truecharts.org/min_helm_version: "3.11" + truecharts.org/train: stable +apiVersion: v2 +appVersion: 1.23.0 +dependencies: + - name: common + version: 25.1.5 + repository: oci://tccr.io/truecharts + condition: "" + alias: "" + tags: [] + import-values: [] +deprecated: false +description: Lightweight multiplexer/proxy for Minecraft-Java servers. +home: https://truecharts.org/charts/stable/minecraft-router +icon: https://truecharts.org/img/hotlink-ok/chart-icons/minecraft-router.webp +keywords: + - minecraft-router + - mc-router + - minecraft +kubeVersion: '>=1.24.0-0' +maintainers: + - name: TrueCharts + email: info@truecharts.org + url: https://truecharts.org +name: minecraft-router +sources: + - https://github.com/itzg/mc-router + - https://github.com/truecharts/charts/tree/master/charts/stable/minecraft-router + - https://hub.docker.com/r/itzg/mc-router +type: application +version: 0.0.1 diff --git a/charts/incubator/minecraft-router/README.md b/charts/incubator/minecraft-router/README.md new file mode 100644 index 00000000000..24aac28e042 --- /dev/null +++ b/charts/incubator/minecraft-router/README.md @@ -0,0 +1,61 @@ +--- +title: README +--- + +## General Info + +TrueCharts can be installed as both _normal_ Helm Charts or as TrueNAS SCALE Apps. +Both solutions are fully supported, but we heavily advice the use of normal Helm Charts where possible + +For more information about this Chart, please check the docs on the TrueCharts [website](https://truecharts.org/charts/stable/mc-router) + +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/charts/issues/new/choose)** + +## Installation + +### Helm-Chart installation + +To install TrueCharts Helm charts using Helm, you can use our OCI Repository. + +`helm install mychart oci://tccr.io/truecharts/mc-router` + +For more information on how to install TrueCharts Helm charts, checkout the [instructions on the website](/guides) + + +### TrueNAS SCALE Apps + +For more information on how to use TrueCharts as TrueNAS SCALE Apps, please checkout the [quick-start guides for TrueNAS SCALE](/deprecated/scale). + +## Chart Specific Guides and information + +All our charts have dedicated documentation pages. +The documentation for this chart can be found here: +https://truecharts.org/charts/stable/mc-router + +## Configuration Options + +Please note: For TrueNAS SCALE, only options available in the GUI are supported. +Hence most of these docs do not apply to TrueNAS SCALE + +To view the chart specific options, please view Values.yaml included in the chart. +The most recent version of which, is available here: https://github.com/truecharts/public/blob/master/charts/stable/mc-router/values.yaml + +All our Charts use a shared "common" library chart that contains most of the templating and options. +For the complete overview of all available options, please checkout the documentation for them on the [common docs on our website](/common) + +For information about the common chart and all defaults included with it, please review its values.yaml file available here: https://github.com/truecharts/public/blob/master/charts/library/common/values.yaml + +## Support + +- See the [Website](https://truecharts.org) +- Check our [Discord](https://discord.gg/tVsPTHWTtr) +- Open a [issue](https://github.com/truecharts/charts/issues/new/choose) + +--- + +## Sponsor TrueCharts + +TrueCharts can only exist due to the incredible effort of our staff. +Please consider making a [donation](/general/sponsor) or contributing back to the project any way you can! + +_All Rights Reserved - The TrueCharts Project_ diff --git a/charts/incubator/minecraft-router/icon-small.webp b/charts/incubator/minecraft-router/icon-small.webp new file mode 100644 index 00000000000..b8497ff7b6e Binary files /dev/null and b/charts/incubator/minecraft-router/icon-small.webp differ diff --git a/charts/incubator/minecraft-router/icon.webp b/charts/incubator/minecraft-router/icon.webp new file mode 100644 index 00000000000..b126998f2b2 Binary files /dev/null and b/charts/incubator/minecraft-router/icon.webp differ diff --git a/charts/incubator/minecraft-router/templates/NOTES.txt b/charts/incubator/minecraft-router/templates/NOTES.txt new file mode 100644 index 00000000000..efcb74cb772 --- /dev/null +++ b/charts/incubator/minecraft-router/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "tc.v1.common.lib.chart.notes" $ -}} diff --git a/charts/incubator/minecraft-router/templates/common.yaml b/charts/incubator/minecraft-router/templates/common.yaml new file mode 100644 index 00000000000..995efb03eb0 --- /dev/null +++ b/charts/incubator/minecraft-router/templates/common.yaml @@ -0,0 +1,5 @@ +{{/* Make sure all variables are set properly */}} +{{- include "tc.v1.common.loader.init" . }} + +{{/* Render the templates */}} +{{ include "tc.v1.common.loader.apply" . }} diff --git a/charts/incubator/minecraft-router/values.yaml b/charts/incubator/minecraft-router/values.yaml new file mode 100644 index 00000000000..8c4d5145bdd --- /dev/null +++ b/charts/incubator/minecraft-router/values.yaml @@ -0,0 +1,46 @@ +image: + repository: docker.io/itzg/mc-router + pullPolicy: IfNotPresent + tag: 1.23.0@sha256:e8c8d56a1244209fffc1f8ec35eca89631d0bfdfb55b375b04b8d2f27d55afb3 +service: + main: + ports: + main: + port: 25565 + api: + enabled: true + ports: + api: + enabled: true + port: 25564 + +mcrouter: + default: vanilla:25565 + mappings: + - vanilla:25565 + - forge:25565 + +workload: + main: + podSpec: + containers: + main: + probes: + liveness: + enabled: true + type: tcp + readiness: + enabled: true + type: tcp + startup: + enabled: true + type: tcp + env: + API_BINDING: ":{{ .Values.service.api.ports.api.port }}" + PORT: "{{ .Values.service.main.ports.main.port }}" + DEFAULT: "{{ .Values.mcrouter.default }}" + MAPPING: '{{ join "," .Values.mcrouter.mappings }}' + +portal: + open: + enabled: false diff --git a/charts/stable/mc-router/Chart.yaml b/charts/stable/mc-router/Chart.yaml index ad8d90cfe94..bffa17d1d49 100644 --- a/charts/stable/mc-router/Chart.yaml +++ b/charts/stable/mc-router/Chart.yaml @@ -33,4 +33,4 @@ sources: - https://github.com/truecharts/charts/tree/master/charts/stable/mc-router - https://hub.docker.com/r/itzg/mc-router type: application -version: 6.5.2 +version: 6.5.3 diff --git a/charts/stable/mc-router/docs/validation.md b/charts/stable/mc-router/docs/validation.md index 2aa81c21765..c0554961058 100644 --- a/charts/stable/mc-router/docs/validation.md +++ b/charts/stable/mc-router/docs/validation.md @@ -1,25 +1,25 @@ ---- -title: Input Validation ---- - -**`Domain and Minecraft Service`** - -Accepts: - -- domain=service:port -- IP or DNS host -- Characters (`0-9`, `a-z`, `A-Z`, `-`, `.`) -- Port - -Accepted formats are: - -- `minecraft.local=minecraft-java.ix-minecraft-java.svc.cluster.local:25565` -- `minecraft.local=localhost:25565` -- `minecraft.local=0.0.0.0:25565` - -Regex used to match this: `^$|^(http(s)?:\/\/([a-zA-Z0-9.-]*)(:\d{0,5})?,?)*$` -You can try live [here](https://regex101.com/r/u2ifZm/1) - ---- - -_If you find a field that you think it needs validation, please open an issue on github_ +--- +title: Input Validation +--- + +**`Domain and Minecraft Service`** + +Accepts: + +- domain=service:port +- IP or DNS host +- Characters (`0-9`, `a-z`, `A-Z`, `-`, `.`) +- Port + +Accepted formats are: + +- `minecraft.local=minecraft-java.ix-minecraft-java.svc.cluster.local:25565` +- `minecraft.local=localhost:25565` +- `minecraft.local=0.0.0.0:25565` + +Regex used to match this: `^$|^(http(s)?:\/\/([a-zA-Z0-9.-]*)(:\d{0,5})?,?)*$` +You can try live [here](https://regex101.com/r/u2ifZm/1) + +--- + +_If you find a field that you think it needs validation, please open an issue on github_ diff --git a/charts/stable/mc-router/templates/_secrets.tpl b/charts/stable/mc-router/templates/secrets.tpl similarity index 95% rename from charts/stable/mc-router/templates/_secrets.tpl rename to charts/stable/mc-router/templates/secrets.tpl index 61883b6b82f..77d0f4a6b0f 100644 --- a/charts/stable/mc-router/templates/_secrets.tpl +++ b/charts/stable/mc-router/templates/secrets.tpl @@ -1,8 +1,8 @@ -{{/* Define the secrets */}} -{{- define "mcrouter.secrets" -}} -{{- $mcrouter := .Values.mcrouter }} - -enabled: true -data: - MAPPING: {{ join "," $mcrouter.host_minecraft }} -{{- end -}} +{{/* Define the secrets */}} +{{- define "mcrouter.secrets" -}} +{{- $mcrouter := .Values.mcrouter }} + +enabled: true +data: + MAPPING: {{ join "," $mcrouter.host_minecraft }} +{{- end -}}