diff options
| author | Paul Bütow <pbuetow@mimecast.com> | 2020-02-07 16:53:33 +0000 |
|---|---|---|
| committer | Paul Bütow <pbuetow@mimecast.com> | 2020-02-07 16:53:33 +0000 |
| commit | 3a8d8ae4686256d0af9a3cc76128c140d89acd9e (patch) | |
| tree | b49d29370b3fb8382a46c8ee7cdf27d0607337cb /doc | |
| parent | 0945da8dfefcbb723eecea0e5f4eafff63398253 (diff) | |
add drun to the docs
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/drun.gif | bin | 0 -> 1668728 bytes | |||
| -rw-r--r-- | doc/examples.md | 13 | ||||
| -rw-r--r-- | doc/quickstart.md | 6 |
3 files changed, 16 insertions, 3 deletions
diff --git a/doc/drun.gif b/doc/drun.gif Binary files differnew file mode 100644 index 0000000..a3efeed --- /dev/null +++ b/doc/drun.gif diff --git a/doc/examples.md b/doc/examples.md index 964660a..df61631 100644 --- a/doc/examples.md +++ b/doc/examples.md @@ -50,7 +50,18 @@ The following example demonstrates how to grep files (display only the lines whi --regex swap ``` - + + +# How to use ``drun`` + +The following example demonstrates how to execute a command on multiple machines remotely: + +```shell +% drun --servers <(head -n 30 serverlist.txt) \ + --command uptime +``` + + # How to use ``dmap`` diff --git a/doc/quickstart.md b/doc/quickstart.md index 7b6fbf4..de50d06 100644 --- a/doc/quickstart.md +++ b/doc/quickstart.md @@ -10,19 +10,21 @@ This guide assumes that you know how to generate and configure a public/private To compile and install all DTail binaries directly from GitHub run: ```console -% go get github.com/mimecast/dtail/cmd/dtail % go get github.com/mimecast/dtail/cmd/dcat % go get github.com/mimecast/dtail/cmd/dgrep % go get github.com/mimecast/dtail/cmd/dmap +% go get github.com/mimecast/dtail/cmd/drun +% go get github.com/mimecast/dtail/cmd/dtail % go get github.com/mimecast/dtail/cmd/dserver ``` It produces the following executables in ``$GOPATH/bin``: -* ``dtail``: Client for tailing/following log files remotely (distributed tail) * ``dcat``: Client for displaying whole files remotely (distributed cat) * ``dgrep``: Client for searching whole files files remotely using a regex (distributed grep) * ``dmap``: Client for executing distributed mapreduce queries (may will consume a lot of RAM and CPU) +* ``drun``: Client for executing commands on remote servers. +* ``dtail``: Client for tailing/following log files remotely (distributed tail) * ``dserver``: The DTail server # Start DTail server |
