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

62 lines
2.4 KiB
Markdown
Raw Permalink Normal View History

Commit daily changes Signed-off-by: TrueCharts-Bot <bot@truecharts.org>
2024-03-31 00:10:19 +00:00
---
title: README
---
## General Info
Chore: rework SCALE catagories/groups to match helm and remove deprecated charts (#21111) **Description** We want to improve the meager-at-best descriptions for the option groups/catagories on SCALE. They should also match the naming scheme of Helm/Kubernetes. With those things combined, we can then link users to the actual common docs for more indepth info on each available option. Saving us needlessly duplicated docs that need to be maintained and giving more indepth information to users. Having naming schemes that match *actual* kubernetes, also makes it easier for users to migrate to a true kubernetes platform in the future. **⚙️ Type of change** - [x] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [x] 🔃 Refactor of current code **🧪 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 - [ ] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ 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 - [ ] I made sure the title starts with `feat(chart-name):`, `fix(chart-name):` or `chore(chart-name):` **➕ 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: Kjeld Schouten <kjeld@schouten-lebbing.nl>
2024-04-21 12:31:23 +00:00
TrueCharts can be installed as both _normal_ Helm Charts or as TrueNAS SCALE Apps.
Both solutions are fully supported, but we heavily advice the use of normal Helm Charts where possible
Commit daily changes Signed-off-by: TrueCharts-Bot <bot@truecharts.org>
2024-03-31 00:10:19 +00:00
Chore: rework SCALE catagories/groups to match helm and remove deprecated charts (#21111) **Description** We want to improve the meager-at-best descriptions for the option groups/catagories on SCALE. They should also match the naming scheme of Helm/Kubernetes. With those things combined, we can then link users to the actual common docs for more indepth info on each available option. Saving us needlessly duplicated docs that need to be maintained and giving more indepth information to users. Having naming schemes that match *actual* kubernetes, also makes it easier for users to migrate to a true kubernetes platform in the future. **⚙️ Type of change** - [x] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [x] 🔃 Refactor of current code **🧪 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 - [ ] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ 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 - [ ] I made sure the title starts with `feat(chart-name):`, `fix(chart-name):` or `chore(chart-name):` **➕ 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: Kjeld Schouten <kjeld@schouten-lebbing.nl>
2024-04-21 12:31:23 +00:00
For more information about this Chart, please check the docs on the TrueCharts [website](https://truecharts.org/charts/incubator/peppermint)
Commit daily changes Signed-off-by: TrueCharts-Bot <bot@truecharts.org>
2024-03-31 00:10:19 +00:00
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/charts/issues/new/choose)**
Chore: rework SCALE catagories/groups to match helm and remove deprecated charts (#21111) **Description** We want to improve the meager-at-best descriptions for the option groups/catagories on SCALE. They should also match the naming scheme of Helm/Kubernetes. With those things combined, we can then link users to the actual common docs for more indepth info on each available option. Saving us needlessly duplicated docs that need to be maintained and giving more indepth information to users. Having naming schemes that match *actual* kubernetes, also makes it easier for users to migrate to a true kubernetes platform in the future. **⚙️ Type of change** - [x] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [x] 🔃 Refactor of current code **🧪 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 - [ ] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ 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 - [ ] I made sure the title starts with `feat(chart-name):`, `fix(chart-name):` or `chore(chart-name):` **➕ 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: Kjeld Schouten <kjeld@schouten-lebbing.nl>
2024-04-21 12:31:23 +00:00
## Installation
### Helm-Chart installation
To install TrueCharts Helm charts using Helm, you can use our OCI Repository.
Commit daily changes Signed-off-by: TrueCharts-Bot <bot@truecharts.org>
2024-07-06 00:14:19 +00:00
`helm install mychart oci://tccr.io/truecharts/peppermint`
Chore: rework SCALE catagories/groups to match helm and remove deprecated charts (#21111) **Description** We want to improve the meager-at-best descriptions for the option groups/catagories on SCALE. They should also match the naming scheme of Helm/Kubernetes. With those things combined, we can then link users to the actual common docs for more indepth info on each available option. Saving us needlessly duplicated docs that need to be maintained and giving more indepth information to users. Having naming schemes that match *actual* kubernetes, also makes it easier for users to migrate to a true kubernetes platform in the future. **⚙️ Type of change** - [x] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [x] 🔃 Refactor of current code **🧪 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 - [ ] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ 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 - [ ] I made sure the title starts with `feat(chart-name):`, `fix(chart-name):` or `chore(chart-name):` **➕ 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: Kjeld Schouten <kjeld@schouten-lebbing.nl>
2024-04-21 12:31:23 +00:00
Commit daily changes Signed-off-by: TrueCharts-Bot <bot@truecharts.org>
2024-06-10 00:15:07 +00:00
For more information on how to install TrueCharts Helm charts, checkout the [instructions on the website](/guides)
Chore: rework SCALE catagories/groups to match helm and remove deprecated charts (#21111) **Description** We want to improve the meager-at-best descriptions for the option groups/catagories on SCALE. They should also match the naming scheme of Helm/Kubernetes. With those things combined, we can then link users to the actual common docs for more indepth info on each available option. Saving us needlessly duplicated docs that need to be maintained and giving more indepth information to users. Having naming schemes that match *actual* kubernetes, also makes it easier for users to migrate to a true kubernetes platform in the future. **⚙️ Type of change** - [x] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [x] 🔃 Refactor of current code **🧪 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 - [ ] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ 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 - [ ] I made sure the title starts with `feat(chart-name):`, `fix(chart-name):` or `chore(chart-name):` **➕ 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: Kjeld Schouten <kjeld@schouten-lebbing.nl>
2024-04-21 12:31:23 +00:00
### TrueNAS SCALE Apps
Commit daily changes Signed-off-by: TrueCharts-Bot <bot@truecharts.org>
2024-06-10 00:15:07 +00:00
For more information on how to use TrueCharts as TrueNAS SCALE Apps, please checkout the [quick-start guides for TrueNAS SCALE](/deprecated/scale).
Commit daily changes Signed-off-by: TrueCharts-Bot <bot@truecharts.org>
2024-05-26 00:16:57 +00:00
## Chart Specific Guides and information
All our charts have dedicated documentation pages.
The documentation for this chart can be found here:
https://truecharts.org/charts/incubator/peppermint
Chore: rework SCALE catagories/groups to match helm and remove deprecated charts (#21111) **Description** We want to improve the meager-at-best descriptions for the option groups/catagories on SCALE. They should also match the naming scheme of Helm/Kubernetes. With those things combined, we can then link users to the actual common docs for more indepth info on each available option. Saving us needlessly duplicated docs that need to be maintained and giving more indepth information to users. Having naming schemes that match *actual* kubernetes, also makes it easier for users to migrate to a true kubernetes platform in the future. **⚙️ Type of change** - [x] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [x] 🔃 Refactor of current code **🧪 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 - [ ] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ 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 - [ ] I made sure the title starts with `feat(chart-name):`, `fix(chart-name):` or `chore(chart-name):` **➕ 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: Kjeld Schouten <kjeld@schouten-lebbing.nl>
2024-04-21 12:31:23 +00:00
## Configuration Options
Commit daily changes Signed-off-by: TrueCharts-Bot <bot@truecharts.org>
2024-05-26 00:16:57 +00:00
Please note: For TrueNAS SCALE, only options available in the GUI are supported.
Hence most of these docs do not apply to TrueNAS SCALE
Chore: rework SCALE catagories/groups to match helm and remove deprecated charts (#21111) **Description** We want to improve the meager-at-best descriptions for the option groups/catagories on SCALE. They should also match the naming scheme of Helm/Kubernetes. With those things combined, we can then link users to the actual common docs for more indepth info on each available option. Saving us needlessly duplicated docs that need to be maintained and giving more indepth information to users. Having naming schemes that match *actual* kubernetes, also makes it easier for users to migrate to a true kubernetes platform in the future. **⚙️ Type of change** - [x] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [x] 🔃 Refactor of current code **🧪 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 - [ ] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ 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 - [ ] I made sure the title starts with `feat(chart-name):`, `fix(chart-name):` or `chore(chart-name):` **➕ 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: Kjeld Schouten <kjeld@schouten-lebbing.nl>
2024-04-21 12:31:23 +00:00
To view the chart specific options, please view Values.yaml included in the chart.
Commit daily changes Signed-off-by: TrueCharts-Bot <bot@truecharts.org>
2024-07-06 00:14:19 +00:00
The most recent version of which, is available here: https://github.com/truecharts/charts/blob/master/charts/incubator/peppermint/values.yaml
Chore: rework SCALE catagories/groups to match helm and remove deprecated charts (#21111) **Description** We want to improve the meager-at-best descriptions for the option groups/catagories on SCALE. They should also match the naming scheme of Helm/Kubernetes. With those things combined, we can then link users to the actual common docs for more indepth info on each available option. Saving us needlessly duplicated docs that need to be maintained and giving more indepth information to users. Having naming schemes that match *actual* kubernetes, also makes it easier for users to migrate to a true kubernetes platform in the future. **⚙️ Type of change** - [x] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [x] 🔃 Refactor of current code **🧪 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 - [ ] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ 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 - [ ] I made sure the title starts with `feat(chart-name):`, `fix(chart-name):` or `chore(chart-name):` **➕ 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: Kjeld Schouten <kjeld@schouten-lebbing.nl>
2024-04-21 12:31:23 +00:00
All our Charts use a shared "common" library chart that contains most of the templating and options.
Commit daily changes Signed-off-by: TrueCharts-Bot <bot@truecharts.org>
2024-06-10 00:15:07 +00:00
For the complete overview of all available options, please checkout the documentation for them on the [common docs on our website](/common)
Chore: rework SCALE catagories/groups to match helm and remove deprecated charts (#21111) **Description** We want to improve the meager-at-best descriptions for the option groups/catagories on SCALE. They should also match the naming scheme of Helm/Kubernetes. With those things combined, we can then link users to the actual common docs for more indepth info on each available option. Saving us needlessly duplicated docs that need to be maintained and giving more indepth information to users. Having naming schemes that match *actual* kubernetes, also makes it easier for users to migrate to a true kubernetes platform in the future. **⚙️ Type of change** - [x] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [x] 🔃 Refactor of current code **🧪 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 - [ ] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ 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 - [ ] I made sure the title starts with `feat(chart-name):`, `fix(chart-name):` or `chore(chart-name):` **➕ 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: Kjeld Schouten <kjeld@schouten-lebbing.nl>
2024-04-21 12:31:23 +00:00
Commit daily changes Signed-off-by: TrueCharts-Bot <bot@truecharts.org>
2024-05-26 00:16:57 +00:00
For information about the common chart and all defaults included with it, please review its values.yaml file available here: https://github.com/truecharts/library-charts/blob/main/library/common/values.yaml
Chore: rework SCALE catagories/groups to match helm and remove deprecated charts (#21111) **Description** We want to improve the meager-at-best descriptions for the option groups/catagories on SCALE. They should also match the naming scheme of Helm/Kubernetes. With those things combined, we can then link users to the actual common docs for more indepth info on each available option. Saving us needlessly duplicated docs that need to be maintained and giving more indepth information to users. Having naming schemes that match *actual* kubernetes, also makes it easier for users to migrate to a true kubernetes platform in the future. **⚙️ Type of change** - [x] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [x] 🔃 Refactor of current code **🧪 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 - [ ] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ 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 - [ ] I made sure the title starts with `feat(chart-name):`, `fix(chart-name):` or `chore(chart-name):` **➕ 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: Kjeld Schouten <kjeld@schouten-lebbing.nl>
2024-04-21 12:31:23 +00:00
Commit daily changes Signed-off-by: TrueCharts-Bot <bot@truecharts.org>
2024-03-31 00:10:19 +00:00
## Support
- See the [Website](https://truecharts.org)
- Check our [Discord](https://discord.gg/tVsPTHWTtr)
- Open a [issue](https://github.com/truecharts/charts/issues/new/choose)
---
## Sponsor TrueCharts
TrueCharts can only exist due to the incredible effort of our staff.
Commit daily changes Signed-off-by: TrueCharts-Bot <bot@truecharts.org>
2024-06-10 00:15:07 +00:00
Please consider making a [donation](/general/sponsor) or contributing back to the project any way you can!
Commit daily changes Signed-off-by: TrueCharts-Bot <bot@truecharts.org>
2024-03-31 00:10:19 +00:00
_All Rights Reserved - The TrueCharts Project_