Storage

The bucket and disks the control plane stores Rivet Actor data on, how to configure them, and what losing one means.

Each Rivet Actor’s data lives in its own durable volume, which holds both its SQLite database and its key-value data. The control plane stores volumes in two places:

A write is acknowledged once a majority of the instances holding that volume have it on disk, so losing one instance loses no acknowledged write.

Bucket

Set object_storage.primary to one backend. Use S3, an S3-compatible store, Google Cloud Storage or Azure Blob Storage in production. The local file system and in-memory backends are for trying Rivet on one machine.

{
	"object_storage": {
		"primary": {
			"s3": {
				"bucket": "my-rivet-bucket",
				"region": "us-east-1",
				"access_key_id": "AKIA...",
				"secret_access_key": "..."
			}
		}
	}
}

{
	"object_storage": {
		"primary": {
			"s3": {
				"bucket": "rivet",
				"endpoint": "https://minio.example.com:9000",
				"region": "us-east-1",
				"access_key_id": "...",
				"secret_access_key": "..."
			}
		}
	}
}

{
	"object_storage": {
		"primary": {
			"gcs": {
				"bucket": "my-rivet-bucket",
				"service_account_key": "<service account key JSON>"
			}
		}
	}
}

{
	"object_storage": {
		"primary": {
			"azure": {
				"account": "myaccount",
				"container": "rivet",
				"access_key": "..."
			}
		}
	}
}

{
	"object_storage": {
		"primary": {
			"file_system": { "path": "/var/lib/rivet/objects" }
		}
	}
}

{
	"object_storage": {
		"primary": "in_memory"
	}
}

The s3, gcs and azure backends accept prefix to store Rivet’s objects under a path in a shared bucket. Give the control plane its own bucket or prefix, and never point two clusters at the same one.

Environment variables

Every setting above can also be set with environment variables, as described in Configuration. The S3 example as environment variables:

RIVET__OBJECT_STORAGE__PRIMARY__S3__BUCKET=my-rivet-bucket
RIVET__OBJECT_STORAGE__PRIMARY__S3__REGION=us-east-1
RIVET__OBJECT_STORAGE__PRIMARY__S3__ACCESS_KEY_ID=AKIA...
RIVET__OBJECT_STORAGE__PRIMARY__S3__SECRET_ACCESS_KEY=...
RIVET__OBJECT_STORAGE__PRIMARY__S3__ENDPOINT=https://minio.example.com:9000
RIVET__OBJECT_STORAGE__PRIMARY__S3__PREFIX=rivet

Set only the fields you need. The same pattern works for the other backends, for example RIVET__OBJECT_STORAGE__PRIMARY__GCS__BUCKET and RIVET__OBJECT_STORAGE__PRIMARY__AZURE__CONTAINER.

Disks

Set depot.log_directory to a directory on the instance’s disk. The directory must already exist.

• One disk per instance. The disk holds the instance’s identity. Never share it, copy it to another instance, or mount it on two instances.
• Block storage only. Use local SSDs or block volumes such as EBS or Persistent Disk. Network file systems such as NFS and EFS are not supported.
• Size. The control plane sizes its use of the disk from the free space at startup and keeps at least 10% free. Give each instance at least 100 GiB in production.

The read cache lives in the same directory by default. Move it to another disk with depot.cold_store.disk_cache_directory; it is disposable.

Losing a disk or an instance

Next steps

• Backup & restore
• Production checklist
• Configuration