From 0fdc4e1ebd3a9b9efad27414aa244b3e5a9e10b4 Mon Sep 17 00:00:00 2001 From: Stavros Kois <47820033+stavros-k@users.noreply.github.com> Date: Thu, 25 Aug 2022 17:38:56 +0300 Subject: [PATCH] update support doc --- .github/SUPPORT.md | 53 +++++++++------------------------------------- 1 file changed, 10 insertions(+), 43 deletions(-) diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md index ac9aa031daf..89cbf8ed3b2 100644 --- a/.github/SUPPORT.md +++ b/.github/SUPPORT.md @@ -1,6 +1,5 @@ # Support Policy - ## TrueCharts on TrueNAS SCALE TrueCharts aims to always support the latest version of TrueNAS SCALE. @@ -12,54 +11,22 @@ We also document which versions of TrueNAS will receive TrueCharts updates and f ### Supported Versions | TrueNAS version | Branch | Supported with updates | Accepting Support tickets | Accepting Bug Reports | Notes | -| ---------------- | -------- | ---------------------- | ------------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------- | -| 22.02.2 or prior | `master` | :white_check_mark: | :x: | :x: | Advised to update to 22.02.3 release of [TrueNAS SCALE](https://www.truenas.com/docs/scale/scalereleasenotes/) | -| 22.02.3 | `master` | :white_check_mark: | :white_check_mark: | :white_check_mark: | Most Stable Release as of 2022-08-09 | -| Nightly | `master` | :white_check_mark: | :x: | :white_check_mark: | Please only submit bug reports during codefreeze | +| ---------------- | -------- | ---------------------- | ------------------------- | --------------------- | -------------------------------------------------------------------------------------------------------------- | +| 22.02.2 or prior | `master` | :white_check_mark: | :x: | :x: | Advised to update to 22.02.3 release of [TrueNAS SCALE](https://www.truenas.com/docs/scale/scalereleasenotes/) | +| 22.02.3 | `master` | :white_check_mark: | :white_check_mark: | :white_check_mark: | Most Stable Release as of 2022-08-09 | +| Nightly | `master` | :white_check_mark: | :x: | :white_check_mark: | Please only submit bug reports during codefreeze | ## Stable Train Charts We provide direct support for getting `stable` train charts working on our [discord](https://discord.gg/tVsPTHWTtr) inside the **#support** channel. That includes installation and guidance on getting it working with defaults or basic settings (not advanced customisations or remote smb shares, etc). -Bug reports aren't accepted on [discord](https://discord.gg/tVsPTHWTtr) so if you spot a bug (all charts in the stable train should work with defaults) +Bug reports aren't accepted on [discord](https://discord.gg/tVsPTHWTtr) so if you spot a bug (Charts in the stable train should work with mostly defaults configuration) please report them to our [github](https://github.com/truecharts/charts/issues/new/choose). Bug reports that state something doesn't work without supporting items may be closed. ## Incubator Train Charts -Our support policy for `incubator` train charts is different for those on the `stable` train. Those charts are work in progress, -may break at anytime and we're still going through many of the charts from unRAID. We won't respond to #support tickets on our discord for `incubator` train -charts on our [discord](https://discord.gg/tVsPTHWTtr). However we have an **#incubator-chat** channel for these apps to help get them running. Assume anything -in the `incubator` train is in beta and you're testing it. As well, anything installed in `incubator` will have to be REINSTALLED once it moves to the `stable` train. - -## Specific TrueCharts Support Items (FAQ) - -1. Checking the Advanced and Expert Networking boxes render your ticket ineligible for standard support. - charts will work with these boxes enabled but the support staff won't help you with your advanced setups, use **#customised-setups**. - If you find a bug with those boxes we always accept bug reports on our [github](https://github.com/truecharts/charts/issues/new/choose) - -2. If you're using another Load Balancer in front of Traefik this falls outside the realm - of basic support and your support ticket will be ineligible - -3. Certain applications require ingress to work correctly due to security reasons. - Which is why doing so is also required for **#support** tickets. - Failure to use ingress for those charts will render your support ticket ineligible. *Example* apps are: - - Vaultwarden - - Nextcloud - - Monica - - Recipes - -4. We currently advise people to NOT use ACL's for host path storage. We cannot guide each user through setting up their ACL's for each chart. - Apart from a few exceptions user 568 (apps) must have access to their host path storage. - -5. Along with above, we heavily suggest using PVC whenever possible and should be the main way your charts are installed. - These PVC's can be mounted using [truetool](https://github.com/truecharts/truetool). - User storage for user files can be mounted in the GUI and for certain charts there's specific sections for this storage. - The reason for using PVC with charts is the Rollback support on a failed change or update to your chart. No PVC, no GUI rollback inside TrueNAS - -6. TrueCharts uses [Semantic Versioning](https://semver.org/) on the aspects of the chart that TrueCharts has changed. - All charts in `stable` begin at `1.0.0` and increase with updates from the common chart or if the chart is updated. - Some chart use latest and/or poor versioning so updates aren't always clear upstream but be sure to check the **CHANGELOG** for each chart before updating. - This is especially important for **MAJOR** changes, such as 13.2.1 -> 14.0.0 or if the upstream chart has undergone a major change itself. - These are potentially a `Breaking change` (the semver first digit change). If charts undergo after a `breaking change` we cannot guarantee that they will - all update properly out of the box, therefore have backups beforehand (Truetool) or making sure the ability to rollback works for your chart. - We try to help on a best effort basis, but support will be limited as they are expected to be more-or-less breaking and we cannot control all scenarios. \ No newline at end of file +Our support policy for `incubator` train charts is different for those on the `stable` train. Those charts are work in progress, +may break at anytime and we're still going through many of the charts from unRAID. We won't accept support tickets on our discord for `incubator` train +charts on our [discord](https://discord.gg/tVsPTHWTtr). However we have an **#incubator-chat** channel for these apps to help get them running and/or receive feedback. +With enough posivite feedback a chart can be promoted to `stable` train. Feedback about bugs is also accepted there which can be used to fix them. +Assume anything in the `incubator` train is in beta and you're testing it. As well, anything installed in `incubator` will have to be REINSTALLED once it moves to the `stable` train.