fa05e82285
**Description** <!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. --> ⚒️ Fixes # <!--(issue)--> **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code - [x] 📜 Documentation Changes **🧪 How Has This Been Tested?** <!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration --> **📃 Notes:** <!-- Please enter any other relevant information here --> **✔️ Checklist:** - [ ] ⚖️ My code follows the style guidelines of this project - [ ] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [x] 📄 I have made changes to the documentation - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [ ] ⬆️ I increased versions for any altered app according to semantic versioning - [ ] I made sure the title starts with `feat(chart-name):`, `fix(chart-name):`, `chore(chart-name):`, `docs(chart-name):` or `fix(docs):` **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._ --------- Signed-off-by: Alfred Göppel <43101280+alfi0812@users.noreply.github.com> Co-authored-by: Kjeld Schouten <info@kjeldschouten.nl>
2.9 KiB
title
| title |
|---|
| Exporting SCALE App config only |
With the removal of kubernetes-based TrueNAS SCALE Apps and the discontinuation of our TrueNAS SCALE App catalog, We understand users want to be looking to move to other solutions. We've had a lot of users request guidance on how to export the SCALE App configuration, so they can copy-paste parts of it into other solutions, such as Docker-Compose or iX-Systems SCALE Apps.
As part of your ClusterTool project, we've, for this usercase, implemented 2 commands to export and clean-up the whole configuration of the Apps as intered in the GUI. Into neatly structured YAML files. From which users can easily copy-paste into, for example, a docker-compose file.
Pre-Migrations Advisory
Prior to migration, we require the following to be done:
DO NOT update to Electric Eel
As soon as you migupdaterated to TrueNAS SCALE 24.10 "Electric Eel", you cannot, in any way, migrate your TrueCharts Apps anymore.
Install ClusterTool
Ensure the Clustertool binary is downloaded into a folder on your TrueNAS SCALE Machine, all exports will be output into this folder.
Note on storage
Storage and data stored within apps is not included with this export. The tool will just provide a clean export of the configuration you entered into the GUI.
For access to PVC-based datastores, we advice the use of HeavyScript instead.
Important note
We do not sanitise the exported/migated configuration from SCALE. We dont, to ensure the data is 100% cleanly exported. Hence it may contain passwords or sensative data.
Exporting SCALE Apps
- Open a Shell, either through SSH or the Web-GUI shell of SCALE
- cd into the folder you downloaded clustertool into
- Run now
./clustertool scale export
This will output a complete dump of the configuration values for your SCALE Apps.
Converting SCALE Apps to easily readableHelm-Release files
The default json is quite hard to read, to make it easier readable, you can use the SCALE migrate function to generate easier readable files. In contrast to the name, this is just a formatting tool and doesn't actually migrate anything itself.
- Open a Shell, either through SSH or the Web-GUI shell of SCALE
- cd into the folder you downloaded clustertool into
- Run
./clustertool scale migrateto convert all exported SCALE Apps to ClusterTool/FluxCD compatible Helm-Releases
This should put a whole lot of "helmrelease.yaml" files, containing the structured App configuration data under "values".
Known Issues
Some application specific settings might be hidden
Some application specific settings might not directly be created by the user, but instead dynamically generated by us on install. Such configuration options will hence, as they are not part of the user-entered configuration, not part of the export either.
TrueNAS SCALE 24.10 "Electric Eel" not supported
Its NOT possible in any way to do the migration after updating to TrueNAS SCALE 24.10 "Electric Eel"