apps/ix-dev/dev/docker-socket-proxy/questions.yaml

groups:
  - name: Docker Socket Proxy Configuration
    description: Configure Docker Socket Proxy
  - name: Network Configuration
    description: Configure Network for Docker Socket Proxy
  - name: Storage Configuration
    description: Configure Storage for Docker Socket Proxy
  - name: Labels Configuration
    description: Configure Labels for Docker Socket Proxy
  - name: Resources Configuration
    description: Configure Resources for Docker Socket Proxy

questions:
  - variable: TZ
    group: Docker Socket Proxy Configuration
    label: Timezone
    schema:
      type: string
      default: Etc/UTC
      required: true
      $ref:
        - definitions/timezone
  - variable: socket_proxy
    label: ""
    group: Docker Socket Proxy Configuration
    description: |
      For more information what each option does, please refer to the documentation of the Docker Socket Proxy project.</br>
      Documentation at https://github.com/Tecnativa/docker-socket-proxy?tab=readme-ov-file#grant-or-revoke-access-to-certain-api-sections
    schema:
      type: dict
      attrs:
        - variable: allow_restarts
          label: Allow Restarts
          schema:
            type: boolean
            default: true
        - variable: allow_start
          label: Allow Start
          schema:
            type: boolean
            default: true
        - variable: allow_stop
          label: Allow Stop
          schema:
            type: boolean
            default: true
        - variable: auth
          label: Auth
          schema:
            type: boolean
            default: true
        - variable: build
          label: Build
          schema:
            type: boolean
            default: true
        - variable: commit
          label: Commit
          schema:
            type: boolean
            default: true
        - variable: configs
          label: Configs
          schema:
            type: boolean
            default: true
        - variable: containers
          label: Containers
          schema:
            type: boolean
            default: true
        - variable: distribution
          label: Distribution
          schema:
            type: boolean
            default: true
        - variable: events
          label: Events
          schema:
            type: boolean
            default: true
        - variable: exec
          label: Exec
          schema:
            type: boolean
            default: true
        - variable: grpc
          label: gRPC
          schema:
            type: boolean
            default: true
        - variable: images
          label: Images
          schema:
            type: boolean
            default: true
        - variable: info
          label: Info
          schema:
            type: boolean
            default: true
        - variable: networks
          label: Networks
          schema:
            type: boolean
            default: true
        - variable: nodes
          label: Nodes
          schema:
            type: boolean
            default: true
        - variable: ping
          label: Ping
          schema:
            type: boolean
            default: true
        - variable: plugins
          label: Plugins
          schema:
            type: boolean
            default: true
        - variable: post
          label: Post
          schema:
            type: boolean
            default: true
        - variable: secrets
          label: Secrets
          schema:
            type: boolean
            default: true
        - variable: services
          label: Services
          schema:
            type: boolean
            default: true
        - variable: session
          label: Session
          schema:
            type: boolean
            default: true
        - variable: swarm
          label: Swarm
          schema:
            type: boolean
            default: true
        - variable: system
          label: System
          schema:
            type: boolean
            default: true
        - variable: tasks
          label: Tasks
          schema:
            type: boolean
            default: true
        - variable: version
          label: Version
          schema:
            type: boolean
            default: true
        - variable: volumes
          label: Volumes
          schema:
            type: boolean
            default: true
        - variable: additional_envs
          label: Additional Environment Variables
          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

  - variable: network
    label: ""
    group: Network Configuration
    schema:
      type: dict
      attrs:
        - variable: tcp_port
          label: TCP Port
          schema:
            type: dict
            attrs:
              - variable: bind_mode
                label: Port Bind Mode
                description: |
                  The port bind mode.</br>
                  - Publish: The port will be published on the host for external access.</br>
                  - Expose: The port will be exposed for inter-container communication.</br>
                  - None: The port will not be exposed or published.</br>
                  Note: If the Dockerfile defines an EXPOSE directive,
                  the port will still be exposed for inter-container communication regardless of this setting.
                schema:
                  type: string
                  default: "published"
                  enum:
                    - value: "published"
                      description: Publish port on the host for external access
                    - value: ""
                      description: None
              - variable: port_number
                label: Port Number
                schema:
                  type: int
                  default: 2375
                  show_if: [["bind_mode", "=", "published"]]
                  min: 1
                  max: 65535
                  required: true
              - variable: host_ips
                label: Host IPs
                description: IPs on the host to bind this port
                schema:
                  type: list
                  show_if: [["bind_mode", "=", "published"]]
                  default: []
                  items:
                    - variable: host_ip
                      label: Host IP
                      schema:
                        type: string
                        required: true
                        $ref:
                          - definitions/node_bind_ip
  - variable: storage
    label: ""
    group: Storage Configuration
    schema:
      type: dict
      attrs:
        - variable: additional_storage
          label: Additional Storage
          schema:
            type: list
            default: []
            items:
              - variable: storageEntry
                label: Storage Entry
                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.</br>
                        SMB Share: Is a SMB share that is mounted to as a volume.
                      schema:
                        type: string
                        required: true
                        default: "ix_volume"
                        enum:
                          - value: "host_path"
                            description: Host Path (Path that already exists on the system)
                          - value: "ix_volume"
                            description: ixVolume (Dataset created automatically by the system)
                          - value: "cifs"
                            description: SMB/CIFS Share (Mounts a volume to a SMB share)
                    - variable: read_only
                      label: Read Only
                      description: Mount the volume as read only.
                      schema:
                        type: boolean
                        default: false
                    - variable: mount_path
                      label: Mount Path
                      description: The path inside the container to mount the storage.
                      schema:
                        type: path
                        required: true
                    - variable: host_path_config
                      label: Host Path Configuration
                      schema:
                        type: dict
                        show_if: [["type", "=", "host_path"]]
                        attrs:
                          - variable: acl_enable
                            label: Enable ACL
                            description: Enable ACL for the storage.
                            schema:
                              type: boolean
                              default: false
                          - variable: acl
                            label: ACL Configuration
                            schema:
                              type: dict
                              show_if: [["acl_enable", "=", true]]
                              attrs: []
                              $ref:
                                - "normalize/acl"
                          - variable: path
                            label: Host Path
                            description: The host path to use for storage.
                            schema:
                              type: hostpath
                              show_if: [["acl_enable", "=", false]]
                              required: true
                    - variable: ix_volume_config
                      label: ixVolume Configuration
                      description: The configuration for the ixVolume dataset.
                      schema:
                        type: dict
                        show_if: [["type", "=", "ix_volume"]]
                        $ref:
                          - "normalize/ix_volume"
                        attrs:
                          - variable: acl_enable
                            label: Enable ACL
                            description: Enable ACL for the storage.
                            schema:
                              type: boolean
                              default: false
                          - variable: dataset_name
                            label: Dataset Name
                            description: The name of the dataset to use for storage.
                            schema:
                              type: string
                              required: true
                              default: "storage_entry"
                          - variable: acl_entries
                            label: ACL Configuration
                            schema:
                              type: dict
                              show_if: [["acl_enable", "=", true]]
                              attrs: []
                              $ref:
                                - "normalize/acl"
                    - variable: cifs_config
                      label: SMB Configuration
                      description: The configuration for the SMB dataset.
                      schema:
                        type: dict
                        show_if: [["type", "=", "cifs"]]
                        attrs:
                          - variable: server
                            label: Server
                            description: The server to mount the SMB share.
                            schema:
                              type: string
                              required: true
                          - variable: path
                            label: Path
                            description: The path to mount the SMB share.
                            schema:
                              type: string
                              required: true
                          - variable: username
                            label: Username
                            description: The username to use for the SMB share.
                            schema:
                              type: string
                              required: true
                          - variable: password
                            label: Password
                            description: The password to use for the SMB share.
                            schema:
                              type: string
                              required: true
                              private: true
                          - variable: domain
                            label: Domain
                            description: The domain to use for the SMB share.
                            schema:
                              type: string
  - variable: labels
    label: ""
    group: Labels Configuration
    schema:
      type: list
      default: []
      items:
        - variable: label
          label: Label
          schema:
            type: dict
            attrs:
              - variable: key
                label: Key
                schema:
                  type: string
                  required: true
              - variable: value
                label: Value
                schema:
                  type: string
                  required: true
              - variable: containers
                label: Containers
                description: Containers where the label should be applied
                schema:
                  type: list
                  items:
                    - variable: container
                      label: Container
                      schema:
                        type: string
                        required: true
                        enum:
                          - value: docker-socket-proxy
                            description: docker-socket-proxy
  - variable: resources
    label: ""
    group: Resources Configuration
    schema:
      type: dict
      attrs:
        - variable: limits
          label: Limits
          schema:
            type: dict
            attrs:
              - variable: cpus
                label: CPUs
                description: CPUs limit for Docker Socket Proxy.
                schema:
                  type: int
                  default: 2
                  required: true
              - variable: memory
                label: Memory (in MB)
                description: Memory limit for Docker Socket Proxy.
                schema:
                  type: int
                  default: 4096
                  required: true