IsleDB / Docs

Documentation

IsleDB keeps a key-value database in your object storage bucket. Start with a few minutes on your machine, then use the APIs or run the services.

Start

• Get startedRun a writer and a reader with Docker, or embed IsleDB in Go, in a few minutes.
• How IsleDB worksThe writer, readers, maintenance, the read cache, revisions, and the change feed.

Build

• HTTP APIWrite and delete keys on the writer; read, scan, and follow the change feed on readers.
• Go APIOpen a database, write and read keys, follow the change feed, and run maintenance from Go.
• Follow changesTurn on the change feed, read it, keep your place, and build a copy that stays current.

Operate

• DeployWhat to run for a database, how many of each, and a production checklist.
• Object storageWhich object stores work, and how to create and secure a bucket for IsleDB.
• Writer serviceRun isledb writer: configuration, authentication, the change feed, and metrics.
• Reader serviceRun isledb reader: replicas, freshness, caches, and metrics.
• Maintenance serviceRun isledb maintenance: compaction, change-feed retention, and cleanup.
• Read cacheRun isledb cache, the regional read cache, and the HTTP API readers use with it.
• SecurityTokens, TLS, admin addresses, and storage credentials for every service.

Reference

• ConfigurationEvery setting of every service, with its flag, environment variable, and default.
• MetricsEvery Prometheus metric of every service, and what to alert on.
• Storage layoutWhat IsleDB keeps under a database's prefix, for backups, permissions, and recovery.