Skip to content

Latest commit

 

History

History
30 lines (21 loc) · 1.71 KB

README.md

File metadata and controls

30 lines (21 loc) · 1.71 KB
Raw

AWS Kinesis KEDA Connector

AWS Kinesis KEDA connector image can be used in the Kubernetes deployment as scaleTargetRef in scaledObject of AWS Kinesis scaler.

The job of the connector is to read messages from the stream, call an HTTP endpoint with the body of the message, and write response or error in the respective Stream. Following enviornment variables are used by connector image as configuration to connect and authenticate with AWS Kinesis cluster which should be defined in the Kubernetes deployment manifest.

  • TOPIC: Stream from which messages are read.
  • HTTP_ENDPOINT: http endpoint to post request.
  • ERROR_TOPIC: Stream to write errors on failure.
  • RESPONSE_TOPIC: Stream to write responses on success response.
  • SOURCE_NAME: Optional. Name of the Source. Default is "KEDAConnector".
  • MAX_RETRIES: Maximum number of times an http endpoint will be retried upon failure.
  • CONTENT_TYPE: Content type used while creating post request.

Ways to connect to AWS

  • AWS_REGION: Region is mandatory for any aws connection.
  1. Through AWS endpoint
  1. Through AWS aws key and secret
  • AWS_ACCESS_KEY_ID: aws access key of your account.
  • AWS_SECRET_ACCESS_KEY: aws secret key got from your account.
  1. Through AWS credentials
  • AWS_CRED_PATH: Path where aws credentials are present, ex ~/.aws/credentials.
  • AWS_CRED_PROFILE: Profile With which to connect to AWS, present in ~/.aws/credentials file.

More information about the above parameters and how to define it scaledobject refer AWS SQS scaler doc.