From 7df612f527bd5dc2e785bf766d7d61124c260b94 Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Mon, 16 Nov 2020 22:11:44 +0000 Subject: remove drun command for simplicity. only focus on interactive commands dealing with log streams --- doc/drun.gif | Bin 1668728 -> 0 bytes doc/examples.md | 11 ----------- doc/quickstart.md | 3 +-- 3 files changed, 1 insertion(+), 13 deletions(-) delete mode 100644 doc/drun.gif (limited to 'doc') diff --git a/doc/drun.gif b/doc/drun.gif deleted file mode 100644 index a3efeed..0000000 Binary files a/doc/drun.gif and /dev/null differ diff --git a/doc/examples.md b/doc/examples.md index 5a5d892..964660a 100644 --- a/doc/examples.md +++ b/doc/examples.md @@ -52,17 +52,6 @@ The following example demonstrates how to grep files (display only the lines whi ![dgrep](dgrep.gif "Grep 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`` To run a mapreduce aggregation over logs written in the past the ``dmap`` command can be used. For example the following command aggregates all mapreduce fields of all the logs and calculates the average memory free grouped by day of the month, hour, minute and the server hostname. ``dmap`` will print interim results every few seconds. The final result however will be written to file ``mapreduce.csv``. diff --git a/doc/quickstart.md b/doc/quickstart.md index 733442f..6baedbb 100644 --- a/doc/quickstart.md +++ b/doc/quickstart.md @@ -16,7 +16,7 @@ On Linux you need to install the libacl development library for file system ACL To compile and install all DTail binaries directly from GitHub run: ```console -% for cmd in dcat dgrep dmap drun dtail dserver; do +% for cmd in dcat dgrep dmap dtail dserver; do go get github.com/mimecast/dtail/cmd/$cmd; done ``` @@ -26,7 +26,6 @@ It produces the following executables in ``$GOPATH/bin``: * ``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 -- cgit v1.2.3 From 68eb22ca70590219f9be8dbb533af90cc3560cfa Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Mon, 28 Dec 2020 10:25:37 +0000 Subject: add separate licenses md --- doc/licenses.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 doc/licenses.md (limited to 'doc') diff --git a/doc/licenses.md b/doc/licenses.md new file mode 100644 index 0000000..83a94e7 --- /dev/null +++ b/doc/licenses.md @@ -0,0 +1,11 @@ +Licenses +======== + +DTails main license is [Apache 2.0](../LICENSE). Further 3rd party licenses are: + +## DataDog zstd compression library + +Not included in DTail repository but imported automatically on build. + +* URL: https://github.com/DataDog/zstd +* License: [Simplified BSD](../LICENSE.DataDog.zstd) -- cgit v1.2.3 From 0099a7ab9e1d28300c69c3b50b4ebe1cde9a8cbc Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Tue, 29 Dec 2020 08:34:04 +0000 Subject: Make Linux ACL support optional, as it requires CGo and makes the binary less portable --- doc/installation.md | 20 ++++++++++++++++++++ doc/quickstart.md | 6 ------ 2 files changed, 20 insertions(+), 6 deletions(-) (limited to 'doc') diff --git a/doc/installation.md b/doc/installation.md index 6f946c4..6bf17b0 100644 --- a/doc/installation.md +++ b/doc/installation.md @@ -7,6 +7,26 @@ The following installation guide has been tested successfully on CentOS 7. You m Please check the [Quick Starting Guide](quickstart.md) for instructions how to compile DTail. It is recommended to automate the build process via your build pipeline (e.g. produce a deployable RPM via Jenkins). You don't have to use ``go get...`` to compile and install the binaries. You can also clone the repository and use ``make`` instead. +## Linux ACL support + +This is optional but it gives you better security. On Linux you have the option to compile `dserver` with File System Access Control List support. For that you need: + +### 1. Install the `libacl` development library. On RHEL, CentOS and Fedora it would be + +```console +% sudo dnf install libacl-devel -y +``` + +### 2. Enable ACL via a Go build flag + +Set the `USE_ACL` environment variable before invoking the make command. + +```console +% export USE_ACL=yes +``` + +Alternatively you could just add `-tags linuxacl` to the Go compiler. + # Install it It is recommended to automate all the installation process outlined here. You could use a configuration management system such as Puppet, Chef or Ansible. However, that relies heavily on how your infrastructure is managed and is out of scope of this documentation. diff --git a/doc/quickstart.md b/doc/quickstart.md index 6baedbb..f1ac000 100644 --- a/doc/quickstart.md +++ b/doc/quickstart.md @@ -7,12 +7,6 @@ This guide assumes that you know how to generate and configure a public/private # Install it -On Linux you need to install the libacl development library for file system ACL permission support in `dserver`. On RHEL, CentOS and Fedora it would be - -```console -% sudo dnf install libacl-devel -y -``` - To compile and install all DTail binaries directly from GitHub run: ```console -- cgit v1.2.3