docs(minio): helmify docs (#32759)

**Description**
<!--
helmify docs
-->
⚒️ 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
- [x] 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._
This commit is contained in:
Boemeltrein
2025-03-02 15:02:49 +01:00
committed by GitHub
parent 45be444098
commit 78377b9443
+10 -23
View File
@@ -2,37 +2,24 @@
title: Installation Notes
---
## TrueNAS SCALE
:::note[Written for]
- Platform: TrueNAS SCALE Cobia 23.10.1
- App Version: 2023.12.23
- Chart Version: 9.1.0
:::
:::caution
When using a PVC the backup data will be stored on the dataset that holds the app data. If minio is used to store backup data to safe guard your application data it is recommended to configure it on a different zpool, this can be done with a hostpath.
There is only one persistence configured in the standard template. Which is used to store the config of minio and is mounted to `/data`.
If you want the backup data on a different PVC/NFS share/.... Configure an extra persistence in your Helm values.
When minio is used to store backup data like your VOLSYNC data for example, make sure this deployment is not on the same server as where all other charts are running.
:::
:::note[Preparation]
1. Create a dataset for the data mount of minio referred to as <minio_data>
2. Set the proper owner and permissions required for the hostpath, 600 is the minimal permission level required
3. Make sure you have DNS setup for all buckets as S3 requires DNS to be set for each bucket. See "Using Ingress and API ingress is recommended"
1. CHMOD 600 is the minimal permission level required for storage
2. Make sure you have DNS setup for all buckets as S3 requires DNS to be set for each bucket. See "Using Ingress and API ingress is recommended"
:::
This is a guide containing the minimal required settings for installation:
This is the minimal required settings for deployment via environment variables:
- Workload->Settings->Containers->Main Container->Image Environment
- `MINIO_ROOT_USER` and `MINIO_ROOT_PASSWORD` represent the username and password used to login to minio
- Storage and Persistence->Integrated Persistent Storage->App Config Storage
- `Type of Storage` set to host path
- `Host Path` select the dataset <minio_data>
- Using Ingress and API ingress is recommended
- Main Ingress (Also the Console) : minio.mydomain.com
- API ingress: bucket_name.minio.mydomain.com (one entry for each bucket)
- `MINIO_ROOT_USER` and `MINIO_ROOT_PASSWORD` represent the username and password used to login to minio.
For detailed information regarding all environment variables, check documention upstream.