add deprecated website docs pages to archive

.gitignore

@@ -56,3 +56,4 @@ tgz_cache/
 index_cache/
 helm/
 node_modules/
+!archive/website

archive/website/src/content/deprecated/SCALE/SUPPORT.md

@@ -0,0 +1,92 @@
+---
+title: Support Policy
+sidebar:
+  order: 2
+---
+
+## TrueCharts on TrueNAS SCALE
+
+:::danger
+
+TrueNAS SCALE Apps are considered Deprecated. We heavily recommend using a more mature Kubernetes platform such as "TalosOS" instead, and no longer offer an apps/charts catalogue for SCALE users to install. The below docs exist purely as historical references and may be removed at any time.
+
+:::
+
+### Supported Versions of TrueNAS SCALE
+
+| TrueNAS Version    | Branch         | Getting Updates | Accepting Support Tickets | Accepting Bug Reports | Notes                                                                                          |
+| ------------------ | -------------- | --------------- | ------------------------- | --------------------- | ---------------------------------------------------------------------------------------------- |
+| 22.12.4.2 or prior | `master`       | ❌              | ❌                        | ❌                    | SCALE is deprecated |
+| 23.10.2            | `legacy_23.10` | ❌              | ❌                        | ❌                    | SCALE is deprecated |
+| 24.04.X            | `master`       | ❌              | ❌                        | ❌                    | SCALE is deprecated |
+| Alpha/BETA/RC      | `master`       | ❌              | ❌                        | ❌                    | SCALE is deprecated |
+| Nightly            | `master`       | ❌              | ❌                        | ❌                    | SCALE is deprecated |
+
+:::tip
+
+Set aside time for a maintenance window or simple check-in for your SCALE system every week, month or quarter as this can go a long way to helping prevent lengthy amounts of time needing to be spent bringing a SCALE system up to date. SCALE _usually_ has two major version releases each year, so at a minimum ensuring you're prepared for those will help.
+
+:::
+
+## Project Scope
+
+For more info on what to expect from TrueCharts Apps, be sure to also read the [Project Scope documentation](/general/scope).
+
+:::caution[Support Guidelines]
+
+Our [Discord](/s/discord) support (the ticketing system inside #support) is primarily limited to what is covered by our written guides. This includes installing, linking and editing apps. This doesn't mean the actual setup of the application. All #support tickets covered by the staff are done so on a **best effort** basis.
+
+:::
+
+## Unsupported Features
+
+iX-Systems has built a rather crude middleware in-between Apps and the Kubernetes cluster itself. Many of its features have severe design flaws, and they do not have the expertise in-house nor the intention to fix the codebase.
+
+For this reason we do not support a number of features on TrueNAS SCALE Apps and/or have alternative features implemented ourselves. This includes
+
+### Stop Button
+
+**DO NOT** use the iX-provided `Stop` button in the SCALE GUI. Its implementation is severely flawed and only works with Kubernetes objects designed by iX-Systems themselves, leaving your Apps open to being left in a limbo state.
+Instead of the Stop button, use either
+
+- The TrueCharts "Stop-All" feature available in the apps configuration/edit section or
+
+- [HeavyScript](https://github.com/Heavybullets8/heavy_script) with the `-x appname` or `--stop appname` arguments.
+
+### Storage Rollback
+
+While rollback of Kubernetes objects works fine, this is a native feature on normal Helm deployments as well.
+The "include storage" option for rollback on SCALE either does not work at all or breaks some things (like databases).
+
+### Migration to another Pool
+
+While the idea of cross-pool migration is nice, it inherently does not work because it's not Kubernetes aware and only works correctly with a limited subset of Kubernetes objects created by iX-Systems.
+
+Migration certainly does not work with CNPG, our PostgreSQL backend at all.
+Manual steps might be needed to restore systems containing databases.
+
+### SCALE Certificates
+
+There are a lot of issues with SCALE certificates and they are crudely injected into the Kubernetes cluster in ways that are not "normal" when working with Kubernetes.
+We instead rely on `Cert-Manager`, an industry-standard Kubernetes-aware certificate management solution for Kubernetes.
+
+### iX-Volumes
+
+iX-Volumes are a crudely designed "PVC-like" storage solution by iX-Systems, offloading behavior that should normally be handled by PVC storage controllers onto the host system.
+This is not a good way to deal with storage on Kubernetes and might unexpectedly lead to issues.
+
+We use PVC storage, like normal with Kubernetes, instead.
+
+### Backup and Restore
+
+iX-Systems has not officially released backup and restore, and SCALE Apps do not work with normal Kubernetes backup and restore tools like Velero, due to their archaic Kubernetes folder-structure-design.
+[HeavyScript](https://github.com/Heavybullets8/heavy_script) offers an alternative, but we cannot guarantee it works out-of-the-box, at all or with our Apps. But it's the best there is at the moment.
+
+Backup and Restore certainly does not work with CNPG, our PostgreSQL backend at all. Manual steps might be needed to restore systems containing databases.
+
+### TrueNAS GPU Selectors
+
+The GPU selectors have weirdly worded options, confusing many users and heavily rely on the host system to say which GPUs are available or not. This might cause issues with updates, installs, edits etc.
+Kubernetes usually handles GPUs itself, the amount entered is just a request of how many GPUs the applications/container wants assigned and Kubernetes can handle the rest.
+
+Instead we offer our own option, where you can enter the number of specific GPUs you want assigned under "Resources" in the "Limits" section

archive/website/src/content/deprecated/SCALE/guides/add-storage.md

@@ -0,0 +1,74 @@
+---
+title: Adding Storage
+---
+
+:::danger
+
+TrueNAS SCALE Apps are considered Deprecated. We heavily recommend using a more mature Kubernetes platform such as "TalosOS" instead, and no longer offer an apps/charts catalogue for SCALE users to install. The below docs exist purely as historical references and may be removed at any time.
+
+:::
+
+Apps in SCALE rely on several kinds of storage for core data:
+
+- [Persistent Volumes](https://docs.k3s.io/storage) (`PVC`), a specific volume which Kubernetes will not delete (i.e. persist) through upgrades, restarts, and rollbacks of your app/chart.
+- Hostpaths (`hostpath`), a path (/mnt/tank/pool/folder) to a data volume, typically a dataset within a pool on your SCALE installation, or a mounted folder to network attached storage.
+- You can use a folder mapped to the container or memory (`emptyDir`).
+- You can directly link an NFS share (`NFS Share`) to your app storage.
+
+You can choose during app installation to use a PVC to store all of your app's data, or manually assign a hostpath.
+
+**Note:** We only provide support for apps using **PVC** for core app storage, often named "config", but you can always add additional hostpaths for other storage, such as your media.
+
+## Adding additional app storage
+
+Even if an app doesn't let you specify a hostpath in its chart config, the TrueCharts config lets you **add additional app storage** through hostpaths which are linked to a local path on the app (e.g linking `/mnt/tank/pool/folder` to `/media/folder`). This will allow the path on your SCALE installation to be available from your app, assuming permissions are correctly configured.
+
+From your SCALE App's configuration (during or after installation):
+
+1. Scroll down to `Storage and Persistence`
+2. Under `Additional App Storage`, click **Add**
+3. Check the box next to **Automatic Permissions** if you'd like the app to automatically configure permissions to the UID of the container (_default:_ `568`)
+4. Specify the type of storage you'd like to add (typically a `hostpath`)
+5. _(For hostpaths)_ Specify the path on your SCALE installation you'd like to mount to the container (e.g. `/mnt/tank/pool/folder`)
+6. _(For hostpaths)_ Specify the path on you App you'd like to link to the hostpath (e.g. `/media/folder`)
+7. Click **Save** to re-create your App with the specified additional app storage.
+
+## Permissions
+
+Permissions apply for app storage and are based on the app's fsGroup which you can configure during app installation. By default most apps will set this to the `apps` group (568).
+
+Apps also have a **Automatic Permissions** option for app storage and additional app storage. If you enable automatic permissions, the app will attempt to `chown` the hostpath and all subfolders within the hostpath during deployment. **Note:** This may not work for large volumes.
+
+- Be careful with automatic permissions for shared datasets, especially if folders or subfolders carry different user/group owners. Be sure that your permission changes will not break other apps/services.
+- The `Automatic Permissions` command for an app will only apply upon the installation or update of an app.
+- It's not typically recommended to use automatic permissions for mounted shares (e.g. NFS shares on other external systems) since it will rewrite permissions for those folders which may be shared with multiple systems.
+- You can always add the apps fsGroup (_default:_ `568`)
+- ACLs are not recommended or supported for app storage as many apps have issues with accessing data managed by an ACL.
+
+You can learn more about permissions and ACLs in the [TrueNAS SCALE Docs](https://www.truenas.com/docs/scale/scaleuireference/storage/datasets/editaclscreens/).
+
+## Host Path Validation Safety
+
+Starting with SCALE Bluefin (22.12), there's a new safety check on apps called **Host Path Safety Checks** located in your SCALE installation's Apps **Advanced Settings** (the same place as your k3s network, GPU, and other settings). This check is intended to ensure datasets used by your apps (e.g. media datasets) are not in use by a network share (e.g. SMB, NFS, CIFS). We require this for security (Protect the system from container escape vulnerabilities using hostPath) and reliability (Prevent multiple services (shares for example) from using the same dataset.) reasons. **You can disable these checks, but it may lead to issues with your Apps depending on your permissions configuration**.
+
+To disable Host Path Safety Checks:
+
+1. From the SCALE Apps page, click **Settings** > **Advanced Settings**
+2. Uncheck **Enable Host Path Safety Checks**
+3. Click **Save** and wait for your apps to re-deploy.
+
+Alternatively, you can add your additional app storage [using the NFS share option](/deprecated/scale/guides/nfs-share) instead of hostpath without violating Host Path Safety Checks.
+
+**If you choose to disable your host path safety checks, we cannot provide support for any issues related to storage or permission.** When opening a TrueCharts support ticket related to storage issues, you must show that host path safety checks are still enabled in order for us to help.
+
+## Video Guide
+
+<iframe width="560" height="315" src="https://www.youtube.com/embed/aktv1r-KRI0" title="YouTube video player" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowFullScreen></iframe>
+
+## Notes
+
+- When using hostpaths for config data and other app data, you typically want to create a dataset in your pool for each app so you can individually configure and manage the data and permissions.
+- Using hostpath instead of PVC can also cause issues with rollbacks if the container isn't able to update config files and other data during the rollback.
+- If you have legacy (i.e. FreeNAS, TrueNAS or early SCALE) datasets, you may typically see the media fsGroup or PUID (`8675309`) which you'll want to adjust your permission to work with apps running under the apps PUID (`568`).
+- Apps which violate Host Path Safety Checks will not finish deploying. In other words, if you have an app deploying which includes a hostpath shared with an SMB/NFS share, you'll see errors in the App's events during deployment.
+- Creating separate datasets in your pool will let you independently manage permissions each for parent or child dataset.

archive/website/src/content/deprecated/SCALE/guides/backup-restore.md

@@ -0,0 +1,127 @@
+---
+title: Backup, Migrations and Restoring
+sidebar:
+  order: 15
+---
+
+:::danger
+
+TrueNAS SCALE Apps are considered Deprecated. We heavily recommend using a more mature Kubernetes platform such as "TalosOS" instead, and no longer offer an apps/charts catalogue for SCALE users to install. The below docs exist purely as historical references and may be removed at any time.
+
+:::
+
+:::caution[The below is a work in progress]
+
+We've recently completely reworked the way we handle backups, moving away from platform-specific solutions to a "one size fits everyone" system using VolSync and CNPG backups. We're also making it known that the prior version of this guide will **not** work on TrueNAS SCALE 24.04.X "DragonFish". This updated guide has been written with the best efforts of the staff and tested as best possible. We are not responsible if it doesn't work for every scenario or user situation.
+
+:::
+
+## Requirements
+
+### System Apps
+
+As this is a SCALE-specific guide, we expect users to have fully followed the SCALE quick-start [guide](/deprecated/scale) and hence have installed _all_ [operators](/deprecated/scale/#minimal-getting-started-setup-with-scale) from the `system` train as listed there. This includes `VolSync`, which depends on `Prometheus-Operator`, so ensure you have installed `Prometheus-Operator` prior to installing `VolSync`.
+
+### S3 Provider Setup
+
+## Backup Configuration
+
+:::caution[Credentials]
+
+Do not add the credentials inside the VolSync chart. This won't work as they need to be added to each chart individually.
+
+:::
+
+Enter your S3 credentials under the `credentials` section in each app you want to enable backup/restore functionality on.
+
+![S3 Credentials](./img/s3_scale_credentials.png)
+
+### PVC Backups
+
+PVC data can be easily backed up to S3 storage by using our integrated VolSync support. For each individual app, the `VolSync Destination (Restore)` option _must_ set on creation of the app by doing the following:
+
+1. Add `VolSync` to each persistence object you want synced as below
+
+![S3 Scale VolSync ](./img/s3_scale_pvc_backup.png)
+
+2. Add the name you gave to the S3 credentials earlier, under the `credentials` section of VolumeSnapshots
+
+3. Enable the `VolSync Source (backup)` and/or `VolSync Destination Restore)` options as desired
+
+4. Confirm the data is being sent to your S3 host after ~5 minutes
+
+:::note[Bucket Creation]
+
+You do not have to manually create the bucket beforehand, although this is recommended to ensure the bucket's name is available beforehand.
+
+:::
+
+### CNPG Database Backups
+
+CNPG-backed PostgreSQL databases have their own S3 backup system. We have integrated it in such a way that they can safely share a bucket with the above PVC backups.
+
+For each app:
+
+1. Add CNPG backups to each database you want backed up like shown below
+
+2. Add the name you gave to the S3 credentials earlier, under the `credentials` section
+
+3. Confirm the data is being sent to your S3 host after ~5 minutes
+
+4. We advise you to set the "mode" to `restore`, this should prevent the app starting with an empty database upon restore.
+
+![S3 Scale CNPG ](./img/s3_scale_cnpg_backup.png)
+
+#### Exporting App Configuration
+
+To be done. This section will contain information to export your App configuration so it can be imported later.
+
+## Restoration Configuration
+
+:::note[SCALE Restore Functionality]
+
+As mentioned in our news post, this new restore functionality isn't yet functional on TrueNAS SCALE due to an [upstream bug](https://github.com/openebs/zfs-localpv/issues/536) with OpenEBS. We've submitted a bug report and will update this page once resolved.
+
+:::
+
+### Recreating an App
+
+When you've no exported app configuration, you can remake the app while also restoring your PVC and CNPG backups using the steps as follows:
+
+1. Ensure the app name matches the name of the app previously backed up
+
+2. Enter the same S3 credentials from earlier, under the `credentials` section
+
+3. Preferably ensure all other configuration options are set precisely the same as the last time you used the app, to ensure compatibility
+
+### PVC data Restoration
+
+PVC data restoration will happen automatically before the app starts. Please be aware this can take a while depending on the size of the backup, your connection speed, etc.
+
+### CNPG Database Restore
+
+Before CNPG will correctly restore the database, the following modifications need to be done after recreating or importing the app configuration:
+
+1. Ensure you've setup CNPG backups as well as restore as it was previously
+
+2. Ensure the "mode" is set to `recovery`
+
+3. Set "revision" on your restore to match the previous **revision** setting on your backup settings
+
+4. Increase the **revision** on your backup setting by 1 (or set to 1 if previously empty)
+
+#### Importing App Configuration
+
+To be done. This section will contain information to import your App configuration so you do not have to manually recreate it.
+
+## Total System Restore and Migration to New System
+
+When on a completely new system, you can easily restore using the above steps with the following caveats:
+
+- On a non-SCALE system, the PVC backend needs to support snapshots
+- The apps need to be called **exactly** the same as they were before, preferably using a previously-exported config
+- If you've any non-PVC storage attached, be sure that this is still available or apps won't start until this is resolved
+
+## Video Guide
+
+TBD

archive/website/src/content/deprecated/SCALE/guides/cnpg-migration-guide.md

@@ -0,0 +1,117 @@
+---
+title: "Postgresql Export/Import"
+---
+
+:::danger
+
+TrueNAS SCALE Apps are considered Deprecated. We heavily recommend using a more mature Kubernetes platform such as "TalosOS" instead, and no longer offer an apps/charts catalogue for SCALE users to install. The below docs exist purely as historical references and may be removed at any time.
+
+:::
+
+This guide will assist you in migrating to the new CNPG operator.
+
+## Prerequisites
+
+1. Install PGAdmin from the TrueCharts Stable train.
+
+2. Setup the [tcdbinfo.sh script](/deprecated/scale/guides/sql-export#how-to-list-database-login-info-for-truecharts-apps)
+
+3. Add the system train to your TrueCharts Catalog
+
+![cnpg-add-system-train](./img/Dragonfish-Storage5b.png)
+
+## Acquire Database Credentials
+
+1. Run tcdbinfo.sh to get a list of database credentials.
+
+```bash
+bash tcdbinfo.sh
+```
+
+![cnpg-info](./img/cnpg-info.png)
+
+## Connect to CNPG Databases in PGAdmin
+
+1. Click Add Server.
+
+![cnpg-pgadmin-add](./img/cnpg-pgadmin-add.png)
+
+2. Choose a name for the database, this will only be used to help you identify it.
+
+![cnpg-pgadmin-name](./img/cnpg-pgadmin-name.png)
+
+3. Enter database server and credentials previously acquired from tcdbinfo.sh script and save.
+
+![cnpg-pgadmin-creds](./img/cnpg-pgadmin-creds.png)
+
+## Backup CNPG Databases
+
+1. Right click on the database and select backup as shown below.
+
+![cnpg-pgadmin-backup](./img/cnpg-pgadmin-backup.png)
+
+2. Choose a name for the database backup and click backup.
+
+![cnpg-pgadmin-save](./img/cnpg-pgadmin-save.png)
+
+## Remove Old CNPG
+
+1. Run the following command in system shell as root.
+
+```bash
+k3s kubectl delete --grace-period 30 --v=4 -k https://github.com/truecharts/manifests/delete2
+```
+
+## Install cloudnative-pg
+
+1. Install cloudnative-pg from the system train, wait for it to go ACTIVE.
+
+## Prepare CNPG Apps
+
+1. Edit the app config of the CNPG application (home assistant in this example) and save the configuration without making any changes.
+
+2. Wait for all pods to be created and app to be Active. This may take a few minutes. In this example Home Assistant will show ACTIVE 3/3 when its ready.
+
+3. Get the name of the app deploy.
+
+```bash
+k3s kubectl get deploy -n ix-<app>
+```
+
+4. Stop the main pod of the app you are migrating.
+
+```bash
+k3s kubectl scale deploy <app> -n ix-<app> --replicas=0
+```
+
+![cnpg-scaled](./img/cnpg-scaled.png)
+
+## Restore CNPG Databases
+
+1. Right click on the database and select restore as shown below in PGAdmin.
+
+![cnpg-pgadmin-restore](./img/cnpg-pgadmin-restore.png)
+
+2. Select the database backup you created previously.
+
+![cnpg-pgadmin-restore2](./img/cnpg-pgadmin-restore2.png)
+
+3. Configure Data/Objects as shown below.
+
+![cnpg-pgadmin-restore3](./img/cnpg-pgadmin-restore3.png)
+
+4. Configure Options as shown below and click restore.
+
+![cnpg-pgadmin-restore4](./img/cnpg-pgadmin-restore4.png)
+
+:::caution PGAdmin Error
+
+PGAdmin may display an error during the restore process. This is known to occur and may be ignored if the app functions properly.
+
+:::
+
+5. Start the main pod of the app you are migrating.
+
+```bash
+k3s kubectl scale deploy <app> -n ix-<app> --replicas=1
+```

archive/website/src/content/deprecated/SCALE/guides/dataset.md

@@ -0,0 +1,91 @@
+---
+title: Dataset and Share Setup Guide
+---
+
+:::danger
+
+TrueNAS SCALE Apps are considered Deprecated. We heavily recommend using a more mature Kubernetes platform such as "TalosOS" instead, and no longer offer an apps/charts catalogue for SCALE users to install. The below docs exist purely as historical references and may be removed at any time.
+
+:::
+
+This guide provides the recommended setup for dataset permissions, shares and application data storage.
+
+## Dataset Permissions
+
+TrueCharts applications are designed to use the `apps` (568) user for data permissions. Configure your dataset permissions as shown below to allows applications access.
+
+:::tip[ACL]
+
+If your existing dataset shows `Edit ACL` then you need to `Strip ACL` before continuing.
+
+:::
+
+![data-perms](./img/data-perms.png)
+
+## SMB Access
+
+For SMB access you will need to create a user(s) that are members of the `apps` group and modify the default SMB settings.
+
+### SMB User
+
+Create a user and assign it to the `apps` group under `Auxiliary Groups` as shown below.
+
+![user-groups](./img/user-groups.png)
+
+### SMB Share
+
+Create an SMB Share as shown below. All settings should remain default.
+
+:::caution[ACL]
+
+After saving SMB settings TrueNAS Scale will ask if you want to `Configure ACL`. Do **NOT** as this will overwrite the previously configured permissions. You can select `Cancel`, the SMB Share will still be configured.
+
+:::
+
+![share-smb](./img/share-smb-cobia.png)
+
+#### Setup SMB Share Auxiliary Parameters
+
+With the release of Cobia the `Auxiliary Parameters` has been removed from the WebUI. The below will guide you through the use of API calls and the system shell to add the correct parameters.
+
+Open the SCALE System GUI Shell and enter the following command:
+
+```bash
+midclt call sharing.smb.query | jq
+```
+
+![smb-cli1](./img/smb-cli1.png)
+
+Take note of the id(s) you wish to setup.
+
+Enter the following command, make sure to replace `<id>` with the id from above.
+
+```bash
+midclt call sharing.smb.update <id> '{"auxsmbconf": "force user = apps\nforce group = apps"}'
+```
+
+The output should include the following if it was done correctly:
+
+![smb-cli2](./img/smb-cli2.png)
+
+Repeat for any additional SMB Shares.
+
+## NFS Share
+
+Create an NFS Share which will be used for applications to access the dataset. Configure an NFS Share as shown below. You will need to click `Advanced Options` to set `Maproot User` to `root`.
+
+![nfs-share-cobia](./img/nfs-share-cobia.png)
+
+## App Storage
+
+For most applications data access will be configured under `Additional App Storage`.
+
+:::caution[APP CONFIG STORAGE]
+
+NFS should **NOT** be used for `App Config Storage`. This should be left on the default of PVC.
+
+:::
+
+Configure `Additional App Storage` as shown below. In some applications data storage is part of the application configuration, in those cases you would still configure NFS but not need to setup a `Mount Path`.
+
+![app-storage](./img/app-storage.png)