feat(apps): move koel and zerotier to stable (#2232)

* feat(koel): move to stable

* feat(zerotier): move to stable

* update app req
This commit is contained in:
Stavros Kois
2022-03-20 22:21:31 +02:00
committed by GitHub
parent 35b228a474
commit f29a6746ba
21 changed files with 2 additions and 3 deletions
+36
View File
@@ -0,0 +1,36 @@
# Changelog<br>
<a name="koel-0.0.5"></a>
### [koel-0.0.5](https://github.com/truecharts/apps/compare/koel-0.0.4...koel-0.0.5) (2022-03-17)
#### Chore
* update helm general non-major helm releases ([#2186](https://github.com/truecharts/apps/issues/2186))
<a name="koel-0.0.4"></a>
### [koel-0.0.4](https://github.com/truecharts/apps/compare/koel-0.0.3...koel-0.0.4) (2022-03-16)
#### Fix
* Run as root ([#2191](https://github.com/truecharts/apps/issues/2191))
<a name="koel-0.0.3"></a>
### [koel-0.0.3](https://github.com/truecharts/apps/compare/koel-0.0.1...koel-0.0.3) (2022-03-16)
#### Fix
* use installContainer to init app and run as www-data ([#2189](https://github.com/truecharts/apps/issues/2189))
<a name="koel-0.0.1"></a>
### koel-0.0.1 (2022-03-15)
#### Feat
* Add koel ([#2182](https://github.com/truecharts/apps/issues/2182))
+8
View File
@@ -0,0 +1,8 @@
# Configuration Options
##### Connecting to other apps
If you need to connect this App to other Apps on TrueNAS SCALE, please refer to our "Linking Apps Internally" quick-start guide:
https://truecharts.org/manual/Quick-Start%20Guides/14-linking-apps/
##### Available config options
In the future this page is going to contain an automated list of options available in the installation/edit UI.
+33
View File
@@ -0,0 +1,33 @@
apiVersion: v2
appVersion: "latest"
dependencies:
- name: common
repository: https://truecharts.org
version: 9.1.6
- condition: mariadb.enabled
name: mariadb
repository: https://truecharts.org/
version: 2.0.6
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: 1.0.0
annotations:
truecharts.org/catagories: |
- media
truecharts.org/SCALE-support: "true"
truecharts.org/grade: U
+40
View File
@@ -0,0 +1,40 @@
# Introduction
Koel is a simple web-based personal audio streaming service written in Vue on the client side and Laravel on the server side.
TrueCharts are designed to be installed as TrueNAS SCALE app only. We can not guarantee this charts works as a stand-alone helm installation.
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/apps/issues/new/choose)**
## Source Code
* <https://github.com/koel/docker>
* <https://hub.docker.com/r/hyzual/koel>
* <https://github.com/koel/koel>
## Requirements
Kubernetes: `>=1.16.0-0`
## Dependencies
| Repository | Name | Version |
|------------|------|---------|
| https://truecharts.org/ | mariadb | 2.0.4 |
| https://truecharts.org | common | 9.1.4 |
## Installing the Chart
To install this App on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/03-Installing-an-App/).
## Uninstalling the Chart
To remove this App from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/07-Deleting-an-App/).
## Support
- Please check our [quick-start guides](https://truecharts.org/manual/Quick-Start%20Guides/01-Open-Apps/) first.
- See the [Wiki](https://truecharts.org)
- Check our [Discord](https://discord.gg/tVsPTHWTtr)
- Open a [issue](https://github.com/truecharts/apps/issues/new/choose)
---
All Rights Reserved - The TrueCharts Project
+77
View File
@@ -0,0 +1,77 @@
# Default Helm-Values
TrueCharts is primarily build to supply TrueNAS SCALE Apps.
However, we also supply all Apps as standard Helm-Charts. In this document we aim to document the default values in our values.yaml file.
Most of our Apps also consume our "common" Helm Chart.
If this is the case, this means that all values.yaml values are set to the common chart values.yaml by default. This values.yaml file will only contain values that deviate from the common chart.
You will, however, be able to use all values referenced in the common chart here, besides the values listed in this document.
## Values
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| env.DB_CONNECTION | string | `"mysql"` | |
| env.DB_DATABASE | string | `"{{ .Values.mariadb.mariadbDatabase }}"` | |
| env.DB_PORT | string | `"3306"` | |
| env.DB_USERNAME | string | `"{{ .Values.mariadb.mariadbUsername }}"` | |
| env.FORCE_HTTPS | bool | `false` | |
| env.LASTFM_API_KEY | string | `""` | |
| env.LASTFM_API_SECRET | string | `""` | |
| env.MEMORY_LIMIT | int | `2048` | |
| env.YOUTUBE_API_KEY | string | `""` | |
| envValueFrom.APP_KEY.secretKeyRef.key | string | `"APP_KEY"` | |
| envValueFrom.APP_KEY.secretKeyRef.name | string | `"koel-secrets"` | |
| envValueFrom.DB_HOST.secretKeyRef.key | string | `"plainhost"` | |
| envValueFrom.DB_HOST.secretKeyRef.name | string | `"mariadbcreds"` | |
| envValueFrom.DB_PASSWORD.secretKeyRef.key | string | `"mariadb-password"` | |
| envValueFrom.DB_PASSWORD.secretKeyRef.name | string | `"mariadbcreds"` | |
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"tccr.io/truecharts/koel"` | |
| image.tag | string | `"latest@sha256:4fdc640e5b7d3fd6dd32e61f70bd9d9ac9f59b43d553064a19453b04de0251f1"` | |
| installContainers.initdb.command[0] | string | `"php"` | |
| installContainers.initdb.command[1] | string | `"artisan"` | |
| installContainers.initdb.command[2] | string | `"koel:init"` | |
| installContainers.initdb.command[3] | string | `"--no-assets"` | |
| installContainers.initdb.env[0].name | string | `"DB_CONNECTION"` | |
| installContainers.initdb.env[0].value | string | `"mysql"` | |
| installContainers.initdb.env[1].name | string | `"DB_PORT"` | |
| installContainers.initdb.env[1].value | string | `"3306"` | |
| installContainers.initdb.env[2].name | string | `"DB_USERNAME"` | |
| installContainers.initdb.env[2].value | string | `"{{ .Values.mariadb.mariadbUsername }}"` | |
| installContainers.initdb.env[3].name | string | `"DB_DATABASE"` | |
| installContainers.initdb.env[3].value | string | `"{{ .Values.mariadb.mariadbDatabase }}"` | |
| installContainers.initdb.env[4].name | string | `"DB_HOST"` | |
| installContainers.initdb.env[4].valueFrom.secretKeyRef.key | string | `"plainhost"` | |
| installContainers.initdb.env[4].valueFrom.secretKeyRef.name | string | `"mariadbcreds"` | |
| installContainers.initdb.env[5].name | string | `"DB_PASSWORD"` | |
| installContainers.initdb.env[5].valueFrom.secretKeyRef.key | string | `"mariadb-password"` | |
| installContainers.initdb.env[5].valueFrom.secretKeyRef.name | string | `"mariadbcreds"` | |
| installContainers.initdb.env[6].name | string | `"APP_KEY"` | |
| installContainers.initdb.env[6].valueFrom.secretKeyRef.key | string | `"APP_KEY"` | |
| installContainers.initdb.env[6].valueFrom.secretKeyRef.name | string | `"koel-secrets"` | |
| installContainers.initdb.image | string | `"{{ .Values.image.repository }}:{{ .Values.image.tag }}"` | |
| installContainers.initdb.volumeMounts[0].mountPath | string | `"/music"` | |
| installContainers.initdb.volumeMounts[0].name | string | `"music"` | |
| installContainers.initdb.volumeMounts[1].mountPath | string | `"/var/www/html/public/img/covers"` | |
| installContainers.initdb.volumeMounts[1].name | string | `"covers"` | |
| installContainers.initdb.volumeMounts[2].mountPath | string | `"/var/www/html/storage/search-indexes"` | |
| installContainers.initdb.volumeMounts[2].name | string | `"searchindex"` | |
| mariadb.enabled | bool | `true` | |
| mariadb.existingSecret | string | `"mariadbcreds"` | |
| mariadb.mariadbDatabase | string | `"koel"` | |
| mariadb.mariadbUsername | string | `"koel"` | |
| persistence.covers.enabled | bool | `true` | |
| persistence.covers.mountPath | string | `"/var/www/html/public/img/covers"` | |
| persistence.music.enabled | bool | `true` | |
| persistence.music.mountPath | string | `"/music"` | |
| persistence.searchindex.enabled | bool | `true` | |
| persistence.searchindex.mountPath | string | `"/var/www/html/storage/search-indexes"` | |
| podSecurityContext.runAsGroup | int | `0` | |
| podSecurityContext.runAsUser | int | `0` | |
| securityContext.readOnlyRootFilesystem | bool | `false` | |
| securityContext.runAsNonRoot | bool | `false` | |
| service.main.ports.main.port | int | `10185` | |
| service.main.ports.main.targetPort | int | `80` | |
All Rights Reserved - The TrueCharts Project
+439
View File
@@ -0,0 +1,439 @@
# 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_SECRET
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: YOUTUBE_API_KEY
label: "YOUTUBE_API_KEY"
description: "Enable YouTube integration. See https://docs.koel.dev/3rd-party.html#youtube"
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}
File diff suppressed because one or more lines are too long
+20
View File
@@ -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 -}}
+8
View File
@@ -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" . }}
+97
View File
@@ -0,0 +1,97 @@
image:
repository: tccr.io/truecharts/koel
tag: latest@sha256:1b84c90e846d0dab98bc14d413a9de1fd357679022795456d27ff4c75869fd9d
pullPolicy: IfNotPresent
securityContext:
readOnlyRootFilesystem: false
runAsNonRoot: false
podSecurityContext:
runAsUser: 0
runAsGroup: 0
env:
DB_CONNECTION: "mysql"
DB_USERNAME: "{{ .Values.mariadb.mariadbUsername }}"
DB_DATABASE: "{{ .Values.mariadb.mariadbDatabase }}"
DB_PORT: "3306"
FORCE_HTTPS: false
MEMORY_LIMIT: 2048
LASTFM_API_KEY: ""
LASTFM_API_SECRET: ""
YOUTUBE_API_KEY: ""
service:
main:
ports:
main:
port: 10185
targetPort: 80
envValueFrom:
DB_HOST:
secretKeyRef:
name: mariadbcreds
key: plainhost
DB_PASSWORD:
secretKeyRef:
name: mariadbcreds
key: mariadb-password
APP_KEY:
secretKeyRef:
name: koel-secrets
key: APP_KEY
installContainers:
initdb:
image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
volumeMounts:
- name: music
mountPath: "/music"
- name: covers
mountPath: "/var/www/html/public/img/covers"
- name: searchindex
mountPath: "/var/www/html/storage/search-indexes"
env:
- name: DB_CONNECTION
value: "mysql"
- name: DB_PORT
value: "3306"
- name: DB_USERNAME
value: "{{ .Values.mariadb.mariadbUsername }}"
- name: DB_DATABASE
value: "{{ .Values.mariadb.mariadbDatabase }}"
- name: DB_HOST
valueFrom:
secretKeyRef:
name: mariadbcreds
key: plainhost
- name: DB_PASSWORD
valueFrom:
secretKeyRef:
name: mariadbcreds
key: mariadb-password
- name: APP_KEY
valueFrom:
secretKeyRef:
name: koel-secrets
key: APP_KEY
command: ["php", "artisan", "koel:init", "--no-assets"]
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"
mariadb:
enabled: true
mariadbUsername: koel
mariadbDatabase: koel
existingSecret: "mariadbcreds"