truenas/library/ix-dev/community/mineos/questions.yaml

groups:
  - name: MineOS Configuration
    description: Configure MineOS
  - name: User and Group Configuration
    description: Configure User and Group for MineOS
  - name: Network Configuration
    description: Configure Network for MineOS
  - name: Storage Configuration
    description: Configure Storage for MineOS
  - name: Resources Configuration
    description: Configure Resources for MineOS

portals:
  web_portal:
    protocols:
      - "$kubernetes-resource_configmap_portal_protocol"
    host:
      - "$kubernetes-resource_configmap_portal_host"
    ports:
      - "$kubernetes-resource_configmap_portal_port"
    path: "$kubernetes-resource_configmap_portal_path"

questions:
  - variable: mineosConfig
    label: ""
    group: MineOS Configuration
    schema:
      type: dict
      attrs:
        - variable: username
          label: Username
          description: The username for MineOS WebUI.
          schema:
            type: string
            empty: false
            required: true
            valid_chars: '^[a-zA-Z0-9]+$'
            valid_chars_error: |
              Username can only contain alphanumeric characters [0-9, a-z, A-Z].
        - variable: password
          label: Password
          description: The password for MineOS WebUI.
          schema:
            type: string
            empty: false
            required: true
            private: true
        - variable: terminationGracePeriodSeconds
          label: Stop Grace Period
          description: |
            The time in seconds given to MineOS to stop before it is killed.
            Killing a MineOS server without a grace period can cause data corruption.
          schema:
            type: int
            empty: false
            min: 30
            required: true
            default: 600
        - variable: additionalEnvs
          label: Additional Environment Variables
          description: Configure additional environment variables for MineOS.
          schema:
            type: list
            default: []
            items:
              - variable: env
                label: Environment Variable
                schema:
                  type: dict
                  attrs:
                    - variable: name
                      label: Name
                      schema:
                        type: string
                        required: true
                    - variable: value
                      label: Value
                      schema:
                        type: string
                        required: true

  - variable: mineosID
    label: ""
    group: User and Group Configuration
    schema:
      type: dict
      attrs:
        - variable: user
          label: User ID
          description: The user id that MineOS files will be owned by.
          schema:
            type: int
            min: 568
            default: 568
            required: true
        - variable: group
          label: Group ID
          description: The group id that MineOS files will be owned by.
          schema:
            type: int
            min: 568
            default: 568
            required: true

  - variable: mineosNetwork
    label: ""
    group: Network Configuration
    schema:
      type: dict
      attrs:
        - variable: webPort
          label: WebUI Port
          description: The port for MineOS WebUI
          schema:
            type: int
            default: 30015
            min: 9000
            max: 65535
            required: true
        - variable: mineosPortRangeStart
          label: Port Range Start
          description: |
            The start of the port range for MineOS servers.</br>
            It will open both TCP and UDP ports.
          schema:
            type: int
            default: 30016
            min: 9000
            max: 65535
            required: true
        - variable: mineosPortRangeEnd
          label: Port Range End
          description: |
            The end of the port range for MineOS servers.</br>
            It will open both TCP and UDP ports.</br>
            Keep in mind that the port range can be at max 10 ports.
          schema:
            type: int
            default: 30017
            min: 9000
            max: 65535
            required: true
        - variable: useHTTPS
          label: Use HTTPS
          description: |
            Enable HTTPS for MineOS WebUI.</br>
            If enabled, and you don't specify a certificate, </br>
            a self-signed certificate will be generated.
          schema:
            type: boolean
            default: false
        - variable: certificateID
          label: Certificate
          description: The certificate to use for MineOS WebUI
          schema:
            show_if: [["useHTTPS", "=", true]]
            type: int
            "null": true
            $ref:
              - "definitions/certificate"

  - variable: mineosStorage
    label: ""
    group: Storage Configuration
    schema:
      type: dict
      attrs:
        - variable: data
          label: MineOS Data Storage
          description: The path to store MineOS Data.
          schema:
            type: dict
            attrs:
              - variable: type
                label: Type
                description: |
                  ixVolume: Is dataset created automatically by the system.</br>
                  Host Path: Is a path that already exists on the system.
                schema:
                  type: string
                  required: true
                  immutable: true
                  default: ixVolume
                  enum:
                    - value: hostPath
                      description: Host Path (Path that already exists on the system)
                    - value: ixVolume
                      description: ixVolume (Dataset created automatically by the system)
              - variable: datasetName
                label: Dataset Name
                schema:
                  type: string
                  show_if: [["type", "=", "ixVolume"]]
                  required: true
                  hidden: true
                  immutable: true
                  default: data
                  $ref:
                    - "normalize/ixVolume"
              - variable: hostPath
                label: Host Path
                schema:
                  type: hostpath
                  show_if: [["type", "=", "hostPath"]]
                  immutable: true
                  required: true

  - variable: resources
    label: Resources Configuration
    group: Resources Configuration
    schema:
      type: dict
      attrs:
        - variable: limits
          label: Limits
          schema:
            type: dict
            attrs:
              - variable: cpu
                label: CPU
                description: CPU limit for MineOS.
                schema:
                  type: string
                  max_length: 6
                  valid_chars: '^(0\.[1-9]|[1-9][0-9]*)(\.[0-9]|m?)$'
                  valid_chars_error: |
                    Valid CPU limit formats are</br>
                    - Plain Integer - eg. 1</br>
                    - Float - eg. 0.5</br>
                    - Milicpu - eg. 500m
                  default: "4000m"
                  required: true
              - variable: memory
                label: Memory
                description: Memory limit for MineOS.
                schema:
                  type: string
                  max_length: 12
                  valid_chars: '^[1-9][0-9]*([EPTGMK]i?|e[0-9]+)?$'
                  valid_chars_error: |
                    Valid Memory limit formats are</br>
                    - Suffixed with E/P/T/G/M/K - eg. 1G</br>
                    - Suffixed with Ei/Pi/Ti/Gi/Mi/Ki - eg. 1Gi</br>
                    - Plain Integer in bytes - eg. 1024</br>
                    - Exponent - eg. 134e6
                  default: "8Gi"
                  required: true