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: "\U0001F41D MQTT"
    application: MQTT
    deploymentType: Service
    version: 80a595a522653946d0cc76b97c24715869b19818
    resources:
      cpu: 200
      memory: 500
      replicas: 1
    desiredStatus: Stopped
    variables:
      - name: output
        inputType: OutputTopic
        description: Name of the output topic to publish to.
        required: true
        value: rawdata
      - name: mqtt_topic
        inputType: FreeText
        description: The root for messages in MQTT, this can be anything
        required: true
        value: machine/#
      - name: mqtt_server
        inputType: FreeText
        description: The address of your MQTT server
        required: true
        value: broker.hivemq.com
      - name: mqtt_port
        inputType: FreeText
        description: The port of your MQTT instance
        required: true
        value: 1883
      - name: mqtt_username
        inputType: FreeText
        description: Your MQTT username
        required: true
        value: foo
      - name: mqtt_version
        inputType: FreeText
        description: 'MQTT protocol version: 3.1, 3.1.1, 5'
        required: true
        value: 3.1.1
      - name: mqtt_password
        inputType: Secret
        description: ''
        required: true
        value: mqtt_password
  - name: "\U0001F4BE InfluxDB Machine Data"
    application: write_rawdata
    deploymentType: Service
    version: 287d0fbe673385dbe34ed402ae5e9d5676c00f19
    resources:
      cpu: 200
      memory: 500
      replicas: 1
    desiredStatus: Stopped
    variables:
      - name: input
        inputType: InputTopic
        description: This is the input topic
        required: true
        value: rawdata
      - name: INFLUXDB_HOST
        inputType: FreeText
        description: Host address for the InfluxDB instance.
        required: true
        value: eu-central-1-1.aws.cloud2.influxdata.com
      - name: INFLUXDB_TOKEN
        inputType: FreeText
        description: Authentication token to access InfluxDB.
        required: true
        value: 
      - name: INFLUXDB_ORG
        inputType: FreeText
        description: Organization name in InfluxDB.
        required: false
        value: 6a841c0c08328fb1
      - name: INFLUXDB_DATABASE
        inputType: FreeText
        description: Database name in InfluxDB where data should be stored.
        required: true
        value: quix
      - name: INFLUXDB_TAG_COLUMNS
        inputType: FreeText
        description: Columns to be used as tags when writing data to InfluxDB.
        required: false
        value: "['tag1', 'tag2']"
      - 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
        required: false
        value: machine_data
  - name: "\U0001F440 InfluxDB Machine Data"
    application: influxdb-query
    deploymentType: Service
    version: 392f510e525b2deeb85ac235e0c00aa01c538def
    resources:
      cpu: 200
      memory: 500
      replicas: 1
    desiredStatus: Stopped
    variables:
      - name: output
        inputType: OutputTopic
        description: This is the Quix topic that will receive the stream
        required: true
        value: influxdb
      - name: task_interval
        inputType: FreeText
        description: Interval to run query. Must be within the InfluxDB notation; 1s, 1m, 1h, 1d, 1w, 1mo, 1y
        required: true
        value: 5m
      - name: INFLUXDB_HOST
        inputType: FreeText
        description: Host address for the InfluxDB instance.
        required: true
        value: eu-central-1-1.aws.cloud2.influxdata.com
      - name: INFLUXDB_TOKEN
        inputType: FreeText
        description: Authentication token to access InfluxDB.
        required: true
        value: 
      - name: INFLUXDB_ORG
        inputType: FreeText
        description: Organization name in InfluxDB.
        required: true
        value: 6a841c0c08328fb1
      - name: INFLUXDB_DATABASE
        inputType: FreeText
        description: Database name in InfluxDB where data is stored.
        required: true
        value: quix
      - name: INFLUXDB_MEASUREMENT_NAME
        inputType: FreeText
        description: The InfluxDB measurement to read data from. If not specified, the name of the output topic will be used
        required: false
        value: machine_data
  - name: "\U0001F917 Anomaly Detection"
    application: Event Detection
    deploymentType: Service
    version: 5eefd66c8d1c0a9c6cc040e658d135baebe97d36
    resources:
      cpu: 200
      memory: 500
      replicas: 1
    desiredStatus: Stopped
    variables:
      - name: input
        inputType: InputTopic
        description: This is the input topic for f1 data
        required: true
        value: influxdb
      - name: output
        inputType: OutputTopic
        description: This is the output topic for hard braking events
        required: true
        value: detection-results
      - name: model
        inputType: FreeText
        description: ''
        required: false
        value: jayclifford345/vibration-autoencoder
      - name: threshold
        inputType: FreeText
        description: ''
        required: false
        value: 60
  - name: "\U0001F4BE InfluxDB ML Result"
    application: write-model-result
    deploymentType: Service
    version: 6bbbc0d0745b277933d419ff861fe48325a436da
    resources:
      cpu: 200
      memory: 500
      replicas: 1
    desiredStatus: Stopped
    variables:
      - name: input
        inputType: InputTopic
        description: This is the input topic
        required: true
        value: detection-results
      - name: INFLUXDB_HOST
        inputType: FreeText
        description: Host address for the InfluxDB instance.
        required: true
        value: eu-central-1-1.aws.cloud2.influxdata.com
      - name: INFLUXDB_TOKEN
        inputType: FreeText
        description: Authentication token to access InfluxDB.
        required: true
        value: 
      - name: INFLUXDB_ORG
        inputType: FreeText
        description: Organization name in InfluxDB.
        required: false
        value: 6a841c0c08328fb1
      - name: INFLUXDB_DATABASE
        inputType: FreeText
        description: Database name in InfluxDB where data should be stored.
        required: true
        value: quix
      - name: INFLUXDB_TAG_COLUMNS
        inputType: FreeText
        description: Columns to be used as tags when writing data to InfluxDB.
        required: false
        value: "['machineID']"
      - 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
        required: false
        value: mlresult

# This section describes the Topics of the data pipeline
topics:
  - name: rawdata
    persisted: false
    configuration:
      partitions: 2
      replicationFactor: 2
      retentionInMinutes: 43200
      retentionInBytes: 262144000
  - name: influxdb
    persisted: false
    configuration:
      partitions: 2
      replicationFactor: 2
      retentionInMinutes: 43200
      retentionInBytes: 262144000
  - name: detection-results
    persisted: false
    configuration:
      partitions: 2
      replicationFactor: 2
      retentionInMinutes: 43200
      retentionInBytes: 262144000