3840 lines
164 KiB
YAML
Executable File
3840 lines
164 KiB
YAML
Executable File
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>
|
||
|
||
|
||
- 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>
|
||
|
||
|
||
- 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>
|
||
|
||
|
||
- 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>
|
||
|
||
- 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>
|
||
|
||
- 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>
|
||
|
||
- 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>
|
||
|
||
|
||
- 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>
|
||
|
||
|
||
- 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>
|
||
|
||
|
||
- 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>
|
||
|
||
- 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>
|
||
|
||
- name: Middlewares
|
||
description: Traefik Middlewares
|
||
|
||
- name: StorageClass
|
||
description: |
|
||
StorageClasses define where to storage Storage.<br>
|
||
<br>
|
||
Checkout the following documentation for more information:<br>
|
||
|
||
- 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>
|
||
|
||
|
||
- 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>
|
||
|
||
|
||
- name: Experimental
|
||
description: |
|
||
Experimental Configuration Options<br>
|
||
Often these are not fully flushed-out, could randomly break or might not work at-all.<br>
|
||
|
||
- 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>
|
||
|
||
- name: Dependencies
|
||
description: |
|
||
contains dependency setting for which we, currently, do not have seperate catagories (yet)<br>
|
||
|
||
|
||
- 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>
|
||
and many of the other documentation pages...
|
||
portals:
|
||
open:
|
||
protocols:
|
||
- "$kubernetes-resource_configmap_tcportal-open_protocol"
|
||
host:
|
||
- "$kubernetes-resource_configmap_tcportal-open_host"
|
||
ports:
|
||
- "$kubernetes-resource_configmap_tcportal-open_port"
|
||
|
||
questions:
|
||
- variable: global
|
||
group: General
|
||
label: "Global Settings"
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: stopAll
|
||
label: Stop All
|
||
description: "Stops All Running pods and hibernates cnpg"
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
|
||
- variable: workload
|
||
group: "Workload"
|
||
label: ""
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: main
|
||
label: ""
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
|
||
- variable: type
|
||
label: Type (Advanced)
|
||
schema:
|
||
type: string
|
||
default: Deployment
|
||
enum:
|
||
- value: Deployment
|
||
description: Deployment
|
||
- value: DaemonSet
|
||
description: DaemonSet
|
||
|
||
- variable: replicas
|
||
label: Replicas (Advanced)
|
||
description: Set the number of Replicas
|
||
schema:
|
||
type: int
|
||
show_if: [["type", "!=", "DaemonSet"]]
|
||
default: 1
|
||
|
||
- variable: podSpec
|
||
label: ""
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: containers
|
||
label: Containers
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
|
||
- variable: main
|
||
label: Main Container
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
|
||
- variable: envList
|
||
label: Extra Environment Variables
|
||
description: "Please be aware that some variables are set in the background, adding duplicates here might cause issues or prevent the app from starting..."
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: envItem
|
||
label: Environment Variable
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: name
|
||
label: Name
|
||
schema:
|
||
type: string
|
||
- variable: value
|
||
label: Value
|
||
schema:
|
||
type: string
|
||
- variable: extraArgs
|
||
label: Extra Args
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: arg
|
||
label: Arg
|
||
schema:
|
||
type: string
|
||
|
||
- variable: advanced
|
||
label: Show Advanced Settings
|
||
description: Advanced settings are not covered by TrueCharts Support
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
show_subquestions_if: true
|
||
subquestions:
|
||
- variable: command
|
||
label: Command
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: param
|
||
label: Param
|
||
schema:
|
||
type: string
|
||
|
||
- variable: webUI
|
||
group: App Configuration
|
||
label: WebUI Configuration
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: Enable Web UI
|
||
description: Enables Web UI
|
||
schema:
|
||
type: boolean
|
||
default: true
|
||
- variable: apiURL
|
||
label: API URL
|
||
description: API URL for webUI, including port. Only used when not using ingress
|
||
schema:
|
||
type: string
|
||
default: "http://127.0.0.1:4000"
|
||
- variable: overrideDefaults
|
||
group: App Configuration
|
||
label: Override Default Upstreams
|
||
description: Overrides the predefined DNS server upstream list
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
show_subquestions_if: true
|
||
subquestions:
|
||
- variable: defaultUpstreams
|
||
label: Default Upstreams
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: upstreamEntry
|
||
label: Upstream Entry
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
- variable: upstreams
|
||
group: App Configuration
|
||
label: Upstreams Groups
|
||
description: Refer to
|
||
<br /><a href="https://0xerr0r.github.io/blocky/configuration/#upstream-configuration" target="_blank" rel="noopener noreferrer">https://0xerr0r.github.io/blocky/configuration/#upstream-configuration</a>
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: upstreamsGroupEntry
|
||
label: Upstreams Group Entry
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: name
|
||
label: Group Name
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
- variable: upstreams
|
||
label: Upstreams
|
||
schema:
|
||
type: list
|
||
required: true
|
||
default: []
|
||
items:
|
||
- variable: upstreamEntry
|
||
label: upstream Entry
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
- variable: bootstrapDns
|
||
group: App Configuration
|
||
label: Bootstrap DNS
|
||
description: Used to resolve upstream DoH and DoT servers that are specified as hostnames.
|
||
<br />Refer to <a href="https://0xerr0r.github.io/blocky/configuration/#bootstrap-dns-configuration" target="_blank" rel="noopener noreferrer">https://0xerr0r.github.io/blocky/configuration/#bootstrap-dns-configuration</a>
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: upstream
|
||
label: Upstream
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: ips
|
||
label: IPs
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: ipEntry
|
||
label: IP Entry
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
- variable: additionalBootstrapDns
|
||
group: App Configuration
|
||
label: Additional Bootstrap DNS
|
||
schema:
|
||
type: list
|
||
show_if: [[ "bootstrapDns", "!=", {"upstream": "", "ips": []} ]]
|
||
default: []
|
||
items:
|
||
- variable: additionalBootstrapDnsEntry
|
||
label: Additional Bootstrap DNS Entry
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: upstream
|
||
label: Upstream
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: ips
|
||
label: IPs
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: ipEntry
|
||
label: IP Entry
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
- variable: filtering
|
||
group: App Configuration
|
||
label: Filtering
|
||
description: Define one or more DNS query types; all queries with these types will be dropped
|
||
<br />Refer to <a href="https://0xerr0r.github.io/blocky/configuration/#filtering" target="_blank" rel="noopener noreferrer">https://0xerr0r.github.io/blocky/configuration/#filtering</a>
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: queryTypes
|
||
label: Query Types
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: queryTypeEntry
|
||
label: Query Type Entry
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
- variable: customDNS
|
||
group: App Configuration
|
||
label: Custom DNS
|
||
description: Define your own domain name to IP mappings.
|
||
<br />Refer to <a href="https://0xerr0r.github.io/blocky/configuration/#custom-dns" target="_blank" rel="noopener noreferrer">https://0xerr0r.github.io/blocky/configuration/#custom-dns</a>
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: customTTL
|
||
label: Custom TTL
|
||
schema:
|
||
type: string
|
||
default: 1h
|
||
- variable: filterUnmappedTypes
|
||
label: Filter Unmapped Types
|
||
schema:
|
||
type: boolean
|
||
default: true
|
||
- variable: rewrite
|
||
label: Rewrite
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: rewriteEntry
|
||
label: Rewrite Entry
|
||
schema:
|
||
type: dict
|
||
additional_attrs: true
|
||
attrs:
|
||
- variable: in
|
||
label: In
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
- variable: out
|
||
label: Out
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
- variable: mapping
|
||
label: Mapping
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: mappingEntry
|
||
label: Mapping Entry
|
||
schema:
|
||
type: dict
|
||
additional_attrs: true
|
||
attrs:
|
||
- variable: domain
|
||
label: Domain
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
- variable: dnsserver
|
||
label: DNS Server
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
- variable: clientLookup
|
||
group: App Configuration
|
||
label: Client Lookup
|
||
description: Blocky can try to resolve a user-friendly client name from the IP address or server URL (DoT and DoH)
|
||
<br />Refer to <a href="https://0xerr0r.github.io/blocky/configuration/#client-name-lookup" target="_blank" rel="noopener noreferrer">https://0xerr0r.github.io/blocky/configuration/#client-name-lookup</a>
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: upstream
|
||
label: Upstream
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: singleNameOrder
|
||
label: Single Name Order
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: singleNameEntry
|
||
label: Single Name Entry
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
- variable: clients
|
||
label: Clients
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: clientEntry
|
||
label: Client Entry
|
||
schema:
|
||
type: dict
|
||
additional_attrs: true
|
||
attrs:
|
||
- variable: domain
|
||
label: Domain
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
- variable: ips
|
||
label: IPs
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: ipEntry
|
||
label: IP Entry
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
- variable: caching
|
||
group: App Configuration
|
||
label: Caching
|
||
description: Refer to
|
||
<br /><a href="https://0xerr0r.github.io/blocky/configuration/#caching" target="_blank" rel="noopener noreferrer">https://0xerr0r.github.io/blocky/configuration/#caching</a>
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: minTime
|
||
label: Min Time
|
||
schema:
|
||
type: string
|
||
default: 5m
|
||
- variable: maxTime
|
||
label: Max Time
|
||
schema:
|
||
type: string
|
||
default: 30m
|
||
- variable: maxItemsCount
|
||
label: Max Items Count
|
||
schema:
|
||
type: int
|
||
default: 0
|
||
- variable: prefetching
|
||
label: Prefetching
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
- variable: prefetchExpires
|
||
label: Prefetch Expires
|
||
schema:
|
||
type: string
|
||
default: 2h
|
||
- variable: prefetchThreshold
|
||
label: Prefetch Threshold
|
||
schema:
|
||
type: int
|
||
default: 5
|
||
- variable: prefetchMaxItemsCount
|
||
label: Prefetch Max Items Count
|
||
schema:
|
||
type: int
|
||
default: 0
|
||
- variable: cacheTimeNegative
|
||
label: Cache Time Negative
|
||
schema:
|
||
type: string
|
||
default: 30m
|
||
- variable: conditional
|
||
group: App Configuration
|
||
label: Conditional
|
||
description: Define which DNS resolver(s) should be used for queries for the particular domain
|
||
<br />Refer to <a href="https://0xerr0r.github.io/blocky/configuration/#conditional-dns-resolution" target="_blank" rel="noopener noreferrer">https://0xerr0r.github.io/blocky/configuration/#conditional-dns-resolution</a>
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: rewrite
|
||
label: Rewrite
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: rewriteEntry
|
||
label: Rewrite Entry
|
||
schema:
|
||
type: dict
|
||
additional_attrs: true
|
||
attrs:
|
||
- variable: in
|
||
label: In
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
- variable: out
|
||
label: Out
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
- variable: mapping
|
||
label: Mapping
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: mappingEntry
|
||
label: Mapping Entry
|
||
schema:
|
||
type: dict
|
||
additional_attrs: true
|
||
attrs:
|
||
- variable: domain
|
||
label: Domain
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
- variable: dnsserver
|
||
label: DNS Server
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
- variable: blocking
|
||
group: App Configuration
|
||
label: Blocking
|
||
description: Each black or whitelist can be either a path to the local file or a URL to download. All Urls must be grouped to a group name.
|
||
<br />Refer to <a href="https://0xerr0r.github.io/blocky/configuration/#blocking-and-whitelisting" target="_blank" rel="noopener noreferrer">https://0xerr0r.github.io/blocky/configuration/#blocking-and-whitelisting</a>
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: blockType
|
||
label: Block Type
|
||
description: Set the response should be sent to the client, if a requested query is blocked
|
||
schema:
|
||
type: string
|
||
default: nxDomain
|
||
- variable: blockTTL
|
||
label: Block TTL
|
||
description: Set the TTL for answers to blocked domains
|
||
schema:
|
||
type: string
|
||
default: 6h
|
||
- variable: refreshPeriod
|
||
label: Refresh Period
|
||
description: Set how often blocky should refresh list cache
|
||
schema:
|
||
type: string
|
||
default: 4h
|
||
- variable: downloadTimeout
|
||
label: Download Timeout
|
||
description: Download attempt timeout
|
||
schema:
|
||
type: string
|
||
default: 60s
|
||
- variable: downloadAttempts
|
||
label: Download Attempts
|
||
description: How many download attempts should be performed
|
||
schema:
|
||
type: int
|
||
default: 3
|
||
- variable: downloadCooldown
|
||
label: Download Cooldown
|
||
description: Time between the download attempts
|
||
schema:
|
||
type: string
|
||
default: 2s
|
||
- variable: startStrategy
|
||
label: Start Strategy
|
||
description: |
|
||
blocking: all blocking lists will be loaded before DNS resolution starts.</br>
|
||
failOnError: like blocking but blocky will shut down if any download fails.</br>
|
||
fast: DNS resolution starts immediately without blocking which will be enabled after list load is completed
|
||
schema:
|
||
type: string
|
||
default: blocking
|
||
enum:
|
||
- value: blocking
|
||
description: Blocking
|
||
- value: failOnError
|
||
description: Fail On Error
|
||
- value: fast
|
||
description: Fast
|
||
- variable: processingConcurrency
|
||
label: Processing Concurrency
|
||
description: Sets how many list-groups can be processed at the same time
|
||
schema:
|
||
type: int
|
||
default: 4
|
||
- variable: whitelist
|
||
label: Whitelist
|
||
description: Define whitelists, either URL or file
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: whitelistEntry
|
||
label: Whitelist Group Entry
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: name
|
||
label: Group Name
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
- variable: lists
|
||
label: Lists
|
||
schema:
|
||
type: list
|
||
required: true
|
||
default: []
|
||
items:
|
||
- variable: listEntry
|
||
label: List Entry
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
- variable: blacklist
|
||
label: Blacklist
|
||
description: Define blacklists, either URL or file
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: blacklistEntry
|
||
label: Blacklist Group Entry
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: name
|
||
label: Group Name
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
- variable: lists
|
||
label: Lists
|
||
schema:
|
||
type: list
|
||
required: true
|
||
default: []
|
||
items:
|
||
- variable: listEntry
|
||
label: List Entry
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
- variable: clientGroupsBlock
|
||
label: Client Groups Block
|
||
description: Define, which blocking group(s) should be used for which client in your network.
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: clientGroupBlockEntry
|
||
label: Client Group Block Entry
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: name
|
||
label: Client Group Name
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
- variable: groups
|
||
label: Groups
|
||
schema:
|
||
type: list
|
||
required: true
|
||
default: []
|
||
items:
|
||
- variable: groupEntry
|
||
label: Group Entry
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
- variable: hostsFile
|
||
group: App Configuration
|
||
label: Hosts File
|
||
description: You can enable resolving of entries, located in local hosts file.
|
||
<br />Refer to <a href="https://0xerr0r.github.io/blocky/configuration/#hosts-file" target="_blank" rel="noopener noreferrer">https://0xerr0r.github.io/blocky/configuration/#hosts-file</a>
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: Enabled
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
show_subquestions_if: true
|
||
subquestions:
|
||
- variable: filePath
|
||
label: File Path
|
||
schema:
|
||
type: string
|
||
default: /etc/hosts
|
||
- variable: hostsTTL
|
||
label: Hosts TTL
|
||
schema:
|
||
type: string
|
||
default: 60m
|
||
- variable: refreshPeriod
|
||
label: Refresh Period
|
||
schema:
|
||
type: string
|
||
default: 30m
|
||
- variable: queryLog
|
||
group: App Configuration
|
||
label: Query Logging configuration
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: type
|
||
label: Type
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
enum:
|
||
- value: ""
|
||
description: Console
|
||
- value: postgresql
|
||
description: postgresql
|
||
- value: csv
|
||
description: csv
|
||
- value: csv-client
|
||
description: csv-client
|
||
- variable: target
|
||
label: Target
|
||
schema:
|
||
type: string
|
||
show_if: [["type", "!=", "postgresql"]]
|
||
default: "/var/log/something"
|
||
- variable: logRetentionDays
|
||
label: Log Retention Days
|
||
schema:
|
||
type: int
|
||
default: 0
|
||
- variable: creationAttempts
|
||
label: Creation Attempts
|
||
schema:
|
||
type: int
|
||
default: 3
|
||
- variable: creationCooldown
|
||
label: Creation Cooldown
|
||
schema:
|
||
type: string
|
||
default: 2s
|
||
- variable: k8sgateway
|
||
group: App Configuration
|
||
label: k8s-Gateway Configuration
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: Enable k8s-Gateway
|
||
description: Enables k8s-Gateway
|
||
schema:
|
||
type: boolean
|
||
default: true
|
||
show_subquestions_if: true
|
||
subquestions:
|
||
- variable: domains
|
||
label: Domains
|
||
description: Please refer to CoreDNS docs for options
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: domainEntry
|
||
label: ""
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: domain
|
||
label: Domain name
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: example.com
|
||
- variable: dnsChallenge
|
||
label: Forward dnsChallenge
|
||
description: Optional configuration option for DNS01 challenge that will redirect all acme
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: Enable
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
show_subquestions_if: true
|
||
subquestions:
|
||
- variable: domain
|
||
label: Forward to Domain
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: dns01.clouddns.com
|
||
- variable: advancedOptions
|
||
label: Advanced Options
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
show_if: [["enabled", "=", true]]
|
||
show_subquestions_if: true
|
||
subquestions:
|
||
- variable: ttl
|
||
label: ttl
|
||
description: TTL for non-apex responses (in seconds)
|
||
schema:
|
||
type: int
|
||
default: 300
|
||
- variable: watchedResources
|
||
label: Watched Resources
|
||
description: imit what kind of resources to watch, e.g. Ingress
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: watchedResource
|
||
label: Watched Resource
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: secondary
|
||
label: Secondary DNS Server Service
|
||
description: Service name of a secondary DNS server (should be serviceName.namespace)
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: apex
|
||
label: Apex
|
||
description: Override the default `serviceName.namespace` domain apex
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: TZ
|
||
label: Timezone
|
||
group: "General"
|
||
schema:
|
||
type: string
|
||
default: "Etc/UTC"
|
||
$ref:
|
||
- "definitions/timezone"
|
||
|
||
- variable: podOptions
|
||
group: "General"
|
||
label: "Global Pod Options (Advanced)"
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: expertPodOpts
|
||
label: "Expert - Pod Options"
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
show_subquestions_if: true
|
||
subquestions:
|
||
- variable: hostNetwork
|
||
label: "Host Networking"
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
- variable: dnsConfig
|
||
label: "DNS Configuration"
|
||
schema:
|
||
type: dict
|
||
additional_attrs: true
|
||
attrs:
|
||
- variable: options
|
||
label: "Options"
|
||
schema:
|
||
type: list
|
||
default: [{"name": "ndots", "value": "1"}]
|
||
items:
|
||
- variable: optionsEntry
|
||
label: "Option Entry"
|
||
schema:
|
||
type: dict
|
||
additional_attrs: true
|
||
attrs:
|
||
- variable: name
|
||
label: "Name"
|
||
schema:
|
||
type: string
|
||
required: true
|
||
- variable: value
|
||
label: "Value"
|
||
schema:
|
||
type: string
|
||
- variable: nameservers
|
||
label: "Nameservers"
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: nsEntry
|
||
label: "Nameserver Entry"
|
||
schema:
|
||
type: string
|
||
required: true
|
||
- variable: searches
|
||
label: "Searches"
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: searchEntry
|
||
label: "Search Entry"
|
||
schema:
|
||
type: string
|
||
required: true
|
||
|
||
- variable: imagePullSecretList
|
||
group: "General"
|
||
label: "Image Pull Secrets"
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: pullsecretentry
|
||
label: "Pull Secret"
|
||
schema:
|
||
type: dict
|
||
additional_attrs: true
|
||
attrs:
|
||
- variable: enabled
|
||
label: Enabled
|
||
schema:
|
||
type: boolean
|
||
default: true
|
||
- variable: data
|
||
label: Data
|
||
schema:
|
||
type: dict
|
||
additional_attrs: true
|
||
attrs:
|
||
- variable: registry
|
||
label: "Registry"
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: "https://index.docker.io/v1/"
|
||
- variable: username
|
||
label: "Username"
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
- variable: password
|
||
label: "Password"
|
||
schema:
|
||
type: string
|
||
required: true
|
||
private: true
|
||
default: ""
|
||
- variable: email
|
||
label: "Email"
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
|
||
- variable: service
|
||
group: Services
|
||
label: Configure Service(s)
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
|
||
- variable: dns
|
||
label: DNS Service
|
||
description: The DNS service
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: Enable the Service
|
||
schema:
|
||
type: boolean
|
||
default: true
|
||
hidden: true
|
||
- variable: type
|
||
label: Service Type
|
||
description: "ClusterIP's are only internally available and Loadbalancer exposes the service using the system loadbalancer"
|
||
schema:
|
||
type: string
|
||
default: LoadBalancer
|
||
enum:
|
||
- value: LoadBalancer
|
||
description: LoadBalancer (Expose Ports)
|
||
- value: ClusterIP
|
||
description: ClusterIP (Do Not Expose Ports)
|
||
|
||
- variable: loadBalancerIP
|
||
label: LoadBalancer IP
|
||
description: "MetalLB Only: Selects the Loadbalancer IP to expose on. Required when using PortalButton with MetalLB"
|
||
schema:
|
||
show_if: [["type", "=", "LoadBalancer"]]
|
||
type: string
|
||
default: ""
|
||
- variable: ports
|
||
label: "Service's Port(s) Configuration"
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
|
||
- variable: dns
|
||
label: DNS Port Configuration
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: port
|
||
label: Port
|
||
description: This port exposes the container port on the service
|
||
schema:
|
||
type: int
|
||
default: 53
|
||
required: true
|
||
- variable: dot
|
||
label: DoT Service
|
||
description: "DNS-over-TLS service"
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: Enable the Service
|
||
schema:
|
||
type: boolean
|
||
default: true
|
||
hidden: true
|
||
- variable: type
|
||
label: Service Type
|
||
description: "ClusterIP's are only internally available and Loadbalancer exposes the service using the system loadbalancer"
|
||
schema:
|
||
type: string
|
||
default: ClusterIP
|
||
enum:
|
||
- value: LoadBalancer
|
||
description: LoadBalancer (Expose Ports)
|
||
- value: ClusterIP
|
||
description: ClusterIP (Do Not Expose Ports)
|
||
|
||
- variable: loadBalancerIP
|
||
label: LoadBalancer IP
|
||
description: "MetalLB Only: Selects the Loadbalancer IP to expose on. Required when using PortalButton with MetalLB"
|
||
schema:
|
||
show_if: [["type", "=", "LoadBalancer"]]
|
||
type: string
|
||
default: ""
|
||
- variable: ports
|
||
label: "Service's Port(s) Configuration"
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
|
||
- variable: dot
|
||
label: DoT Port Configuration
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: port
|
||
label: Port
|
||
description: This port exposes the container port on the service
|
||
schema:
|
||
type: int
|
||
default: 853
|
||
required: true
|
||
|
||
|
||
- variable: serviceList
|
||
label: Add Manual Custom Services
|
||
group: Services
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: serviceListEntry
|
||
label: Custom Service
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: Enable the service
|
||
schema:
|
||
type: boolean
|
||
default: true
|
||
hidden: true
|
||
- variable: name
|
||
label: Name
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: type
|
||
label: Service Type
|
||
description: "ClusterIP's are only internally available and Loadbalancer exposes the service using the system loadbalancer"
|
||
schema:
|
||
type: string
|
||
default: LoadBalancer
|
||
enum:
|
||
- value: LoadBalancer
|
||
description: LoadBalancer (Expose Ports)
|
||
- value: ClusterIP
|
||
description: ClusterIP (Do Not Expose Ports)
|
||
- value: Simple
|
||
description: Deprecated CHANGE THIS
|
||
- variable: loadBalancerIP
|
||
label: LoadBalancer IP
|
||
description: "MetalLB Only: Selects the Loadbalancer IP to expose on. Required when using PortalButton with MetalLB"
|
||
schema:
|
||
show_if: [["type", "=", "LoadBalancer"]]
|
||
type: string
|
||
default: ""
|
||
- variable: advancedsvcset
|
||
label: Show Advanced Service Settings
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
show_subquestions_if: true
|
||
subquestions:
|
||
- variable: externalIPs
|
||
label: "External IP's"
|
||
description: "External IP's"
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: externalIP
|
||
label: External IP
|
||
schema:
|
||
type: string
|
||
- variable: ipFamilyPolicy
|
||
label: IP Family Policy
|
||
description: Specify the IP Policy
|
||
schema:
|
||
type: string
|
||
default: SingleStack
|
||
enum:
|
||
- value: SingleStack
|
||
description: SingleStack
|
||
- value: PreferDualStack
|
||
description: PreferDualStack
|
||
- value: RequireDualStack
|
||
description: RequireDualStack
|
||
- variable: ipFamilies
|
||
label: IP Families
|
||
description: (Advanced) The IP Families that should be used
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: ipFamily
|
||
label: IP Family
|
||
schema:
|
||
type: string
|
||
- variable: portsList
|
||
label: Additional Service Ports
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: portsListEntry
|
||
label: Custom ports
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: Enable the Port
|
||
schema:
|
||
type: boolean
|
||
default: true
|
||
hidden: true
|
||
- variable: name
|
||
label: Port Name
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: protocol
|
||
label: Port Type
|
||
schema:
|
||
type: string
|
||
default: tcp
|
||
enum:
|
||
- value: http
|
||
description: HTTP
|
||
- value: https
|
||
description: HTTPS
|
||
- value: tcp
|
||
description: TCP
|
||
- value: udp
|
||
description: UDP
|
||
- variable: targetPort
|
||
label: Target Port
|
||
description: This port exposes the container port on the service
|
||
schema:
|
||
type: int
|
||
required: true
|
||
- variable: port
|
||
label: Container Port
|
||
schema:
|
||
type: int
|
||
required: true
|
||
|
||
- variable: persistenceList
|
||
label: Additional App Storage
|
||
group: Persistence
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: persistenceListEntry
|
||
label: Custom Storage
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: Enable the storage
|
||
schema:
|
||
type: boolean
|
||
default: true
|
||
hidden: true
|
||
- variable: type
|
||
label: Type of Storage
|
||
description: Sets the persistence type, Anything other than PVC could break rollback!
|
||
schema:
|
||
type: string
|
||
default: hostPath
|
||
enum:
|
||
- value: pvc
|
||
description: PVC
|
||
- value: hostPath
|
||
description: Host Path
|
||
- value: emptyDir
|
||
description: emptyDir
|
||
- value: nfs
|
||
description: NFS Share
|
||
- variable: server
|
||
label: NFS Server
|
||
schema:
|
||
show_if: [["type", "=", "nfs"]]
|
||
type: string
|
||
default: ""
|
||
- variable: path
|
||
label: Path on NFS Server
|
||
schema:
|
||
show_if: [["type", "=", "nfs"]]
|
||
type: string
|
||
default: ""
|
||
- variable: iscsi
|
||
label: iSCSI Options
|
||
schema:
|
||
show_if: [["type", "=", "iscsi"]]
|
||
type: dict
|
||
additional_attrs: true
|
||
attrs:
|
||
- variable: targetPortal
|
||
label: targetPortal
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
- variable: iqn
|
||
label: iqn
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
- variable: lun
|
||
label: lun
|
||
schema:
|
||
type: int
|
||
default: 0
|
||
- variable: authSession
|
||
label: authSession
|
||
schema:
|
||
type: dict
|
||
additional_attrs: true
|
||
attrs:
|
||
- variable: username
|
||
label: username
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: password
|
||
label: password
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: usernameInitiator
|
||
label: usernameInitiator
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: passwordInitiator
|
||
label: passwordInitiator
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: authDiscovery
|
||
label: authDiscovery
|
||
schema:
|
||
type: dict
|
||
additional_attrs: true
|
||
attrs:
|
||
- variable: username
|
||
label: username
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: password
|
||
label: password
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: usernameInitiator
|
||
label: usernameInitiator
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: passwordInitiator
|
||
label: passwordInitiator
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: autoPermissions
|
||
label: Automatic Permissions Configuration
|
||
description: Automatically set permissions
|
||
schema:
|
||
show_if: [["type", "!=", "pvc"]]
|
||
type: dict
|
||
additional_attrs: true
|
||
attrs:
|
||
- variable: enabled
|
||
label: enabled
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
show_subquestions_if: true
|
||
subquestions:
|
||
- variable: chown
|
||
label: Run CHOWN
|
||
description: |
|
||
It will run CHOWN on the path with the given fsGroup
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
- variable: chmod
|
||
label: Run CHMOD
|
||
description: |
|
||
It will run CHMOD on the path with the given value</br>
|
||
Format should be 3 digits, e.g. 770
|
||
schema:
|
||
type: string
|
||
valid_chars: '[0-9]{3}'
|
||
default: ""
|
||
- variable: recursive
|
||
label: Recursive
|
||
description: |
|
||
It will run CHOWN and CHMOD recursively
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
- variable: readOnly
|
||
label: Read Only
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
- variable: hostPath
|
||
label: Host Path
|
||
description: Path inside the container the storage is mounted
|
||
schema:
|
||
show_if: [["type", "=", "hostPath"]]
|
||
type: hostpath
|
||
- variable: mountPath
|
||
label: Mount Path
|
||
description: Path inside the container the storage is mounted
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
required: true
|
||
valid_chars: '^\/([a-zA-Z0-9._-]+(\s?[a-zA-Z0-9._-]+|\/?))+$'
|
||
- variable: medium
|
||
label: EmptyDir Medium
|
||
schema:
|
||
show_if: [["type", "=", "emptyDir"]]
|
||
type: string
|
||
default: ""
|
||
enum:
|
||
- value: ""
|
||
description: Default
|
||
- value: Memory
|
||
description: Memory
|
||
- variable: size
|
||
label: Size Quotum of Storage
|
||
schema:
|
||
show_if: [["type", "=", "pvc"]]
|
||
type: string
|
||
default: 256Gi
|
||
- variable: storageClass
|
||
label: 'storageClass (Advanced)'
|
||
description: 'sets the storageClass to something other than iX default. Only for advanced usecases!'
|
||
schema:
|
||
show_if: [["type", "=", "pvc"]]
|
||
type: string
|
||
default: ""
|
||
- variable: static
|
||
label: 'Static Fixed PVC Bindings (Experimental)'
|
||
description: Link a PVC to a specific storage location
|
||
schema:
|
||
show_if: [["type", "=", "pvc"]]
|
||
type: dict
|
||
additional_attrs: true
|
||
attrs:
|
||
- variable: mode
|
||
label: mode
|
||
description: |
|
||
disabled: use normal dynamic PVCs
|
||
smb: connect to an SMB share
|
||
nfs: connect to an NFS share
|
||
schema:
|
||
type: string
|
||
default: "disabled"
|
||
enum:
|
||
- value: "disabled"
|
||
description: disabled
|
||
- value: smb
|
||
description: smb
|
||
- value: nfs
|
||
description: nfs
|
||
- variable: server
|
||
label: Server
|
||
description: server to connect to
|
||
schema:
|
||
type: string
|
||
show_if: [["mode", "!=", "disabled"]]
|
||
default: "myserver"
|
||
- variable: share
|
||
label: Share
|
||
description: share to connect to
|
||
schema:
|
||
type: string
|
||
show_if: [["mode", "!=", "disabled"]]
|
||
default: "/myshare"
|
||
- variable: user
|
||
label: User
|
||
description: connecting user
|
||
schema:
|
||
type: string
|
||
show_if: [["mode", "=", "smb"]]
|
||
default: "myuser"
|
||
- variable: domain
|
||
label: Domain
|
||
description: user domain
|
||
schema:
|
||
type: string
|
||
show_if: [["mode", "=", "smb"]]
|
||
default: ""
|
||
- variable: password
|
||
label: Password
|
||
description: connecting password
|
||
schema:
|
||
type: string
|
||
show_if: [["mode", "=", "smb"]]
|
||
default: ""
|
||
- variable: volumeSnapshots
|
||
label: 'Volume Snapshots (Experimental)'
|
||
description: Add an entry to the list to force creation of a volumeSnapshot of this PVC
|
||
schema:
|
||
show_if: [["type", "=", "pvc"]]
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: volumeSnapshotEntry
|
||
label: Custom volumeSnapshot
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: name
|
||
label: Name
|
||
description: 'WARNING: renaming this, means deletion of the snapshot with the old name!'
|
||
schema:
|
||
type: string
|
||
default: "mysnapshot"
|
||
required: true
|
||
- variable: volumeSnapshotClassName
|
||
label: 'volumeSnapshot Class Name (Advanced)'
|
||
description: For use with PVCs using a non-default storageClass
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
|
||
- variable: ingress
|
||
label: ""
|
||
group: Ingress
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
|
||
- variable: main
|
||
label: Main Ingress
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: Enable Ingress
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
show_subquestions_if: true
|
||
subquestions:
|
||
- variable: hosts
|
||
label: Hosts
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: hostEntry
|
||
label: Host
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: host
|
||
label: HostName
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
required: true
|
||
- variable: paths
|
||
label: Paths
|
||
schema:
|
||
type: list
|
||
default: [{path: "/", pathType: "Prefix"}]
|
||
items:
|
||
- variable: pathEntry
|
||
label: Host
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: path
|
||
label: Path
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: "/"
|
||
- variable: pathType
|
||
label: Path Type
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: Prefix
|
||
|
||
- variable: integrations
|
||
label: Integrations
|
||
description: Connect ingress with other charts
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: traefik
|
||
label: Traefik
|
||
description: Connect ingress with Traefik
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: enabled
|
||
schema:
|
||
type: boolean
|
||
default: true
|
||
- variable: allowCors
|
||
label: 'Allow Cross Origin Requests (advanced)'
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
show_if: [["enabled", "=", true]]
|
||
- variable: entrypoints
|
||
label: Entrypoints
|
||
schema:
|
||
type: list
|
||
default: ["websecure"]
|
||
show_if: [["enabled", "=", true]]
|
||
items:
|
||
- variable: entrypoint
|
||
label: Entrypoint
|
||
schema:
|
||
type: string
|
||
- variable: middlewares
|
||
label: Middlewares
|
||
schema:
|
||
type: list
|
||
default: []
|
||
show_if: [["enabled", "=", true]]
|
||
items:
|
||
- variable: middleware
|
||
label: Middleware
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: name
|
||
label: name
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
required: true
|
||
- variable: namespace
|
||
label: 'namespace (optional)'
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: certManager
|
||
label: certManager
|
||
description: Connect ingress with certManager
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: enabled
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
- variable: certificateIssuer
|
||
label: certificateIssuer
|
||
description: defaults to chartname
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
show_if: [["enabled", "=", true]]
|
||
- variable: homepage
|
||
label: Homepage
|
||
description: Connect ingress with Homepage
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: enabled
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
- variable: name
|
||
label: Name (Optional)
|
||
description: Defaults to chart name
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
show_if: [["enabled", "=", true]]
|
||
- variable: description
|
||
label: Description (Optional)
|
||
description: Defaults to chart description
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
show_if: [["enabled", "=", true]]
|
||
- variable: icon
|
||
label: Icon (Optional)
|
||
description: Defaults to chart icon
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
show_if: [["enabled", "=", true]]
|
||
- variable: group
|
||
label: Group
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: "default"
|
||
show_if: [["enabled", "=", true]]
|
||
- variable: widget
|
||
label: Widget Settings
|
||
schema:
|
||
type: dict
|
||
additional_attrs: true
|
||
show_if: [["enabled", "=", true]]
|
||
attrs:
|
||
- variable: enabled
|
||
label: Enable Widget
|
||
description: When disabled all widget annotations are skipped.
|
||
schema:
|
||
type: boolean
|
||
default: true
|
||
- variable: custom
|
||
label: Options
|
||
schema:
|
||
type: dict
|
||
additional_attrs: true
|
||
attrs:
|
||
- variable: key
|
||
label: API-key (key)
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: customkv
|
||
label: Custom Options
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: option
|
||
label: Option
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: key
|
||
label: Key
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
required: true
|
||
- variable: value
|
||
label: Value
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
required: true
|
||
- variable: advanced
|
||
label: Show Advanced Settings
|
||
description: Advanced settings are not covered by TrueCharts Support
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
- variable: ingressClassName
|
||
label: (Advanced/Optional) IngressClass Name
|
||
schema:
|
||
type: string
|
||
show_if: [["advanced", "=", true]]
|
||
default: ""
|
||
- variable: tls
|
||
label: TLS-Settings
|
||
schema:
|
||
type: list
|
||
show_if: [["advanced", "=", true]]
|
||
default: []
|
||
items:
|
||
- variable: tlsEntry
|
||
label: Host
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: hosts
|
||
label: Certificate Hosts
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: host
|
||
label: Host
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
required: true
|
||
|
||
- variable: certificateIssuer
|
||
label: Use Cert-Manager clusterIssuer
|
||
description: 'add the name of your cert-manager clusterIssuer here for automatic tls certificates.'
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: clusterCertificate
|
||
label: 'Cluster Certificate (Advanced)'
|
||
description: 'Add the name of your cluster-wide certificate, that you set up in the ClusterIssuer chart.'
|
||
schema:
|
||
type: string
|
||
show_if: [["certificateIssuer", "=", ""]]
|
||
default: ""
|
||
- variable: secretName
|
||
label: 'Use Custom Certificate Secret (Advanced)'
|
||
schema:
|
||
show_if: [["certificateIssuer", "=", ""]]
|
||
type: string
|
||
default: ""
|
||
|
||
- variable: ingressList
|
||
label: Add Manual Custom Ingresses
|
||
group: Ingress
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: ingressListEntry
|
||
label: Custom Ingress
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: Enable Ingress
|
||
schema:
|
||
type: boolean
|
||
default: true
|
||
hidden: true
|
||
- variable: name
|
||
label: Name
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: ingressClassName
|
||
label: IngressClass Name
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: hosts
|
||
label: Hosts
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: hostEntry
|
||
label: Host
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: host
|
||
label: HostName
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
required: true
|
||
- variable: paths
|
||
label: Paths
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: pathEntry
|
||
label: Host
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: path
|
||
label: Path
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: "/"
|
||
- variable: pathType
|
||
label: Path Type
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: Prefix
|
||
- variable: overrideService
|
||
label: Linked Service
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: name
|
||
label: Service Name
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: port
|
||
label: Service Port
|
||
schema:
|
||
type: int
|
||
- variable: tls
|
||
label: TLS-Settings
|
||
schema:
|
||
type: list
|
||
default: []
|
||
show_if: [["certificateIssuer", "=", ""]]
|
||
items:
|
||
- variable: tlsEntry
|
||
label: Host
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: hosts
|
||
label: Certificate Hosts
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: host
|
||
label: Host
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
required: true
|
||
- variable: certificateIssuer
|
||
label: Use Cert-Manager clusterIssuer
|
||
description: 'add the name of your Cert-Manager clusterIssuer here for automatic tls certificates.'
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: clusterCertificate
|
||
label: 'Cluster Certificate (Advanced)'
|
||
description: 'Add the name of your cluster-wide certificate, that you set up in the ClusterIssuer chart.'
|
||
schema:
|
||
type: string
|
||
show_if: [["certificateIssuer", "=", ""]]
|
||
default: ""
|
||
- variable: secretName
|
||
label: Use Custom Secret (Advanced)
|
||
schema:
|
||
type: string
|
||
show_if: [["certificateIssuer", "=", ""]]
|
||
default: ""
|
||
- variable: integrations
|
||
label: Integrations
|
||
description: Connect ingress with other charts
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: traefik
|
||
label: Traefik
|
||
description: Connect ingress with Traefik
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: enabled
|
||
schema:
|
||
type: boolean
|
||
default: true
|
||
- variable: allowCors
|
||
label: "Allow Cross Origin Requests"
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
show_if: [["enabled", "=", true]]
|
||
- variable: entrypoints
|
||
label: Entrypoints
|
||
schema:
|
||
type: list
|
||
default: ["websecure"]
|
||
show_if: [["enabled", "=", true]]
|
||
items:
|
||
- variable: entrypoint
|
||
label: Entrypoint
|
||
schema:
|
||
type: string
|
||
- variable: middlewares
|
||
label: Middlewares
|
||
schema:
|
||
type: list
|
||
default: []
|
||
show_if: [["enabled", "=", true]]
|
||
items:
|
||
- variable: middleware
|
||
label: Middleware
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: name
|
||
label: name
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
required: true
|
||
- variable: namespace
|
||
label: namespace
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: certManager
|
||
label: certManager
|
||
description: Connect ingress with certManager
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: enabled
|
||
schema:
|
||
type: boolean
|
||
default: true
|
||
- variable: certificateIssuer
|
||
label: certificateIssuer
|
||
description: defaults to chartname
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
show_if: [["enabled", "=", true]]
|
||
- variable: homepage
|
||
label: Homepage
|
||
description: Connect ingress with Homepage
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: enabled
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
- variable: name
|
||
label: Name
|
||
description: defaults to chartname
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
show_if: [["enabled", "=", true]]
|
||
- variable: description
|
||
label: Description
|
||
description: defaults to chart description
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
show_if: [["enabled", "=", true]]
|
||
- variable: group
|
||
label: Group
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: "default"
|
||
show_if: [["enabled", "=", true]]
|
||
|
||
- variable: securityContext
|
||
group: SecurityContext
|
||
label: Security Context
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: container
|
||
label: Container
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
# Settings from questions.yaml get appended here on a per-app basis
|
||
|
||
- variable: runAsUser
|
||
label: "runAsUser"
|
||
description: "The UserID of the user running the application"
|
||
schema:
|
||
type: int
|
||
default: 568
|
||
- variable: runAsGroup
|
||
label: "runAsGroup"
|
||
description: "The groupID of the user running the application"
|
||
schema:
|
||
type: int
|
||
default: 568
|
||
# Settings from questions.yaml get appended here on a per-app basis
|
||
- variable: PUID
|
||
label: Process User ID - PUID
|
||
description: When supported by the container, this sets the User ID running the Application Process. Not supported by all Apps
|
||
schema:
|
||
type: int
|
||
show_if: [["runAsUser", "=", 0]]
|
||
default: 568
|
||
- variable: UMASK
|
||
label: UMASK
|
||
description: When supported by the container, this sets the UMASK for the App. Not supported by all Apps
|
||
schema:
|
||
type: string
|
||
default: "0022"
|
||
|
||
- variable: advanced
|
||
label: Show Advanced Settings
|
||
description: Advanced settings are not covered by TrueCharts Support
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
show_subquestions_if: true
|
||
subquestions:
|
||
- variable: privileged
|
||
label: "Privileged mode"
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
- variable: readOnlyRootFilesystem
|
||
label: "ReadOnly Root Filesystem"
|
||
schema:
|
||
type: boolean
|
||
default: true
|
||
|
||
- variable: pod
|
||
label: Pod
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: fsGroupChangePolicy
|
||
label: "When should we take ownership?"
|
||
schema:
|
||
type: string
|
||
default: OnRootMismatch
|
||
enum:
|
||
- value: OnRootMismatch
|
||
description: OnRootMismatch
|
||
- value: Always
|
||
description: Always
|
||
- variable: supplementalGroups
|
||
label: Supplemental Groups
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: supplementalGroupsEntry
|
||
label: Supplemental Group
|
||
schema:
|
||
type: int
|
||
# Settings from questions.yaml get appended here on a per-app basis
|
||
|
||
- variable: fsGroup
|
||
label: "fsGroup"
|
||
description: "The group that should own ALL storage."
|
||
schema:
|
||
type: int
|
||
default: 568
|
||
- variable: resources
|
||
group: Resources
|
||
label: "Resource Limits"
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: limits
|
||
label: Advanced Limit Resource Consumption
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: cpu
|
||
label: CPU
|
||
description: "1000m means 1 hyperthread. Detailed info: https://truecharts.org/manual/SCALE/validation"
|
||
schema:
|
||
type: string
|
||
default: 4000m
|
||
valid_chars: '^(?!^0(\.0|m|)$)([0-9]+)(\.[0-9]|m?)$'
|
||
- variable: memory
|
||
label: RAM
|
||
description: "1Gi means 1 Gibibyte RAM. Detailed info: https://truecharts.org/manual/SCALE/validation"
|
||
schema:
|
||
type: string
|
||
default: 8Gi
|
||
valid_chars: '^(?!^0(e[0-9]|[EPTGMK]i?|)$)([0-9]+)(|[EPTGMK]i?|e[0-9]+)$'
|
||
- variable: 'gpu.intel.com/i915'
|
||
label: Add Intel i915 GPUs
|
||
schema:
|
||
type: int
|
||
default: 0
|
||
- variable: 'nvidia.com/gpu'
|
||
label: Add NVIDIA GPUs (Experimental)
|
||
schema:
|
||
type: int
|
||
default: 0
|
||
- variable: 'amd.com/gpu'
|
||
label: Add AMD GPUs
|
||
schema:
|
||
type: int
|
||
default: 0
|
||
- variable: requests
|
||
label: "Minimum Resources Required (request)"
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
hidden: true
|
||
attrs:
|
||
- variable: cpu
|
||
label: CPU
|
||
description: "1000m means 1 hyperthread. Detailed info: https://truecharts.org/manual/SCALE/validation"
|
||
schema:
|
||
type: string
|
||
default: 10m
|
||
hidden: true
|
||
valid_chars: '^(?!^0(\.0|m|)$)([0-9]+)(\.[0-9]|m?)$'
|
||
- variable: memory
|
||
label: "RAM"
|
||
description: "1Gi means 1 Gibibyte RAM. Detailed info: https://truecharts.org/manual/SCALE/validation"
|
||
schema:
|
||
type: string
|
||
default: 50Mi
|
||
hidden: true
|
||
valid_chars: '^(?!^0(e[0-9]|[EPTGMK]i?|)$)([0-9]+)(|[EPTGMK]i?|e[0-9]+)$'
|
||
- variable: deviceList
|
||
label: Mount USB Devices
|
||
group: Devices
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: deviceListEntry
|
||
label: Device
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: Enable the Storage
|
||
schema:
|
||
type: boolean
|
||
default: true
|
||
- variable: type
|
||
label: (Advanced) Type of Storage
|
||
description: Sets the persistence type
|
||
schema:
|
||
type: string
|
||
default: device
|
||
hidden: true
|
||
- variable: readOnly
|
||
label: readOnly
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
- variable: hostPath
|
||
label: Host Device Path
|
||
description: Path to the device on the host system
|
||
schema:
|
||
type: path
|
||
- variable: mountPath
|
||
label: Container Device Path
|
||
description: Path inside the container the device is mounted
|
||
schema:
|
||
type: string
|
||
default: "/dev/ttyACM0"
|
||
|
||
- variable: cnpg
|
||
group: Postgresql
|
||
label: "CloudNative-PG (CNPG)"
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: main
|
||
label: "Main Postgresql Database"
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: hibernate
|
||
label: Hibernate
|
||
description: "enable to safely hibernate and shutdown the postgresql cluster"
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
- variable: mode
|
||
label: Mode
|
||
description: 'Cluster mode of operation. Available modes: standalone - default mode. Creates new or updates an existing CNPG cluster. recovery - Same as standalone but creates a cluster from a backup, object store or via pg_basebackup replica - Creates a replica cluster from an existing CNPG cluster. # TODO.'
|
||
schema:
|
||
type: string
|
||
default: "standalone"
|
||
enum:
|
||
- value: standalone
|
||
description: standalone
|
||
- value: replica
|
||
description: replica
|
||
- value: recovery
|
||
description: recovery
|
||
- variable: pgVersion
|
||
label: Postgres Version
|
||
description: "Set the Postgresql version used"
|
||
schema:
|
||
type: int
|
||
default: 16
|
||
required: true
|
||
- variable: password
|
||
label: Password
|
||
description: "Set the password for the database-user"
|
||
schema:
|
||
type: string
|
||
default: "PLACEHOLDERPASSWORD"
|
||
required: true
|
||
- variable: cluster
|
||
label: "Cluster Settings"
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: instances
|
||
label: Instances
|
||
schema:
|
||
type: int
|
||
default: 1
|
||
- variable: singleNode
|
||
label: singleNode
|
||
schema:
|
||
type: boolean
|
||
default: true
|
||
hidden: true
|
||
- variable: storage
|
||
label: "Storage"
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: size
|
||
label: Size
|
||
schema:
|
||
type: string
|
||
default: "256Gi"
|
||
- variable: walStorage
|
||
label: "WAL Storage"
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: size
|
||
label: Size
|
||
schema:
|
||
type: string
|
||
default: "256Gi"
|
||
- variable: monitoring
|
||
label: "Monitoring Settings"
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enablePodMonitor
|
||
label: "enablePodMonitor"
|
||
schema:
|
||
type: boolean
|
||
default: true
|
||
- variable: disableDefaultQueries
|
||
label: "disableDefaultQueries"
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
- variable: pooler
|
||
label: "Pooler Settings"
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: Enabled
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
- variable: instances
|
||
label: Instances
|
||
schema:
|
||
type: int
|
||
show_if: [["enabled", "=", true]]
|
||
default: 1
|
||
- variable: createRO
|
||
label: "Create ReadOnly Instance"
|
||
schema:
|
||
type: boolean
|
||
show_if: [["enabled", "=", true]]
|
||
default: false
|
||
- variable: backups
|
||
label: "Backup Settings (Experimental)"
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: "enabled"
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
- variable: serverName
|
||
label: "serverName"
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: revision
|
||
label: "revision"
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: endpointURL
|
||
label: "endpointURL"
|
||
schema:
|
||
type: string
|
||
show_if: [["enabled", "=", true]]
|
||
default: ""
|
||
- variable: destinationPath
|
||
label: "destinationPath"
|
||
schema:
|
||
type: string
|
||
show_if: [["enabled", "=", true]]
|
||
default: ""
|
||
- variable: retentionPolicy
|
||
label: "retentionPolicy"
|
||
schema:
|
||
type: string
|
||
show_if: [["enabled", "=", true]]
|
||
default: "30d"
|
||
- variable: provider
|
||
label: "provider"
|
||
schema:
|
||
type: string
|
||
show_if: [["enabled", "=", true]]
|
||
default: "s3"
|
||
enum:
|
||
- value: s3
|
||
description: S3
|
||
- value: azure
|
||
description: Azure
|
||
- value: google
|
||
description: Google
|
||
- variable: s3
|
||
label: "s3"
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
show_if: [["provider", "=", "s3"]]
|
||
attrs:
|
||
- variable: region
|
||
label: "region"
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: bucket
|
||
label: "bucket"
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: path
|
||
label: "path"
|
||
schema:
|
||
type: string
|
||
default: "/"
|
||
- variable: accessKey
|
||
label: "accessKey"
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: secretKey
|
||
label: "secretKey"
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: azure
|
||
label: "azure (EXTREMELY EXPERIMENTAL)"
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
show_if: [["provider", "=", "azure"]]
|
||
attrs:
|
||
- variable: path
|
||
label: "path"
|
||
schema:
|
||
type: string
|
||
default: "/"
|
||
- variable: connectionString
|
||
label: "connectionString"
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: storageAccount
|
||
label: "storageAccount"
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: storageKey
|
||
label: "storageKey"
|
||
schema:
|
||
type: string
|
||
show_if: [["enabled", "=", true]]
|
||
default: ""
|
||
- variable: storageSasToken
|
||
label: "storageSasToken"
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: containerName
|
||
label: "containerName"
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: serviceName
|
||
label: "serviceName"
|
||
schema:
|
||
type: string
|
||
default: "blob"
|
||
- variable: inheritFromAzureAD
|
||
label: "inheritFromAzureAD"
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
- variable: google
|
||
label: "google (EXTREMELY EXPERIMENTAL)"
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
show_if: [["provider", "=", "google"]]
|
||
attrs:
|
||
- variable: path
|
||
label: "path"
|
||
schema:
|
||
type: string
|
||
default: "/"
|
||
- variable: bucket
|
||
label: "bucket"
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: gkeEnvironment
|
||
label: "gkeEnvironment"
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: applicationCredentials
|
||
label: "applicationCredentials"
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: recovery
|
||
label: "Recovery Settings (Experimental)"
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: "enabled"
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
- variable: serverName
|
||
label: "serverName"
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: revision
|
||
label: "revision"
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: endpointURL
|
||
label: "endpointURL"
|
||
schema:
|
||
type: string
|
||
show_if: [["enabled", "=", true]]
|
||
default: ""
|
||
- variable: method
|
||
label: "method"
|
||
schema:
|
||
type: string
|
||
show_if: [["enabled", "=", true]]
|
||
default: "object_store"
|
||
- variable: backupName
|
||
label: "backupName"
|
||
schema:
|
||
type: string
|
||
show_if: [["enabled", "=", true]]
|
||
default: ""
|
||
- variable: provider
|
||
label: "provider"
|
||
schema:
|
||
type: string
|
||
show_if: [["enabled", "=", true]]
|
||
default: "s3"
|
||
enum:
|
||
- value: s3
|
||
description: S3
|
||
- value: azure
|
||
description: Azure
|
||
- value: google
|
||
description: Google
|
||
- variable: s3
|
||
label: "s3"
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
show_if: [["provider", "=", "s3"]]
|
||
attrs:
|
||
- variable: region
|
||
label: "region"
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: bucket
|
||
label: "bucket"
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: path
|
||
label: "path"
|
||
schema:
|
||
type: string
|
||
default: "/"
|
||
- variable: accessKey
|
||
label: "accessKey"
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: secretKey
|
||
label: "secretKey"
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: azure
|
||
label: "azure (EXTREMELY EXPERIMENTAL)"
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
show_if: [["provider", "=", "azure"]]
|
||
attrs:
|
||
- variable: path
|
||
label: "path"
|
||
schema:
|
||
type: string
|
||
default: "/"
|
||
- variable: connectionString
|
||
label: "connectionString"
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: storageAccount
|
||
label: "storageAccount"
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: storageKey
|
||
label: "storageKey"
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: storageSasToken
|
||
label: "storageSasToken"
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: containerName
|
||
label: "containerName"
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: serviceName
|
||
label: "serviceName"
|
||
schema:
|
||
type: string
|
||
default: "blob"
|
||
- variable: inheritFromAzureAD
|
||
label: "inheritFromAzureAD"
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
- variable: google
|
||
label: "google (EXTREMELY EXPERIMENTAL)"
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
show_if: [["provider", "=", "google"]]
|
||
attrs:
|
||
- variable: path
|
||
label: "path"
|
||
schema:
|
||
type: string
|
||
default: "/"
|
||
- variable: bucket
|
||
label: "bucket"
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: gkeEnvironment
|
||
label: "gkeEnvironment"
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: applicationCredentials
|
||
label: "applicationCredentials"
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
|
||
- variable: metrics
|
||
group: Metrics
|
||
label: Prometheus Metrics
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: main
|
||
label: Main Metrics
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: Enabled
|
||
description: Enable Prometheus Metrics
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
show_subquestions_if: true
|
||
subquestions:
|
||
|
||
- variable: prometheusRule
|
||
label: PrometheusRule
|
||
description: Enable and configure Prometheus Rules for the App.
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: Enabled
|
||
description: Enable Prometheus Metrics
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
# TODO: Rule List section
|
||
|
||
# - variable: horizontalPodAutoscaler
|
||
# group: Experimental
|
||
# label: (Advanced) Horizontal Pod Autoscaler
|
||
# schema:
|
||
# type: list
|
||
# default: []
|
||
# items:
|
||
# - variable: hpaEntry
|
||
# label: HPA Entry
|
||
# schema:
|
||
# additional_attrs: true
|
||
# type: dict
|
||
# attrs:
|
||
# - variable: name
|
||
# label: Name
|
||
# schema:
|
||
# type: string
|
||
# required: true
|
||
# default: ""
|
||
# - variable: enabled
|
||
# label: Enabled
|
||
# schema:
|
||
# type: boolean
|
||
# default: false
|
||
# show_subquestions_if: true
|
||
# subquestions:
|
||
# - variable: target
|
||
# label: Target
|
||
# description: Deployment name, Defaults to Main Deployment
|
||
# schema:
|
||
# type: string
|
||
# default: ""
|
||
# - variable: minReplicas
|
||
# label: Minimum Replicas
|
||
# schema:
|
||
# type: int
|
||
# default: 1
|
||
# - variable: maxReplicas
|
||
# label: Maximum Replicas
|
||
# schema:
|
||
# type: int
|
||
# default: 5
|
||
# - variable: targetCPUUtilizationPercentage
|
||
# label: Target CPU Utilization Percentage
|
||
# schema:
|
||
# type: int
|
||
# default: 80
|
||
# - variable: targetMemoryUtilizationPercentage
|
||
# label: Target Memory Utilization Percentage
|
||
# schema:
|
||
# type: int
|
||
# default: 80
|
||
- variable: networkPolicy
|
||
group: Experimental
|
||
label: (Advanced) Network Policy
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: netPolicyEntry
|
||
label: Network Policy Entry
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: name
|
||
label: Name
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: ""
|
||
- variable: enabled
|
||
label: Enabled
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
show_subquestions_if: true
|
||
subquestions:
|
||
- variable: policyType
|
||
label: Policy Type
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
enum:
|
||
- value: ""
|
||
description: Default
|
||
- value: ingress
|
||
description: Ingress
|
||
- value: egress
|
||
description: Egress
|
||
- value: ingress-egress
|
||
description: Ingress and Egress
|
||
- variable: egress
|
||
label: Egress
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: egressEntry
|
||
label: ""
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: to
|
||
label: To
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: toEntry
|
||
label: ""
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: ipBlock
|
||
label: IP Block
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: cidr
|
||
label: CIDR
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: except
|
||
label: Except
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: exceptint
|
||
label: ""
|
||
schema:
|
||
type: string
|
||
- variable: namespaceSelector
|
||
label: Namespace Selector
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: matchExpressions
|
||
label: Match Expressions
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: expressionEntry
|
||
label: ""
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: key
|
||
label: Key
|
||
schema:
|
||
type: string
|
||
- variable: operator
|
||
label: Operator
|
||
schema:
|
||
type: string
|
||
default: TCP
|
||
enum:
|
||
- value: In
|
||
description: In
|
||
- value: NotIn
|
||
description: NotIn
|
||
- value: Exists
|
||
description: Exists
|
||
- value: DoesNotExist
|
||
description: DoesNotExist
|
||
- variable: values
|
||
label: Values
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: value
|
||
label: ""
|
||
schema:
|
||
type: string
|
||
- variable: podSelector
|
||
label: ""
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: matchExpressions
|
||
label: Match Expressions
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: expressionEntry
|
||
label: ""
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: key
|
||
label: Key
|
||
schema:
|
||
type: string
|
||
- variable: operator
|
||
label: Operator
|
||
schema:
|
||
type: string
|
||
default: TCP
|
||
enum:
|
||
- value: In
|
||
description: In
|
||
- value: NotIn
|
||
description: NotIn
|
||
- value: Exists
|
||
description: Exists
|
||
- value: DoesNotExist
|
||
description: DoesNotExist
|
||
- variable: values
|
||
label: Values
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: value
|
||
label: ""
|
||
schema:
|
||
type: string
|
||
- variable: ports
|
||
label: Ports
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: portsEntry
|
||
label: ""
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: port
|
||
label: Port
|
||
schema:
|
||
type: int
|
||
- variable: endPort
|
||
label: End Port
|
||
schema:
|
||
type: int
|
||
- variable: protocol
|
||
label: Protocol
|
||
schema:
|
||
type: string
|
||
default: TCP
|
||
enum:
|
||
- value: TCP
|
||
description: TCP
|
||
- value: UDP
|
||
description: UDP
|
||
- value: SCTP
|
||
description: SCTP
|
||
- variable: ingress
|
||
label: Ingress
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: ingressEntry
|
||
label: ""
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: from
|
||
label: From
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: fromEntry
|
||
label: ""
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: ipBlock
|
||
label: IP Block
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: cidr
|
||
label: CIDR
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: except
|
||
label: Except
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: exceptint
|
||
label: ""
|
||
schema:
|
||
type: string
|
||
- variable: namespaceSelector
|
||
label: Namespace Selector
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: matchExpressions
|
||
label: Match Expressions
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: expressionEntry
|
||
label: ""
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: key
|
||
label: Key
|
||
schema:
|
||
type: string
|
||
- variable: operator
|
||
label: Operator
|
||
schema:
|
||
type: string
|
||
default: TCP
|
||
enum:
|
||
- value: In
|
||
description: In
|
||
- value: NotIn
|
||
description: NotIn
|
||
- value: Exists
|
||
description: Exists
|
||
- value: DoesNotExist
|
||
description: DoesNotExist
|
||
- variable: values
|
||
label: Values
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: value
|
||
label: ""
|
||
schema:
|
||
type: string
|
||
- variable: podSelector
|
||
label: ""
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: matchExpressions
|
||
label: Match Expressions
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: expressionEntry
|
||
label: ""
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: key
|
||
label: Key
|
||
schema:
|
||
type: string
|
||
- variable: operator
|
||
label: Operator
|
||
schema:
|
||
type: string
|
||
default: TCP
|
||
enum:
|
||
- value: In
|
||
description: In
|
||
- value: NotIn
|
||
description: NotIn
|
||
- value: Exists
|
||
description: Exists
|
||
- value: DoesNotExist
|
||
description: DoesNotExist
|
||
- variable: values
|
||
label: Values
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: value
|
||
label: ""
|
||
schema:
|
||
type: string
|
||
- variable: ports
|
||
label: Ports
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: portsEntry
|
||
label: ""
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: port
|
||
label: Port
|
||
schema:
|
||
type: int
|
||
- variable: endPort
|
||
label: End Port
|
||
schema:
|
||
type: int
|
||
- variable: protocol
|
||
label: Protocol
|
||
schema:
|
||
type: string
|
||
default: TCP
|
||
enum:
|
||
- value: TCP
|
||
description: TCP
|
||
- value: UDP
|
||
description: UDP
|
||
- value: SCTP
|
||
description: SCTP
|
||
|
||
- variable: addons
|
||
group: Addons
|
||
label: ""
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
|
||
- variable: codeserver
|
||
label: Codeserver
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: Enabled
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
show_subquestions_if: true
|
||
subquestions:
|
||
- variable: service
|
||
label: ""
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: type
|
||
label: Service Type
|
||
description: "ClusterIP's are only internally available and Loadbalancer exposes the service using the system loadbalancer"
|
||
schema:
|
||
type: string
|
||
default: LoadBalancer
|
||
enum:
|
||
- value: NodePort
|
||
description: Deprecated CHANGE THIS
|
||
- value: ClusterIP
|
||
description: ClusterIP
|
||
- value: LoadBalancer
|
||
description: LoadBalancer
|
||
- variable: loadBalancerIP
|
||
label: LoadBalancer IP
|
||
description: "MetalLB Only: Selects the Loadbalancer IP to expose on. Required when using PortalButton with MetalLB"
|
||
schema:
|
||
show_if: [["type", "=", "LoadBalancer"]]
|
||
type: string
|
||
default: ""
|
||
- variable: ports
|
||
label: ""
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: codeserver
|
||
label: ""
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: port
|
||
label: Port
|
||
schema:
|
||
type: int
|
||
default: 36107
|
||
- variable: ingress
|
||
label: "Ingress"
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: Enable Ingress
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
show_subquestions_if: true
|
||
subquestions:
|
||
- variable: hosts
|
||
label: Hosts
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: hostEntry
|
||
label: Host
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: host
|
||
label: HostName
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
required: true
|
||
- variable: paths
|
||
label: Paths
|
||
schema:
|
||
type: list
|
||
default: [{path: "/", pathType: "Prefix"}]
|
||
items:
|
||
- variable: pathEntry
|
||
label: Host
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: path
|
||
label: Path
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: "/"
|
||
- variable: pathType
|
||
label: Path Type
|
||
schema:
|
||
type: string
|
||
required: true
|
||
default: Prefix
|
||
- variable: integrations
|
||
label: Integrations
|
||
description: Connect ingress with other charts
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: traefik
|
||
label: Traefik
|
||
description: Connect ingress with Traefik
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: enabled
|
||
schema:
|
||
type: boolean
|
||
default: true
|
||
- variable: allowCors
|
||
label: 'Allow Cross Origin Requests (advanced)'
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
show_if: [["enabled", "=", true]]
|
||
- variable: entrypoints
|
||
label: Entrypoints
|
||
schema:
|
||
type: list
|
||
default: ["websecure"]
|
||
show_if: [["enabled", "=", true]]
|
||
items:
|
||
- variable: entrypoint
|
||
label: Entrypoint
|
||
schema:
|
||
type: string
|
||
- variable: middlewares
|
||
label: Middlewares
|
||
schema:
|
||
type: list
|
||
default: []
|
||
show_if: [["enabled", "=", true]]
|
||
items:
|
||
- variable: middleware
|
||
label: Middleware
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: name
|
||
label: name
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
required: true
|
||
- variable: namespace
|
||
label: 'namespace (optional)'
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: certManager
|
||
label: certManager
|
||
description: Connect ingress with certManager
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: enabled
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
- variable: certificateIssuer
|
||
label: certificateIssuer
|
||
description: defaults to chartname
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
show_if: [["enabled", "=", true]]
|
||
- variable: advanced
|
||
label: Show Advanced Settings
|
||
description: Advanced settings are not covered by TrueCharts Support
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
- variable: ingressClassName
|
||
label: (Advanced/Optional) IngressClass Name
|
||
schema:
|
||
type: string
|
||
show_if: [["advanced", "=", true]]
|
||
default: ""
|
||
- variable: tls
|
||
label: TLS-Settings
|
||
schema:
|
||
type: list
|
||
show_if: [["advanced", "=", true]]
|
||
default: []
|
||
items:
|
||
- variable: tlsEntry
|
||
label: Host
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: hosts
|
||
label: Certificate Hosts
|
||
schema:
|
||
type: list
|
||
default: []
|
||
items:
|
||
- variable: host
|
||
label: Host
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
required: true
|
||
|
||
- variable: certificateIssuer
|
||
label: Use Cert-Manager clusterIssuer
|
||
description: 'add the name of your cert-manager clusterIssuer here for automatic tls certificates.'
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: clusterCertificate
|
||
label: 'Cluster Certificate (Advanced)'
|
||
description: 'Add the name of your cluster-wide certificate, that you set up in the ClusterIssuer chart.'
|
||
schema:
|
||
type: string
|
||
show_if: [["certificateIssuer", "=", ""]]
|
||
default: ""
|
||
- variable: secretName
|
||
label: 'Use Custom Certificate Secret (Advanced)'
|
||
schema:
|
||
show_if: [["certificateIssuer", "=", ""]]
|
||
type: string
|
||
default: ""
|
||
- variable: scaleCert
|
||
label: 'Use TrueNAS SCALE Certificate (Deprecated)'
|
||
schema:
|
||
show_if: [["certificateIssuer", "=", ""]]
|
||
type: int
|
||
$ref:
|
||
- "definitions/certificate"
|
||
- variable: envList
|
||
label: Codeserver Environment Variables
|
||
schema:
|
||
type: list
|
||
show_if: [["type", "!=", "disabled"]]
|
||
default: []
|
||
items:
|
||
- variable: envItem
|
||
label: Environment Variable
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: name
|
||
label: Name
|
||
schema:
|
||
type: string
|
||
required: true
|
||
- variable: value
|
||
label: Value
|
||
schema:
|
||
type: string
|
||
required: true
|
||
|
||
- variable: netshoot
|
||
label: Netshoot
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: enabled
|
||
label: Enabled
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
show_subquestions_if: true
|
||
subquestions:
|
||
- variable: envList
|
||
label: Netshoot Environment Variables
|
||
schema:
|
||
type: list
|
||
show_if: [["type", "!=", "disabled"]]
|
||
default: []
|
||
items:
|
||
- variable: envItem
|
||
label: Environment Variable
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: name
|
||
label: Name
|
||
schema:
|
||
type: string
|
||
required: true
|
||
- variable: value
|
||
label: Value
|
||
schema:
|
||
type: string
|
||
required: true
|
||
|
||
- variable: vpn
|
||
label: VPN
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: type
|
||
label: Type
|
||
schema:
|
||
type: string
|
||
default: disabled
|
||
enum:
|
||
- value: disabled
|
||
description: disabled
|
||
- value: gluetun
|
||
description: Gluetun
|
||
- value: tailscale
|
||
description: Tailscale
|
||
- value: openvpn
|
||
description: OpenVPN (Deprecated)
|
||
- value: wireguard
|
||
description: Wireguard (Deprecated)
|
||
- variable: openvpn
|
||
label: OpenVPN Settings
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
show_if: [["type", "=", "openvpn"]]
|
||
attrs:
|
||
- variable: username
|
||
label: Authentication Username (Optional)
|
||
description: Authentication Username, Optional
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: password
|
||
label: Authentication Password
|
||
description: Authentication Credentials
|
||
schema:
|
||
type: string
|
||
show_if: [["username", "!=", ""]]
|
||
default: ""
|
||
required: true
|
||
- variable: tailscale
|
||
label: Tailscale Settings
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
show_if: [["type", "=", "tailscale"]]
|
||
attrs:
|
||
- variable: authkey
|
||
label: Authentication Key
|
||
description: Provide an auth key to automatically authenticate the node as your user account.
|
||
schema:
|
||
type: string
|
||
private: true
|
||
default: ""
|
||
- variable: auth_once
|
||
label: Auth Once
|
||
description: Only attempt to log in if not already logged in.
|
||
schema:
|
||
type: boolean
|
||
default: true
|
||
- variable: accept_dns
|
||
label: Accept DNS
|
||
description: Accept DNS configuration from the admin console.
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
- variable: userspace
|
||
label: Userspace
|
||
description: Userspace Networking mode allows running Tailscale where you do not have access to create a VPN tunnel device.
|
||
schema:
|
||
type: boolean
|
||
default: false
|
||
- variable: routes
|
||
label: Routes
|
||
description: Expose physical subnet routes to your entire Tailscale network.
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: dest_ip
|
||
label: Destination IP
|
||
description: Tells the DNAT mechanism which Destination IP to set in the IP header, and where to send packets that are matched.
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: sock5_server
|
||
label: Sock5 Server
|
||
description: The address on which to listen for SOCKS5 proxying into the tailscale net.
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: outbound_http_proxy_listen
|
||
label: Outbound HTTP Proxy Listen
|
||
description: The address on which to listen for HTTP proxying into the tailscale net.
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: extra_args
|
||
label: Extra Args
|
||
description: Extra Args
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: daemon_extra_args
|
||
label: Tailscale Daemon Extra Args
|
||
description: Tailscale Daemon Extra Args
|
||
schema:
|
||
type: string
|
||
default: ""
|
||
- variable: killSwitch
|
||
label: Enable Killswitch
|
||
schema:
|
||
type: boolean
|
||
show_if: [["type", "!=", "disabled"]]
|
||
default: true
|
||
- variable: excludedNetworks_IPv4
|
||
label: Killswitch Excluded IPv4 networks
|
||
description: List of Killswitch Excluded IPv4 Addresses
|
||
schema:
|
||
type: list
|
||
show_if: [["type", "!=", "disabled"]]
|
||
default: []
|
||
items:
|
||
- variable: networkv4
|
||
label: IPv4 Network
|
||
schema:
|
||
type: string
|
||
required: true
|
||
- variable: excludedNetworks_IPv6
|
||
label: Killswitch Excluded IPv6 networks
|
||
description: "List of Killswitch Excluded IPv6 Addresses"
|
||
schema:
|
||
type: list
|
||
show_if: [["type", "!=", "disabled"]]
|
||
default: []
|
||
items:
|
||
- variable: networkv6
|
||
label: IPv6 Network
|
||
schema:
|
||
type: string
|
||
required: true
|
||
- variable: configFile
|
||
label: VPN Config File Location
|
||
schema:
|
||
type: string
|
||
show_if: [["type", "!=", "disabled"]]
|
||
default: ""
|
||
|
||
- variable: envList
|
||
label: VPN Environment Variables
|
||
schema:
|
||
type: list
|
||
show_if: [["type", "!=", "disabled"]]
|
||
default: []
|
||
items:
|
||
- variable: envItem
|
||
label: Environment Variable
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: name
|
||
label: Name
|
||
schema:
|
||
type: string
|
||
required: true
|
||
- variable: value
|
||
label: Value
|
||
schema:
|
||
type: string
|
||
required: true
|
||
max_length: 10240
|
||
|
||
- variable: docs
|
||
group: Documentation
|
||
label: Please read the documentation at https://truecharts.org
|
||
description: Please read the documentation at
|
||
<br /><a href="https://truecharts.org">https://truecharts.org</a>
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: confirmDocs
|
||
label: I have checked the documentation
|
||
schema:
|
||
type: boolean
|
||
default: true
|
||
- variable: donateNag
|
||
group: Documentation
|
||
label: Please consider supporting TrueCharts, see https://truecharts.org/sponsor
|
||
description: Please consider supporting TrueCharts, see
|
||
<br /><a href="https://truecharts.org/sponsor">https://truecharts.org/sponsor</a>
|
||
schema:
|
||
additional_attrs: true
|
||
type: dict
|
||
attrs:
|
||
- variable: confirmDonate
|
||
label: I have considered donating
|
||
schema:
|
||
type: boolean
|
||
default: true
|
||
hidden: true
|
||
|