docs(Minio): Add installation notes (#17049)

**Description**
- Adds installation notes
-- Adds a warning, PVC is stored on apps storage, this is a easily
overlooked risk
-- Adds version information the guide is based on
-- Adds preparation steps
-- Adds minimal installation notes, including hostpath example
-- Adds information on domain requirement for S3
-- Adds ingress example, including API

⚒️ 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

**🧪 How Has This Been Tested?**
Documentation only, created based on discord thread:
https://discord.com/channels/830763548678291466/1193205734729597030

Copied added content to website repository manually and ran yarn to
verify.

**📃 Notes:**
<!-- Please enter any other relevant information here -->

**✔️ Checklist:**

- [ ] ⚖️ My code follows the style guidelines of this project
- [x] 👀 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 corresponding changes to the documentation
- [x] ⚠️ My changes generate no new warnings
- [ ] 🧪 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

** App addition**

If this PR is an app addition please make sure you have done the
following.

- [ ] 🪞 I have opened a PR on
[truecharts/containers](https://github.com/truecharts/containers) adding
the container to TrueCharts mirror repo.
- [ ] 🖼️ 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: StevenMcElligott <89483932+StevenMcElligott@users.noreply.github.com>
Signed-off-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>
Co-authored-by: StevenMcElligott <89483932+StevenMcElligott@users.noreply.github.com>
Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>
This commit is contained in:
nemesis1982 2024-01-12 22:01:44 +01:00 committed by GitHub
parent 8060a3bf8c
commit f8e4b1c1a1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 38 additions and 0 deletions

View File

@ -0,0 +1,38 @@
---
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
:::
:::warning 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.
:::
:::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"
:::
This is a guide containing the minimal required settings for installation:
- 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)