Quickstart

Get etcd up and running in less than 5 minutes!

Prerequisites

Before you begin, ensure you have the following:

etcd Installed
Build or download etcd from Install and verify that the etcd binary is in your system’s PATH.
Terminal Access
You’ll need two terminal windows: one to run the etcd server and one to interact with it using etcdctl.

Choose the workflow that best fits your role:

Objective: Quickly set up a local etcd cluster for development and testing.

Set Up a Local Cluster
Use our [Set up a local cluster][] page to quickly spin up an etcd instance. Follow along by first launching etcd:
```
$ etcd
{"level":"info","ts":"2021-09-17T09:19:32.783-0400","caller":"etcdmain/etcd.go:72","msg":... }
⋮
```
Interact with etcd
In a separate terminal, run the following commands to set and retrieve a key:
```
$ etcdctl put greeting "Hello, etcd"
OK
```
```
$ etcdctl get greeting
greeting
Hello, etcd
```
Explore the Developer Guide Once your local cluster is running, refer to the [Developer guide][] for integration and development tips.

Objective: Configure and manage an etcd cluster for production.

Install etcd
Follow the detailed instructions in the Install to install and configure etcd for production use.
Run and Monitor etcd
Start etcd in one terminal and review the logs to confirm it’s running properly:
```
$ etcd
{"level":"info","ts":"...","msg": "..."}
```
Configure and Secure etcd
Check out the [Operations guide][] for steps on clustering, securing with TLS, and performance tuning.
Troubleshooting & Maintenance
If issues arise, consult the Troubleshooting section for common problems and solutions.

Learn about more ways to configure and use etcd from the following pages:

Continue with the Developer guide, which includes the [Set up a local cluster][] page, API references, and integration examples.

Proceed to the Operations guide for advanced configuration, clustering, security, and performance tuning.

Was this page helpful?

Sorry to hear that. Please tell us how we can improve.