rustfs

packaged by Chainguard

Chainguard Container for rustfs

RustFS is an S3-compatible distributed object storage system written in Rust.

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/rustfs:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Compatibility Notes

Chainguard's RustFS container is comparable to the upstream rustfs/rustfs image and is designed to be a drop-in replacement for it. The server binary is at /usr/bin/rustfs, the entrypoint is /entrypoint.sh, and the default command is rustfs, all matching upstream.

Three differences are worth knowing:

• Upstream publishes a latest-glibc image built by repackaging a prebuilt release archive. This container is built from source, including the web console, which upstream downloads as a prebuilt bundle at build time.
• The container runs as uid/gid 10001 and ships /data and /logs pre-created and owned by that user, so it starts under a read-only root filesystem without an init container.
• RUSTFS_CHECK_UPDATE is set to false. RustFS otherwise contacts version.rustfs.com on every start, which blocks for 30 seconds where outbound network access is denied. Set it back to true if you want upstream's update notices.

Prerequisites

RustFS stores data on one or more disks that must exist before the server starts; it no longer creates missing disk roots itself. Mount a volume at /data, or set RUSTFS_VOLUMES to paths you have mounted.

Getting Started

Start a single-node server with a data volume and non-default credentials:

docker run -d --name rustfs \
  -p 9000:9000 -p 9001:9001 \
  -e RUSTFS_ACCESS_KEY=rustfsadmin \
  -e RUSTFS_SECRET_KEY=change-me-please \
  -v rustfs-data:/data \
  cgr.dev/ORGANIZATION/rustfs:latest

The S3 API listens on port 9000 and the web console on port 9001 at /rustfs/console/. Check that the server is ready:

curl -sf http://localhost:9000/health/ready

Create a bucket and round-trip an object with the AWS CLI:

export AWS_ACCESS_KEY_ID=rustfsadmin
export AWS_SECRET_ACCESS_KEY=change-me-please
export AWS_ENDPOINT_URL=http://localhost:9000
aws s3 mb s3://demo
aws s3 cp ./somefile s3://demo/somefile

RustFS erasure-codes across multiple disks. Each local drive must be a distinct filesystem; several directories on one filesystem are rejected, since they would provide no fault isolation:

docker run -d --name rustfs \
  -p 9000:9000 -p 9001:9001 \
  -e RUSTFS_ACCESS_KEY=rustfsadmin \
  -e RUSTFS_SECRET_KEY=change-me-please \
  -e RUSTFS_VOLUMES='/data/disk{0...3}' \
  -v disk0:/data/disk0 -v disk1:/data/disk1 \
  -v disk2:/data/disk2 -v disk3:/data/disk3 \
  cgr.dev/ORGANIZATION/rustfs:latest

The entrypoint expands the {0...3} range and pre-creates each disk root, which the server itself does not do.

Deploy on Kubernetes with the upstream chart, pointing it at this container:

# values.yaml
image:
  rustfs:
    repository: cgr.dev/ORGANIZATION/rustfs
    tag: latest
secret:
  rustfs:
    access_key: rustfsadmin
    secret_key: change-me-please

helm repo add rustfs https://charts.rustfs.com
helm install rustfs rustfs/rustfs --values values.yaml

Note that the chart nests the image under image.rustfs, and refuses to render with the well-known default credentials unless you set your own.

Configuration

RustFS is configured through environment variables. A common adjustment is exposing the WebDAV endpoint, which is compiled in but off by default:

docker run -d --name rustfs \
  -p 9000:9000 -p 8080:8080 \
  -e RUSTFS_ACCESS_KEY=rustfsadmin \
  -e RUSTFS_SECRET_KEY=change-me-please \
  -e RUSTFS_WEBDAV_ENABLE=true \
  -v rustfs-data:/data \
  cgr.dev/ORGANIZATION/rustfs:latest

WebDAV then serves on port 8080 using the same credentials as the S3 API, which lets clients that speak WebDAV rather than S3 read and write the same buckets. FTPS is available the same way through RUSTFS_FTPS_ENABLE.

To inspect the effective configuration of a running node without a server connection:

docker run --rm cgr.dev/ORGANIZATION/rustfs:latest info --all --json

Documentation and Resources

• RustFS documentation
• RustFS on GitHub
• Upstream Helm chart

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.