mirror of
https://github.com/etcd-io/etcd.git
synced 2024-09-27 06:25:44 +00:00
etcdctl: Handle ETCDCTL_USERNAME environment
This commit is contained in:
parent
bb8619f4f7
commit
720502b25f
@ -4,15 +4,10 @@ etcdctl
|
|||||||
`etcdctl` is a command line client for [etcd][etcd].
|
`etcdctl` is a command line client for [etcd][etcd].
|
||||||
It can be used in scripts or for administrators to explore an etcd cluster.
|
It can be used in scripts or for administrators to explore an etcd cluster.
|
||||||
|
|
||||||
[etcd]: https://github.com/coreos/etcd
|
|
||||||
|
|
||||||
|
|
||||||
## Getting etcdctl
|
## Getting etcdctl
|
||||||
|
|
||||||
The latest release is available as a binary at [Github][github-release] along with etcd.
|
The latest release is available as a binary at [Github][github-release] along with etcd.
|
||||||
|
|
||||||
[github-release]: https://github.com/coreos/etcd/releases/
|
|
||||||
|
|
||||||
You can also build etcdctl from source using the build script found in the parent directory.
|
You can also build etcdctl from source using the build script found in the parent directory.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
@ -62,6 +57,7 @@ You can also build etcdctl from source using the build script found in the paren
|
|||||||
### --username, -u
|
### --username, -u
|
||||||
+ provide username[:password] and prompt if password is not supplied
|
+ provide username[:password] and prompt if password is not supplied
|
||||||
+ default: none
|
+ default: none
|
||||||
|
+ env variable: ETCDCTL_USERNAME
|
||||||
|
|
||||||
### --timeout
|
### --timeout
|
||||||
+ connection timeout per request
|
+ connection timeout per request
|
||||||
@ -77,61 +73,61 @@ You can also build etcdctl from source using the build script found in the paren
|
|||||||
|
|
||||||
Set a value on the `/foo/bar` key:
|
Set a value on the `/foo/bar` key:
|
||||||
|
|
||||||
```
|
```sh
|
||||||
$ etcdctl set /foo/bar "Hello world"
|
$ etcdctl set /foo/bar "Hello world"
|
||||||
Hello world
|
Hello world
|
||||||
```
|
```
|
||||||
|
|
||||||
Set a value on the `/foo/bar` key with a value that expires in 60 seconds:
|
Set a value on the `/foo/bar` key with a value that expires in 60 seconds:
|
||||||
|
|
||||||
```
|
```sh
|
||||||
$ etcdctl set /foo/bar "Hello world" --ttl 60
|
$ etcdctl set /foo/bar "Hello world" --ttl 60
|
||||||
Hello world
|
Hello world
|
||||||
```
|
```
|
||||||
|
|
||||||
Conditionally set a value on `/foo/bar` if the previous value was "Hello world":
|
Conditionally set a value on `/foo/bar` if the previous value was "Hello world":
|
||||||
|
|
||||||
```
|
```sh
|
||||||
$ etcdctl set /foo/bar "Goodbye world" --swap-with-value "Hello world"
|
$ etcdctl set /foo/bar "Goodbye world" --swap-with-value "Hello world"
|
||||||
Goodbye world
|
Goodbye world
|
||||||
```
|
```
|
||||||
|
|
||||||
Conditionally set a value on `/foo/bar` if the previous etcd index was 12:
|
Conditionally set a value on `/foo/bar` if the previous etcd index was 12:
|
||||||
|
|
||||||
```
|
```sh
|
||||||
$ etcdctl set /foo/bar "Goodbye world" --swap-with-index 12
|
$ etcdctl set /foo/bar "Goodbye world" --swap-with-index 12
|
||||||
Goodbye world
|
Goodbye world
|
||||||
```
|
```
|
||||||
|
|
||||||
Create a new key `/foo/bar`, only if the key did not previously exist:
|
Create a new key `/foo/bar`, only if the key did not previously exist:
|
||||||
|
|
||||||
```
|
```sh
|
||||||
$ etcdctl mk /foo/new_bar "Hello world"
|
$ etcdctl mk /foo/new_bar "Hello world"
|
||||||
Hello world
|
Hello world
|
||||||
```
|
```
|
||||||
|
|
||||||
Create a new in-order key under dir `/fooDir`:
|
Create a new in-order key under dir `/fooDir`:
|
||||||
|
|
||||||
```
|
```sh
|
||||||
$ etcdctl mk --in-order /fooDir "Hello world"
|
$ etcdctl mk --in-order /fooDir "Hello world"
|
||||||
```
|
```
|
||||||
|
|
||||||
Create a new dir `/fooDir`, only if the key did not previously exist:
|
Create a new dir `/fooDir`, only if the key did not previously exist:
|
||||||
|
|
||||||
```
|
```sh
|
||||||
$ etcdctl mkdir /fooDir
|
$ etcdctl mkdir /fooDir
|
||||||
```
|
```
|
||||||
|
|
||||||
Update an existing key `/foo/bar`, only if the key already existed:
|
Update an existing key `/foo/bar`, only if the key already existed:
|
||||||
|
|
||||||
```
|
```sh
|
||||||
$ etcdctl update /foo/bar "Hola mundo"
|
$ etcdctl update /foo/bar "Hola mundo"
|
||||||
Hola mundo
|
Hola mundo
|
||||||
```
|
```
|
||||||
|
|
||||||
Create or update a directory called `/mydir`:
|
Create or update a directory called `/mydir`:
|
||||||
|
|
||||||
```
|
```sh
|
||||||
$ etcdctl setdir /mydir
|
$ etcdctl setdir /mydir
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -140,14 +136,14 @@ $ etcdctl setdir /mydir
|
|||||||
|
|
||||||
Get the current value for a single key in the local etcd node:
|
Get the current value for a single key in the local etcd node:
|
||||||
|
|
||||||
```
|
```sh
|
||||||
$ etcdctl get /foo/bar
|
$ etcdctl get /foo/bar
|
||||||
Hello world
|
Hello world
|
||||||
```
|
```
|
||||||
|
|
||||||
Get the value of a key with additional metadata in a parseable format:
|
Get the value of a key with additional metadata in a parseable format:
|
||||||
|
|
||||||
```
|
```sh
|
||||||
$ etcdctl -o extended get /foo/bar
|
$ etcdctl -o extended get /foo/bar
|
||||||
Key: /foo/bar
|
Key: /foo/bar
|
||||||
Modified-Index: 72
|
Modified-Index: 72
|
||||||
@ -163,7 +159,7 @@ Hello World
|
|||||||
|
|
||||||
Explore the keyspace using the `ls` command
|
Explore the keyspace using the `ls` command
|
||||||
|
|
||||||
```
|
```sh
|
||||||
$ etcdctl ls
|
$ etcdctl ls
|
||||||
/akey
|
/akey
|
||||||
/adir
|
/adir
|
||||||
@ -174,7 +170,7 @@ $ etcdctl ls /adir
|
|||||||
|
|
||||||
Add `--recursive` to recursively list subdirectories encountered.
|
Add `--recursive` to recursively list subdirectories encountered.
|
||||||
|
|
||||||
```
|
```sh
|
||||||
$ etcdctl ls --recursive
|
$ etcdctl ls --recursive
|
||||||
/akey
|
/akey
|
||||||
/adir
|
/adir
|
||||||
@ -184,7 +180,7 @@ $ etcdctl ls --recursive
|
|||||||
|
|
||||||
Directories can also have a trailing `/` added to output using `-p`.
|
Directories can also have a trailing `/` added to output using `-p`.
|
||||||
|
|
||||||
```
|
```sh
|
||||||
$ etcdctl ls -p
|
$ etcdctl ls -p
|
||||||
/akey
|
/akey
|
||||||
/adir/
|
/adir/
|
||||||
@ -194,37 +190,37 @@ $ etcdctl ls -p
|
|||||||
|
|
||||||
Delete a key:
|
Delete a key:
|
||||||
|
|
||||||
```
|
```sh
|
||||||
$ etcdctl rm /foo/bar
|
$ etcdctl rm /foo/bar
|
||||||
```
|
```
|
||||||
|
|
||||||
Delete an empty directory or a key-value pair
|
Delete an empty directory or a key-value pair
|
||||||
|
|
||||||
```
|
```sh
|
||||||
$ etcdctl rmdir /path/to/dir
|
$ etcdctl rmdir /path/to/dir
|
||||||
```
|
```
|
||||||
|
|
||||||
or
|
or
|
||||||
|
|
||||||
```
|
```sh
|
||||||
$ etcdctl rm /path/to/dir --dir
|
$ etcdctl rm /path/to/dir --dir
|
||||||
```
|
```
|
||||||
|
|
||||||
Recursively delete a key and all child keys:
|
Recursively delete a key and all child keys:
|
||||||
|
|
||||||
```
|
```sh
|
||||||
$ etcdctl rm /path/to/dir --recursive
|
$ etcdctl rm /path/to/dir --recursive
|
||||||
```
|
```
|
||||||
|
|
||||||
Conditionally delete `/foo/bar` if the previous value was "Hello world":
|
Conditionally delete `/foo/bar` if the previous value was "Hello world":
|
||||||
|
|
||||||
```
|
```sh
|
||||||
$ etcdctl rm /foo/bar --with-value "Hello world"
|
$ etcdctl rm /foo/bar --with-value "Hello world"
|
||||||
```
|
```
|
||||||
|
|
||||||
Conditionally delete `/foo/bar` if the previous etcd index was 12:
|
Conditionally delete `/foo/bar` if the previous etcd index was 12:
|
||||||
|
|
||||||
```
|
```sh
|
||||||
$ etcdctl rm /foo/bar --with-index 12
|
$ etcdctl rm /foo/bar --with-index 12
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -232,14 +228,14 @@ $ etcdctl rm /foo/bar --with-index 12
|
|||||||
|
|
||||||
Watch for only the next change on a key:
|
Watch for only the next change on a key:
|
||||||
|
|
||||||
```
|
```sh
|
||||||
$ etcdctl watch /foo/bar
|
$ etcdctl watch /foo/bar
|
||||||
Hello world
|
Hello world
|
||||||
```
|
```
|
||||||
|
|
||||||
Continuously watch a key:
|
Continuously watch a key:
|
||||||
|
|
||||||
```
|
```sh
|
||||||
$ etcdctl watch /foo/bar --forever
|
$ etcdctl watch /foo/bar --forever
|
||||||
Hello world
|
Hello world
|
||||||
.... client hangs forever until ctrl+C printing values as key change
|
.... client hangs forever until ctrl+C printing values as key change
|
||||||
@ -247,7 +243,7 @@ Hello world
|
|||||||
|
|
||||||
Continuously watch a key, starting with a given etcd index:
|
Continuously watch a key, starting with a given etcd index:
|
||||||
|
|
||||||
```
|
```sh
|
||||||
$ etcdctl watch /foo/bar --forever --index 12
|
$ etcdctl watch /foo/bar --forever --index 12
|
||||||
Hello world
|
Hello world
|
||||||
.... client hangs forever until ctrl+C printing values as key change
|
.... client hangs forever until ctrl+C printing values as key change
|
||||||
@ -255,7 +251,7 @@ Hello world
|
|||||||
|
|
||||||
Continuously watch a key and exec a program:
|
Continuously watch a key and exec a program:
|
||||||
|
|
||||||
```
|
```sh
|
||||||
$ etcdctl exec-watch /foo/bar -- sh -c "env | grep ETCD"
|
$ etcdctl exec-watch /foo/bar -- sh -c "env | grep ETCD"
|
||||||
ETCD_WATCH_ACTION=set
|
ETCD_WATCH_ACTION=set
|
||||||
ETCD_WATCH_VALUE=My configuration stuff
|
ETCD_WATCH_VALUE=My configuration stuff
|
||||||
@ -268,7 +264,7 @@ ETCD_WATCH_KEY=/foo/bar
|
|||||||
```
|
```
|
||||||
|
|
||||||
Continuously and recursively watch a key and exec a program:
|
Continuously and recursively watch a key and exec a program:
|
||||||
```
|
```sh
|
||||||
$ etcdctl exec-watch --recursive /foo -- sh -c "env | grep ETCD"
|
$ etcdctl exec-watch --recursive /foo -- sh -c "env | grep ETCD"
|
||||||
ETCD_WATCH_ACTION=set
|
ETCD_WATCH_ACTION=set
|
||||||
ETCD_WATCH_VALUE=My configuration stuff
|
ETCD_WATCH_VALUE=My configuration stuff
|
||||||
@ -300,20 +296,28 @@ a `--endpoint` flag or `ETCDCTL_ENDPOINT` environment variable. You can list one
|
|||||||
or a comma-separated list of endpoints. This option is ignored if the `--discovery-srv`
|
or a comma-separated list of endpoints. This option is ignored if the `--discovery-srv`
|
||||||
option is provided.
|
option is provided.
|
||||||
|
|
||||||
```
|
```sh
|
||||||
ETCDCTL_ENDPOINT="http://10.0.28.1:4002" etcdctl set my-key to-a-value
|
ETCDCTL_ENDPOINT="http://10.0.28.1:4002" etcdctl set my-key to-a-value
|
||||||
ETCDCTL_ENDPOINT="http://10.0.28.1:4002,http://10.0.28.2:4002,http://10.0.28.3:4002" etcdctl set my-key to-a-value
|
ETCDCTL_ENDPOINT="http://10.0.28.1:4002,http://10.0.28.2:4002,http://10.0.28.3:4002" etcdctl set my-key to-a-value
|
||||||
etcdctl --endpoint http://10.0.28.1:4002 my-key to-a-value
|
etcdctl --endpoint http://10.0.28.1:4002 my-key to-a-value
|
||||||
etcdctl --endpoint http://10.0.28.1:4002,http://10.0.28.2:4002,http://10.0.28.3:4002 etcdctl set my-key to-a-value
|
etcdctl --endpoint http://10.0.28.1:4002,http://10.0.28.2:4002,http://10.0.28.3:4002 etcdctl set my-key to-a-value
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Username and Password
|
||||||
|
|
||||||
|
If your etcd cluster is protected by [authentication][authentication], you can specify username and password using the [`--username`][username-flag] or `ETCDCTL_USERNAME` environment variable. When `--username` flag or `ETCDCTL_USERNAME` environment variable doesn't contain password, etcdctl will prompt password in interactive mode.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
ETCDCTL_USERNAME="root:password" etcdctl set my-key to-a-value
|
||||||
|
```
|
||||||
|
|
||||||
## DNS Discovery
|
## DNS Discovery
|
||||||
|
|
||||||
If you want to discover your etcd cluster through domain SRV records you can specify
|
If you want to discover your etcd cluster through domain SRV records you can specify
|
||||||
a `--discovery-srv` flag or `ETCDCTL_DISCOVERY_SRV` environment variable. This option takes
|
a `--discovery-srv` flag or `ETCDCTL_DISCOVERY_SRV` environment variable. This option takes
|
||||||
precedence over the `--endpoint` flag.
|
precedence over the `--endpoint` flag.
|
||||||
|
|
||||||
```
|
```sh
|
||||||
ETCDCTL_DISCOVERY_SRV="some-domain" etcdctl set my-key to-a-value
|
ETCDCTL_DISCOVERY_SRV="some-domain" etcdctl set my-key to-a-value
|
||||||
etcdctl --discovery-srv some-domain set my-key to-a-value
|
etcdctl --discovery-srv some-domain set my-key to-a-value
|
||||||
```
|
```
|
||||||
@ -325,10 +329,13 @@ etcdctl --discovery-srv some-domain set my-key to-a-value
|
|||||||
etcdctl uses [semantic versioning][semver].
|
etcdctl uses [semantic versioning][semver].
|
||||||
Releases will follow lockstep with the etcd release cycle.
|
Releases will follow lockstep with the etcd release cycle.
|
||||||
|
|
||||||
[semver]: http://semver.org/
|
|
||||||
|
|
||||||
### License
|
### License
|
||||||
|
|
||||||
etcdctl is under the Apache 2.0 license. See the [LICENSE][license] file for details.
|
etcdctl is under the Apache 2.0 license. See the [LICENSE][license] file for details.
|
||||||
|
|
||||||
|
[authentication]: ../Documentation/authentication.md
|
||||||
|
[etcd]: https://github.com/coreos/etcd
|
||||||
|
[github-release]: https://github.com/coreos/etcd/releases/
|
||||||
[license]: https://github.com/coreos/etcdctl/blob/master/LICENSE
|
[license]: https://github.com/coreos/etcdctl/blob/master/LICENSE
|
||||||
|
[semver]: http://semver.org/
|
||||||
|
[username-flag]: #--username--u
|
||||||
|
@ -315,6 +315,11 @@ func newClient(c *cli.Context) (client.Client, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
uFlag := c.GlobalString("username")
|
uFlag := c.GlobalString("username")
|
||||||
|
|
||||||
|
if uFlag == "" {
|
||||||
|
uFlag = os.Getenv("ETCDCTL_USERNAME")
|
||||||
|
}
|
||||||
|
|
||||||
if uFlag != "" {
|
if uFlag != "" {
|
||||||
username, password, err := getUsernamePasswordFromFlag(uFlag)
|
username, password, err := getUsernamePasswordFromFlag(uFlag)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
Loading…
x
Reference in New Issue
Block a user