Skip to content

Latest commit

 

History

History
135 lines (107 loc) · 3.29 KB

README.md

File metadata and controls

135 lines (107 loc) · 3.29 KB
Raw

File Reader User Manual 2.3.1

Document Information

Introduction

The File reader reads the entire file and sends it as one raw message. File reader produces raw messages. See RawMessage type in infra.proto.

Quick start

General view of the component will look like this:

apiVersion: th2.exactpro.com/v2
kind: Th2Box
metadata:
  name: read-file
spec:
  imageName: ghcr.io/th2-net/th2-read-file
  imageVersion: <image version>
  type: th2-read
  customConfig:
    filesDirectory: "files/dir"
    aliases:
      A:
        pathFilter: "fileA.*"
      B:
        pathFilter: "fileB.*"
      C:
        pathFilter: "fileC.*"
    common:
      staleTimeout: "PT1S"
      maxBatchSize: 100
      maxPublicationDelay: "PT5S"
      leaveLastFileOpen: false
      fixTimestamp: false
      maxBatchesPerSecond: -1 # unlimited
    pullingInterval: "PT5S"
  pins:
    mq:
      publishers:
        - name: out_file
          attributes: [ 'publish', 'transport-group' ]
  extendedSettings:
    service:
      enabled: false
    envVariables:
      JAVA_TOOL_OPTIONS: "-XX:+ExitOnOutOfMemoryError"
    mounting:
      - path: "<destination path in Kubernetes pod>"
        pvcName: <Kubernetes persistent volume component name >
    resources:
      # Min system requirments ...
      limits:
        memory: 200Mi
        cpu: 200m
      requests:
        memory: 100Mi
        cpu: 50m

Configuration

Reader configuration
  • filesDirectory - the directory to watch files
  • aliases - the mapping between alias and files that correspond to that alias
    • pathFilter - filter for files that correspond to that alias
  • common - the common configuration for read core. Please found the description here. NOTE: the fields with Duration type should be described in the following format PT<number><time unit>. Supported time units (H - hours,M - minutes,S - seconds). E.g. PT5S - 5 seconds, PT5M - 5 minutes, PT0.001S - 1 millisecond
  • pullingInterval - how often the directory will be checked for updates after receiving updates
Pin declaration

The File reader requires a single pin with publish and raw attributes. The data is published in a raw format. To use it please conect the output pin with another pin that transforms raw data to parsed data. E.g. the codec box.

Example:

apiVersion: th2.exactpro.com/v2
kind: Th2Box
metadata:
  name: file-reader
spec:
  pins:
    mq:
      publishers:
      - name: out_file
        attributes: [ 'publish', 'transport-group' ]

Changes

2.3.1

Updated:

  • Migrate to th2 gradle plugin 0.0.8

2.3.0

Updated:

  • Migrate to th2 gradle plugin 0.0.6
  • bom: 4.6.1
  • common: 5.11.0-dev
  • read-file-common-core: 3.3.0-dev
  • jakarta.annotation-api: 3.0.0

2.2.0

Updated:

  • read-file-common-core: 3.2.0-dev

2.1.0

Fixed:

read-file throws the IndexOutOfBoundsException when prepare message for publishing

Updated:

  • common: 5.7.1-dev
  • read-file-common-core: 3.1.0-dev

2.0.0

  • Migrate to th2 transport

1.1.0

  • th2-common upgrade to 3.44.0
  • th2-bom upgrade to 4.1.0
  • kotlin upgrade to 1.6.21
  • vulnerability check pipeline step

1.0.0

  • Create a read-file component