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

add pages for TBH quick-start guides

This commit is contained in:
kjeld Schouten-Lebbing 2021-08-26 11:26:47 +02:00
parent f54ec103a0
commit d4f6ff165a
No known key found for this signature in database
GPG Key ID: 4CDAD4A532BC1EDB
4 changed files with 41 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/manual/Quick-Start Guides/15-add-storage.md Normal file
View File

@ -0,0 +1,22 @@
# 15 - Adding additional storage
We provide the option to mount as many host folders as you want.
hostPathMounts are actually quite simple:
It mounts a directory from your TrueNAS SCALE system, directly to a directory inside the App you're installing.
#### Permissions
We offer an optional automatic set the permissions according to App fsGroup or PUID.
Setting permissions automatically means we `chown` the folder and all folder within it, to a group of your choice.
However, we only do so when installing or updating an app.
Please be aware that automatically setting ownership/permissions, does mean it overrides your current CHOWN and CHMOD settings. This could break things and yes, it will destroy your system if used carelessly. It's also not wise to enable the automatic permissions on mounted shares from an external system.
#### Video Guide
TBD
##### Additional Documentation

8
docs/manual/Quick-Start Guides/16-external-services.md Normal file
View File

@ -0,0 +1,8 @@
# 15 - Setting up External-Services
#### Video Guide
TBD
##### Additional Documentation

8
docs/manual/Quick-Start Guides/17-migrate from docker-compose.md Normal file
View File

@ -0,0 +1,8 @@
# 17 - Migrate from Docker-Compose
#### Video Guide
TBD
##### Additional Documentation

26
docs/manual/indepth/storage.md
View File

@ -7,22 +7,15 @@ TrueCharts uses multiple different storage systems:
Storage is currently seperated into two types: Storage is currently seperated into two types:
1. Integrated Persistent Storage 1. Integrated Persistent Storage (PVC)
2. Custom Storage aka "hostPathMounts" 2. Custom Storage aka "hostPathMounts"
### Integrated Persistent Storage ### Integrated Persistent Storage
Integrated Persistent Storage is based around Kubernetes PVC's to integrate as closely as possible into TrueNAS SCALE. They are also heavily preconfigured to work as optimal as possible and provide options for future expansion such as NFS and Gluster options being added. Integrated Persistent Storage is based around Kubernetes PVC's to integrate as closely as possible into TrueNAS SCALE. They are also heavily preconfigured to work as optimal as possible and provide options for future expansion such as NFS and Gluster options being added.
These storage options inherently are not well suited to being shared with multiple applications. These storage options inherently are not well suited to being shared with multiple applications.
We currently have the following Storage options for Integrated Persistent Storage storage:
1. Internal
##### Internal
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. 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.
@ -41,27 +34,14 @@ For both Integrated Persistent Storage and Custom storage, we offer special opti
##### Integrated Persistent Storage ##### Integrated Persistent Storage
These get automatically set to be owned by root:__PGID__ These get automatically set to be owned by :__PGID__
There are no options available to configure this.
##### Custom app storage aka "hostPathMounts" ##### Custom app storage aka "hostPathMounts"
We offer an optional automatic set the permissions according to App PGID and PUID. We offer an optional automatic set the permissions according to App App fsGroup or PUID.
Setting permissions automatically means we `chown` the folder and all folder within it, to a user and group of your choice. Setting permissions automatically means we `chown` the folder and all folder within it, to a user and group of your choice.
However, we only do so when installing or updating an app. However, we only do so when installing or updating an app.
Please be aware that automatically setting ownership/permissions, does mean it overrides your current CHOWN and CHMOD settings. This could break things and yes, it will destroy your system if used carelessly. It's also not wise to enable the automatic permissions on mounted shares from an external system. Please be aware that automatically setting ownership/permissions, does mean it overrides your current CHOWN and CHMOD settings. This could break things and yes, it will destroy your system if used carelessly. It's also not wise to enable the automatic permissions on mounted shares from an external system.
These permission get based on the user and group you enter in the App configuration dialog and default to `568` (the SCALE default Apps user). These permission get based on the user and group you enter in the App configuration dialog and default to `568` (the SCALE default Apps user).
### Depricated Storage systems
##### ix_volumes
ix_volumes, where the default storage option for every TrueCharts App before 21.04ALPHA. They always got created and used unless "hostPath" was checked.
ix_volumes where fully managed by TrueNAS SCALE, they got created and destroyed on demand when creating, updating or editing an App.
But, most importantly, they could be reverted if an upgrade goes wrong. Which makes them an great to use for storing config files.
They are, normally, stored in the following directory:
`/mnt/poolname/ix-applications/releases/releasename/volumes/ix_volumes/`