Mirroristas/etcd
2
0
Fork 0
mirror of https://github.com/etcd-io/etcd.git synced 2024-09-27 06:25:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(Documentation/api): add some intro material

Browse Source 
add some intro material and normalize the headers to the rest of the
coreos/docs.
This commit is contained in:
Brandon Philips 2014-01-05 23:04:27 -08:00
parent 04720bd8bf
commit 1caa3245e6
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Documentation/api.md
View File

@ -1,6 +1,6 @@
## etcd API
# etcd API
### Running a Single Machine Cluster
## Running a Single Machine Cluster
These examples will use a single machine cluster to show you the basics of the etcd REST API.
Let's start etcd:
@ -13,6 +13,10 @@ This will bring up etcd listening on port 4001 for client communication and on p
The `-data-dir machine0` argument tells etcd to write machine configuration, logs and snapshots to the `./machine0/` directory.
The `-name machine` tells the rest of the cluster that this machine is named machine0.
## Key Space Operations
The primary API of etcd is hierarchical key space.
There are directories and keys which are generically referred to as "nodes".
### Setting the value to a key