zendesk/amazon-kinesis-agent repository overview

⁠Introduction

This repository contains a Docker image source for the AWS Kinesis Streaming Agent⁠.

⁠How to use

Use this image as the FROM value in your Dockerfile. Then install a customized configuration file into /etc/aws-kinesis/agent.json.

The configuration file format is documented here⁠.

If you're running in a region other than us-east-1, you'll need to specify values for the CloudWatch and Kinesis service endpoints in your agent.json file. (The Java SDK doesn't yet support the AWS_DEFAULT_REGION environment variable.) You can find a table of regional endpoints here⁠.

⁠Security note

Do not fill in the values for awsAccessKeyId and awsSecretAccessKey in your configuration file. This could result in your credentials being insecurely stored in your version control system. Instead, set the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables when launching your container, or use IAM role authentication (which is automatic if the variables are unset).

⁠Environment variables

The following environment variables are discussed here⁠:

• AWS_ACCESS_KEY_ID
• AWS_SECRET_ACCESS_KEY

Leave the above variables unset if you wish to use IAM role authentication.

Additional environment variables:

• LOG_LEVEL: Log level. Can be TRACE, DEBUG, INFO, WARN, or ERROR. (Default: INFO)
• JAVA_START_HEAP: Java initial heap size (default: 32m)
• JAVA_MAX_HEAP: Java maximum heap size (default: 512m)