mirror of https://github.com/rustfs/rustfs.git synced 2026-08-01 19:12:14 +00:00

Files

T

Zhengchao An 792f2ef204 docs(kms): add observability dashboard, alert rules and runbook (#5517 )

Add a Grafana dashboard for the four KMS backend operation metrics
emitted at the policy choke point, Prometheus alert rules with
conservative default thresholds (pending staging baseline calibration),
and an operations runbook documenting the metric contract and the
response procedure for each alert. Register the new alert rules file in
the observability READMEs.

Refs rustfs/backlog#1584 (part of rustfs/backlog#1562)

2026-07-31 21:28:10 +00:00

compose

fix(docker): use non-default credentials in cluster compose/scripts (#4720 )

2026-07-11 12:41:02 +08:00

mqtt

build: update docker config and refine s3s region handling (#1976 )

2026-02-27 01:21:12 +08:00

nginx

security: same-origin console CORS, fail-closed helm creds, deny.toml, sample-config hardening (#2769 )

2026-05-06 07:34:44 +00:00

observability

docs(kms): add observability dashboard, alert rules and runbook (#5517 )

2026-07-31 21:28:10 +00:00

openobserve-otel

build: update docker config and refine s3s region handling (#1976 )

2026-02-27 01:21:12 +08:00

test

fix(site-replication): delete replicated buckets

2026-07-22 01:22:41 +08:00

README.md

build: update docker config and refine s3s region handling (#1976 )

2026-02-27 01:21:12 +08:00

README.md

RustFS Docker Infrastructure

This directory contains the complete Docker infrastructure for building, deploying, and monitoring RustFS. It provides ready-to-use configurations for development, testing, and production-grade observability.

📂 Directory Structure

Directory	Description	Status
`observability/`	[RECOMMENDED] Full-stack observability (Prometheus, Grafana, Tempo, Loki).	✅ Production-Ready
`compose/`	Specialized setups (e.g., 4-node distributed cluster testing).	⚠️ Testing Only
`mqtt/`	EMQX Broker configuration for MQTT integration testing.	🧪 Development
`openobserve-otel/`	Alternative lightweight observability stack using OpenObserve.	🔄 Alternative

📄 Root Directory Files

The following files in the project root are essential for Docker operations:

Build Scripts & Dockerfiles

File	Description	Usage
`docker-buildx.sh`	Multi-Arch Build Script Automates building and pushing Docker images for `amd64` and `arm64`. Supports release and dev channels.	`./docker-buildx.sh --push`
`Dockerfile`	Production Image (Alpine) Lightweight image using musl libc. Downloads pre-built binaries from GitHub Releases.	`docker build -t rustfs:latest .`
`Dockerfile.glibc`	Production Image (Ubuntu) Standard image using glibc. Useful if you need specific dynamic libraries.	`docker build -f Dockerfile.glibc .`
`Dockerfile.source`	Development Image Builds RustFS from source code. Includes build tools. Ideal for local development and CI.	`docker build -f Dockerfile.source .`

Docker Compose Configurations

File	Description	Usage
`docker-compose.yml`	Main Development Setup Comprehensive setup with profiles for development, observability, and proxying.	`docker compose up -d` `docker compose --profile observability up -d`
`docker-compose-simple.yml`	Quick Start Setup Minimal configuration running a single RustFS instance with 4 volumes. Perfect for first-time users.	`docker compose -f docker-compose-simple.yml up -d`

🌟 Observability Stack (Recommended)

Located in: .docker/observability/

We provide a comprehensive, industry-standard observability stack designed for deep insights into RustFS performance. This is the recommended setup for both development and production monitoring.

Components

Metrics: Prometheus (Collection) + Grafana (Visualization)
Traces: Tempo (Storage) + Jaeger (UI)
Logs: Loki
Ingestion: OpenTelemetry Collector

Key Features

Full Persistence: All metrics, logs, and traces are saved to Docker volumes, ensuring no data loss on restarts.
Correlation: Seamlessly jump between Logs, Traces, and Metrics in Grafana.
High Performance: Optimized configurations for batching, compression, and memory management.

Quick Start

cd .docker/observability
docker compose up -d

🧪 Specialized Environments

Located in: .docker/compose/

These configurations are tailored for specific testing scenarios that require complex topologies.

Distributed Cluster (4-Nodes)

Simulates a real-world distributed environment with 4 RustFS nodes running locally.

docker compose -f .docker/compose/docker-compose.cluster.yaml up -d

Integrated Observability Test

A self-contained environment running 4 RustFS nodes alongside the full observability stack. Useful for end-to-end testing of telemetry.

docker compose -f .docker/compose/docker-compose.observability.yaml up -d

📡 MQTT Integration

Located in: .docker/mqtt/

Provides an EMQX broker for testing RustFS MQTT features.

Quick Start

cd .docker/mqtt
docker compose up -d

Dashboard: http://localhost:18083 (Default: admin / public)
MQTT Port: 1883

👁️ Alternative: OpenObserve

Located in: .docker/openobserve-otel/

For users preferring a lightweight, all-in-one solution, we support OpenObserve. It combines logs, metrics, and traces into a single binary and UI.

Quick Start

cd .docker/openobserve-otel
docker compose up -d

🔧 Common Operations

Cleaning Up

To stop all containers and remove volumes (WARNING: deletes all persisted data):

docker compose down -v

Viewing Logs

To follow logs for a specific service:

docker compose logs -f [service_name]

Checking Status

To see the status of all running containers:

docker compose ps