diff --git a/charts/incubator/koel/Chart.yaml b/charts/incubator/koel/Chart.yaml new file mode 100644 index 00000000000..5ab949c52c0 --- /dev/null +++ b/charts/incubator/koel/Chart.yaml @@ -0,0 +1,33 @@ +apiVersion: v2 +appVersion: "10.6.2" +dependencies: +- name: common + repository: https://truecharts.org + version: 9.1.2 +- condition: postgresql.enabled + name: postgresql + repository: https://truecharts.org/ + version: 7.0.2 +description: Koel is a simple web-based personal audio streaming service written in Vue on the client side and Laravel on the server side. +home: https://github.com/truecharts/apps/tree/master/charts/stable/koel +icon: https://truecharts.org/_static/img/appicons/koel.png +keywords: +- koel +- music +- stream +kubeVersion: '>=1.16.0-0' +maintainers: +- email: info@truecharts.org + name: TrueCharts + url: https://truecharts.org +name: koel +sources: +- https://github.com/koel/docker +- https://hub.docker.com/r/hyzual/koel +- https://github.com/koel/koel +version: 0.0.1 +annotations: + truecharts.org/catagories: | + - media + truecharts.org/SCALE-support: "true" + truecharts.org/grade: U diff --git a/charts/incubator/koel/questions.yaml b/charts/incubator/koel/questions.yaml new file mode 100644 index 00000000000..a0935c0cd4b --- /dev/null +++ b/charts/incubator/koel/questions.yaml @@ -0,0 +1,433 @@ +# Include{groups} +portals: + open: + protocols: + - "$kubernetes-resource_configmap_portal_protocol" + host: + - "$kubernetes-resource_configmap_portal_host" + ports: + - "$kubernetes-resource_configmap_portal_port" +questions: + - variable: portal + group: "Container Image" + label: "Configure Portal Button" + schema: + type: dict + hidden: true + attrs: + - variable: enabled + label: "Enable" + description: "enable the portal button" + schema: + hidden: true + editable: false + type: boolean + default: true +# Include{global} + - variable: controller + group: "Controller" + label: "" + schema: + additional_attrs: true + type: dict + attrs: + - variable: advanced + label: "Show Advanced Controller Settings" + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: type + description: "Please specify type of workload to deploy" + label: "(Advanced) Controller Type" + schema: + type: string + default: "deployment" + required: true + enum: + - value: "deployment" + description: "Deployment" + - value: "statefulset" + description: "Statefulset" + - value: "daemonset" + description: "Daemonset" + - variable: replicas + description: "Number of desired pod replicas" + label: "Desired Replicas" + schema: + type: int + default: 1 + required: true + - variable: strategy + description: "Please specify type of workload to deploy" + label: "(Advanced) Update Strategy" + schema: + type: string + default: "Recreate" + required: true + enum: + - value: "Recreate" + description: "Recreate: Kill existing pods before creating new ones" + - value: "RollingUpdate" + description: "RollingUpdate: Create new pods and then kill old ones" + - value: "OnDelete" + description: "(Legacy) OnDelete: ignore .spec.template changes" +# Include{controllerExpert} + - variable: secret + group: "Container Configuration" + label: "Image Secrets" + schema: + additional_attrs: true + type: dict + attrs: + - variable: LASTFM_API_KEY + label: "LASTFM_API_KEY" + description: "Enable scrobbling to Last.fm. See https://docs.koel.dev/3rd-party.html#last-fm" + schema: + type: string + default: "" + - variable: LASTFM_API_KEY + label: "LASTFM_API_SECRET" + description: "Enable scrobbling to Last.fm. See https://docs.koel.dev/3rd-party.html#last-fm" + schema: + type: string + default: "" + + - variable: env + group: "Container Configuration" + label: "Image Environment" + schema: + additional_attrs: true + type: dict + attrs: + - variable: FORCE_HTTPS + label: "FORCE_HTTPS" + description: "If set to true, all URLs redirects done by koel will use https." + schema: + type: boolean + default: false + - variable: MEMORY_LIMIT + label: "MEMORY_LIMIT" + description: "Amount of memory in MB for the scanning process." + schema: + type: int + default: 2048 + +# Include{containerConfig} + + - variable: service + group: "Networking and Services" + label: "Configure Service(s)" + schema: + additional_attrs: true + type: dict + attrs: + - variable: main + label: "Main Service" + description: "The Primary service on which the healthcheck runs, often the webUI" + schema: + additional_attrs: true + type: dict + attrs: +# Include{serviceSelector} + - 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: 10185 + required: true + - variable: advanced + label: "Show Advanced settings" + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: protocol + label: "Port Type" + schema: + type: string + default: "HTTP" + enum: + - value: HTTP + description: "HTTP" + - value: "HTTPS" + description: "HTTPS" + - value: TCP + description: "TCP" + - value: "UDP" + description: "UDP" + - variable: nodePort + label: "Node Port (Optional)" + description: "This port gets exposed to the node. Only considered when service type is NodePort, Simple or LoadBalancer" + schema: + type: int + min: 9000 + max: 65535 + - variable: targetPort + label: "Target Port" + description: "The internal(!) port on the container the Application runs on" + schema: + type: int + default: 80 + + - variable: serviceexpert + group: "Networking and Services" + label: "Show Expert Config" + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: hostNetwork + group: "Networking and Services" + label: "Host-Networking (Complicated)" + schema: + type: boolean + default: false + +# Include{serviceExpert} + +# Include{serviceList} + + - variable: persistence + label: "Integrated Persistent Storage" + description: "Integrated Persistent Storage" + group: "Storage and Persistence" + schema: + additional_attrs: true + type: dict + attrs: + - variable: music + label: "App Music Storage" + description: "Stores the Application Music." + schema: + additional_attrs: true + type: dict + attrs: + - variable: type + label: "Type of Storage" + description: "Sets the persistence type, Anything other than PVC could break rollback!" + schema: + type: string + default: "simplePVC" + enum: + - value: "simplePVC" + description: "PVC (simple)" + - value: "simpleHP" + description: "HostPath (simple)" + - value: "emptyDir" + description: "emptyDir" + - value: "pvc" + description: "pvc" + - value: "hostPath" + description: "hostPath" +# Include{persistenceBasic} + - variable: hostPath + label: "hostPath" + description: "Path inside the container the storage is mounted" + schema: + show_if: [["type", "=", "hostPath"]] + type: hostpath + - variable: medium + label: "EmptyDir Medium" + schema: + show_if: [["type", "=", "emptyDir"]] + type: string + default: "" + enum: + - value: "" + description: "Default" + - value: "Memory" + description: "Memory" +# Include{persistenceAdvanced} + - variable: covers + label: "App Covers Storage" + description: "Stores the Application Covers." + schema: + additional_attrs: true + type: dict + attrs: + - variable: type + label: "Type of Storage" + description: "Sets the persistence type, Anything other than PVC could break rollback!" + schema: + type: string + default: "simplePVC" + enum: + - value: "simplePVC" + description: "PVC (simple)" + - value: "simpleHP" + description: "HostPath (simple)" + - value: "emptyDir" + description: "emptyDir" + - value: "pvc" + description: "pvc" + - value: "hostPath" + description: "hostPath" +# Include{persistenceBasic} + - variable: hostPath + label: "hostPath" + description: "Path inside the container the storage is mounted" + schema: + show_if: [["type", "=", "hostPath"]] + type: hostpath + - variable: medium + label: "EmptyDir Medium" + schema: + show_if: [["type", "=", "emptyDir"]] + type: string + default: "" + enum: + - value: "" + description: "Default" + - value: "Memory" + description: "Memory" +# Include{persistenceAdvanced} + - variable: searchindex + label: "App Search Index Storage" + description: "Stores the Application Search Index." + schema: + additional_attrs: true + type: dict + attrs: + - variable: type + label: "Type of Storage" + description: "Sets the persistence type, Anything other than PVC could break rollback!" + schema: + type: string + default: "simplePVC" + enum: + - value: "simplePVC" + description: "PVC (simple)" + - value: "simpleHP" + description: "HostPath (simple)" + - value: "emptyDir" + description: "emptyDir" + - value: "pvc" + description: "pvc" + - value: "hostPath" + description: "hostPath" +# Include{persistenceBasic} + - variable: hostPath + label: "hostPath" + description: "Path inside the container the storage is mounted" + schema: + show_if: [["type", "=", "hostPath"]] + type: hostpath + - variable: medium + label: "EmptyDir Medium" + schema: + show_if: [["type", "=", "emptyDir"]] + type: string + default: "" + enum: + - value: "" + description: "Default" + - value: "Memory" + description: "Memory" +# Include{persistenceAdvanced} + +# Include{persistenceList} + + - variable: ingress + label: "" + group: "Ingress" + schema: + additional_attrs: true + type: dict + attrs: + - variable: main + label: "Main Ingress" + schema: + additional_attrs: true + type: dict + attrs: +# Include{ingressDefault} + +# Include{ingressTLS} + +# Include{ingressTraefik} + +# Include{ingressExpert} + +# Include{ingressList} + +# Include{security} + + - variable: advancedSecurity + label: "Show Advanced Security Settings" + group: "Security and Permissions" + schema: + type: boolean + default: false + show_subquestions_if: true + subquestions: + - variable: securityContext + label: "Security Context" + schema: + additional_attrs: true + type: dict + attrs: + - variable: privileged + label: "Privileged mode" + schema: + type: boolean + default: false + - variable: readOnlyRootFilesystem + label: "ReadOnly Root Filesystem" + schema: + type: boolean + default: false + - variable: allowPrivilegeEscalation + label: "Allow Privilege Escalation" + schema: + type: boolean + default: false + - variable: runAsNonRoot + label: "runAsNonRoot" + schema: + type: boolean + default: false +# Include{securityContextAdvanced} + + - variable: podSecurityContext + group: "Security and Permissions" + label: "Pod Security Context" + schema: + additional_attrs: true + type: dict + attrs: + - 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 + - variable: fsGroup + label: "fsGroup" + description: "The group that should own ALL storage." + schema: + type: int + default: 568 +# Include{podSecurityContextAdvanced} + +# Include{resources} + +# Include{advanced} + +# Include{addons} diff --git a/charts/incubator/koel/templates/_secrets.tpl b/charts/incubator/koel/templates/_secrets.tpl new file mode 100644 index 00000000000..314d01fbd8f --- /dev/null +++ b/charts/incubator/koel/templates/_secrets.tpl @@ -0,0 +1,20 @@ +{{/* Define the secrets */}} +{{- define "koel.secrets" -}} +--- + +apiVersion: v1 +kind: Secret +type: Opaque +metadata: + name: koel-secrets +{{- $koelprevious := lookup "v1" "Secret" .Release.Namespace "koel-secrets" }} +{{- $app_key := "" }} +data: + {{- if $koelprevious}} + APP_KEY: {{ index $koelprevious.data "APP_KEY" }} + {{- else }} + {{- $app_key := randAlphaNum 32 }} + APP_KEY: {{ $app_key | b64enc }} + {{- end }} + +{{- end -}} diff --git a/charts/incubator/koel/templates/common.yaml b/charts/incubator/koel/templates/common.yaml new file mode 100644 index 00000000000..1c2c86f4f82 --- /dev/null +++ b/charts/incubator/koel/templates/common.yaml @@ -0,0 +1,8 @@ +{{/* Make sure all variables are set properly */}} +{{- include "common.setup" . }} + +{{/* Render secrets for koel */}} +{{- include "koel.secrets" . }} + +{{/* Render the templates */}} +{{ include "common.postSetup" . }} diff --git a/charts/incubator/koel/values.yaml b/charts/incubator/koel/values.yaml new file mode 100644 index 00000000000..0a77514b2c5 --- /dev/null +++ b/charts/incubator/koel/values.yaml @@ -0,0 +1,59 @@ +image: + repository: hyzual/koel + tag: latest@sha256:fa4bafbe3ae869f153bdc3bc87db739f300bef6cc94e398d7efa587a443f86fa + pullPolicy: IfNotPresent + +securityContext: + readOnlyRootFilesystem: false + runAsNonRoot: false + +podSecurityContext: + runAsUser: 0 + runAsGroup: 0 + +env: + DB_CONNECTION: "pgsql" + DB_USERNAME: "{{ .Values.postgresql.postgresqlUsername }}" + DB_DATABASE: "{{ .Values.postgresql.postgresqlDatabase }}" + FORCE_HTTPS: false + MEMORY_LIMIT: 2048 + LASTFM_API_KEY: "" + LASTFM_API_SECRET: "" + +service: + main: + ports: + main: + port: 10185 + targetPort: 80 + +envValueFrom: + DB_HOST: + secretKeyRef: + name: dbcreds + key: plainhost + DB_PASSWORD: + secretKeyRef: + name: dbcreds + key: postgresql-password + APP_KEY: + secretKeyRef: + name: koel-secrets + key: APP_KEY + +persistence: + music: + enabled: true + mountPath: "/music" + covers: + enabled: true + mountPath: "/var/www/html/public/img/covers" + searchindex: + enabled: true + mountPath: "/var/www/html/storage/search-indexes" + +postgresql: + enabled: true + existingSecret: "dbcreds" + postgresqlUsername: koel + postgresqlDatabase: koel diff --git a/docs/_static/img/appicons/koel.png b/docs/_static/img/appicons/koel.png new file mode 100644 index 00000000000..76c88869ad6 Binary files /dev/null and b/docs/_static/img/appicons/koel.png differ diff --git a/docs/apps/stable/notes.md b/docs/apps/stable/notes.md new file mode 100644 index 00000000000..29879c7dc62 --- /dev/null +++ b/docs/apps/stable/notes.md @@ -0,0 +1,4 @@ +# Default Username/Password + +__email__: `admin@koel.dev` +__password__: `KoelIsCool` diff --git a/docs/manual/default-ports.md b/docs/manual/default-ports.md index b8fc0f0e824..ed6992345a8 100644 --- a/docs/manual/default-ports.md +++ b/docs/manual/default-ports.md @@ -342,6 +342,7 @@ These defaults can of course be changed, but as we guarantee "sane, working defa | self-service-password | main | main | 10182 | TCP | | | nextpvr | main | main | 10183 | TCP | | | ispy-agent-dvr | main | main | 10184 | TCP | | +| koel | main | main | 10185 | TCP | | | hammond | main | main | 10186 | TCP | | | iyuuplus | main | main | 10188 | HTTP | | | storj-node | main | main | 14002 | TCP | |