From 5b983765ad988678e3bfab3a77cabcda8a8df942 Mon Sep 17 00:00:00 2001 From: TrueCharts-Bot Date: Sun, 27 Mar 2022 14:37:57 +0000 Subject: [PATCH] Commit released Helm Chart and docs for TrueCharts Signed-off-by: TrueCharts-Bot --- charts/stable/deemix/CHANGELOG.md | 9 +++ charts/stable/deemix/helm-values.md | 1 + docs/apps/stable/deemix/CHANGELOG.md | 70 ++++++++++++++++++++++ docs/apps/stable/deemix/CONFIG.md | 7 +++ docs/apps/stable/deemix/helm-values.md | 31 ++++++++++ docs/apps/stable/deemix/index.md | 38 ++++++++++++ docs/apps/stable/deemix/security.md | 82 ++++++++++++++++++++++++++ docs/index.yaml | 36 ++++++++++- 8 files changed, 273 insertions(+), 1 deletion(-) create mode 100644 docs/apps/stable/deemix/CHANGELOG.md create mode 100644 docs/apps/stable/deemix/CONFIG.md create mode 100644 docs/apps/stable/deemix/helm-values.md create mode 100644 docs/apps/stable/deemix/index.md create mode 100644 docs/apps/stable/deemix/security.md diff --git a/charts/stable/deemix/CHANGELOG.md b/charts/stable/deemix/CHANGELOG.md index 1ec0858bcee..6f6939e9208 100644 --- a/charts/stable/deemix/CHANGELOG.md +++ b/charts/stable/deemix/CHANGELOG.md @@ -1,6 +1,15 @@ # Changelog
+ +### [deemix-2.0.0](https://github.com/truecharts/apps/compare/deemix-1.0.7...deemix-2.0.0) (2022-03-27) + +#### Feat + +* move to stable ([#2306](https://github.com/truecharts/apps/issues/2306)) + + + ### [deemix-1.0.7](https://github.com/truecharts/apps/compare/deemix-1.0.6...deemix-1.0.7) (2022-03-26) diff --git a/charts/stable/deemix/helm-values.md b/charts/stable/deemix/helm-values.md index b011f0d9ad1..2575a36896f 100644 --- a/charts/stable/deemix/helm-values.md +++ b/charts/stable/deemix/helm-values.md @@ -11,6 +11,7 @@ You will, however, be able to use all values referenced in the common chart here | Key | Type | Default | Description | |-----|------|---------|-------------| +| env.DEEMIX_SINGLE_USER | bool | `false` | | | env.INTPORT | string | `"{{ .Values.service.main.ports.main.targetPort }}"` | | | image.pullPolicy | string | `"IfNotPresent"` | | | image.repository | string | `"tccr.io/truecharts/deemix"` | | diff --git a/docs/apps/stable/deemix/CHANGELOG.md b/docs/apps/stable/deemix/CHANGELOG.md new file mode 100644 index 00000000000..6f6939e9208 --- /dev/null +++ b/docs/apps/stable/deemix/CHANGELOG.md @@ -0,0 +1,70 @@ +# Changelog
+ + + +### [deemix-2.0.0](https://github.com/truecharts/apps/compare/deemix-1.0.7...deemix-2.0.0) (2022-03-27) + +#### Feat + +* move to stable ([#2306](https://github.com/truecharts/apps/issues/2306)) + + + + +### [deemix-1.0.7](https://github.com/truecharts/apps/compare/deemix-1.0.6...deemix-1.0.7) (2022-03-26) + +#### Chore + +* bump all apps to trigger ci + + + + +### [deemix-1.0.2](https://github.com/truecharts/apps/compare/deemix-1.0.1...deemix-1.0.2) (2022-03-15) + +#### Chore + +* update docker general non-major ([#2178](https://github.com/truecharts/apps/issues/2178)) + + + + +### [deemix-1.0.1](https://github.com/truecharts/apps/compare/deemix-1.0.0...deemix-1.0.1) (2022-03-07) + +#### Chore + +* update helm general non-major helm releases ([#2111](https://github.com/truecharts/apps/issues/2111)) +* Remove `-icon` string from icon png's ([#2040](https://github.com/truecharts/apps/issues/2040)) + + + + +### [deemix-1.0.0](https://github.com/truecharts/apps/compare/deemix-0.0.2...deemix-1.0.0) (2022-03-03) + +#### Chore + +* remove fixed env from questions.yaml +* update helm general major helm releases ([#2021](https://github.com/truecharts/apps/issues/2021)) + +#### Fix + +* BREAKING CHANGE Move some env-vars outside of env section ([#2010](https://github.com/truecharts/apps/issues/2010)) +* fix deemix questions.yaml + + + + +### [deemix-0.0.2](https://github.com/truecharts/apps/compare/deemix-0.0.1...deemix-0.0.2) (2022-03-02) + +#### Chore + +* update helm general non-major helm releases ([#1999](https://github.com/truecharts/apps/issues/1999)) + + + + +### deemix-0.0.1 (2022-02-25) + +#### Feat + +* Add deemix ([#1933](https://github.com/truecharts/apps/issues/1933)) diff --git a/docs/apps/stable/deemix/CONFIG.md b/docs/apps/stable/deemix/CONFIG.md new file mode 100644 index 00000000000..c147b7c819c --- /dev/null +++ b/docs/apps/stable/deemix/CONFIG.md @@ -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. diff --git a/docs/apps/stable/deemix/helm-values.md b/docs/apps/stable/deemix/helm-values.md new file mode 100644 index 00000000000..2575a36896f --- /dev/null +++ b/docs/apps/stable/deemix/helm-values.md @@ -0,0 +1,31 @@ +# 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.DEEMIX_SINGLE_USER | bool | `false` | | +| env.INTPORT | string | `"{{ .Values.service.main.ports.main.targetPort }}"` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"tccr.io/truecharts/deemix"` | | +| image.tag | string | `"latest@sha256:b868a80a9b831f934163e219d4866e8279330d16ecaf9d3fbfbeb9dd0eceed01"` | | +| persistence.config.enabled | bool | `true` | | +| persistence.config.mountPath | string | `"/config"` | | +| persistence.data.enabled | bool | `true` | | +| persistence.data.mountPath | string | `"/downloads"` | | +| podSecurityContext.runAsGroup | int | `0` | | +| podSecurityContext.runAsUser | int | `0` | | +| securityContext.readOnlyRootFilesystem | bool | `false` | | +| securityContext.runAsNonRoot | bool | `false` | | +| service.main.enabled | bool | `true` | | +| service.main.ports.main.port | int | `6595` | | +| service.main.ports.main.targetPort | int | `6595` | | + +All Rights Reserved - The TrueCharts Project diff --git a/docs/apps/stable/deemix/index.md b/docs/apps/stable/deemix/index.md new file mode 100644 index 00000000000..d0f123a3981 --- /dev/null +++ b/docs/apps/stable/deemix/index.md @@ -0,0 +1,38 @@ +# Introduction + +deemix is a deezer downloader built from the ashes of Deezloader Remix. + +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 + +* +* + +## Requirements + +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://library-charts.truecharts.org | common | 9.1.15 | + +## 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 diff --git a/docs/apps/stable/deemix/security.md b/docs/apps/stable/deemix/security.md new file mode 100644 index 00000000000..1e1d3e01ebd --- /dev/null +++ b/docs/apps/stable/deemix/security.md @@ -0,0 +1,82 @@ +--- +hide: + - toc +--- + +# Security Overview + + + +## Helm-Chart + +##### Scan Results + +#### Chart Object: deemix/templates/common.yaml + + + +| Type | Misconfiguration ID | Check | Severity | Explaination | Links | +|:----------------|:------------------:|:-----------:|:------------------:|-----------------------------------------|-----------------------------------------| +| Kubernetes Security Check | KSV001 | Process can elevate its own privileges | MEDIUM |
Expand... A program inside the container can elevate its own privileges and run as root, which might give the program control over the container and node.

Container 'hostpatch' of Deployment 'RELEASE-NAME-deemix' should set 'securityContext.allowPrivilegeEscalation' to false
|
Expand...https://kubernetes.io/docs/concepts/security/pod-security-standards/#restricted
https://avd.aquasec.com/appshield/ksv001
| +| Kubernetes Security Check | KSV003 | Default capabilities not dropped | LOW |
Expand... The container should drop all default capabilities and add only those that are needed for its execution.

Container 'RELEASE-NAME-deemix' of Deployment 'RELEASE-NAME-deemix' should add 'ALL' to 'securityContext.capabilities.drop'
|
Expand...https://kubesec.io/basics/containers-securitycontext-capabilities-drop-index-all/
https://avd.aquasec.com/appshield/ksv003
| +| Kubernetes Security Check | KSV003 | Default capabilities not dropped | LOW |
Expand... The container should drop all default capabilities and add only those that are needed for its execution.

Container 'hostpatch' of Deployment 'RELEASE-NAME-deemix' should add 'ALL' to 'securityContext.capabilities.drop'
|
Expand...https://kubesec.io/basics/containers-securitycontext-capabilities-drop-index-all/
https://avd.aquasec.com/appshield/ksv003
| +| Kubernetes Security Check | KSV011 | CPU not limited | LOW |
Expand... Enforcing CPU limits prevents DoS via resource exhaustion.

Container 'hostpatch' of Deployment 'RELEASE-NAME-deemix' should set 'resources.limits.cpu'
|
Expand...https://cloud.google.com/blog/products/containers-kubernetes/kubernetes-best-practices-resource-requests-and-limits
https://avd.aquasec.com/appshield/ksv011
| +| Kubernetes Security Check | KSV012 | Runs as root user | MEDIUM |
Expand... 'runAsNonRoot' forces the running image to run as a non-root user to ensure least privileges.

Container 'RELEASE-NAME-deemix' of Deployment 'RELEASE-NAME-deemix' should set 'securityContext.runAsNonRoot' to true
|
Expand...https://kubernetes.io/docs/concepts/security/pod-security-standards/#restricted
https://avd.aquasec.com/appshield/ksv012
| +| Kubernetes Security Check | KSV012 | Runs as root user | MEDIUM |
Expand... 'runAsNonRoot' forces the running image to run as a non-root user to ensure least privileges.

Container 'autopermissions' of Deployment 'RELEASE-NAME-deemix' should set 'securityContext.runAsNonRoot' to true
|
Expand...https://kubernetes.io/docs/concepts/security/pod-security-standards/#restricted
https://avd.aquasec.com/appshield/ksv012
| +| Kubernetes Security Check | KSV012 | Runs as root user | MEDIUM |
Expand... 'runAsNonRoot' forces the running image to run as a non-root user to ensure least privileges.

Container 'hostpatch' of Deployment 'RELEASE-NAME-deemix' should set 'securityContext.runAsNonRoot' to true
|
Expand...https://kubernetes.io/docs/concepts/security/pod-security-standards/#restricted
https://avd.aquasec.com/appshield/ksv012
| +| Kubernetes Security Check | KSV014 | Root file system is not read-only | LOW |
Expand... An immutable root file system prevents applications from writing to their local disk. This can limit intrusions, as attackers will not be able to tamper with the file system or write foreign executables to disk.

Container 'RELEASE-NAME-deemix' of Deployment 'RELEASE-NAME-deemix' should set 'securityContext.readOnlyRootFilesystem' to true
|
Expand...https://kubesec.io/basics/containers-securitycontext-readonlyrootfilesystem-true/
https://avd.aquasec.com/appshield/ksv014
| +| Kubernetes Security Check | KSV014 | Root file system is not read-only | LOW |
Expand... An immutable root file system prevents applications from writing to their local disk. This can limit intrusions, as attackers will not be able to tamper with the file system or write foreign executables to disk.

Container 'autopermissions' of Deployment 'RELEASE-NAME-deemix' should set 'securityContext.readOnlyRootFilesystem' to true
|
Expand...https://kubesec.io/basics/containers-securitycontext-readonlyrootfilesystem-true/
https://avd.aquasec.com/appshield/ksv014
| +| Kubernetes Security Check | KSV014 | Root file system is not read-only | LOW |
Expand... An immutable root file system prevents applications from writing to their local disk. This can limit intrusions, as attackers will not be able to tamper with the file system or write foreign executables to disk.

Container 'hostpatch' of Deployment 'RELEASE-NAME-deemix' should set 'securityContext.readOnlyRootFilesystem' to true
|
Expand...https://kubesec.io/basics/containers-securitycontext-readonlyrootfilesystem-true/
https://avd.aquasec.com/appshield/ksv014
| +| Kubernetes Security Check | KSV015 | CPU requests not specified | LOW |
Expand... When containers have resource requests specified, the scheduler can make better decisions about which nodes to place pods on, and how to deal with resource contention.

Container 'hostpatch' of Deployment 'RELEASE-NAME-deemix' should set 'resources.requests.cpu'
|
Expand...https://cloud.google.com/blog/products/containers-kubernetes/kubernetes-best-practices-resource-requests-and-limits
https://avd.aquasec.com/appshield/ksv015
| +| Kubernetes Security Check | KSV016 | Memory requests not specified | LOW |
Expand... When containers have memory requests specified, the scheduler can make better decisions about which nodes to place pods on, and how to deal with resource contention.

Container 'hostpatch' of Deployment 'RELEASE-NAME-deemix' should set 'resources.requests.memory'
|
Expand...https://kubesec.io/basics/containers-resources-limits-memory/
https://avd.aquasec.com/appshield/ksv016
| +| Kubernetes Security Check | KSV017 | Privileged container | HIGH |
Expand... Privileged containers share namespaces with the host system and do not offer any security. They should be used exclusively for system containers that require high privileges.

Container 'hostpatch' of Deployment 'RELEASE-NAME-deemix' should set 'securityContext.privileged' to false
|
Expand...https://kubernetes.io/docs/concepts/security/pod-security-standards/#baseline
https://avd.aquasec.com/appshield/ksv017
| +| Kubernetes Security Check | KSV018 | Memory not limited | LOW |
Expand... Enforcing memory limits prevents DoS via resource exhaustion.

Container 'hostpatch' of Deployment 'RELEASE-NAME-deemix' should set 'resources.limits.memory'
|
Expand...https://kubesec.io/basics/containers-resources-limits-memory/
https://avd.aquasec.com/appshield/ksv018
| +| Kubernetes Security Check | KSV020 | Runs with low user ID | MEDIUM |
Expand... Force the container to run with user ID > 10000 to avoid conflicts with the host’s user table.

Container 'RELEASE-NAME-deemix' of Deployment 'RELEASE-NAME-deemix' should set 'securityContext.runAsUser' > 10000
|
Expand...https://kubesec.io/basics/containers-securitycontext-runasuser/
https://avd.aquasec.com/appshield/ksv020
| +| Kubernetes Security Check | KSV020 | Runs with low user ID | MEDIUM |
Expand... Force the container to run with user ID > 10000 to avoid conflicts with the host’s user table.

Container 'autopermissions' of Deployment 'RELEASE-NAME-deemix' should set 'securityContext.runAsUser' > 10000
|
Expand...https://kubesec.io/basics/containers-securitycontext-runasuser/
https://avd.aquasec.com/appshield/ksv020
| +| Kubernetes Security Check | KSV020 | Runs with low user ID | MEDIUM |
Expand... Force the container to run with user ID > 10000 to avoid conflicts with the host’s user table.

Container 'hostpatch' of Deployment 'RELEASE-NAME-deemix' should set 'securityContext.runAsUser' > 10000
|
Expand...https://kubesec.io/basics/containers-securitycontext-runasuser/
https://avd.aquasec.com/appshield/ksv020
| +| Kubernetes Security Check | KSV021 | Runs with low group ID | MEDIUM |
Expand... Force the container to run with group ID > 10000 to avoid conflicts with the host’s user table.

Container 'RELEASE-NAME-deemix' of Deployment 'RELEASE-NAME-deemix' should set 'securityContext.runAsGroup' > 10000
|
Expand...https://kubesec.io/basics/containers-securitycontext-runasuser/
https://avd.aquasec.com/appshield/ksv021
| +| Kubernetes Security Check | KSV021 | Runs with low group ID | MEDIUM |
Expand... Force the container to run with group ID > 10000 to avoid conflicts with the host’s user table.

Container 'autopermissions' of Deployment 'RELEASE-NAME-deemix' should set 'securityContext.runAsGroup' > 10000
|
Expand...https://kubesec.io/basics/containers-securitycontext-runasuser/
https://avd.aquasec.com/appshield/ksv021
| +| Kubernetes Security Check | KSV021 | Runs with low group ID | MEDIUM |
Expand... Force the container to run with group ID > 10000 to avoid conflicts with the host’s user table.

Container 'hostpatch' of Deployment 'RELEASE-NAME-deemix' should set 'securityContext.runAsGroup' > 10000
|
Expand...https://kubesec.io/basics/containers-securitycontext-runasuser/
https://avd.aquasec.com/appshield/ksv021
| +| Kubernetes Security Check | KSV023 | hostPath volumes mounted | MEDIUM |
Expand... HostPath volumes must be forbidden.

Deployment 'RELEASE-NAME-deemix' should not set 'spec.template.volumes.hostPath'
|
Expand...https://kubernetes.io/docs/concepts/security/pod-security-standards/#baseline
https://avd.aquasec.com/appshield/ksv023
| +| Kubernetes Security Check | KSV029 | A root primary or supplementary GID set | LOW |
Expand... Containers should be forbidden from running with a root primary or supplementary GID.

Deployment 'RELEASE-NAME-deemix' should set 'spec.securityContext.runAsGroup', 'spec.securityContext.supplementalGroups[*]' and 'spec.securityContext.fsGroup' to integer greater than 0
|
Expand...https://kubernetes.io/docs/concepts/security/pod-security-standards/#restricted
https://avd.aquasec.com/appshield/ksv029
| + +## Containers + +##### Detected Containers + + tccr.io/truecharts/alpine:v3.15.2@sha256:29ed3480a0ee43f7af681fed5d4fc215516abf1c41eade6938b26d8c9c2c7583 + tccr.io/truecharts/alpine:v3.15.2@sha256:29ed3480a0ee43f7af681fed5d4fc215516abf1c41eade6938b26d8c9c2c7583 + tccr.io/truecharts/deemix:latest@sha256:b868a80a9b831f934163e219d4866e8279330d16ecaf9d3fbfbeb9dd0eceed01 + +##### Scan Results + + +#### Container: tccr.io/truecharts/alpine:v3.15.2@sha256:29ed3480a0ee43f7af681fed5d4fc215516abf1c41eade6938b26d8c9c2c7583 (alpine 3.15.2) + + +**alpine** + + +| No Vulnerabilities found | +|:---------------------------------| + + + + +#### Container: tccr.io/truecharts/alpine:v3.15.2@sha256:29ed3480a0ee43f7af681fed5d4fc215516abf1c41eade6938b26d8c9c2c7583 (alpine 3.15.2) + + +**alpine** + + +| No Vulnerabilities found | +|:---------------------------------| + + + + + + +| No Vulnerabilities found | +|:---------------------------------| + diff --git a/docs/index.yaml b/docs/index.yaml index 2426e8854bd..df3b1eb52c2 100644 --- a/docs/index.yaml +++ b/docs/index.yaml @@ -11218,6 +11218,40 @@ entries: - https://github.com/truecharts/apps/releases/download/deconz-5.0.7/deconz-5.0.7.tgz version: 5.0.7 deemix: + - annotations: + truecharts.org/SCALE-support: "true" + truecharts.org/catagories: | + - media + truecharts.org/grade: U + apiVersion: v2 + appVersion: latest + created: "2022-03-27T14:34:00.084189429Z" + dependencies: + - name: common + repository: https://library-charts.truecharts.org + version: 9.1.15 + description: deemix is a deezer downloader built from the ashes of Deezloader + Remix. + digest: 64b54e99e20b863d2cdc92ac94f2a2dc7164da330f8358ead8677caaea63c714 + home: https://github.com/truecharts/apps/tree/master/charts/incubator/deemix + icon: https://truecharts.org/_static/img/appicons/deemix.png + keywords: + - music + - deemix + - deezer + kubeVersion: '>=1.16.0-0' + maintainers: + - email: info@truecharts.org + name: TrueCharts + url: https://truecharts.org + name: deemix + sources: + - https://gitlab.com/Bockiii/deemix-docker.git + - https://git.freezerapp.xyz/RemixDev/deemix-py + type: application + urls: + - https://github.com/truecharts/apps/releases/download/deemix-2.0.0/deemix-2.0.0.tgz + version: 2.0.0 - annotations: truecharts.org/SCALE-support: "true" truecharts.org/catagories: | @@ -85702,4 +85736,4 @@ entries: urls: - https://github.com/truecharts/apps/releases/download/zwavejs2mqtt-9.0.24/zwavejs2mqtt-9.0.24.tgz version: 9.0.24 -generated: "2022-03-27T13:58:49.513199931Z" +generated: "2022-03-27T14:34:00.091462518Z"