WarpStream Agents (Kafka without the disks)
Official template for deploying the WarpStream Agents.
warpstream-agents
warpstreamlabs/warpstream-railway-template
Just deployed
This template will help you deploy the WarpStream Agents to Railway.
Before proceeding, please create a WarpStream account.
In addition, you will also need an S3-compatible object store. We recommend CloudFlare R2.
Template Content
warpstream-agents
warpstreamlabs/warpstream-railway-templateAWS_ACCESS_KEY_ID
Access key ID for the Cloudflare R2 bucket.
WARPSTREAM_API_KEY
WarpStream API obtained from the WarpStream admin console.
AWS_SECRET_ACCESS_KEY
AWS secret access key for your cloudflare R2 storage bucket.
WARPSTREAM_BUCKET_URL
URL specifying which object store the WarpStream Agents will write/read to/from. We recommend Cloudflare R2 as documented here: https://docs.warpstream.com/warpstream/reference/use-the-agents-with-an-s3-compatible-object-store-minio-oracle-cloud-etc
WARPSTREAM_DEFAULT_VIRTUAL_CLUSTER_ID
WarpStream virtual cluster ID obtained from WarpStream admin console after signing up for a WarpStream account.
WARPSTREAM_DISCOVERY_KAFKA_PORT_OVERRIDE
The port the WarpStream Agents will advertise in the Kafka protocol. This must be the port auto-generated by the Railway TCP proxy after creating the service. Can set a random value until then, but must be updated afterwards.
WARPSTREAM_DISCOVERY_KAFKA_HOSTNAME_OVERRIDE
Hostname the WarpStream Agents will advertise in the Kafka protocol. This must be the Railway TCP proxy domain name generated by railway after the project is deployed. Can set a garbage value when first deploying as long as its updated later.
