feat(kimai): move to stable (#2304)

* feat(kimai): move to stable

* bump
This commit is contained in:
Stavros Kois
2022-03-27 16:02:11 +03:00
committed by GitHub
parent 5b5f748789
commit 811ad4609a
10 changed files with 1 additions and 1 deletions
+49
View File
@@ -0,0 +1,49 @@
# Changelog<br>
<a name="kimai-0.0.6"></a>
### [kimai-0.0.6](https://github.com/truecharts/apps/compare/kimai-0.0.5...kimai-0.0.6) (2022-03-26)
#### Chore
* update helm general non-major helm releases ([#2290](https://github.com/truecharts/apps/issues/2290))
<a name="kimai-0.0.5"></a>
### [kimai-0.0.5](https://github.com/truecharts/apps/compare/kimai-0.0.4...kimai-0.0.5) (2022-03-26)
#### Chore
* bump all apps to trigger ci
<a name="kimai-0.0.3"></a>
### [kimai-0.0.3](https://github.com/truecharts/apps/compare/kimai-0.0.2...kimai-0.0.3) (2022-03-26)
#### Chore
* correct path for nginx ([#2284](https://github.com/truecharts/apps/issues/2284))
#### Fix
* small fixes ([#2282](https://github.com/truecharts/apps/issues/2282))
<a name="kimai-0.0.2"></a>
### [kimai-0.0.2](https://github.com/truecharts/apps/compare/kimai-0.0.1...kimai-0.0.2) (2022-03-24)
#### Fix
* small fixes ([#2274](https://github.com/truecharts/apps/issues/2274))
<a name="kimai-0.0.1"></a>
### kimai-0.0.1 (2022-03-23)
#### Feat
* Add kimai ([#2258](https://github.com/truecharts/apps/issues/2258))
+7
View File
@@ -0,0 +1,7 @@
# 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](https://truecharts.org/manual/Quick-Start%20Guides/06-linking-apps/) quick-start guide.
##### 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: "1.19"
dependencies:
- name: common
repository: https://library-charts.truecharts.org
version: 9.1.15
- condition: mariadb.enabled
name: mariadb
repository: https://truecharts.org/
version: 2.0.12
description: Kimai is a free, open source and online time-tracking software designed for small businesses and freelancers.
home: https://github.com/truecharts/apps/tree/master/charts/stable/kimai
icon: https://truecharts.org/_static/img/appicons/kimai.png
keywords:
- kimai
- time
- tracking
kubeVersion: '>=1.16.0-0'
maintainers:
- email: info@truecharts.org
name: TrueCharts
url: https://truecharts.org
name: kimai
sources:
- https://github.com/kevinpapst/kimai2
- https://github.com/tobybatch/kimai2
- https://hub.docker.com/r/kimai/kimai2
version: 1.0.0
annotations:
truecharts.org/catagories: |
- productivity
truecharts.org/SCALE-support: "true"
truecharts.org/grade: U
+40
View File
@@ -0,0 +1,40 @@
# Introduction
Kimai is a free, open source and online time-tracking software designed for small businesses and freelancers.
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/kevinpapst/kimai2>
* <https://github.com/tobybatch/kimai2>
* <https://hub.docker.com/r/kimai/kimai2>
## Requirements
Kubernetes: `>=1.16.0-0`
## Dependencies
| Repository | Name | Version |
|------------|------|---------|
| https://library-charts.truecharts.org | common | 9.1.15 |
| https://truecharts.org/ | mariadb | 2.0.12 |
## Installing the Chart
To install this App on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/02-Installing-an-App/).
## Upgrading, Rolling Back and Uninstalling the Chart
To upgrade, rollback or delete this App from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/manual/Quick-Start%20Guides/04-Upgrade-rollback-delete-an-App/).
## Support
- Please check our [quick-start guides](https://truecharts.org/manual/Quick-Start%20Guides/01-Adding-TrueCharts/) 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
+49
View File
@@ -0,0 +1,49 @@
# 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.APP_ENV | string | `"prod"` | |
| env.DB_BASE | string | `"{{ .Values.mariadb.mariadbUsername }}"` | |
| env.DB_PORT | string | `"3306"` | |
| env.DB_TYPE | string | `"mysql"` | |
| env.DB_USER | string | `"{{ .Values.mariadb.mariadbDatabase }}"` | |
| env.TRUSTED_HOSTS | string | `"{{ .Values.env.trust_hosts }},localhost"` | |
| env.trust_hosts | string | `"127.0.0.1"` | |
| envValueFrom.APP_SECRET.secretKeyRef.key | string | `"APP_SECRET"` | |
| envValueFrom.APP_SECRET.secretKeyRef.name | string | `"kimai-secrets"` | |
| envValueFrom.DB_HOST.secretKeyRef.key | string | `"plainhost"` | |
| envValueFrom.DB_HOST.secretKeyRef.name | string | `"mariadbcreds"` | |
| envValueFrom.DB_PASS.secretKeyRef.key | string | `"mariadb-password"` | |
| envValueFrom.DB_PASS.secretKeyRef.name | string | `"mariadbcreds"` | |
| image.pullPolicy | string | `"IfNotPresent"` | |
| image.repository | string | `"tccr.io/truecharts/kimai"` | |
| image.tag | string | `"v1.19@sha256:c397c8f343f90c7997cf524d9b05636571c017db8d9e6db3c6328abfe3cd3b81"` | |
| mariadb.enabled | bool | `true` | |
| mariadb.existingSecret | string | `"mariadbcreds"` | |
| mariadb.mariadbDatabase | string | `"kimai"` | |
| mariadb.mariadbUsername | string | `"kimai"` | |
| persistence.data.enabled | bool | `true` | |
| persistence.data.mountPath | string | `"/opt/kimai/var/data"` | |
| persistence.plugins.enabled | bool | `true` | |
| persistence.plugins.mountPath | string | `"/opt/kimai/var/plugins"` | |
| podSecurityContext.runAsGroup | int | `33` | |
| podSecurityContext.runAsUser | int | `33` | |
| probes.liveness.path | string | `"/en/login"` | |
| probes.readiness.path | string | `"/en/login"` | |
| probes.startup.path | string | `"/en/login"` | |
| secret.ADMINMAIL | string | `"admin@mysecretdomain.com"` | |
| secret.ADMINPASS | string | `"MvvTfjagiaqDprGNVA"` | |
| securityContext.readOnlyRootFilesystem | bool | `false` | |
| service.main.ports.main.port | int | `10198` | |
| service.main.ports.main.targetPort | int | `8001` | |
All Rights Reserved - The TrueCharts Project
+384
View File
@@ -0,0 +1,384 @@
# 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: ADMINMAIL
label: "Admin E-mail"
schema:
type: string
default: ""
required: true
- variable: ADMINPASS
label: "Admin Password"
schema:
type: string
default: ""
required: true
private: true
- variable: env
group: "Container Configuration"
label: "Image Environment"
schema:
additional_attrs: true
type: dict
attrs:
- variable: trust_hosts
label: "TRUSTED_HOSTS"
description: "Comma separated list of trusted hosts."
schema:
type: string
default: "YOUR.FQDN or YOUR.NAS.IP"
# 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: 10198
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: 8001
- 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: data
label: "App Data Storage"
description: "Stores the Application Data"
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: plugins
label: "App Plugins Storage"
description: "Stores the Application Plugins"
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: true
# 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: 33
- variable: runAsGroup
label: "runAsGroup"
description: The groupID this App of the user running the application"
schema:
type: int
default: 33
- 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
@@ -0,0 +1,20 @@
{{/* Define the secrets */}}
{{- define "kimai.secrets" -}}
---
apiVersion: v1
kind: Secret
type: Opaque
metadata:
name: kimai-secrets
{{- $kimaiprevious := lookup "v1" "Secret" .Release.Namespace "kimai-secrets" }}
{{- $app_secret := "" }}
data:
{{- if $kimaiprevious}}
APP_SECRET: {{ index $kimaiprevious.data "APP_SECRET" }}
{{- else }}
{{- $app_secret := randAlphaNum 32 }}
APP_SECRET: {{ $app_secret | b64enc }}
{{- end }}
{{- end -}}
@@ -0,0 +1,8 @@
{{/* Make sure all variables are set properly */}}
{{- include "common.setup" . }}
{{/* Render secrets for kimai */}}
{{- include "kimai.secrets" . }}
{{/* Render the templates */}}
{{ include "common.postSetup" . }}
+68
View File
@@ -0,0 +1,68 @@
image:
repository: tccr.io/truecharts/kimai
tag: v1.19@sha256:c397c8f343f90c7997cf524d9b05636571c017db8d9e6db3c6328abfe3cd3b81
pullPolicy: IfNotPresent
securityContext:
readOnlyRootFilesystem: false
podSecurityContext:
runAsUser: 33
runAsGroup: 33
secret:
ADMINMAIL: "admin@mysecretdomain.com"
ADMINPASS: "MvvTfjagiaqDprGNVA"
env:
DB_TYPE: "mysql"
DB_PORT: "3306"
DB_USER: "{{ .Values.mariadb.mariadbDatabase }}"
DB_BASE: "{{ .Values.mariadb.mariadbUsername }}"
APP_ENV: "prod"
TRUSTED_HOSTS: "{{ .Values.env.trust_hosts }},localhost"
# User Defined
trust_hosts: "127.0.0.1"
envValueFrom:
DB_PASS:
secretKeyRef:
name: mariadbcreds
key: mariadb-password
DB_HOST:
secretKeyRef:
name: mariadbcreds
key: plainhost
APP_SECRET:
secretKeyRef:
name: kimai-secrets
key: APP_SECRET
service:
main:
ports:
main:
port: 10198
targetPort: 8001
probes:
liveness:
path: "/en/login"
readiness:
path: "/en/login"
startup:
path: "/en/login"
persistence:
data:
enabled: true
mountPath: "/opt/kimai/var/data"
plugins:
enabled: true
mountPath: "/opt/kimai/var/plugins"
mariadb:
enabled: true
mariadbUsername: kimai
mariadbDatabase: kimai
existingSecret: "mariadbcreds"