quix.yaml

# Quix Project Descriptor
# This file describes the data pipeline and configuration of resources of a Quix Project.

metadata:
  version: 1.0

# This section describes the Deployments of the data pipeline
deployments:
  - name: Grafana
    application: grafana
    version: latest
    deploymentType: Service
    resources:
      cpu: 500
      memory: 500
      replicas: 1
    publicAccess:
      enabled: true
      urlPrefix: grafana
    state:
      enabled: true
      size: 1
    network:
      serviceName: grafana
      ports:
        - port: 80
          targetPort: 3000
    variables:
      - name: GF_SECURITY_ADMIN_PASSWORD
        inputType: Secret
        description: Password for the admin user
        required: true
        secretKey: influxdb_admin_token
      - name: INFLUXDB_TOKEN
        inputType: Secret
        description: The optional InfluxDB Token to use
        secretKey: influxdb_admin_token
  - name: HTTP API Source
    application: http-api-source
    version: latest
    deploymentType: Service
    resources:
      cpu: 200
      memory: 500
      replicas: 1
    publicAccess:
      enabled: true
      urlPrefix: http-source
    network:
      serviceName: http-source
      ports:
        - port: 80
          targetPort: 80
    variables:
      - name: output
        inputType: OutputTopic
        description: This is the output topic for hello world data
        required: true
        value: http_data
      - name: HTTP_AUTH_TOKEN
        inputType: Secret
        description: A security token for authorizing data submissions.
        required: true
        secretKey: http_auth_token
  - name: OPC UA Server
    group: Mock Data Source
    application: opc-ua-server
    version: latest
    deploymentType: Service
    resources:
      cpu: 200
      memory: 500
      replicas: 1
    network:
      serviceName: intopcserver
      ports:
        - port: 4840
          targetPort: 4840
  - name: OPC UA Source
    group: Mock Data Source
    application: opc-ua-source
    version: latest
    deploymentType: Service
    resources:
      cpu: 200
      memory: 200
      replicas: 1
    variables:
      - name: output
        inputType: OutputTopic
        description: This is the Quix Topic that will receive the stream
        required: true
        value: generated-opc_ua_data
      - name: OPC_SERVER_URL
        inputType: FreeText
        description: The URL to your OPC UA server
        required: true
        value: https://intopcserver:4840/freeopcua/server/
      - name: OPC_NAMESPACE
        inputType: FreeText
        description: The namespace of the data coming from your OPC UA server
        required: true
        value: http://quix.freeopcua.io
      - name: PARAMETER_NAMES_TO_PROCESS
        inputType: FreeText
        description: List of parameter names, comma-separated.
        required: true
        value: T001,T002
      - name: LOGLEVEL
        inputType: FreeText
        description: Desired loglevel; Use DEBUG to see change events, else INFO for max performance.
        value: INFO
  - name: HTTP Data Normalization
    application: http-data-normalization
    version: latest
    deploymentType: Service
    resources:
      cpu: 200
      memory: 500
      replicas: 1
    state:
      enabled: true
      size: 1
    variables:
      - name: input
        inputType: InputTopic
        description: Name of the input topic to listen to.
        value: http_data
      - name: output
        inputType: OutputTopic
        description: Name of the output topic to write to.
        value: normalized_data
  - name: InfluxDB2
    group: Aux services
    application: influxdb2
    version: latest
    deploymentType: Service
    resources:
      cpu: 200
      memory: 500
      replicas: 1
    state:
      enabled: true
      size: 1
    network:
      serviceName: influxdb2
      ports:
        - port: 80
          targetPort: 8086
    variables:
      - name: DOCKER_INFLUXDB_INIT_ADMIN_TOKEN
        inputType: Secret
        description: Default Admin Token to initialize Influx with
        required: true
        secretKey: influxdb_admin_token
      - name: DOCKER_INFLUXDB_INIT_PASSWORD
        inputType: Secret
        description: Default Admin password to initialize Influx with
        required: true
        secretKey: influxdb_admin_password
      - name: DOCKER_INFLUXDB_INIT_BUCKET
        inputType: FreeText
        description: Bucket Name to initialize Influx with
        required: true
        value: my_bucket
  - name: HTTP Sink
    group: Mock Data Source
    application: http-sink
    version: latest
    deploymentType: Service
    resources:
      cpu: 200
      memory: 500
      replicas: 1
    variables:
      - name: input
        inputType: InputTopic
        description: Name of the input topic to listen to.
        value: generated-opc_ua_data
      - name: RECEIVER_URL
        inputType: FreeText
        description: What HTTP receiver endpoint to send data to.
        required: true
        value: http://http-source:80/data
      - name: RECEIVER_AUTH_TOKEN
        inputType: Secret
        description: The token for authenticating with an HTTP data receiver.
        required: true
        secretKey: http_auth_token
  - name: InfluxDB2 Sink
    application: influxdb2-sink
    version: latest
    deploymentType: Service
    resources:
      cpu: 200
      memory: 500
      replicas: 1
    variables:
      - name: input
        inputType: InputTopic
        description: This is the input topic
        required: true
        value: config_enriched_data
      - name: INFLUXDB_HOST
        inputType: FreeText
        description: Host address for the InfluxDB instance.
        required: true
        value: http://influxdb2:80
      - name: INFLUXDB_TOKEN
        inputType: Secret
        description: Authentication token to access InfluxDB.
        required: true
        secretKey: influxdb_admin_token
      - name: INFLUXDB_ORG
        inputType: FreeText
        description: Organization name in InfluxDB.
        value: quix
      - name: INFLUXDB_MEASUREMENT_NAME
        inputType: FreeText
        description: The InfluxDB measurement to write data to. If not specified, the name of the input topic will be used
        value: printers
      - name: INFLUXDB_DATABASE
        inputType: FreeText
        description: Database name in InfluxDB where data should be stored.
        required: true
        value: my_bucket
      - name: INFLUXDB_TAG_KEYS
        inputType: FreeText
        description: 'The tags to include when writing the measurement data. Example: Tag1,Tag2'
        value: machine,editor
      - name: INFLUXDB_FIELD_KEYS
        inputType: FreeText
        description: 'The fields to include when writing the measurement data. Example: Field1,Field2'
      - name: CONSUMER_GROUP_NAME
        inputType: FreeText
        description: The name of the consumer group to use when consuming from Kafka
        required: true
        value: influxdb2-sink3
      - name: TIMESTAMP_COLUMN
        inputType: FreeText
        description: 'The column containing the timestamp column. NOTE: Must be nanoseconds'
        value: timestamp
      - name: BUFFER_SIZE
        inputType: FreeText
        description: The number of records that sink holds before flush data to the InfluxDb
        value: 1000
      - name: BUFFER_TIMEOUT
        inputType: FreeText
        description: The number of seconds that sink holds before flush data to the InfluxDb
        value: 1
  - name: HTTP Config Enricher
    application: http-config-enricher
    version: latest
    deploymentType: Service
    resources:
      cpu: 200
      memory: 500
      replicas: 1
    variables:
      - name: DATA_TOPIC
        inputType: InputTopic
        description: Name of the data topic to listen to.
        value: normalized_data
      - name: CONFIG_TOPIC
        inputType: InputTopic
        description: Name of the config topic to listen to.
        value: config-updates
      - name: output
        inputType: OutputTopic
        description: Name of the output topic to write to.
        value: config_enriched_data
  - name: MongoDB
    group: Aux services
    application: mongodb
    version: latest
    deploymentType: Service
    resources:
      cpu: 200
      memory: 800
      replicas: 1
    state:
      enabled: true
      size: 1
    network:
      serviceName: mongodb
      ports:
        - port: 27017
          targetPort: 27017
    variables:
      - name: MONGO_INITDB_ROOT_USERNAME
        inputType: FreeText
        description: The root username to initialize MongoDB with
        required: true
        value: admin
      - name: MONGO_INITDB_ROOT_PASSWORD
        inputType: Secret
        description: The root password to initialize MongoDB with
        required: true
        secretKey: mongo_password
  - name: Machine Config UI
    application: config-frontend
    version: latest
    deploymentType: Service
    plugin:
      embeddedView:                
        enabled: true            
        hideHeader: true       
        default: true
      sidebarItem:                
        show: true               
        label: "Input form"    
        icon: checklist  
    resources:
      cpu: 200
      memory: 500
      replicas: 1
    publicAccess:
      enabled: true
      urlPrefix: machine-config-ui
    variables:
      - name: CONFIG_API_BASE_URL
        inputType: FreeText
        required: true
        value: http://config-api-svc/api/v1
      - name: CONFIG_UI_AUTH_TOKEN
        inputType: Secret
        required: true
        secretKey: config_ui_auth_token
  - name: Dynamic Configuration Manager
    application: DynamicConfiguration
    version: latest
    deploymentType: Managed
    plugin:
      embeddedView:                
        enabled: true            
        hideHeader: true       
        default: true
      sidebarItem:                
        show: true               
        label: "Configurations"    
        icon: "tune"            
    resources:
      cpu: 100
      memory: 500
      replicas: 1
    network:
      serviceName: config-api-svc
    configuration:
      topic: config-updates
      mongoHost: mongodb
      mongoPort: 27017
      mongoUser: admin
      mongoPasswordSecret: mongo_password
      mongoDatabase: quix
      mongoCollection: configuration-api

# This section describes the Topics of the data pipeline
topics:
  - name: generated-opc_ua_data
    dataTier: Bronze
  - name: http_data
    dataTier: Bronze
  - name: normalized_data
    dataTier: Silver
  - name: config_enriched_data
    dataTier: Silver
  - name: config-updates
  - name: tsbs_data
    configuration:
      partitions: 4
  - name: aggregates
  - name: watermarks__downsampling-v1.1--watermarks
    configuration:
      partitions: 1
      cleanupPolicy: Compact
  - name: watermarks__downsampling-v1.2--watermarks
    configuration:
      partitions: 1
      cleanupPolicy: Compact
  - name: watermarks__downsampling-v1.3--watermarks
    configuration:
      partitions: 1
      cleanupPolicy: Compact
  - name: sensor-data
  - name: s3-data