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

etcdctl:readme.md doc made uniform

Browse Source
This commit is contained in:
sharat 2016-09-09 15:19:52 +05:30
parent b22b405465
commit d5edb62bd0
1 changed files with 93 additions and 83 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

172
etcdctl/README.md
View File

@ -34,10 +34,10 @@ The protobuf encoding of the PUT [RPC response][etcdrpc].
``` bash ``` bash
./etcdctl put foo bar --lease=1234abcd ./etcdctl put foo bar --lease=1234abcd
OK # OK
./etcdctl get foo ./etcdctl get foo
foo # foo
bar # bar
``` ```
#### Notes #### Notes
@ -94,8 +94,8 @@ The protobuf encoding of the [RPC message][etcdrpc] for a key-value pair for eac
``` bash ``` bash
./etcdctl get foo ./etcdctl get foo
foo # foo
bar # bar
``` ```
#### Notes #### Notes
@ -133,9 +133,9 @@ The protobuf encoding of the DeleteRange [RPC response][etcdrpc].
``` bash ``` bash
./etcdctl put foo bar ./etcdctl put foo bar
OK # OK
./etcdctl del foo ./etcdctl del foo
1 # 1
./etcdctl get foo ./etcdctl get foo
``` ```
@ -198,11 +198,11 @@ put key1 "overwrote-key1"
put key1 "created-key1" put key1 "created-key1"
put key2 "some extra key" put key2 "some extra key"
FAILURE # FAILURE
OK # OK
OK # OK
``` ```
txn in non-interactive mode: txn in non-interactive mode:
@ -215,12 +215,12 @@ put key1 "created-key1"
put key2 "some extra key" put key2 "some extra key"
' '
FAILURE # FAILURE
OK # OK
OK # OK
```` ```
### WATCH [options] [key or prefix] [range_end] ### WATCH [options] [key or prefix] [range_end]
@ -268,9 +268,9 @@ The protobuf encoding of the [RPC message][storagerpc] for each received Event.
``` bash ``` bash
./etcdctl watch foo ./etcdctl watch foo
PUT # PUT
foo # foo
bar # bar
``` ```
##### Interactive ##### Interactive
@ -279,12 +279,12 @@ bar
./etcdctl watch -i ./etcdctl watch -i
watch foo watch foo
watch foo watch foo
PUT # PUT
foo # foo
bar # bar
PUT # PUT
foo # foo
bar # bar
``` ```
### LEASE \<subcommand\> ### LEASE \<subcommand\>
@ -306,7 +306,7 @@ greater than or equal to the requested TTL value.
```bash ```bash
./etcdctl lease grant 10 ./etcdctl lease grant 10
lease 32695410dcc0ca06 granted with TTL(10s) # lease 32695410dcc0ca06 granted with TTL(10s)
``` ```
### LEASE REVOKE \<leaseID\> ### LEASE REVOKE \<leaseID\>
@ -323,7 +323,7 @@ LEASE REVOKE destroys a given lease, deleting all attached keys.
```bash ```bash
./etcdctl lease revoke 32695410dcc0ca06 ./etcdctl lease revoke 32695410dcc0ca06
lease 32695410dcc0ca06 revoked # lease 32695410dcc0ca06 revoked
``` ```
@ -341,22 +341,22 @@ LEASE TIMETOLIVE retrieves the lease information with the given lease ID.
```bash ```bash
./etcdctl lease grant 500 ./etcdctl lease grant 500
lease 2d8257079fa1bc0c granted with TTL(500s) # lease 2d8257079fa1bc0c granted with TTL(500s)
./etcdctl put foo1 bar --lease=2d8257079fa1bc0c ./etcdctl put foo1 bar --lease=2d8257079fa1bc0c
./etcdctl put foo2 bar --lease=2d8257079fa1bc0c ./etcdctl put foo2 bar --lease=2d8257079fa1bc0c
./etcdctl lease timetolive 2d8257079fa1bc0c ./etcdctl lease timetolive 2d8257079fa1bc0c
lease 2d8257079fa1bc0c granted with TTL(500s), remaining(481s) # lease 2d8257079fa1bc0c granted with TTL(500s), remaining(481s)
./etcdctl lease timetolive 2d8257079fa1bc0c --keys ./etcdctl lease timetolive 2d8257079fa1bc0c --keys
lease 2d8257079fa1bc0c granted with TTL(500s), remaining(472s), attached keys([foo2 foo1]) # lease 2d8257079fa1bc0c granted with TTL(500s), remaining(472s), attached keys([foo2 foo1])
./etcdctl lease timetolive 2d8257079fa1bc0c --write-out=json ./etcdctl lease timetolive 2d8257079fa1bc0c --write-out=json
{"cluster_id":17186838941855831277,"member_id":4845372305070271874,"revision":3,"raft_term":2,"id":3279279168933706764,"ttl":465,"granted-ttl":500,"keys":null} # {"cluster_id":17186838941855831277,"member_id":4845372305070271874,"revision":3,"raft_term":2,"id":3279279168933706764,"ttl":465,"granted-ttl":500,"keys":null}
./etcdctl lease timetolive 2d8257079fa1bc0c --write-out=json --keys ./etcdctl lease timetolive 2d8257079fa1bc0c --write-out=json --keys
{"cluster_id":17186838941855831277,"member_id":4845372305070271874,"revision":3,"raft_term":2,"id":3279279168933706764,"ttl":459,"granted-ttl":500,"keys":["Zm9vMQ==","Zm9vMg=="]} # {"cluster_id":17186838941855831277,"member_id":4845372305070271874,"revision":3,"raft_term":2,"id":3279279168933706764,"ttl":459,"granted-ttl":500,"keys":["Zm9vMQ==","Zm9vMg=="]}
``` ```
@ -372,10 +372,10 @@ LEASE KEEP-ALIVE periodically refreshes a lease so it does not expire.
#### Example #### Example
```bash ```bash
/etcdctl lease keep-alive 32695410dcc0ca0 ./etcdctl lease keep-alive 32695410dcc0ca0
lease 32695410dcc0ca0 keepalived with TTL(100) # lease 32695410dcc0ca0 keepalived with TTL(100)
lease 32695410dcc0ca0 keepalived with TTL(100) # lease 32695410dcc0ca0 keepalived with TTL(100)
lease 32695410dcc0ca0 keepalived with TTL(100) # lease 32695410dcc0ca0 keepalived with TTL(100)
... ...
``` ```
@ -402,7 +402,7 @@ MEMBER ADD introduces a new member into the etcd cluster as a new peer.
```bash ```bash
./etcdctl member add newMember --peer-urls=https://127.0.0.1:12345 ./etcdctl member add newMember --peer-urls=https://127.0.0.1:12345
Member 2be1eb8f84b7f63e added to cluster ef37ad9dc622a7c4 # Member 2be1eb8f84b7f63e added to cluster ef37ad9dc622a7c4
``` ```
@ -424,7 +424,7 @@ MEMBER UPDATE sets the peer URLs for an existing member in the etcd cluster.
```bash ```bash
./etcdctl member update 2be1eb8f84b7f63e --peer-urls=https://127.0.0.1:11112 ./etcdctl member update 2be1eb8f84b7f63e --peer-urls=https://127.0.0.1:11112
Member 2be1eb8f84b7f63e updated in cluster ef37ad9dc622a7c4 # Member 2be1eb8f84b7f63e updated in cluster ef37ad9dc622a7c4
``` ```
@ -442,7 +442,7 @@ MEMBER REMOVE removes a member of an etcd cluster from participating in cluster
```bash ```bash
./etcdctl member remove 2be1eb8f84b7f63e ./etcdctl member remove 2be1eb8f84b7f63e
Member 2be1eb8f84b7f63e removed from cluster ef37ad9dc622a7c4 # Member 2be1eb8f84b7f63e removed from cluster ef37ad9dc622a7c4
``` ```
### MEMBER LIST ### MEMBER LIST
@ -467,14 +467,14 @@ The protobuf encoding of the MEMBER LIST [RPC response][member_list_rpc].
```bash ```bash
./etcdctl member list ./etcdctl member list
8211f1d0f64f3269, started, infra1, http://127.0.0.1:12380, http://127.0.0.1:2379 # 8211f1d0f64f3269, started, infra1, http://127.0.0.1:12380, http://127.0.0.1:2379
91bc3c398fb3c146, started, infra2, http://127.0.0.1:22380, http://127.0.0.1:22379 # 91bc3c398fb3c146, started, infra2, http://127.0.0.1:22380, http://127.0.0.1:22379
fd422379fda50e48, started, infra3, http://127.0.0.1:32380, http://127.0.0.1:32379 # fd422379fda50e48, started, infra3, http://127.0.0.1:32380, http://127.0.0.1:32379
``` ```
```bash ```bash
./etcdctl -w json member list ./etcdctl -w json member list
{"header":{"cluster_id":17237436991929493444,"member_id":9372538179322589801,"raft_term":2},"members":[{"ID":9372538179322589801,"name":"infra1","peerURLs":["http://127.0.0.1:12380"],"clientURLs":["http://127.0.0.1:2379"]},{"ID":10501334649042878790,"name":"infra2","peerURLs":["http://127.0.0.1:22380"],"clientURLs":["http://127.0.0.1:22379"]},{"ID":18249187646912138824,"name":"infra3","peerURLs":["http://127.0.0.1:32380"],"clientURLs":["http://127.0.0.1:32379"]}]} # {"header":{"cluster_id":17237436991929493444,"member_id":9372538179322589801,"raft_term":2},"members":[{"ID":9372538179322589801,"name":"infra1","peerURLs":["http://127.0.0.1:12380"],"clientURLs":["http://127.0.0.1:2379"]},{"ID":10501334649042878790,"name":"infra2","peerURLs":["http://127.0.0.1:22380"],"clientURLs":["http://127.0.0.1:22379"]},{"ID":18249187646912138824,"name":"infra3","peerURLs":["http://127.0.0.1:32380"],"clientURLs":["http://127.0.0.1:32379"]}]}
``` ```
```bash ```bash
@ -509,9 +509,9 @@ when it cannot participate in consensus with the rest of the cluster.
```bash ```bash
./etcdctl endpoint health ./etcdctl endpoint health
127.0.0.1:32379 is healthy: successfully committed proposal: took = 2.130877ms # 127.0.0.1:32379 is healthy: successfully committed proposal: took = 2.130877ms
127.0.0.1:2379 is healthy: successfully committed proposal: took = 2.095242ms # 127.0.0.1:2379 is healthy: successfully committed proposal: took = 2.095242ms
127.0.0.1:22379 is healthy: successfully committed proposal: took = 2.083263ms # 127.0.0.1:22379 is healthy: successfully committed proposal: took = 2.083263ms
``` ```
### ENDPOINT STATUS ### ENDPOINT STATUS
@ -536,14 +536,14 @@ ENDPOINT STATUS does not support protobuf encoded output.
```bash ```bash
./etcdctl endpoint status ./etcdctl endpoint status
127.0.0.1:2379, 8211f1d0f64f3269, 3.0.0, 25 kB, false, 2, 63 # 127.0.0.1:2379, 8211f1d0f64f3269, 3.0.0, 25 kB, false, 2, 63
127.0.0.1:22379, 91bc3c398fb3c146, 3.0.0, 25 kB, false, 2, 63 # 127.0.0.1:22379, 91bc3c398fb3c146, 3.0.0, 25 kB, false, 2, 63
127.0.0.1:32379, fd422379fda50e48, 3.0.0, 25 kB, true, 2, 63 # 127.0.0.1:32379, fd422379fda50e48, 3.0.0, 25 kB, true, 2, 63
``` ```
```bash ```bash
./etcdctl -w json endpoint status ./etcdctl -w json endpoint status
[{"Endpoint":"127.0.0.1:2379","Status":{"header":{"cluster_id":17237436991929493444,"member_id":9372538179322589801,"revision":2,"raft_term":2},"version":"3.0.0","dbSize":24576,"leader":18249187646912138824,"raftIndex":32623,"raftTerm":2}},{"Endpoint":"127.0.0.1:22379","Status":{"header":{"cluster_id":17237436991929493444,"member_id":10501334649042878790,"revision":2,"raft_term":2},"version":"3.0.0","dbSize":24576,"leader":18249187646912138824,"raftIndex":32623,"raftTerm":2}},{"Endpoint":"127.0.0.1:32379","Status":{"header":{"cluster_id":17237436991929493444,"member_id":18249187646912138824,"revision":2,"raft_term":2},"version":"3.0.0","dbSize":24576,"leader":18249187646912138824,"raftIndex":32623,"raftTerm":2}}] # [{"Endpoint":"127.0.0.1:2379","Status":{"header":{"cluster_id":17237436991929493444,"member_id":9372538179322589801,"revision":2,"raft_term":2},"version":"3.0.0","dbSize":24576,"leader":18249187646912138824,"raftIndex":32623,"raftTerm":2}},{"Endpoint":"127.0.0.1:22379","Status":{"header":{"cluster_id":17237436991929493444,"member_id":10501334649042878790,"revision":2,"raft_term":2},"version":"3.0.0","dbSize":24576,"leader":18249187646912138824,"raftIndex":32623,"raftTerm":2}},{"Endpoint":"127.0.0.1:32379","Status":{"header":{"cluster_id":17237436991929493444,"member_id":18249187646912138824,"revision":2,"raft_term":2},"version":"3.0.0","dbSize":24576,"leader":18249187646912138824,"raftIndex":32623,"raftTerm":2}}]
``` ```
```bash ```bash
@ -570,7 +570,7 @@ LOCK acquires a distributed named mutex with a given name. Once the lock is acqu
#### Example #### Example
```bash ```bash
./etcdctl lock mylock ./etcdctl lock mylock
mylock/1234534535445 # mylock/1234534535445
``` ```
@ -602,8 +602,8 @@ Whenever a leader is elected, its proposal is given as output.
#### Example #### Example
```bash ```bash
./etcdctl elect myelection foo ./etcdctl elect myelection foo
myelection/1456952310051373265 # myelection/1456952310051373265
foo # foo
``` ```
@ -628,7 +628,7 @@ all superseded keys may be compacted away to reclaim storage space in the etcd b
#### Example #### Example
```bash ```bash
./etcdctl compaction 1234 ./etcdctl compaction 1234
compacted revision 1234 # compacted revision 1234
``` ```
### DEFRAG ### DEFRAG
@ -648,8 +648,8 @@ the database, the etcd member releases this free space back to the file system.
#### Example #### Example
```bash ```bash
./etcdctl --endpoints=localhost:2379,badendpoint:2379 defrag ./etcdctl --endpoints=localhost:2379,badendpoint:2379 defrag
Finished defragmenting etcd member[localhost:2379] # Finished defragmenting etcd member[localhost:2379]
Failed to defragment etcd member[badendpoint:2379] (grpc: timed out trying to connect) # Failed to defragment etcd member[badendpoint:2379] (grpc: timed out trying to connect)
``` ```
@ -679,8 +679,8 @@ Simple reply
``` ```
./etcdctl make-mirror mirror.example.com:2379 ./etcdctl make-mirror mirror.example.com:2379
10 # 10
18 # 18
``` ```
[mirror]: ./doc/mirror_maker.md [mirror]: ./doc/mirror_maker.md
@ -770,12 +770,12 @@ SNAPSHOT STATUS does not support protobuf encoded output.
#### Examples #### Examples
```bash ```bash
./etcdctl snapshot status file.db ./etcdctl snapshot status file.db
cf1550fb, 3, 3, 25 kB # cf1550fb, 3, 3, 25 kB
``` ```
```bash ```bash
./etcdctl -write-out=json snapshot status file.db ./etcdctl -write-out=json snapshot status file.db
{"hash":3474280699,"revision":3,"totalKey":3,"totalSize":24576} # {"hash":3474280699,"revision":3,"totalKey":3,"totalSize":24576}
``` ```
```bash ```bash
@ -837,7 +837,7 @@ The provided transformer should read until EOF and flush the stdout before exiti
``` ```
./etcdctl --data-dir=/var/etcd --transformer=k8s-transformer ./etcdctl --data-dir=/var/etcd --transformer=k8s-transformer
finished transforming keys # finished transforming keys
``` ```
### AUTH \<enable or disable\> ### AUTH \<enable or disable\>
@ -855,13 +855,22 @@ finished transforming keys
#### Examples #### Examples
``` bash ``` bash
etcdctl user add root ./etcdctl user add root
etcdctl user grant-role root root # Password of root:#type password for root
etcdctl user get root # Type password of root again for confirmation:#re-type password for root
etcdctl role add root # User root created
etcdctl role get root ./etcdctl user grant-role root root
# Role root is granted to user root
etcdctl auth enable ./etcdctl user get root
# User: root
# Roles: root
./etcdctl role add root
# Role root created
./etcdctl role get root
# Role root
# KV Read:
# KV Write:
./etcdctl auth enable
# Authentication Enabled # Authentication Enabled
``` ```
@ -880,7 +889,8 @@ etcdctl auth enable
#### Examples #### Examples
``` bash ``` bash
etcdctl --user=root:123 role add myrole ./etcdctl --user=root:123 role add myrole
# Role myrole created
``` ```
### ROLE DELETE \<role name\> ### ROLE DELETE \<role name\>
@ -898,7 +908,7 @@ etcdctl --user=root:123 role add myrole
#### Examples #### Examples
``` bash ``` bash
etcdctl --user=root:123 role delete myrole ./etcdctl --user=root:123 role delete myrole
# Role myrole deleted # Role myrole deleted
``` ```
@ -917,7 +927,7 @@ etcdctl --user=root:123 role delete myrole
#### Examples #### Examples
``` bash ``` bash
etcdctl --user=root:123 role get myrole ./etcdctl --user=root:123 role get myrole
# Role myrole # Role myrole
# KV Read: # KV Read:
# foo # foo
@ -940,7 +950,7 @@ etcdctl --user=root:123 role get myrole
#### Examples #### Examples
``` bash ``` bash
etcdctl --user=root:123 role grant-permission myrole readwrite foo ./etcdctl --user=root:123 role grant-permission myrole readwrite foo
# Role myrole updated # Role myrole updated
``` ```
@ -959,7 +969,7 @@ etcdctl --user=root:123 role grant-permission myrole readwrite foo
#### Examples #### Examples
``` bash ``` bash
etcdctl --user=root:123 role revoke-permission myrole foo ./etcdctl --user=root:123 role revoke-permission myrole foo
# Permission of key foo is revoked from role myrole # Permission of key foo is revoked from role myrole
``` ```
@ -978,9 +988,9 @@ etcdctl --user=root:123 role revoke-permission myrole foo
#### Examples #### Examples
``` bash ``` bash
etcdctl --user=root:123 user add myuser ./etcdctl --user=root:123 user add myuser
# Password of myuser: # Password of myuser: #type password for my user
# Type password of myuser again for confirmation: # Type password of myuser again for confirmation:#re-type password for my user
# User myuser created # User myuser created
``` ```
@ -999,7 +1009,7 @@ etcdctl --user=root:123 user add myuser
#### Examples #### Examples
``` bash ``` bash
etcdctl --user=root:123 user delete myuser ./etcdctl --user=root:123 user delete myuser
# User myuser deleted # User myuser deleted
``` ```
@ -1018,7 +1028,7 @@ etcdctl --user=root:123 user delete myuser
#### Examples #### Examples
``` bash ``` bash
etcdctl --user=root:123 user get myuser ./etcdctl --user=root:123 user get myuser
# User: myuser # User: myuser
# Roles: # Roles:
``` ```
@ -1042,9 +1052,9 @@ etcdctl --user=root:123 user get myuser
#### Examples #### Examples
``` bash ``` bash
etcdctl --user=root:123 user passwd myuser ./etcdctl --user=root:123 user passwd myuser
# Password of myuser: # Password of myuser: #type new password for my user
# Type password of myuser again for confirmation: # Type password of myuser again for confirmation: #re-type the new password for my user
# Password updated # Password updated
``` ```
@ -1063,7 +1073,7 @@ etcdctl --user=root:123 user passwd myuser
#### Examples #### Examples
``` bash ``` bash
etcdctl --user=root:123 user grant-role userA roleA ./etcdctl --user=root:123 user grant-role userA roleA
# Role roleA is granted to user userA # Role roleA is granted to user userA
``` ```
@ -1082,7 +1092,7 @@ etcdctl --user=root:123 user grant-role userA roleA
#### Examples #### Examples
``` bash ``` bash
etcdctl --user=root:123 user revoke-role userA roleA ./etcdctl --user=root:123 user revoke-role userA roleA
# Role roleA is revoked from user userA # Role roleA is revoked from user userA
``` ```