TrueChartsCatalogClone/system/kubeapps/2.10.12/questions.yaml

groups:
  - name: Image
    description: |
      Configured the images to be used for the Chart.
      It's wise to use "digest pinned" tags and to avoid using "latest".
      More information can be found here: https://truecharts.org/common/#images
    
    
  - name: General
    description: |
      For TrueNAS SCALE We've grouped a number of settings here, that all effact how apps run in general.
      More info can be found on their respective pages in manual:
        - Global Settings https://truecharts.org/common/global/
        - TimeZone https://truecharts.org/common/#tz
        - Pod Options https://truecharts.org/common/podoptions/
        - Image Pull Secrets
    
    
  - name: Workload
    description: |
      These settings configure how the actual Pods and containers are running.
      Generally, on SCALE, we only expose a limited subset of these settings for the primary workload and container.
      
      More info on workload options can be found here: https://truecharts.org/common/workload/
      Whereas the container options can be found here: https://truecharts.org/common/container/
    
    
  - name: App Configuration
    description: |
       Every application has different values that may be required to run or have multiple options that the user may choose to enable or disable to change the behavior of the application.
       Most options should have a Tooltip (Circled Question Mark) to further describe said option.
       
       More information can be found by looking up the chart-specifc docs on the website: https://truecharts.org/charts/description-list/
    
    
  - name: Services
    description: |
      Service and Networking options for any applications are contained here. 
      Some applications may have complicated networking setups with multiple options or some may have no options here at all. 
      
      Options here include the service and port configurations for the application, and more may be enabled or changed under the Advanced Settings and Show Expert Config boxes.
      
      Information the Kubernetes service options can be found here: https://truecharts.org/common/service/
      
  - name: Networking
    description: |
      Contains advanced networking options that are not actively supported by the TrueCharts team.
      
      Currently only contains scaleExternalInterfaces.
      Information for which is available here: https://truecharts.org/common/scaleexternalinterface/
    
  - name: Persistence
    description: |
      Many applications will have certain options for storage to be configurable by the user, the main two being PVC and hostpath but may include other types. 
      This storage is called Persistence since it is not deleted upon restart or upgrade of an application.
      
      For more information on the many different storage options, checkout the docs here: https://truecharts.org/common/persistence/
      
      For more information on why TrueCharts advices the use of PVC storage, please see: https://truecharts.org/general/faq/#why-pvc-is-recommended-over-hostpath
    
    
  - name: Ingress
    description: |
      Ingress (more commonly known as Reverse Proxy) settings can be configured here. This is how Kubernetes connects your Applications in containers to FQDNs (fully qualified domain names). 
      If you choose to enable this you must have a "Ingress Provider" aka "Reverse Proxy" installed (We highly advice Traefik: https://truecharts.org/charts/premium/traefik/) 
      It also requiresa DNS service to actually resolve the DNS name of the FQDN specified.
      
      More info on Ingress configuration options: https://truecharts.org/common/ingress/
      
    
  - name: SecurityContext
    description: |
      The security settings for each application and/or permissions that each application may have for the files/directories created. 
      Each application will come with predefined permissions but users may want to change certain setting depending on their usage or capabilities. 
      
      Unless necessary users are advised to keep this section mostly to defaults.
      
      For more information on security settings see: https://truecharts.org/common/securitycontext/
    
    
  - name: Resources
    description: |
      Resources limits that have been defined by each application are in this section. 
      Most will have a specific default that some users may want to change based on their specific hardware or needs.
      
      This also contains the options to mount GPUs or, more precisely, "request" GPU's to be mounted.
      
      For more information checkout: https://truecharts.org/common/resources/
    
  - name: Devices
    description: |
      These are special "mountpoints" that can be used to mount miscelanious USB and PCI devices using special hostPath mounts.
      For clearity we've decided to seperate this from persistence on SCALE.
      
      For more inforation see: https://truecharts.org/common/persistence/device/
    
  - name: Middlewares
    description: Traefik Middlewares
    
  - name: StorageClass
    description: |
      StorageClasses define where to storage Storage.
    
  - name: Metrics
    description: |
      Contains options to configure Prometheus metrics for the application.
      Checkout https://truecharts.org/common/metrics/ for more info
      
    
  - 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. 
      Things included here are VPN addons, Codeserver for editing files inside the application’s container, Netshoot for network troubelshooting, etc. 
      
      Generally not required for use but may be necessary or usefull at times for specific applications.
      
      For more information see: https://truecharts.org/common/addons/
    
  - name: Experimental
    description: |
      Experimental Configuration Options
      Often these are not fully flushed-out, could randomly break or might not work at-all.
    
  - name: Postgresql
    description: |
      For Postgresql we use "CloudNative-PG" as a backend, which has to be installed first.
      
      For more information see: https://truecharts.org/common/cnpg/
    
    
  - name: Dependencies
    description: |
      contains dependency setting for which we, currently, do not have seperate catagories (yet)
    
    
  - name: Documentation
    description: |
      We added this section to make everyone aware that OpenSource isn't always easy.
      It doesn't keep existing without signficant ongoing support, so please consider supporting TrueCharts and other OpenSource projects.

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: service
    group: Services
    label: Configure Service(s)
    schema:
      additional_attrs: true
      type: dict
      attrs:

        - variable: tckubeapps
          label: "KubeApps Service"
          description: "The Primary service on which the healthcheck runs, often the webUI"
          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: tckubeapps
                      label: "KubeApps Service 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: 8080
                              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: 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: 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