Doc patches

2021-05-23 20:34:11 +02:00
parent f8b79ac51a
commit a869e30188
10 changed files with 75 additions and 60 deletions
@@ -3,7 +3,7 @@
 Sometimes we can not guarantee automatic updating between new versions of our Apps.
 These pages include some common scenario's and give some guidance how to manually move between different versions and Trains.

-##### Between Trains
+### Between Trains

 An app will always be just in one train. If an App moves to a different train, you will not be able to update automatically
 Our basic guidence for these cases is:
@@ -17,7 +17,17 @@ Our basic guidence for these cases is:
 - Put back all your old files.
 - Re start the new App

-##### Between Versions
+### Between Versions

 When new versions introduce breaking changes (which would often be major version changes) they might(!) require the user to reinstall.
 However: We often already provide migration scrips and dealth with these issues manually.
+
+##### Common 2.0 -> common 3.0 based Apps
+
+In cases you upgrade to a common 3.0 based app, reinstall is currently required. Please be aware: Installing will nuke your data!
+Be also aware that we do not have common 2.0 based installs available in the version dropdown
+
+##### Common 3.0 -> common 4.0 based Apps
+
+In cases you upgrade to a common 4.0 based app, reinstall is currently required. Please be aware: Installing will nuke your data!
+However: Common 3.0 based Apps are still available to be installed using the version dropdown
@@ -1,6 +1,6 @@
 # General Configuration

-There are some setting that are always present on every App from TrueCharts.
+These are some common settings you might find on Apps and an explaination of their usecase.

 ##### Explaination sheet:

@@ -28,3 +28,11 @@ There are, however, multiple downsides to using nodeports:

 - You can only pick ports above 9000
 - You can not connect two Apps to the same port
+
+##### LoadBalancer
+
+Loadbalancer connects a service targetPort directly to the Host Network. However: it can do so in lower ranges than NodePort, making it a great solution for things like DNS servers.
+
+There are, however, downsides to using LoadBalancer:
+
+- You can not connect two Apps to the same port
@@ -4,6 +4,10 @@ Within TrueCharts our aim is to make it as easy as possible to secure your Apps.

 To use Traefik as a Reverse Proxy, all you have to do is enable "Reverse Proxy" in the App of your choice and fill out a little form.

+## Note
+
+Currently for charts using common 4.0, we do NOT support Reverse-Proxy/Ingress as it's being completely rewrithen from scratch at the moment.
+
 ### Types of Reverse Proxys

 We currently offer the following types of pre-configured reverse proxies:
@@ -8,7 +8,7 @@ TrueCharts uses multiple different storage systems:
 Storage is currently seperated into two types:

 1. Integrated Persistent Storage
-2. Custom Storage
+2. Custom Storage aka "hostPathMounts"


 ### Integrated Persistent Storage
@@ -26,15 +26,13 @@ We currently have the following Storage options for Integrated Persistent Storag
 This storage is integrated into TrueNAS SCALE and completely supports reverting upgrades. Thats why this is the default (and only actually supported!) way of storing App configuration files.


-### Custom Storage
+### Custom app storage aka "hostPathMounts"

 Besides the earlier mentioned Integrated Persistent Storage, we also provide the option to mount as many host folders as you want.

-Custom storage currently actually quite simple:
+hostPathMounts are actually quite simple:
 It mounts a directory from your TrueNAS SCALE system, directly to a directory inside the App you're installing.

-However: We might port this to PVC's in the future, which is not fully decided on yet.
-

 ### Permissions

@@ -46,7 +44,7 @@ For both Integrated Persistent Storage and Custom storage, we offer special opti
 These get automatically set to be owned by root:__PGID__
 There are no options available to configure this.

-##### Custom storage
+##### Custom app storage aka "hostPathMounts"

 We offer an optional automatic set the permissions according to App PGID and PUID.