Cloned2Preserve
/
TrueChartsClone
mirror of https://github.com/truecharts/charts.git
1
0
Fork 0
Code

fix(Docs): Add info to Support.md (#3457) 

* add support.md on gh

* might as well add changes here

* format

* added a large FAQ section

* Make some changes + formatting

* Update .github/SUPPORT.md

* Update .github/SUPPORT.md

* Apply suggestions from code review

* Update .github/SUPPORT.md

Co-authored-by: Stavros kois <s.kois@outlook.com>
Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>
Co-authored-by: Kjeld Schouten-Lebbing <kjeld@schouten-lebbing.nl>
This commit is contained in:
StevenMcElligott 2022-08-13 04:49:06 -04:00 committed by GitHub
parent 25c42bf62a
commit cc4788bfe6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 65 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
.github/SUPPORT.md vendored Normal file
View File

@ -0,0 +1,65 @@
# Support Policy
## TrueCharts on TrueNAS SCALE
TrueCharts aims to always support the latest version of TrueNAS SCALE.
However, sometimes new versions of either TrueNAS or TrueCharts introduces breaking changes.
This document highlights which versions of TrueCharts (or rather branches), support which versions of TrueNAS SCALE.
We also document which versions of TrueNAS will receive TrueCharts updates and for which versions we are accepting bug reports.
### 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 |
## 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)
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.