From 8e9b049ed9915caa726a6d5b0fbd6d2e49d06859 Mon Sep 17 00:00:00 2001 From: Xstar97TheNoob <9399967+xstar97@users.noreply.github.com> Date: Tue, 29 Oct 2024 16:38:02 -0400 Subject: [PATCH] feat(minecraft-router) add minecraft-router (#28554) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit **Description** add new chart (rename of old chart) ⚒️ Fixes # **⚙️ Type of change** - [X] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code **🧪 How Has This Been Tested?** **📃 Notes:** **✔️ Checklist:** - [X] ⚖️ My code follows the style guidelines of this project - [X] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [ ] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ My changes generate no new warnings - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [ ] ⬆️ I increased versions for any altered app according to semantic versioning - [ ] I made sure the title starts with `feat(chart-name):`, `fix(chart-name):` or `chore(chart-name):` **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._ --- charts/incubator/minecraft-router/.helmignore | 32 +++++++++ .../incubator/minecraft-router/CHANGELOG.md | 4 ++ charts/incubator/minecraft-router/Chart.yaml | 37 +++++++++++ charts/incubator/minecraft-router/README.md | 61 ++++++++++++++++++ .../minecraft-router/icon-small.webp | Bin 0 -> 526 bytes charts/incubator/minecraft-router/icon.webp | Bin 0 -> 2722 bytes .../minecraft-router/templates/NOTES.txt | 1 + .../minecraft-router/templates/common.yaml | 5 ++ charts/incubator/minecraft-router/values.yaml | 46 +++++++++++++ charts/stable/mc-router/Chart.yaml | 2 +- charts/stable/mc-router/docs/validation.md | 50 +++++++------- .../templates/{_secrets.tpl => secrets.tpl} | 16 ++--- 12 files changed, 220 insertions(+), 34 deletions(-) create mode 100644 charts/incubator/minecraft-router/.helmignore create mode 100644 charts/incubator/minecraft-router/CHANGELOG.md create mode 100644 charts/incubator/minecraft-router/Chart.yaml create mode 100644 charts/incubator/minecraft-router/README.md create mode 100644 charts/incubator/minecraft-router/icon-small.webp create mode 100644 charts/incubator/minecraft-router/icon.webp create mode 100644 charts/incubator/minecraft-router/templates/NOTES.txt create mode 100644 charts/incubator/minecraft-router/templates/common.yaml create mode 100644 charts/incubator/minecraft-router/values.yaml rename charts/stable/mc-router/templates/{_secrets.tpl => secrets.tpl} (95%) 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 0000000000000000000000000000000000000000..b8497ff7b6e0ff25ef2be237eb7502685093a61c GIT binary patch literal 526 zcmV+p0`dJ)Nk&En0ssJ4MM6+kP&il$0000G0000V0018V06|PpNU{I`00Dr4ZQHTu z{yE!bGTM^jlG&K7Xm8z)t6pAH@|ta1pTF;U<61;a0JORWfvIi%!)LE2ow@X!<2dfQ z&4EUrzso6J*H{vytZ}Lj3k(|K7dg$_sX7(mQ-2)gQi7cS#1BWk5Cb6bon!c00%USb z8~;P%E|`=7uxoiCTSUz5Nic|~@JBjL9kZ_whTQT(x*K9(3 z2IGIs+*8hn1Luch^8SnJ?DX*J=5@zmkdRKT8*q9m9At$urG8?0RPgtQPxU65lt8v7 zVlizz3Ne!)b2W(96Nj!bbsZ9lW?gfLK;r*IV<&f?4=$r}@mDE6t7ccJID7+6!eDma z_^ew8Uj>tHNt}z@(tB&4Es<2@N453CQEvHd$`eUSsQ;DSAZ?2LPmCA-VgtY&#LogX zP*I@ygUuL-Vndq`E>Ax(|4$vWKT0wh$>yfRB4{d4QK-xG=tBTr37vLLRqTlvSO#YD Q5)vZOM|bioc1!>O02eguApigX literal 0 HcmV?d00001 diff --git a/charts/incubator/minecraft-router/icon.webp b/charts/incubator/minecraft-router/icon.webp new file mode 100644 index 0000000000000000000000000000000000000000..b126998f2b2e6c86c74e89fb9b25aa2e7db74644 GIT binary patch literal 2722 zcmV;T3SIS5Nk&GR3IG6CMM6+kP&il$0000G0001$005N$06|PpNbdpw00E#tTbm(C z`lDPmwr$(CZQHhO+qP}nwrx+F8UMH{BmT(IA|fUL{v@l^g^ zow^o9*_%8;w|1 zZB9>2_MIGQ3|^d&kQ6I8(it!@1`%;*gdnY61H%&#b+|9m`?7;mvT)tsBF%T}TP3nL zeS~yhC~ua;Qsp|5&JX2h60oADkbG@Z2H~>q=BUEZMTvz0)p32vvQlyxC*s>eo@>{78Q05mxLZDqh=?k-1mr zI2yo^eYxC8g$D7J-Hp^n;r0Li`%hqL3`*+%#o-#`Z%65mEs*n{aK-X}+KFGr*(spD8-D6G;R1H5_gn@|3S97IYugpNy z+y~Y1u&D(EW|gn2;Z+S=%$F8XR)GXv#edcK!}A1wsbN1Gfd-qp$s6qsans8|mg znL&{`_j7Sxb#{O{P35l&;x#xTsMX&5nE?LNVu5-i4EU&1@Y1B9=D5>?bkMeC0(GZd z&ppJC6=b0Ff+sw3rMwAL&uZRs>tO>67(sidmp}BXgA0seq>(<~@fsKjjAX(^!HDQT zDHa&b%sYb?B?AM>;=nI@09H^qAcO}105CNGodGJA0G0qgZ77dNq#~gqJ-={(4T(S+ z8BAOc(*NFIzj)a1?i=$(=JDrMzTfBp(u@7`9$(HopTt>4QMiA|hWXd)N^$|vC_vEm z+U^%038963?uVwdxKE=kCt#WvBSn{!qA@ch{&Bq$u$Et)Iy5pKAWyFAL7)pjTiA=N zhYL=IEPNL&2{@b4fzN}b<=>&;tZ6ks^Y5C_u=QL;UM!7r^6ulL2mZ3U!e~tbc?tCq zt#gpefVPx)$Ma9V5zZ?wO^OE8lzPee{^Ct)GoVt)-9(&)$byJYG~{RltoGvW zY3&bQFiV<@$ZJZgb47_qjBnjM5PS@!g5Xj~PNQIn=vDldRN9^`P>&w z8{TA>@~$tR+3!xo>b*44B^Dys?sISf_n4)qMB%`2ky4oj4Yx1Z@AQ}e{`;K39sjE} z891I+IqZ8352i)uyod%-jOF`sqPd6a{o~i&R-&Ka{dF7r1S%f=i#%|?6Q&|wM=gEHwGZB5TdUTmKxGhicI~vFzrEa zE_w6D*xzN4;R30C?M%LW-y7VuGzCMzPW(ckAh`hG(_n<7x`}+ ziY}AON2@dczSlw1x2_#@F=tdbzI1`z$HvjPLytKMDe5L%HZeRnPlTa5FkGvmdQ%Bn z(netqWS%=nmYxS=?4($xo0yqW5IAp(s0wOw0i>Pk+6&{*nva^cflUH|_R zEAEw6Z-s+5zaJ9HI)S8*a!}>Xi{;GN^y$5ukOQTDazT+8VqsR(lK#%M1YjeZ_`Pdk zxqSK>=yW=zPtG1DnaVxP;mSm}uY!WDpKC(Y|Lzic4cg-W3JdxZAgEc;2vaqUxqf$d zb9JtstH1E|OLr_|Sat-2KNH|*o9`YPK~`dx(pFFrQh~2E=j?xUA)0g9E+4EB z+5cyV7ql00?j)-=ahDb1O*+EX+dTJ?V^?pWZZ3&5zaB9=5mT~bjM<<1n>$nmJ5zv% z1;!8u8@yZlR>$$OL6c|lvYC8)2}?ZDVX4Cw+#*B?UUWc%T8$S<+{(s&-(6(r7d_Lb z8>--H`3^)~izL7jI-Feee7LXd$SP<~3_&*e=CbEC`sj%(|EDp9{SyOq;?X3vbcI)5 z_)o|dUW$kR(dYlcA^-XyTGv}j_aDRjh85kWm7v$lCRTg6rp`V#kzC{`EuopcNe!qe z5}a5EF-Ofaa9SG`U&b($DA^olzxP%$@rXuZcGG8@!HxE;SxrYgqn(-Zw#Mn}qve`S zk8Y!dGvPhep}}}7lD@O^3-oV!=aMR+ABZ13a+d(ec0u-@jDa>L`hnTCr3wO&SO5T} zd*UyP)bd7GKIfkOpQYM#7iVDFll1---Y3J&L?H-$e3W2|CCgN~yhPLL=?ir?$412i zEWk-RKXmmKbQ0J4vr#JA)DAYgvBt}_3WoU1wO5k~0&Q(VUw_af7S;<)000r5%M-vJ c$K>fJJq-)sFs`t<{(wJ!{|FEO000000BXKBU;qFB literal 0 HcmV?d00001 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 -}}