diff --git a/.github/ct-install.yaml b/.github/ct-install.yaml index 2856d09725b..e5b38211d9b 100644 --- a/.github/ct-install.yaml +++ b/.github/ct-install.yaml @@ -32,6 +32,7 @@ excluded-charts: - charts/stable/promcord - charts/stable/rdesktop - charts/stable/reg + - charts/incubator/romm - charts/stable/ser2sock - charts/stable/storj-node - charts/stable/tailscale diff --git a/charts/incubator/romm/.helmignore b/charts/incubator/romm/.helmignore new file mode 100644 index 00000000000..77ca5567b26 --- /dev/null +++ b/charts/incubator/romm/.helmignore @@ -0,0 +1,30 @@ +# 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 diff --git a/charts/incubator/romm/CHANGELOG.md b/charts/incubator/romm/CHANGELOG.md new file mode 100644 index 00000000000..825c32f0d03 --- /dev/null +++ b/charts/incubator/romm/CHANGELOG.md @@ -0,0 +1 @@ +# Changelog diff --git a/charts/incubator/romm/Chart.yaml b/charts/incubator/romm/Chart.yaml new file mode 100644 index 00000000000..6da1b82ac56 --- /dev/null +++ b/charts/incubator/romm/Chart.yaml @@ -0,0 +1,32 @@ +apiVersion: v2 +appVersion: "1.7.1" +dependencies: + - name: common + repository: https://library-charts.truecharts.org + version: 12.8.1 + - condition: mariadb.enabled + name: mariadb + repository: https://deps.truecharts.org/ + version: 7.0.27 +deprecated: false +description: game library manager focused in retro gaming +home: https://truecharts.org/charts/incubator/romm +icon: https://truecharts.org/img/hotlink-ok/chart-icons/romm.png +keywords: + - romm + - rom-manager +kubeVersion: ">=1.16.0-0" +maintainers: + - email: info@truecharts.org + name: TrueCharts + url: https://truecharts.org +name: romm +sources: + - https://github.com/truecharts/charts/tree/master/charts/incubator/romm + - https://github.com/zurdi15/romm +type: application +version: 0.0.1 +annotations: + truecharts.org/catagories: | + - media + truecharts.org/SCALE-support: "true" diff --git a/charts/incubator/romm/README.md b/charts/incubator/romm/README.md new file mode 100644 index 00000000000..7e59600739c --- /dev/null +++ b/charts/incubator/romm/README.md @@ -0,0 +1 @@ +# README diff --git a/charts/incubator/romm/docs/installation_notes.md b/charts/incubator/romm/docs/installation_notes.md new file mode 100644 index 00000000000..75ea60c8de9 --- /dev/null +++ b/charts/incubator/romm/docs/installation_notes.md @@ -0,0 +1,50 @@ +# Installation Notes + +Set Client Id and Client Secret with the API key from [IGDB](https://api-docs.igdb.com/#about) +SteamGridDB API Key is still WIP and doesnt need to be set. + +This app has two folder structures found [here](https://github.com/zurdi15/romm/blob/master/README.md#-folder-structure). + +Structure 1 (high priority) - roms folder at root of library folder: + +```txt +library/ +├─ roms/ + ├─ gbc/ + │ ├─ rom_1.gbc + │ ├─ rom_2.gbc + │ + ├─ gba/ + │ ├─ rom_1.gba + │ ├─ rom_2.gba + │ + ├─ ps/ + ├─ my_multifile_game/ + │ ├─ my_game_cd1.iso + │ ├─ my_game_cd2.iso + │ + ├─ rom_1.iso +``` + +Structure 2 (low priority) - roms folder inside each platform folder + +```txt +library/ +├─ gbc/ +│ ├─ roms/ +│ ├─ rom_1.gbc +│ ├─ rom_2.gbc +| +├─ gba/ +│ ├─ roms/ +│ ├─ rom_1.gba +│ ├─ rom_2.gba +| +├─ ps/ +│ ├─ roms/ +│ ├─ my_multifile_game/ +│ │ ├─ my_game_cd1.iso +│ │ ├─ my_game_cd2.iso +│ │ +│ ├─ rom_1.iso +``` diff --git a/charts/incubator/romm/icon.png b/charts/incubator/romm/icon.png new file mode 100644 index 00000000000..0b6558ce36e Binary files /dev/null and b/charts/incubator/romm/icon.png differ diff --git a/charts/incubator/romm/questions.yaml b/charts/incubator/romm/questions.yaml new file mode 100644 index 00000000000..ecb046414f3 --- /dev/null +++ b/charts/incubator/romm/questions.yaml @@ -0,0 +1,126 @@ +# Include{groups} +portals: + open: +# Include{portalLink} +questions: +# Include{global} +# Include{workload} +# Include{workloadDeployment} + +# Include{replicas1} +# Include{podSpec} +# Include{containerMain} + - variable: env + label: Image Environment + schema: + additional_attrs: true + type: dict + attrs: + - variable: CLIENT_ID + label: Client Id + description: IGDB Client Id + schema: + type: string + required: true + default: "" + - variable: CLIENT_SECRET + label: Client Secret + description: IGDB Client Secret + schema: + type: string + required: true + private: true + default: "" + - variable: STEAMGRIDDB_API_KEY + label: SteamGridDB API Key + description: SteamGridDB WIP (optional) + schema: + type: string + private: true + default: "" + +# Include{containerBasic} +# Include{containerAdvanced} + +# Include{containerConfig} +# Include{serviceRoot} +# Include{serviceMain} +# Include{serviceSelectorLoadBalancer} +# Include{serviceSelectorExtras} + - variable: main + label: Main Service Port Configuration + 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: 10680 + required: true +# Include{serviceExpertRoot} + default: false +# Include{serviceExpert} +# Include{serviceList} +# Include{persistenceRoot} + - variable: romm + label: App Romm Storage + description: Stores the Application Romm. + schema: + additional_attrs: true + type: dict + attrs: +# Include{persistenceBasic} + - variable: library + label: App Library Storage + description: Stores the Application Library. + schema: + additional_attrs: true + type: dict + attrs: +# Include{persistenceBasic} +# Include{persistenceList} +# Include{ingressRoot} + - variable: main + label: Main Ingress + schema: + additional_attrs: true + type: dict + attrs: +# Include{ingressDefault} +# Include{ingressTLS} +# Include{ingressTraefik} +# Include{ingressList} +# Include{securityContextRoot} + + - variable: runAsUser + label: runAsUser + description: The UserID of the user running the application + schema: + type: int + default: 0 + - variable: runAsGroup + label: runAsGroup + description: The groupID this App of the user running the application + schema: + type: int + default: 0 +# Include{securityContextContainer} +# Include{securityContextAdvanced} +# Include{securityContextPod} + - variable: fsGroup + label: fsGroup + description: The group that should own ALL storage. + schema: + type: int + default: 568 + +# Include{resources} +# Include{advanced} +# Include{addons} +# Include{codeserver} +# Include{netshoot} +# Include{vpn} +# Include{documentation} diff --git a/charts/incubator/romm/templates/NOTES.txt b/charts/incubator/romm/templates/NOTES.txt new file mode 100644 index 00000000000..efcb74cb772 --- /dev/null +++ b/charts/incubator/romm/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "tc.v1.common.lib.chart.notes" $ -}} diff --git a/charts/incubator/romm/templates/common.yaml b/charts/incubator/romm/templates/common.yaml new file mode 100644 index 00000000000..b51394e00a4 --- /dev/null +++ b/charts/incubator/romm/templates/common.yaml @@ -0,0 +1 @@ +{{ include "tc.v1.common.loader.all" . }} diff --git a/charts/incubator/romm/values.yaml b/charts/incubator/romm/values.yaml new file mode 100644 index 00000000000..c519b539ed3 --- /dev/null +++ b/charts/incubator/romm/values.yaml @@ -0,0 +1,70 @@ +image: + repository: tccr.io/truecharts/romm + pullPolicy: IfNotPresent + tag: v1.8.1@sha256:b8e1b4d352c223b73b049e48aa960827bc59e7587d5b64452a3fa99ca219f71f + +securityContext: + container: + readOnlyRootFilesystem: false + runAsNonRoot: false + runAsUser: 0 + runAsGroup: 0 + +workload: + main: + podSpec: + containers: + main: + probes: + liveness: + type: http + readiness: + type: http + startup: + type: http + env: + ROMM_DB_DRIVER: mariadb + # IGDB client id + CLIENT_ID: "" + # IGDB client secret + CLIENT_SECRET: "" + # WIP + STEAMGRIDDB_API_KEY: "" + DB_PORT: 3306 + DB_NAME: "{{ .Values.mariadb.mariadbDatabase }}" + DB_USER: "{{ .Values.mariadb.mariadbUsername }}" + DB_HOST: + secretKeyRef: + expandObjectName: false + name: '{{ printf "%s-%s" .Release.Name "mariadbcreds" }}' + key: plainhost + DB_PASSWD: + secretKeyRef: + expandObjectName: false + name: '{{ printf "%s-%s" .Release.Name "mariadbcreds" }}' + key: mariadb-password + +service: + main: + ports: + main: + protocol: http + targetPort: 80 + port: 10680 + +persistence: + romm: + enabled: true + mountPath: /romm + library: + enabled: true + mountPath: /romm/library + +mariadb: + enabled: true + mariadbUsername: romm + mariadbDatabase: romm + +portal: + open: + enabled: true