From 96b12736868c4d5fae13d4c5f95ee00027e444e7 Mon Sep 17 00:00:00 2001 From: TrueCharts-Bot Date: Sun, 12 Sep 2021 08:16:02 +0000 Subject: [PATCH] Commit released Helm Chart and docs for TrueCharts Signed-off-by: TrueCharts-Bot --- charts/stable/custom-app/CHANGELOG.md | 9 +++++ charts/stable/custom-app/Chart.yaml | 2 +- charts/stable/custom-app/SCALE/CHANGELOG.md | 8 ++-- charts/stable/custom-app/helm-values.md | 12 +++++- docs/apps/stable/custom-app/CHANGELOG.md | 16 ++++++++ docs/apps/stable/custom-app/CONFIG.md | 8 ++++ docs/apps/stable/custom-app/helm-values.md | 43 +++++++++++++++++++++ docs/apps/stable/custom-app/index.md | 37 ++++++++++++++++++ docs/index.yaml | 27 ++++++++++++- 9 files changed, 154 insertions(+), 8 deletions(-) create mode 100644 docs/apps/stable/custom-app/CHANGELOG.md create mode 100644 docs/apps/stable/custom-app/CONFIG.md create mode 100644 docs/apps/stable/custom-app/helm-values.md create mode 100644 docs/apps/stable/custom-app/index.md diff --git a/charts/stable/custom-app/CHANGELOG.md b/charts/stable/custom-app/CHANGELOG.md index 4be64bb84ba..5848fa3223c 100644 --- a/charts/stable/custom-app/CHANGELOG.md +++ b/charts/stable/custom-app/CHANGELOG.md @@ -1,3 +1,12 @@ +# Changelog
+ + + +### [custom-app-0.2.22](https://github.com/truecharts/apps/compare/custom-app-0.2.21...custom-app-0.2.22) (2021-09-12) + +#### Chore + +* move custom-app to stable ## [custom-app-0.2.21](https://github.com/truecharts/apps/compare/custom-app-0.2.20...custom-app-0.2.21) (2021-09-08) diff --git a/charts/stable/custom-app/Chart.yaml b/charts/stable/custom-app/Chart.yaml index dff7d2c1cae..da40924d9e7 100644 --- a/charts/stable/custom-app/Chart.yaml +++ b/charts/stable/custom-app/Chart.yaml @@ -1,5 +1,5 @@ apiVersion: v2 -appVersion: auto +appVersion: 0.18.729 dependencies: - name: common repository: https://truecharts.org/ diff --git a/charts/stable/custom-app/SCALE/CHANGELOG.md b/charts/stable/custom-app/SCALE/CHANGELOG.md index 4be64bb84ba..36fb681accd 100644 --- a/charts/stable/custom-app/SCALE/CHANGELOG.md +++ b/charts/stable/custom-app/SCALE/CHANGELOG.md @@ -1,7 +1,7 @@ - -## [custom-app-0.2.21](https://github.com/truecharts/apps/compare/custom-app-0.2.20...custom-app-0.2.21) (2021-09-08) + +### [custom-app-0.2.22](https://github.com/truecharts/apps/compare/custom-app-0.2.21...custom-app-0.2.22) (2021-09-12) -### Fix +#### Chore -* repair Hyperion and some misplaced GUI elements ([#922](https://github.com/truecharts/apps/issues/922)) +* move custom-app to stable diff --git a/charts/stable/custom-app/helm-values.md b/charts/stable/custom-app/helm-values.md index 407cf5f52b3..e2599d26330 100644 --- a/charts/stable/custom-app/helm-values.md +++ b/charts/stable/custom-app/helm-values.md @@ -14,12 +14,21 @@ You will, however, be able to use all values referenced in the common chart here | env | object | `{}` | | | image.pullPolicy | string | `"IfNotPresent"` | | | image.repository | string | `"ghcr.io/k8s-at-home/jackett"` | | -| image.tag | string | `"v0.18.686"` | | +| image.tag | string | `"v0.18.729@sha256:7b814d426af9f3329edeb17cedab01217f7eee638f12e32f91c56d27aba48b6c"` | | | persistence.config.accessMode | string | `"ReadWriteOnce"` | | | persistence.config.enabled | bool | `true` | | | persistence.config.mountPath | string | `"/config"` | | | persistence.config.size | string | `"100Gi"` | | | persistence.config.type | string | `"pvc"` | | +| podSecurityContext.fsGroup | int | `568` | | +| podSecurityContext.fsGroupChangePolicy | string | `"OnRootMismatch"` | | +| podSecurityContext.runAsGroup | int | `568` | | +| podSecurityContext.runAsUser | int | `568` | | +| podSecurityContext.supplementalGroups | list | `[]` | | +| securityContext.allowPrivilegeEscalation | bool | `true` | | +| securityContext.privileged | bool | `false` | | +| securityContext.readOnlyRootFilesystem | bool | `false` | | +| securityContext.runAsNonRoot | bool | `true` | | | service.main.enabled | bool | `true` | | | service.main.ports.main.port | int | `9117` | | | service.main.portsList[0].enabled | bool | `true` | | @@ -30,6 +39,5 @@ You will, however, be able to use all values referenced in the common chart here | serviceList[0].portsList[0].enabled | bool | `true` | | | serviceList[0].portsList[0].name | string | `"extrasvcport"` | | | serviceList[0].portsList[0].port | int | `9119` | | -| strategy.type | string | `"Recreate"` | | All Rights Reserved - The TrueCharts Project diff --git a/docs/apps/stable/custom-app/CHANGELOG.md b/docs/apps/stable/custom-app/CHANGELOG.md new file mode 100644 index 00000000000..5848fa3223c --- /dev/null +++ b/docs/apps/stable/custom-app/CHANGELOG.md @@ -0,0 +1,16 @@ +# Changelog
+ + + +### [custom-app-0.2.22](https://github.com/truecharts/apps/compare/custom-app-0.2.21...custom-app-0.2.22) (2021-09-12) + +#### Chore + +* move custom-app to stable + + +## [custom-app-0.2.21](https://github.com/truecharts/apps/compare/custom-app-0.2.20...custom-app-0.2.21) (2021-09-08) + +### Fix + +* repair Hyperion and some misplaced GUI elements ([#922](https://github.com/truecharts/apps/issues/922)) diff --git a/docs/apps/stable/custom-app/CONFIG.md b/docs/apps/stable/custom-app/CONFIG.md new file mode 100644 index 00000000000..fc9b2fa2d5f --- /dev/null +++ b/docs/apps/stable/custom-app/CONFIG.md @@ -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. diff --git a/docs/apps/stable/custom-app/helm-values.md b/docs/apps/stable/custom-app/helm-values.md new file mode 100644 index 00000000000..e2599d26330 --- /dev/null +++ b/docs/apps/stable/custom-app/helm-values.md @@ -0,0 +1,43 @@ +# 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 | object | `{}` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"ghcr.io/k8s-at-home/jackett"` | | +| image.tag | string | `"v0.18.729@sha256:7b814d426af9f3329edeb17cedab01217f7eee638f12e32f91c56d27aba48b6c"` | | +| persistence.config.accessMode | string | `"ReadWriteOnce"` | | +| persistence.config.enabled | bool | `true` | | +| persistence.config.mountPath | string | `"/config"` | | +| persistence.config.size | string | `"100Gi"` | | +| persistence.config.type | string | `"pvc"` | | +| podSecurityContext.fsGroup | int | `568` | | +| podSecurityContext.fsGroupChangePolicy | string | `"OnRootMismatch"` | | +| podSecurityContext.runAsGroup | int | `568` | | +| podSecurityContext.runAsUser | int | `568` | | +| podSecurityContext.supplementalGroups | list | `[]` | | +| securityContext.allowPrivilegeEscalation | bool | `true` | | +| securityContext.privileged | bool | `false` | | +| securityContext.readOnlyRootFilesystem | bool | `false` | | +| securityContext.runAsNonRoot | bool | `true` | | +| service.main.enabled | bool | `true` | | +| service.main.ports.main.port | int | `9117` | | +| service.main.portsList[0].enabled | bool | `true` | | +| service.main.portsList[0].name | string | `"extraport"` | | +| service.main.portsList[0].port | int | `9118` | | +| serviceList[0].enabled | bool | `true` | | +| serviceList[0].name | string | `"extraservice"` | | +| serviceList[0].portsList[0].enabled | bool | `true` | | +| serviceList[0].portsList[0].name | string | `"extrasvcport"` | | +| serviceList[0].portsList[0].port | int | `9119` | | + +All Rights Reserved - The TrueCharts Project diff --git a/docs/apps/stable/custom-app/index.md b/docs/apps/stable/custom-app/index.md new file mode 100644 index 00000000000..2d8f2239a34 --- /dev/null +++ b/docs/apps/stable/custom-app/index.md @@ -0,0 +1,37 @@ +# Introduction + +Advanced tool to create your own TrueCharts-based App + +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://truecharts.org/ | common | 6.13.8 | + +## 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 diff --git a/docs/index.yaml b/docs/index.yaml index f498d19048c..6f29a174277 100644 --- a/docs/index.yaml +++ b/docs/index.yaml @@ -19635,6 +19635,31 @@ entries: - https://github.com/truecharts/apps/releases/download/common-test-2.0.0/common-test-2.0.0.tgz version: 2.0.0 custom-app: + - apiVersion: v2 + appVersion: 0.18.729 + created: "2021-09-12T08:16:00.265422005Z" + dependencies: + - name: common + repository: https://truecharts.org/ + version: 6.13.8 + description: Advanced tool to create your own TrueCharts-based App + digest: 221524f9b60d74e90fdbb38437ec17a162c688ee87d3380006adcdf04887e87a + home: https://github.com/truecharts/apps/tree/master/charts/stable/custom-app + icon: https://truecharts.org/_static/img/custom-app-icon.png + keywords: + - custom + kubeVersion: '>=1.16.0-0' + maintainers: + - email: info@truecharts.org + name: TrueCharts + url: truecharts.org + name: custom-app + sources: + - https://github.com/truecharts/apps/tree/master/charts/stable/custom-app + type: application + urls: + - https://github.com/truecharts/apps/releases/download/custom-app-0.2.22/custom-app-0.2.22.tgz + version: 0.2.22 - apiVersion: v2 appVersion: auto created: "2021-09-08T03:33:28.137687197Z" @@ -178926,4 +178951,4 @@ entries: urls: - https://github.com/truecharts/apps/releases/download/zwavejs2mqtt-3.1.5/zwavejs2mqtt-3.1.5.tgz version: 3.1.5 -generated: "2021-09-12T08:08:41.802044581Z" +generated: "2021-09-12T08:16:00.314773566Z"