Implementation:Risingwavelabs Risingwave Docker Environment Config
| Knowledge Sources | |
|---|---|
| Domains | Deployment, Configuration_Management |
| Last Updated | 2026-02-09 07:00 GMT |
Overview
Concrete tool for managing RisingWave deployment configuration through environment files and TOML configuration provided by the Docker deployment setup.
Description
Docker Environment Config encompasses the configuration files that control RisingWave deployment behavior: risingwave.toml (application config), aws.env (AWS credentials), multiple_object_storage.env (multi-cloud credentials), and Docker Compose environment variables. These files are consumed by the Docker Compose service definitions to configure storage backends, telemetry, licensing, and security.
Usage
Edit these files before running docker compose up to customize the deployment for your environment.
Code Reference
Source Location
- Repository: risingwave
- File: docker/risingwave.toml (L1-3), docker/aws.env, docker/multiple_object_storage.env
Signature
# risingwave.toml - Application configuration (initially empty)
# Mounted into container at /risingwave.toml
# aws.env - AWS credentials for S3 backend
AWS_REGION=us-east-1
AWS_ACCESS_KEY_ID=your_key
AWS_SECRET_ACCESS_KEY=your_secret
# Docker Compose environment variables
ENABLE_TELEMETRY=true
RW_SECRET_STORE_PRIVATE_KEY_HEX=0123456789abcdef
RW_LICENSE_KEY=your_license_key
RW_IMAGE=risingwavelabs/risingwave:v2.7.1
Import
# No import - files are referenced by Docker Compose
# Example: docker compose --env-file docker/aws.env up -d
I/O Contract
Inputs
| Name | Type | Required | Description |
|---|---|---|---|
| risingwave.toml | TOML file | No | Application-level config overrides |
| aws.env | Env file | Yes (for S3) | AWS_REGION, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY |
| multiple_object_storage.env | Env file | Yes (for GCS/Azure/OSS/OBS) | Cloud provider credentials |
| RW_IMAGE | Environment variable | No | Docker image override (default: v2.7.1) |
Outputs
| Name | Type | Description |
|---|---|---|
| Configured deployment | Docker containers | RisingWave cluster with the specified configuration applied |
Usage Examples
Configure for AWS S3
# Edit aws.env
cat > docker/aws.env << 'EOF'
AWS_REGION=us-east-1
AWS_ACCESS_KEY_ID=AKIA...
AWS_SECRET_ACCESS_KEY=wJal...
RW_S3_ENDPOINT=https://s3.us-east-1.amazonaws.com
EOF
# Deploy with S3
docker compose -f docker/docker-compose-with-s3.yml up -d
Configure for GCS
# Edit multiple_object_storage.env
cat > docker/multiple_object_storage.env << 'EOF'
GOOGLE_APPLICATION_CREDENTIALS=/path/to/service-account.json
EOF
# Deploy with GCS
docker compose -f docker/docker-compose-with-gcs.yml up -d
Related Pages
Implements Principle
Requires Environment
Uses Heuristic
Page Connections
Double-click a node to navigate. Hold to expand connections.
Principle
Implementation
Heuristic
Environment