From b264daf0daf72dc295aff2f7a6c5f59ad23ed342 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Paul=20B=C3=BCtow?= Date: Fri, 7 Feb 2020 16:53:33 +0000 Subject: add drun to the docs --- doc/drun.gif | Bin 0 -> 1668728 bytes doc/examples.md | 13 ++++++++++++- doc/quickstart.md | 6 ++++-- 3 files changed, 16 insertions(+), 3 deletions(-) create mode 100644 doc/drun.gif diff --git a/doc/drun.gif b/doc/drun.gif new file mode 100644 index 0000000..a3efeed Binary files /dev/null and b/doc/drun.gif differ 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 ``` -![dgrep](dgrep.gif "Grep example") +![dgrep](drun.gif "Run example") + +# 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 +``` + +![dgrep](drun.gif "Run example") # 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 -- cgit v1.2.3