From 66da4ab46cf867ac0467005e6ba77c3561a99d16 Mon Sep 17 00:00:00 2001 From: TrueCharts-Bot Date: Thu, 9 Sep 2021 18:57:08 +0000 Subject: [PATCH] Commit released Helm Chart and docs for TrueCharts Signed-off-by: TrueCharts-Bot --- charts/library/common/CHANGELOG.md | 9 +++++ charts/library/common/SCALE/CHANGELOG.md | 8 ++-- charts/library/common/helm-values.md | 51 ++++++++++++++++++++++++ docs/apps/common/helm-values.md | 51 ++++++++++++++++++++++++ docs/index.yaml | 26 +++++++++++- 5 files changed, 140 insertions(+), 5 deletions(-) diff --git a/charts/library/common/CHANGELOG.md b/charts/library/common/CHANGELOG.md index 31bc2fd72ea..5c385cd7a0e 100644 --- a/charts/library/common/CHANGELOG.md +++ b/charts/library/common/CHANGELOG.md @@ -1,6 +1,15 @@ # Changelog
+ +### [common-6.14.0](https://github.com/truecharts/apps/compare/common-6.13.11...common-6.14.0) (2021-09-09) + +#### Feat + +* port addons from k8s-at-home to common ([#948](https://github.com/truecharts/apps/issues/948)) + + + ### [common-6.13.11](https://github.com/truecharts/apps/compare/common-6.13.10...common-6.13.11) (2021-09-09) diff --git a/charts/library/common/SCALE/CHANGELOG.md b/charts/library/common/SCALE/CHANGELOG.md index 77229f986b8..fe16126ab9e 100644 --- a/charts/library/common/SCALE/CHANGELOG.md +++ b/charts/library/common/SCALE/CHANGELOG.md @@ -1,7 +1,7 @@ - -### [common-6.13.11](https://github.com/truecharts/apps/compare/common-6.13.10...common-6.13.11) (2021-09-09) + +### [common-6.14.0](https://github.com/truecharts/apps/compare/common-6.13.11...common-6.14.0) (2021-09-09) -#### Chore +#### Feat -* update common test dependencies ([#949](https://github.com/truecharts/apps/issues/949)) +* port addons from k8s-at-home to common ([#948](https://github.com/truecharts/apps/issues/948)) diff --git a/charts/library/common/helm-values.md b/charts/library/common/helm-values.md index 69704b7e0e1..21e3aea391f 100644 --- a/charts/library/common/helm-values.md +++ b/charts/library/common/helm-values.md @@ -9,6 +9,57 @@ This chart is used by a lot of our Apps to provide sane defaults and logic. | Key | Type | Default | Description | |-----|------|---------|-------------| | additionalContainers | list | `[]` | Specify any additional containers here. Yaml will be passed in to the Pod as-is. | +| addons | object | See below | The common chart supports several add-ons. These can be configured under this key. | +| addons.codeserver | object | See values.yaml | The common library supports adding a code-server add-on to access files. It can be configured under this key. For more info, check out [our docs](http://docs.k8s-at-home.com/our-helm-charts/common-library-add-ons/#code-server) | +| addons.codeserver.args | list | `["--auth","none"]` | Set codeserver command line arguments. Consider setting --user-data-dir to a persistent location to preserve code-server setting changes | +| addons.codeserver.enabled | bool | `false` | Enable running a code-server container in the pod | +| addons.codeserver.env | object | `{}` | Set any environment variables for code-server here | +| addons.codeserver.git | object | See below | Optionally allow access a Git repository by passing in a private SSH key | +| addons.codeserver.git.deployKey | string | `""` | Raw SSH private key | +| addons.codeserver.git.deployKeyBase64 | string | `""` | Base64-encoded SSH private key. When both variables are set, the raw SSH key takes precedence. | +| addons.codeserver.git.deployKeySecret | string | `""` | Existing secret containing SSH private key The chart expects it to be present under the `id_rsa` key. | +| addons.codeserver.image.pullPolicy | string | `"IfNotPresent"` | Specify the code-server image pull policy | +| addons.codeserver.image.repository | string | `"codercom/code-server"` | Specify the code-server image | +| addons.codeserver.image.tag | string | `"3.9.2"` | Specify the code-server image tag | +| addons.codeserver.ingress.enabled | bool | `false` | Enable an ingress for the code-server add-on. | +| addons.codeserver.service.enabled | bool | `true` | Enable a service for the code-server add-on. | +| addons.codeserver.volumeMounts | list | `[]` | Specify a list of volumes that get mounted in the code-server container. At least 1 volumeMount is required! | +| addons.codeserver.workingDir | string | `""` | Specify the working dir that will be opened when code-server starts If not given, the app will default to the mountpah of the first specified volumeMount | +| addons.netshoot | object | See values.yaml | The common library supports adding a netshoot add-on to troubleshoot network issues within a Pod. It can be configured under this key. | +| addons.netshoot.enabled | bool | `false` | Enable running a netshoot container in the pod | +| addons.netshoot.env | object | `{}` | Set any environment variables for netshoot here | +| addons.netshoot.image.pullPolicy | string | `"Always"` | Specify the netshoot image pull policy | +| addons.netshoot.image.repository | string | `"nicolaka/netshoot"` | Specify the netshoot image | +| addons.netshoot.image.tag | string | `"latest"` | Specify the netshoot image tag | +| addons.promtail | object | See values.yaml | The common library supports adding a promtail add-on to to access logs and ship them to loki. It can be configured under this key. | +| addons.promtail.args | list | `[]` | Set promtail command line arguments | +| addons.promtail.enabled | bool | `false` | Enable running a promtail container in the pod | +| addons.promtail.env | object | `{}` | Set any environment variables for promtail here | +| addons.promtail.image.pullPolicy | string | `"IfNotPresent"` | Specify the promtail image pull policy | +| addons.promtail.image.repository | string | `"grafana/promtail"` | Specify the promtail image | +| addons.promtail.image.tag | string | `"2.2.0"` | Specify the promtail image tag | +| addons.promtail.logs | list | `[]` | The paths to logs on the volume | +| addons.promtail.loki | string | `""` | The URL to Loki | +| addons.promtail.volumeMounts | list | `[]` | Specify a list of volumes that get mounted in the promtail container. At least 1 volumeMount is required! | +| addons.vpn | object | See values.yaml | The common chart supports adding a VPN add-on. It can be configured under this key. For more info, check out [our docs](http://docs.k8s-at-home.com/our-helm-charts/common-library-add-ons/#wireguard-vpn) | +| addons.vpn.configFile | string | `nil` | Provide a customized vpn configuration file to be used by the VPN. | +| addons.vpn.configFileSecret | string | `nil` | Reference an existing secret that contains the VPN configuration file The chart expects it to be present under the `vpnConfigfile` key. | +| addons.vpn.enabled | bool | `false` | Enable running a VPN in the pod to route traffic through a VPN | +| addons.vpn.env | object | `{}` | All variables specified here will be added to the vpn sidecar container See the documentation of the VPN image for all config values | +| addons.vpn.livenessProbe | object | `{}` | Optionally specify a livenessProbe, e.g. to check if the connection is still being protected by the VPN | +| addons.vpn.openvpn | object | See below | OpenVPN specific configuration | +| addons.vpn.openvpn.auth | string | `nil` | Credentials to connect to the VPN Service (used with -a) | +| addons.vpn.openvpn.authSecret | string | `nil` | Optionally specify an existing secret that contains the credentials. Credentials should be stored under the `VPN_AUTH` key | +| addons.vpn.openvpn.image.pullPolicy | string | `"IfNotPresent"` | Specify the openvpn client image pull policy | +| addons.vpn.openvpn.image.repository | string | `"dperson/openvpn-client"` | Specify the openvpn client image | +| addons.vpn.openvpn.image.tag | string | `"latest"` | Specify the openvpn client image tag | +| addons.vpn.scripts | object | See values.yaml | Provide custom up/down scripts that can be used by the vpn configuration. | +| addons.vpn.securityContext | object | See values.yaml | Set the VPN container securityContext | +| addons.vpn.type | string | `"openvpn"` | Specify the VPN type. Valid options are openvpn or wireguard | +| addons.vpn.wireguard | object | See below | WireGuard specific configuration | +| addons.vpn.wireguard.image.pullPolicy | string | `"IfNotPresent"` | Specify the WireGuard image pull policy | +| addons.vpn.wireguard.image.repository | string | `"ghcr.io/k8s-at-home/wireguard"` | Specify the WireGuard image | +| addons.vpn.wireguard.image.tag | string | `"v1.0.20210424"` | Specify the WireGuard image tag | | affinity | object | `{}` | Defines affinity constraint rules. [[ref]](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity) | | args | list | `[]` | Override the args for the default container | | autoscaling | object | | Add a Horizontal Pod Autoscaler | diff --git a/docs/apps/common/helm-values.md b/docs/apps/common/helm-values.md index 69704b7e0e1..21e3aea391f 100644 --- a/docs/apps/common/helm-values.md +++ b/docs/apps/common/helm-values.md @@ -9,6 +9,57 @@ This chart is used by a lot of our Apps to provide sane defaults and logic. | Key | Type | Default | Description | |-----|------|---------|-------------| | additionalContainers | list | `[]` | Specify any additional containers here. Yaml will be passed in to the Pod as-is. | +| addons | object | See below | The common chart supports several add-ons. These can be configured under this key. | +| addons.codeserver | object | See values.yaml | The common library supports adding a code-server add-on to access files. It can be configured under this key. For more info, check out [our docs](http://docs.k8s-at-home.com/our-helm-charts/common-library-add-ons/#code-server) | +| addons.codeserver.args | list | `["--auth","none"]` | Set codeserver command line arguments. Consider setting --user-data-dir to a persistent location to preserve code-server setting changes | +| addons.codeserver.enabled | bool | `false` | Enable running a code-server container in the pod | +| addons.codeserver.env | object | `{}` | Set any environment variables for code-server here | +| addons.codeserver.git | object | See below | Optionally allow access a Git repository by passing in a private SSH key | +| addons.codeserver.git.deployKey | string | `""` | Raw SSH private key | +| addons.codeserver.git.deployKeyBase64 | string | `""` | Base64-encoded SSH private key. When both variables are set, the raw SSH key takes precedence. | +| addons.codeserver.git.deployKeySecret | string | `""` | Existing secret containing SSH private key The chart expects it to be present under the `id_rsa` key. | +| addons.codeserver.image.pullPolicy | string | `"IfNotPresent"` | Specify the code-server image pull policy | +| addons.codeserver.image.repository | string | `"codercom/code-server"` | Specify the code-server image | +| addons.codeserver.image.tag | string | `"3.9.2"` | Specify the code-server image tag | +| addons.codeserver.ingress.enabled | bool | `false` | Enable an ingress for the code-server add-on. | +| addons.codeserver.service.enabled | bool | `true` | Enable a service for the code-server add-on. | +| addons.codeserver.volumeMounts | list | `[]` | Specify a list of volumes that get mounted in the code-server container. At least 1 volumeMount is required! | +| addons.codeserver.workingDir | string | `""` | Specify the working dir that will be opened when code-server starts If not given, the app will default to the mountpah of the first specified volumeMount | +| addons.netshoot | object | See values.yaml | The common library supports adding a netshoot add-on to troubleshoot network issues within a Pod. It can be configured under this key. | +| addons.netshoot.enabled | bool | `false` | Enable running a netshoot container in the pod | +| addons.netshoot.env | object | `{}` | Set any environment variables for netshoot here | +| addons.netshoot.image.pullPolicy | string | `"Always"` | Specify the netshoot image pull policy | +| addons.netshoot.image.repository | string | `"nicolaka/netshoot"` | Specify the netshoot image | +| addons.netshoot.image.tag | string | `"latest"` | Specify the netshoot image tag | +| addons.promtail | object | See values.yaml | The common library supports adding a promtail add-on to to access logs and ship them to loki. It can be configured under this key. | +| addons.promtail.args | list | `[]` | Set promtail command line arguments | +| addons.promtail.enabled | bool | `false` | Enable running a promtail container in the pod | +| addons.promtail.env | object | `{}` | Set any environment variables for promtail here | +| addons.promtail.image.pullPolicy | string | `"IfNotPresent"` | Specify the promtail image pull policy | +| addons.promtail.image.repository | string | `"grafana/promtail"` | Specify the promtail image | +| addons.promtail.image.tag | string | `"2.2.0"` | Specify the promtail image tag | +| addons.promtail.logs | list | `[]` | The paths to logs on the volume | +| addons.promtail.loki | string | `""` | The URL to Loki | +| addons.promtail.volumeMounts | list | `[]` | Specify a list of volumes that get mounted in the promtail container. At least 1 volumeMount is required! | +| addons.vpn | object | See values.yaml | The common chart supports adding a VPN add-on. It can be configured under this key. For more info, check out [our docs](http://docs.k8s-at-home.com/our-helm-charts/common-library-add-ons/#wireguard-vpn) | +| addons.vpn.configFile | string | `nil` | Provide a customized vpn configuration file to be used by the VPN. | +| addons.vpn.configFileSecret | string | `nil` | Reference an existing secret that contains the VPN configuration file The chart expects it to be present under the `vpnConfigfile` key. | +| addons.vpn.enabled | bool | `false` | Enable running a VPN in the pod to route traffic through a VPN | +| addons.vpn.env | object | `{}` | All variables specified here will be added to the vpn sidecar container See the documentation of the VPN image for all config values | +| addons.vpn.livenessProbe | object | `{}` | Optionally specify a livenessProbe, e.g. to check if the connection is still being protected by the VPN | +| addons.vpn.openvpn | object | See below | OpenVPN specific configuration | +| addons.vpn.openvpn.auth | string | `nil` | Credentials to connect to the VPN Service (used with -a) | +| addons.vpn.openvpn.authSecret | string | `nil` | Optionally specify an existing secret that contains the credentials. Credentials should be stored under the `VPN_AUTH` key | +| addons.vpn.openvpn.image.pullPolicy | string | `"IfNotPresent"` | Specify the openvpn client image pull policy | +| addons.vpn.openvpn.image.repository | string | `"dperson/openvpn-client"` | Specify the openvpn client image | +| addons.vpn.openvpn.image.tag | string | `"latest"` | Specify the openvpn client image tag | +| addons.vpn.scripts | object | See values.yaml | Provide custom up/down scripts that can be used by the vpn configuration. | +| addons.vpn.securityContext | object | See values.yaml | Set the VPN container securityContext | +| addons.vpn.type | string | `"openvpn"` | Specify the VPN type. Valid options are openvpn or wireguard | +| addons.vpn.wireguard | object | See below | WireGuard specific configuration | +| addons.vpn.wireguard.image.pullPolicy | string | `"IfNotPresent"` | Specify the WireGuard image pull policy | +| addons.vpn.wireguard.image.repository | string | `"ghcr.io/k8s-at-home/wireguard"` | Specify the WireGuard image | +| addons.vpn.wireguard.image.tag | string | `"v1.0.20210424"` | Specify the WireGuard image tag | | affinity | object | `{}` | Defines affinity constraint rules. [[ref]](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity) | | args | list | `[]` | Override the args for the default container | | autoscaling | object | | Add a Horizontal Pod Autoscaler | diff --git a/docs/index.yaml b/docs/index.yaml index 6160b6d2941..96c2b244970 100644 --- a/docs/index.yaml +++ b/docs/index.yaml @@ -16643,6 +16643,30 @@ entries: - https://github.com/truecharts/apps/releases/download/collabora-online-3.1.5/collabora-online-3.1.5.tgz version: 3.1.5 common: + - apiVersion: v2 + appVersion: auto + created: "2021-09-09T18:57:06.903954178Z" + description: Function library for TrueCharts + digest: 25f36fbd640fc88c76804d3107f9734c7b921257f620701e19b40535b9105fac + home: https://github.com/truecharts/apps/tree/master/charts/common + icon: https://avatars.githubusercontent.com/u/76400755 + keywords: + - truecharts + - library-chart + - common + kubeVersion: '>=1.16.0-0' + maintainers: + - email: info@truecharts.org + name: TrueCharts + url: truecharts.org + - email: kjeld@schouten-lebbing.nl + name: Ornias1993 + url: truecharts.org + name: common + type: library + urls: + - https://github.com/truecharts/apps/releases/download/common-6.14.0/common-6.14.0.tgz + version: 6.14.0 - apiVersion: v2 appVersion: auto created: "2021-09-09T18:43:20.434488147Z" @@ -177875,4 +177899,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-09T18:43:20.485664786Z" +generated: "2021-09-09T18:57:06.950721967Z"