# Netsy: replicated key-value database backed by object storage.

> Netsy is an Open Source, replicated key-value database which stores data in object storage. It implements a subset of the etcd API (Range, Txn, Watch) and can be used as a drop-in etcd replacement for Kubernetes or as a general-purpose KV store for applications that need durable, low-latency persistence without the operational complexity of running a traditional database.

- Website: https://netsy.dev/
- GitHub: https://github.com/netsy-dev/netsy
- LLMs.txt: https://netsy.dev/llms.txt

## Documentation

- [Motivation](https://netsy.dev/docs/motivation.md): Background context on why Netsy was created
- [Development](https://netsy.dev/docs/development.md): How to work on and develop Netsy locally

### Deployment

> Deploying and running Netsy

- [Configuration](https://netsy.dev/docs/deployment/config.md): Netsy configuration reference — environment variables and cluster config file
- [TLS Certificates](https://netsy.dev/docs/deployment/tls.md): TLS certificate requirements and generation for Netsy clusters
- [Systemd](https://netsy.dev/docs/deployment/systemd.md): Example systemd unit file
- [Kubernetes](https://netsy.dev/docs/deployment/kubernetes.md): Deploying Netsy on Kubernetes using the Helm chart
- [AWS](https://netsy.dev/docs/deployment/aws.md): How to run Netsy on AWS
- [Google Cloud](https://netsy.dev/docs/deployment/gcp.md): How to run Netsy on Google Cloud (GCP)
- [Nstance](https://netsy.dev/docs/deployment/nstance.md): Deploying Netsy to auto-scaled VMs using Nstance

### System Design

> Netsy concepts and system design for data files, multi-node/replication, and watches/compaction

- [Overview](https://netsy.dev/docs/design/overview.md): Overview of Netsy terminology, requirements, leader election, and startup process
- [Leader Election](https://netsy.dev/docs/design/leader-election.md): Netsy two-tier leader election system design
- [Netsy Data Files](https://netsy.dev/docs/design/data-files.md): Netsy (.netsy) data file format/specification
- [Storage & Replication](https://netsy.dev/docs/design/storage-replication.md): Netsy data storage and replication system design
- [Loading, Startup, & Shutdown](https://netsy.dev/docs/design/loading-startup.md): Outline of how Node Loading, Primary Startup, and graceful Node Shutdown works.
- [Failure Scenarios](https://netsy.dev/docs/design/failure-scenarios.md): Data integrity and safety analysis across quorum configurations and cluster sizes
- [Watches & Compaction](https://netsy.dev/docs/design/watches-compaction.md): Watch support & Compaction system design
- [Compatibility With etcd](https://netsy.dev/docs/design/etcd-compatibility.md): Netsy etcd API compatibility matrix and notes on supported and unsupported RPCs
- [Observability](https://netsy.dev/docs/design/observability.md): Metrics, structured logging, and debugging for Netsy clusters

---

Tip: Append `.md` to any page URL to get the markdown version.