truenas/library/ix-dev/charts/pihole/questions.yaml

groups:
  - name: "Configuration"
    description: "Pihole application configuration"
  - name: "Storage"
    description: "Configure storage for pihole"
  - name: "Networking"
    description: "Networking Configuration for pihole"
  - name: "Advanced DNS Settings"
    description: "Configure DNS settings"
  - name: "Resource Limits"
    description: "Set CPU/memory limits for Kubernetes Pod"


portals:
  web_portal:
    protocols:
      - "http"
    host:
      - "$node_ip"
    ports:
      - "$variable-web_port"
    path: "/admin/"

questions:
  - variable: web_port
    label: "Web Port for pihole"
    group: Networking
    schema:
      type: int
      min: 8000
      max: 65535
      default: 20720
      required: true
  - variable: dns_tcp_port
    label: "DNS TCP Port for pihole"
    group: Networking
    schema:
      type: int
      min: 8000
      max: 65535
      default: 20721
      show_if: [["hostNetwork", "=", false]]
      required: true
  - variable: dns_udp_port
    label: "DNS UDP Port for pihole"
    group: Networking
    schema:
      type: int
      min: 8000
      max: 65535
      default: 20721
      show_if: [["hostNetwork", "=", false]]
      required: true
  - variable: dhcp
    label: "Enable DHCP"
    group: "Networking"
    schema:
      type: boolean
      default: false
      show_subquestions_if: true
      subquestions:
        - variable: dhcp_port
          label: "DHCP Port for pihole"
          group: Networking
          schema:
            type: int
            min: 8000
            max: 65535
            default: 20722
            show_if: [["hostNetwork", "=", false]]
            required: true
        - variable: dhcp_start
          label: "DHCP Start Address"
          group: Networking
          schema:
            type: ipaddr
            cidr: false
            required: true
        - variable: dhcp_end
          label: "DHCP End Address"
          group: Networking
          schema:
            type: ipaddr
            cidr: false
            required: true
        - variable: dhcp_gateway
          label: "Gateway"
          group: Networking
          schema:
            type: ipaddr
            cidr: false
            required: true

  - variable: dnsConfig
    label: "DNS Configuration"
    group: "Advanced DNS Settings"
    schema:
      type: dict
      attrs:
        - variable: options
          label: "DNS Options"
          schema:
            type: list
            items:
              - variable: optionsEntry
                label: "Option Entry Configuration"
                schema:
                  type: dict
                  attrs:
                    - variable: name
                      label: "Option Name"
                      schema:
                        type: string
                        required: true
                    - variable: value
                      label: "Option Value"
                      schema:
                        type: string
                        required: true

  - variable: ownerUID
    label: "Storage User ID"
    description: "User ID of the dnsmasq volume being used (application will chown the volume path with specified UID)"
    group: Configuration
    schema:
      type: int
      default: 568
      min: 1
      max: 65535

  - variable: ownerGID
    label: "Storage Group ID"
    description: "Group ID of the dnsmasq volume being used (application will chown the volume path with specified GID)"
    group: Configuration
    schema:
      type: int
      default: 568
      min: 1
      max: 65535

  - variable: password
    label: "Admin password"
    group: "Configuration"
    schema:
      type: string
      private: true
      required: true
      empty: false
      immutable: true

  - variable: timezone
    label: "Configure timezone"
    group: "Configuration"
    description: "Configure timezone for pihole"
    schema:
      type: string
      $ref:
        - "definitions/timezone"

  - variable: hostNetwork
    label: "Enable Host Network"
    group: "Networking"
    schema:
      type: boolean
      default: false

  - variable: environmentVariables
    label: "Pihole environment"
    group: "Configuration"
    schema:
      type: list
      default: []
      items:
        - variable: environmentVariable
          label: "Environment Variable"
          schema:
            type: dict
            attrs:
              - variable: name
                label: "Name"
                schema:
                  type: string
              - variable: value
                label: "Value"
                schema:
                  type: string

  - variable: appVolumeMounts
    label: "Pihole Storage"
    group: "Storage"
    schema:
      type: dict
      attrs:
        - variable: config
          label: "Configuration Volume"
          schema:
            type: dict
            attrs:
              - variable: datasetName
                label: "Configuration Volume Dataset Name"
                schema:
                  type: string
                  hidden: true
                  $ref:
                    - "normalize/ixVolume"
                  show_if: [["hostPathEnabled", "=", false]]
                  default: "ix-pihole_config"
                  editable: false
              - variable: mountPath
                label: "Configuration Mount Path"
                description: "Path where the volume will be mounted inside the pod"
                schema:
                  type: path
                  hidden: true
                  editable: true
                  default: "/etc/pihole"
              - variable: hostPathEnabled
                label: "Enable Custom Host Path for Pihole Configuration Volume"
                schema:
                  type: boolean
                  default: false
                  show_subquestions_if: true
                  subquestions:
                    - variable: hostPath
                      label: "Host Path for Pihole Configuration Volume"
                      schema:
                        type: hostpath
                        required: true
        - variable: dnsmasq
          label: "DNSMASQ Volume for pihole"
          schema:
            type: dict
            attrs:
              - variable: datasetName
                label: "DNSMASQ Volume Dataset Name"
                schema:
                  type: string
                  hidden: true
                  $ref:
                    - "normalize/ixVolume"
                  show_if: [["hostPathEnabled", "=", false]]
                  default: "ix-pihole_dnsmasq"
                  editable: false
              - variable: mountPath
                label: "DNSMASQ Mount Path"
                description: "Path where the volume will be mounted inside the pod"
                schema:
                  type: path
                  hidden: true
                  editable: true
                  default: "/etc/dnsmasq.d"
              - variable: hostPathEnabled
                label: "Enable Custom Host Path for Pihole DNSMASQ Volume"
                schema:
                  type: boolean
                  default: false
                  show_subquestions_if: true
                  subquestions:
                    - variable: hostPath
                      label: "Host Path for Pihole DNSMASQ Volume"
                      schema:
                        type: hostpath
                        required: true

  - variable: extraAppVolumeMounts
    label: "Extra Host Path Volumes"
    group: "Storage"
    schema:
      type: list
      items:
        - variable: extraAppVolume
          label: "Host Path Volume"
          description: "Add an extra host path volume for Pihole application"
          schema:
            type: dict
            attrs:
              - variable: mountPath
                label: "Mount Path in Pod"
                description: "Path where the volume will be mounted inside the pod"
                schema:
                  type: path
                  required: true
              - variable: hostPath
                label: "Host Path"
                description: "Host path"
                schema:
                  type: hostpath
                  required: true

  - variable: enableResourceLimits
    label: "Enable Pod resource limits"
    group: "Resource Limits"
    schema:
      type: boolean
      default: false
  - variable: cpuLimit
    label: "CPU Limresource limitsit"
    description: "CPU resource limit allow  plain integer values with suffix m(milli) e.g 1000m, 100."
    group: "Resource Limits"
    schema:
      type: string
      show_if: [["enableResourceLimits", "=", true]]
      valid_chars: "^\\d+(?:\\.\\d+(?!.*m$)|m?$)"
      default: "4000m"
  - variable: memLimit
    label: "Memory Limit"
    group: "Resource Limits"
    description: "Memory limits is specified by number of bytes. Followed by quantity suffix like E,P,T,G,M,k and Ei,Pi,Ti,Mi,Gi,Ki can also be used. e.g 129e6, 129M,  128974848000m, 123Mi"
    schema:
      type: string
      show_if: [["enableResourceLimits", "=", true]]
      valid_chars: "^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$"
      default: "8Gi"