Skip to content

S3 Agent Configuration

Instrument Registration

To connect a new sequencing instrument click the user icon in the upper-right corner and navigate to settings. Select the "Instruments" tab at the top, and click "New Instrument". Complete the form to register the new instrument, and note the instrument ID which will be used to configure the upload agent.

Agent Configuration

The sequencing data upload agent must have the following properties configured in a file called bcl-uploader.properties:

  • endpoint - The HTTP endpoint at which the SeqCMD server is running.
  • storage - The strategy used to archive sequencing data. Possible values: [filesystem, s3].
  • directory (CONDITIONAL) - If the storage strategy is filesystem this identifies the path at which the sequencing data will be stored.
  • s3bucket (CONDITIONAL) - If the storage strategy 's3' this identifies the bucket in which the sequencing data will be stored.
  • s3prefix (CONDITIONAL) - If the storage strategy 's3' this identifies the prefix added to object keys when uploaded to s3.
  • instrument - This identifies the instrument that was used to generate sequencing data.

Example Configuration file

An example bcl-uploader.properties is:

endpoint=example.seqcmd.com:443
storage=s3
s3bucket=seqcmd
s3prefix=nextseq500
instrument=1

Agent Service

The data upload agent is configured as a system service that runs as a daemon. The service can be managed using:

service bcluploader start