chore: sanitise group descriptions
This commit is contained in:
Kjeld Schouten
parent
b624382cad
commit
19dc949738
|
|
@ -1,163 +1,163 @@
|
|||
groups:
|
||||
- name: Image
|
||||
description: |
|
||||
Configured the images to be used for the Chart.<br>
|
||||
It's wise to use "digest pinned" tags and to avoid using "latest"<br>.
|
||||
<br>
|
||||
Checkout the following documentation for more information:<br>
|
||||
- <a target="_blank" href="https://truecharts.org/common/#images">TrueCharts Docs - truecharts.org/common/#images</a><br>
|
||||
Configured the images to be used for the Chart.
|
||||
It's wise to use "digest pinned" tags and to avoid using "latest".
|
||||
|
||||
Checkout the following documentation for more information:
|
||||
- https://truecharts.org/common/#images
|
||||
|
||||
|
||||
- name: General
|
||||
description: |
|
||||
For TrueNAS SCALE We've grouped a number of settings here, that all effact how apps run in general.<br>
|
||||
<br>
|
||||
Checkout the following documentation for more information:<br>
|
||||
- <a target="_blank" href="https://truecharts.org/common/global/">TrueCharts Docs - Global Settings</a><br>
|
||||
- <a target="_blank" href="https://truecharts.org/common/#tz">TrueCharts Docs - TimeZone</a><br>
|
||||
- <a target="_blank" href="https://truecharts.org/common/podoptions/">TrueCharts Docs - Pod Options</a><br>
|
||||
- Image Pull Secrets <br>
|
||||
For TrueNAS SCALE We've grouped a number of settings here, that all effact how apps run in general.
|
||||
|
||||
Checkout the following documentation for more information:
|
||||
- https://truecharts.org/common/global/
|
||||
- https://truecharts.org/common/#tz
|
||||
- https://truecharts.org/common/podoptions/
|
||||
- Image Pull Secrets
|
||||
|
||||
|
||||
- name: Workload
|
||||
description: |
|
||||
These settings configure how the actual Pods and containers are running.<br>
|
||||
Generally, on SCALE, we only expose a limited subset of these settings for the primary workload and container.<br>
|
||||
<br>
|
||||
Checkout the following documentation for more information:<br>
|
||||
- <a target="_blank" href="https://truecharts.org/common/workload/">TrueCharts Docs - Workload</a><br>
|
||||
- <a target="_blank" href="https://truecharts.org/common/container/">TrueCharts Docs - Container</a><br>
|
||||
These settings configure how the actual Pods and containers are running.
|
||||
Generally, on SCALE, we only expose a limited subset of these settings for the primary workload and container.
|
||||
|
||||
Checkout the following documentation for more information:
|
||||
- https://truecharts.org/common/workload/
|
||||
- https://truecharts.org/common/container/
|
||||
|
||||
|
||||
- name: App Configuration
|
||||
description: |
|
||||
Every application has different values that may be required to run or have multiple options that the user may choose to enable or disable to change the behavior of the application.<br>
|
||||
Most options should have a Tooltip (Circled Question Mark) to further describe said option.<br>
|
||||
<br>
|
||||
To find more information, lookup your chart-specific documentation in the <a target="_blank" href="https://truecharts.org/charts/description-list/">TrueCharts Docs - Charts List</a><br>
|
||||
Every application has different values that may be required to run or have multiple options that the user may choose to enable or disable to change the behavior of the application.
|
||||
Most options should have a Tooltip (Circled Question Mark) to further describe said option.
|
||||
|
||||
To find more information, lookup your chart-specific documentation in the Charts List: https://truecharts.org/charts/description-list/
|
||||
|
||||
- name: Services
|
||||
description: |
|
||||
Service and Networking options for any applications are contained here. <br>
|
||||
Some applications may have complicated networking setups with multiple options or some may have no options here at all. <br>
|
||||
<br>
|
||||
Options here include the service and port configurations for the application, and more may be enabled or changed under the Advanced Settings and Show Expert Config boxes.<br>
|
||||
<br>
|
||||
Checkout the following documentation for more information:<br>
|
||||
- <a target="_blank" href="https://truecharts.org/common/service/">TrueCharts Docs - Services</a><br>
|
||||
Service and Networking options for any applications are contained here.
|
||||
Some applications may have complicated networking setups with multiple options or some may have no options here at all.
|
||||
|
||||
Options here include the service and port configurations for the application, and more may be enabled or changed under the Advanced Settings and Show Expert Config boxes.
|
||||
|
||||
Checkout the following documentation for more information:
|
||||
- https://truecharts.org/common/service/
|
||||
|
||||
- name: Networking
|
||||
description: |
|
||||
Contains advanced networking options that are not actively supported by the TrueCharts team.<br>
|
||||
Currently only contains scaleExternalInterfaces.<br>
|
||||
<br>
|
||||
Checkout the following documentation for more information:<br>
|
||||
- <a target="_blank" href="https://truecharts.org/common/scaleexternalinterface/">TrueCharts Docs - External Interfaces</a><br>
|
||||
Contains advanced networking options that are not actively supported by the TrueCharts team.
|
||||
Currently only contains scaleExternalInterfaces.
|
||||
|
||||
Checkout the following documentation for more information:
|
||||
- https://truecharts.org/common/scaleexternalinterface/
|
||||
|
||||
- name: Persistence
|
||||
description: |
|
||||
Many applications will have certain options for storage to be configurable by the user, the main two being PVC and hostpath but may include other types. <br>
|
||||
This storage is called Persistence since it is not deleted upon restart or upgrade of an application.<br>
|
||||
<br>
|
||||
Checkout the following documentation for more information:<br>
|
||||
- <a target="_blank" href="https://truecharts.org/common/persistence/">TrueCharts Docs - Persistence</a><br>
|
||||
- <a target="_blank" href="https://truecharts.org/scale/guides/nfs-share/">TrueCharts Docs - Apps NFS Share Guide</a><br>
|
||||
- <a target="_blank" href="https://truecharts.org/general/faq/#why-pvc-is-recommended-over-hostpath">TrueCharts Docs - FAQ</a><br>
|
||||
Many applications will have certain options for storage to be configurable by the user, the main two being PVC and hostpath but may include other types.
|
||||
This storage is called Persistence since it is not deleted upon restart or upgrade of an application.
|
||||
|
||||
Checkout the following documentation for more information:
|
||||
- https://truecharts.org/common/persistence/
|
||||
- https://truecharts.org/scale/guides/nfs-share/
|
||||
- https://truecharts.org/general/faq/#why-pvc-is-recommended-over-hostpath
|
||||
|
||||
|
||||
- name: Ingress
|
||||
description: |
|
||||
Ingress (more commonly known as Reverse Proxy) settings can be configured here. This is how Kubernetes connects your Applications in containers to FQDNs (fully qualified domain names). <br>
|
||||
If you choose to enable this you must have a "Ingress Provider" aka "Reverse Proxy" installed (We highly advice Traefik: <a target="_blank" href="https://truecharts.org/charts/premium/traefik/)">TrueCharts Docs - Traefik</a> <br>
|
||||
It also requiresa DNS service to actually resolve the DNS name of the FQDN specified.<br>
|
||||
<br>
|
||||
Checkout the following documentation for more information:<br>
|
||||
- <a target="_blank" href="https://truecharts.org/common/ingress/">TrueCharts Docs - Ingress</a><br>
|
||||
Ingress (more commonly known as Reverse Proxy) settings can be configured here. This is how Kubernetes connects your Applications in containers to FQDNs (fully qualified domain names).
|
||||
If you choose to enable this you must have a "Ingress Provider" aka "Reverse Proxy" installed (We highly advice Traefik: https://truecharts.org/charts/premium/traefik/)
|
||||
It also requiresa DNS service to actually resolve the DNS name of the FQDN specified.
|
||||
|
||||
Checkout the following documentation for more information:
|
||||
- https://truecharts.org/common/ingress/
|
||||
|
||||
|
||||
- name: SecurityContext
|
||||
description: |
|
||||
The security settings for each application and/or permissions that each application may have for the files/directories created. <br>
|
||||
Each application will come with predefined permissions but users may want to change certain setting depending on their usage or capabilities. <br>
|
||||
<br>
|
||||
Unless necessary users are advised to keep this section mostly to defaults.<br>
|
||||
<br>
|
||||
Checkout the following documentation for more information:<br>
|
||||
- <a target="_blank" href="https://truecharts.org/common/securitycontext/">TrueCharts Docs - SecurityContext</a><br>
|
||||
The security settings for each application and/or permissions that each application may have for the files/directories created.
|
||||
Each application will come with predefined permissions but users may want to change certain setting depending on their usage or capabilities.
|
||||
|
||||
Unless necessary users are advised to keep this section mostly to defaults.
|
||||
|
||||
Checkout the following documentation for more information:
|
||||
- https://truecharts.org/common/securitycontext/
|
||||
|
||||
|
||||
- name: Resources
|
||||
description: |
|
||||
Resources limits that have been defined by each application are in this section.
|
||||
Most will have a specific default that some users may want to change based on their specific hardware or needs.<br>
|
||||
<br>
|
||||
This also contains the options to mount GPUs or, more precisely, "request" GPU's to be mounted.<br>
|
||||
<br>
|
||||
Checkout the following documentation for more information:<br>
|
||||
- <a target="_blank" href="https://truecharts.org/common/resources/">TrueCharts Docs - Resources</a><br>
|
||||
Most will have a specific default that some users may want to change based on their specific hardware or needs.
|
||||
|
||||
This also contains the options to mount GPUs or, more precisely, "request" GPU's to be mounted.
|
||||
|
||||
Checkout the following documentation for more information:
|
||||
- https://truecharts.org/common/resources/
|
||||
|
||||
- name: Devices
|
||||
description: |
|
||||
These are special "mountpoints" that can be used to mount miscelanious USB and PCI devices using special hostPath mounts.<br>
|
||||
For clearity we've decided to seperate this from persistence on SCALE.<br>
|
||||
<br>
|
||||
Checkout the following documentation for more information:<br>
|
||||
- <a target="_blank" href="https://truecharts.org/common/persistence/device/">TrueCharts Docs - Devices</a><br>
|
||||
- <a target="_blank" href="https://truecharts.org/scale/guides/pci-passthrough/">TrueCharts Docs - PCI Passthrough Guide</a><br>
|
||||
These are special "mountpoints" that can be used to mount miscelanious USB and PCI devices using special hostPath mounts.
|
||||
For clearity we've decided to seperate this from persistence on SCALE.
|
||||
|
||||
Checkout the following documentation for more information:
|
||||
- https://truecharts.org/common/persistence/device/
|
||||
- https://truecharts.org/scale/guides/pci-passthrough/
|
||||
|
||||
- name: Middlewares
|
||||
description: Traefik Middlewares
|
||||
|
||||
- name: StorageClass
|
||||
description: |
|
||||
StorageClasses define where to storage Storage.<br>
|
||||
<br>
|
||||
Checkout the following documentation for more information:<br>
|
||||
StorageClasses define where to storage Storage.
|
||||
|
||||
Checkout the following documentation for more information:
|
||||
|
||||
- name: Metrics
|
||||
description: |
|
||||
Contains options to configure Prometheus metrics for the application.<br>
|
||||
<br>
|
||||
Checkout the following documentation for more information:<br>
|
||||
- <a target="_blank" href="https://truecharts.org/common/metrics/">TrueCharts Docs - Metrics</a><br>
|
||||
Contains options to configure Prometheus metrics for the application.
|
||||
|
||||
Checkout the following documentation for more information:
|
||||
- https://truecharts.org/common/metrics/
|
||||
|
||||
|
||||
- name: Addons
|
||||
description: |
|
||||
Addons that are supplied by the TrueCharts team to add additional capabilities for users to use on top of the application’s defaults. <br>
|
||||
Things included here are VPN addons, Codeserver for editing files inside the application’s container, Netshoot for network troubelshooting, etc. <br>
|
||||
<br>
|
||||
Generally not required for use but may be necessary or usefull at times for specific applications.<br>
|
||||
<br>
|
||||
Checkout the following documentation for more information:<br>
|
||||
- <a target="_blank" href="https://truecharts.org/common/addons/">TrueCharts Docs - Addons</a><br>
|
||||
- <a target="_blank" href="https://truecharts.org/scale/guides/vpn-setup/">TrueCharts Docs - VPN Setup Guide</a><br>
|
||||
Addons that are supplied by the TrueCharts team to add additional capabilities for users to use on top of the application’s defaults.
|
||||
Things included here are VPN addons, Codeserver for editing files inside the application’s container, Netshoot for network troubelshooting, etc.
|
||||
|
||||
Generally not required for use but may be necessary or usefull at times for specific applications.
|
||||
|
||||
Checkout the following documentation for more information:
|
||||
- https://truecharts.org/common/addons/
|
||||
- https://truecharts.org/scale/guides/vpn-setup/
|
||||
|
||||
|
||||
- name: Experimental
|
||||
description: |
|
||||
Experimental Configuration Options<br>
|
||||
Often these are not fully flushed-out, could randomly break or might not work at-all.<br>
|
||||
Experimental Configuration Options
|
||||
Often these are not fully flushed-out, could randomly break or might not work at-all.
|
||||
|
||||
- name: Postgresql
|
||||
description: |
|
||||
For Postgresql we use "CloudNative-PG" as a backend, which has to be installed first.<br>
|
||||
<br>
|
||||
Checkout the following documentation for more information:<br>
|
||||
- <a target="_blank" href="https://truecharts.org/common/cnpg/">TrueCharts Docs - CNPG</a><br>
|
||||
- <a target="_blank" href="https://truecharts.org/scale/guides/sql-export/">TrueCharts Docs - Postgresql Database Export Guide</a><br>
|
||||
- <a target="_blank" href="https://truecharts.org/scale/guides/recover-cnpg/">TrueCharts Docs - Recovering CNPG after reboot</a><br>
|
||||
For Postgresql we use "CloudNative-PG" as a backend, which has to be installed first.
|
||||
|
||||
Checkout the following documentation for more information:
|
||||
- https://truecharts.org/common/cnpg/
|
||||
- https://truecharts.org/scale/guides/sql-export/
|
||||
- https://truecharts.org/scale/guides/recover-cnpg/
|
||||
|
||||
- name: Dependencies
|
||||
description: |
|
||||
contains dependency setting for which we, currently, do not have seperate catagories (yet)<br>
|
||||
contains dependency setting for which we, currently, do not have seperate catagories (yet)
|
||||
|
||||
|
||||
- name: Documentation
|
||||
description: |
|
||||
We added this section to make everyone aware that OpenSource isn't always easy.<br>
|
||||
It doesn't keep existing without signficant ongoing support, so please consider supporting TrueCharts and other OpenSource projects.<br>
|
||||
<br>
|
||||
Before installing, be sure you've followed the <a target="_blank" href="https://truecharts.org/scale/guides/getting-started/">Getting-Started Guide</a><br>
|
||||
We would also advice going over our <a target="_blank" href="https://truecharts.org/scale/guides/scale-intro/">Introduction to TrueNAS SCALE</a><br>
|
||||
We added this section to make everyone aware that OpenSource isn't always easy.
|
||||
It doesn't keep existing without signficant ongoing support, so please consider supporting TrueCharts and other OpenSource projects.
|
||||
|
||||
Before installing, be sure you've followed the https://truecharts.org/scale/guides/getting-started/
|
||||
We would also advice going over our https://truecharts.org/scale/guides/scale-intro/
|
||||
and many of the other documentation pages...
|
||||
|
|
|
|||
Loading…
Reference in New Issue