From 41a611fd95cc30841bb73520b5d7e8a274478396 Mon Sep 17 00:00:00 2001 From: Xstar97 Date: Mon, 22 Aug 2022 04:54:47 -0400 Subject: [PATCH] fix(mineos): add docs and update chart.yaml (#3338) * fix(mineos): add ports and update chart.yaml * update port * added docs and removed conflicting ports * added the necessary mc and rcon ports * update services and separate ports * splt tcp and udp in different services * update questions * update * Update charts/incubator/mineos/values.yaml * Update charts/incubator/mineos/values.yaml * no dupes * shorter name Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com> --- charts/incubator/mineos/Chart.yaml | 2 +- .../mineos/docs/installation_notes.md | 11 + charts/incubator/mineos/questions.yaml | 546 +++++++++++++++++- charts/incubator/mineos/values.yaml | 120 ++++ 4 files changed, 664 insertions(+), 15 deletions(-) create mode 100644 charts/incubator/mineos/docs/installation_notes.md diff --git a/charts/incubator/mineos/Chart.yaml b/charts/incubator/mineos/Chart.yaml index fe19d489409..f4efea49b4f 100644 --- a/charts/incubator/mineos/Chart.yaml +++ b/charts/incubator/mineos/Chart.yaml @@ -26,6 +26,6 @@ maintainers: url: https://truecharts.org annotations: truecharts.org/catagories: | - - incubator + - games truecharts.org/SCALE-support: "true" truecharts.org/grade: U diff --git a/charts/incubator/mineos/docs/installation_notes.md b/charts/incubator/mineos/docs/installation_notes.md new file mode 100644 index 00000000000..444de60c48e --- /dev/null +++ b/charts/incubator/mineos/docs/installation_notes.md @@ -0,0 +1,11 @@ +# Installation Notes + +- Set `USE_HTTPS` to **false**, to use **http** for the web interface. However, if using ingress set `USE_HTTPS` to **true**. + +- Set `USER_NAME` to **mc** or whatever username that you want other than ~~root~~, to set the user for the web interface. + +- Set `USER_PASSWORD` to **MySuperSecurePass1** or an actual super secure password, to set the user pass for the web interface. + +- The servers are stored in `/var/games/minecraft/*SERVER_NAME*` so in order to add plugins/mods/additional files if the config volume is set to PVC(simple) which is default...is to use the bash truetool to mount the pvc volume to a temporarily dataset/dir, here's the guide for [truetool](https://truecharts.org/docs/manual/SCALE%20Apps/Quick-Start%20Guides/pvc-access). + +- To add additional ports to run your minecraft servers, please follow the [minecraft-java guide](https://truecharts.org/docs/charts/stable/minecraft-java/community-guide#pluginsmods-that-need-additional-ports) at the extra ports section. diff --git a/charts/incubator/mineos/questions.yaml b/charts/incubator/mineos/questions.yaml index 09a957c3711..539d9605e68 100644 --- a/charts/incubator/mineos/questions.yaml +++ b/charts/incubator/mineos/questions.yaml @@ -13,19 +13,6 @@ questions: # Include{controllerExpert} # Include{controllerExpertExtraArgs} # Include{containerConfig} - - variable: env - group: "Container Configuration" - label: "Image Environment" - schema: - additional_attrs: true - type: dict - attrs: - - variable: USE_HTTPS - label: "USE HTTPS" - description: "Should the web interface use HTTPS(true) or HTTP?(false)" - schema: - type: boolean - default: false - variable: secretEnv group: "Container Configuration" label: "Image Secrets" @@ -48,6 +35,19 @@ questions: private: true required: true default: "" + - variable: env + group: "Container Configuration" + label: "Image Environment" + schema: + additional_attrs: true + type: dict + attrs: + - variable: USE_HTTPS + label: "USE HTTPS" + description: "Should the web interface use HTTPS(true) or HTTP?(false)" + schema: + type: boolean + default: false # Include{serviceRoot} - variable: main label: "Main Service" @@ -77,6 +77,524 @@ questions: schema: type: int default: 10278 + - variable: minecraft-java-tcp + label: "Minecraft Java Service" + description: "Minecraft Java Service" + schema: + additional_attrs: true + type: dict + attrs: +# Include{serviceSelector} + - variable: mc-port-1-tcp + label: "MC Port 1 TCP" + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: "Port" + description: "This port exposes the container port on the service" + schema: + type: int + default: 25565 + required: true +# Include{advancedPortTCP} + - variable: targetPort + label: "Target Port" + description: "The internal(!) port on the container the Application runs on" + schema: + type: int + default: 25565 + - variable: mc-port-2-tcp + label: "MC Port 2 TCP" + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: "Port" + description: "This port exposes the container port on the service" + schema: + type: int + default: 25566 + required: true +# Include{advancedPortTCP} + - variable: targetPort + label: "Target Port" + description: "The internal(!) port on the container the Application runs on" + schema: + type: int + default: 25566 + - variable: mc-port-3-tcp + label: "MC Port 3 TCP" + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: "Port" + description: "This port exposes the container port on the service" + schema: + type: int + default: 25567 + required: true +# Include{advancedPortTCP} + - variable: targetPort + label: "Target Port" + description: "The internal(!) port on the container the Application runs on" + schema: + type: int + default: 25567 + - variable: mc-port-4-tcp + label: "MC Port 4 TCP" + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: "Port" + description: "This port exposes the container port on the service" + schema: + type: int + default: 25568 + required: true +# Include{advancedPortTCP} + - variable: targetPort + label: "Target Port" + description: "The internal(!) port on the container the Application runs on" + schema: + type: int + default: 25568 + - variable: mc-port-5-tcp + label: "MC Port 5 TCP" + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: "Port" + description: "This port exposes the container port on the service" + schema: + type: int + default: 25569 + required: true +# Include{advancedPortTCP} + - variable: targetPort + label: "Target Port" + description: "The internal(!) port on the container the Application runs on" + schema: + type: int + default: 25569 + - variable: mc-port-6-tcp + label: "MC Port 6 TCP" + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: "Port" + description: "This port exposes the container port on the service" + schema: + type: int + default: 25570 + required: true +# Include{advancedPortTCP} + max: 65535 + - variable: targetPort + label: "Target Port" + description: "The internal(!) port on the container the Application runs on" + schema: + type: int + default: 25570 + - variable: minecraft-java-udp + label: "Minecraft Java Service" + description: "Minecraft Java Service" + schema: + additional_attrs: true + type: dict + attrs: +# Include{serviceSelector} + - variable: mc-port-1-udp + label: "MC Port 1 UDP" + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: "Port" + description: "This port exposes the container port on the service" + schema: + type: int + default: 25565 + required: true +# Include{advancedPortUDP} + - variable: targetPort + label: "Target Port" + description: "The internal(!) port on the container the Application runs on" + schema: + type: int + default: 25565 + - variable: mc-port-2-udp + label: "MC Port 2 UDP" + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: "Port" + description: "This port exposes the container port on the service" + schema: + type: int + default: 25566 + required: true +# Include{advancedPortUDP} + - variable: targetPort + label: "Target Port" + description: "The internal(!) port on the container the Application runs on" + schema: + type: int + default: 25566 + - variable: mc-port-3-udp + label: "MC Port 3 UDP" + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: "Port" + description: "This port exposes the container port on the service" + schema: + type: int + default: 25567 + required: true +# Include{advancedPortUDP} + - variable: targetPort + label: "Target Port" + description: "The internal(!) port on the container the Application runs on" + schema: + type: int + default: 25567 + - variable: mc-port-4-udp + label: "MC Port 4 UDP" + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: "Port" + description: "This port exposes the container port on the service" + schema: + type: int + default: 25568 + required: true +# Include{advancedPortUDP} + - variable: targetPort + label: "Target Port" + description: "The internal(!) port on the container the Application runs on" + schema: + type: int + default: 25568 + - variable: mc-port-5-udp + label: "MC Port 5 UDP" + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: "Port" + description: "This port exposes the container port on the service" + schema: + type: int + default: 25569 + required: true +# Include{advancedPortUDP} + - variable: targetPort + label: "Target Port" + description: "The internal(!) port on the container the Application runs on" + schema: + type: int + default: 25569 + - variable: mc-port-6-udp + label: "MC Port 6 UDP" + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: "Port" + description: "This port exposes the container port on the service" + schema: + type: int + default: 25570 + required: true +# Include{advancedPortUDP} + max: 65535 + - variable: targetPort + label: "Target Port" + description: "The internal(!) port on the container the Application runs on" + schema: + type: int + default: 25570 + - variable: minecraft-br + label: "Minecraft Bedrock Service" + description: "Minecraft Bedrock Service" + schema: + additional_attrs: true + type: dict + attrs: +# Include{serviceSelector} + - variable: br-port-1-udp + label: "MC Port 1 UDP" + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: "Port" + description: "This port exposes the container port on the service" + schema: + type: int + default: 19132 + required: true +# Include{advancedPortUDP} + - variable: targetPort + label: "Target Port" + description: "The internal(!) port on the container the Application runs on" + schema: + type: int + default: 19132 + - variable: br-port-2-udp + label: "MC Port 2 UDP" + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: "Port" + description: "This port exposes the container port on the service" + schema: + type: int + default: 19133 + required: true +# Include{advancedPortUDP} + - variable: targetPort + label: "Target Port" + description: "The internal(!) port on the container the Application runs on" + schema: + type: int + default: 19133 + - variable: br-port-3-udp + label: "MC Port 3 UDP" + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: "Port" + description: "This port exposes the container port on the service" + schema: + type: int + default: 19134 + required: true +# Include{advancedPortUDP} + max: 65535 + - variable: targetPort + label: "Target Port" + description: "The internal(!) port on the container the Application runs on" + schema: + type: int + default: 19134 + - variable: br-port-4-udp + label: "MC Port 4 UDP" + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: "Port" + description: "This port exposes the container port on the service" + schema: + type: int + default: 19135 + required: true +# Include{advancedPortUDP} + - variable: targetPort + label: "Target Port" + description: "The internal(!) port on the container the Application runs on" + schema: + type: int + default: 19135 + - variable: br-port-5-udp + label: "MC Port 5 UDP" + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: "Port" + description: "This port exposes the container port on the service" + schema: + type: int + default: 19136 + required: true +# Include{advancedPortUDP} + - variable: targetPort + label: "Target Port" + description: "The internal(!) port on the container the Application runs on" + schema: + type: int + default: 19136 + - variable: br-port-6-udp + label: "MC Port 6 UDP" + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: "Port" + description: "This port exposes the container port on the service" + schema: + type: int + default: 19137 + required: true +# Include{advancedPortUDP} + - variable: targetPort + label: "Target Port" + description: "The internal(!) port on the container the Application runs on" + schema: + type: int + default: 19137 + - variable: minecraft-rcon + label: "Minecraft RCON Service" + description: "Minecraft RCON Service" + schema: + additional_attrs: true + type: dict + attrs: +# Include{serviceSelector} + - variable: mc-rcon-1 + label: "MC Port 1 RCON" + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: "Port" + description: "This port exposes the container port on the service" + schema: + type: int + default: 25575 + required: true +# Include{advancedPortTCP} + max: 65535 + - variable: targetPort + label: "Target Port" + description: "The internal(!) port on the container the Application runs on" + schema: + type: int + default: 25575 + - variable: mc-rcon-2 + label: "MC Port 2 RCON" + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: "Port" + description: "This port exposes the container port on the service" + schema: + type: int + default: 25576 + required: true +# Include{advancedPortTCP} + max: 65535 + - variable: targetPort + label: "Target Port" + description: "The internal(!) port on the container the Application runs on" + schema: + type: int + default: 25576 + - variable: mc-rcon-3 + label: "MC Port 3 RCON" + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: "Port" + description: "This port exposes the container port on the service" + schema: + type: int + default: 25577 + required: true +# Include{advancedPortTCP} + - variable: targetPort + label: "Target Port" + description: "The internal(!) port on the container the Application runs on" + schema: + type: int + default: 25577 + - variable: mc-rcon-4 + label: "MC Port 4 RCON" + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: "Port" + description: "This port exposes the container port on the service" + schema: + type: int + default: 25578 + required: true +# Include{advancedPortTCP} + - variable: targetPort + label: "Target Port" + description: "The internal(!) port on the container the Application runs on" + schema: + type: int + default: 25578 + - variable: mc-rcon-5 + label: "MC Port 1 RCON" + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: "Port" + description: "This port exposes the container port on the service" + schema: + type: int + default: 25579 + required: true +# Include{advancedPortTCP} + - variable: targetPort + label: "Target Port" + description: "The internal(!) port on the container the Application runs on" + schema: + type: int + default: 25579 + - variable: mc-rcon-6 + label: "MC Port 6 RCON" + schema: + additional_attrs: true + type: dict + attrs: + - variable: port + label: "Port" + description: "This port exposes the container port on the service" + schema: + type: int + default: 25580 + required: true +# Include{advancedPortTCP} + - variable: targetPort + label: "Target Port" + description: "The internal(!) port on the container the Application runs on" + schema: + type: int + default: 25580 + # Include{serviceExpertRoot} default: false # Include{serviceExpert} @@ -145,7 +663,7 @@ questions: description: "The group that should own ALL storage." schema: type: int - default: 0 + default: 568 # Include{podSecurityContextAdvanced} # Include{resources} # Include{advanced} diff --git a/charts/incubator/mineos/values.yaml b/charts/incubator/mineos/values.yaml index 9b1125c75c2..873b8d3ec8a 100644 --- a/charts/incubator/mineos/values.yaml +++ b/charts/incubator/mineos/values.yaml @@ -30,6 +30,126 @@ service: protocol: HTTP targetPort: 10278 port: 10278 + minecraft-java-tcp: + enabled: true + ports: + mc-port-1-tcp: + enabled: true + port: 25565 + targetPort: 25565 + mc-port-2-tcp: + enabled: true + port: 25566 + targetPort: 25566 + mc-port-3-tcp: + enabled: true + port: 25567 + targetPort: 25567 + mc-port-4-tcp: + enabled: true + port: 25568 + targetPort: 25568 + mc-port-5-tcp: + enabled: true + port: 25569 + targetPort: 25569 + mc-port-6-tcp: + enabled: true + port: 25570 + targetPort: 25570 + minecraft-java-udp: + enabled: true + ports: + mc-port-1-udp: + protocol: UDP + enabled: true + port: 25565 + targetPort: 25565 + mc-port-2-udp: + protocol: UDP + enabled: true + port: 25566 + targetPort: 25566 + mc-port-3-udp: + protocol: UDP + enabled: true + port: 25567 + targetPort: 25567 + mc-port-4-udp: + protocol: UDP + enabled: true + port: 25568 + targetPort: 25568 + mc-port-5-udp: + protocol: UDP + enabled: true + port: 25569 + targetPort: 25569 + mc-port-6-udp: + protocol: UDP + enabled: true + port: 25570 + targetPort: 25570 + minecraft-br: + enabled: true + ports: + br-port-1-udp: + enabled: true + port: 19132 + protocol: UDP + targetPort: 19132 + br-port-2-udp: + enabled: true + port: 19133 + protocol: UDP + targetPort: 19133 + br-port-3-udp: + enabled: true + port: 19134 + protocol: UDP + targetPort: 19134 + br-port-4-udp: + enabled: true + port: 19135 + protocol: UDP + targetPort: 19135 + br-port-5-udp: + enabled: true + port: 19136 + protocol: UDP + targetPort: 19136 + br-port-6-udp: + enabled: true + port: 19137 + protocol: UDP + targetPort: 19137 + minecraft-rcon: + enabled: true + ports: + mc-port-1-rcon: + enabled: true + port: 25575 + targetPort: 25575 + mc-port-2-rcon: + enabled: true + port: 25576 + targetPort: 25576 + mc-port-3-rcon: + enabled: true + port: 25577 + targetPort: 25577 + mc-port-4-rcon: + enabled: true + port: 25578 + targetPort: 25578 + mc-port-5-rcon: + enabled: true + port: 25579 + targetPort: 25579 + mc-port-6-rcon: + enabled: true + port: 25580 + targetPort: 25580 persistence: config: