REFERENCE.md

Reference

Table of Contents

Classes

• s3daemon: Client/server for pushing objects to S3 storage.

Defined types

• s3daemon::instance: Deploy the s3daemon service

Classes

s3daemon

Client/server for pushing objects to S3 storage.

Parameters

The following parameters are available in the s3daemon class:

• instances

instances

Data type: Optional[Hash[String[1], Hash]]

A hash of instances to configure. The key is the instance name and the value is a hash of s3daemon::instance parameters.

Default value: undef

Defined types

s3daemon::instance

Deploy the s3daemon service

Parameters

The following parameters are available in the s3daemon::instance defined type:

• s3_endpoint_url
• aws_access_key_id
• aws_secret_access_key
• port
• image
• volumes

s3_endpoint_url

Data type: Stdlib::HTTPUrl

The URL of the S3 endpoint to which the s3daemon service will send files.

aws_access_key_id

Data type: Variant[String[1], Sensitive[String[1]]]

The AWS access key ID to use for authentication.

aws_secret_access_key

Data type: Variant[String[1], Sensitive[String[1]]]

The AWS secret access key to use for authentication.

port

Data type: Stdlib::Port

The tcp port on which the s3daemon service will listen. Default: 16666

Default value: 15556

image

Data type: String[1]

The container image to use for the s3daemon service.

Default value: 'ghcr.io/lsst-dm/s3daemon:main'

volumes

Data type: Array[Stdlib::Absolutepath]

An array of volumes to mount in the container. Uses the format '/host:/contaner'. E.g. ['/home:/home', '/data:/data']

Default: ['/home:/home']

Default value: ['/home:/home']