From fe5b3fbcc90123544d74bb31a571eb7d538e0d13 Mon Sep 17 00:00:00 2001 From: Steffen Siering Date: Tue, 25 Feb 2020 12:58:05 +0100 Subject: [PATCH] Update redis host settings docs (#16518) * Update redis host settings docs The redis host setting accepts passwords and URL schemas by now. This change update the reference config files and docs. (cherry picked from commit c4671ebdd0261d3de549b5328f4173c00e1ee8e7) --- auditbeat/auditbeat.reference.yml | 2 ++ filebeat/filebeat.reference.yml | 2 ++ heartbeat/heartbeat.reference.yml | 2 ++ journalbeat/journalbeat.reference.yml | 2 ++ libbeat/_meta/config.reference.yml.tmpl | 2 ++ libbeat/outputs/redis/docs/redis.asciidoc | 6 ++++++ metricbeat/metricbeat.reference.yml | 2 ++ packetbeat/packetbeat.reference.yml | 2 ++ winlogbeat/winlogbeat.reference.yml | 2 ++ x-pack/auditbeat/auditbeat.reference.yml | 2 ++ x-pack/filebeat/filebeat.reference.yml | 2 ++ x-pack/metricbeat/metricbeat.reference.yml | 2 ++ x-pack/winlogbeat/winlogbeat.reference.yml | 2 ++ 13 files changed, 30 insertions(+) diff --git a/auditbeat/auditbeat.reference.yml b/auditbeat/auditbeat.reference.yml index 9110e57b75e..15c4343c440 100644 --- a/auditbeat/auditbeat.reference.yml +++ b/auditbeat/auditbeat.reference.yml @@ -788,6 +788,8 @@ output.elasticsearch: # The list of Redis servers to connect to. If load-balancing is enabled, the # events are distributed to the servers in the list. If one server becomes # unreachable, the events are distributed to the reachable servers only. + # The hosts setting supports redis and rediss urls with custom password like + # redis://:password@localhost:6379. #hosts: ["localhost:6379"] # The name of the Redis list or channel the events are published to. The diff --git a/filebeat/filebeat.reference.yml b/filebeat/filebeat.reference.yml index 57082c85509..b9bd006d0e1 100644 --- a/filebeat/filebeat.reference.yml +++ b/filebeat/filebeat.reference.yml @@ -1493,6 +1493,8 @@ output.elasticsearch: # The list of Redis servers to connect to. If load-balancing is enabled, the # events are distributed to the servers in the list. If one server becomes # unreachable, the events are distributed to the reachable servers only. + # The hosts setting supports redis and rediss urls with custom password like + # redis://:password@localhost:6379. #hosts: ["localhost:6379"] # The name of the Redis list or channel the events are published to. The diff --git a/heartbeat/heartbeat.reference.yml b/heartbeat/heartbeat.reference.yml index 233ae8b4889..d953d31cd07 100644 --- a/heartbeat/heartbeat.reference.yml +++ b/heartbeat/heartbeat.reference.yml @@ -932,6 +932,8 @@ output.elasticsearch: # The list of Redis servers to connect to. If load-balancing is enabled, the # events are distributed to the servers in the list. If one server becomes # unreachable, the events are distributed to the reachable servers only. + # The hosts setting supports redis and rediss urls with custom password like + # redis://:password@localhost:6379. #hosts: ["localhost:6379"] # The name of the Redis list or channel the events are published to. The diff --git a/journalbeat/journalbeat.reference.yml b/journalbeat/journalbeat.reference.yml index 38357dc0de7..6f8ddba94e8 100644 --- a/journalbeat/journalbeat.reference.yml +++ b/journalbeat/journalbeat.reference.yml @@ -726,6 +726,8 @@ output.elasticsearch: # The list of Redis servers to connect to. If load-balancing is enabled, the # events are distributed to the servers in the list. If one server becomes # unreachable, the events are distributed to the reachable servers only. + # The hosts setting supports redis and rediss urls with custom password like + # redis://:password@localhost:6379. #hosts: ["localhost:6379"] # The name of the Redis list or channel the events are published to. The diff --git a/libbeat/_meta/config.reference.yml.tmpl b/libbeat/_meta/config.reference.yml.tmpl index aae8dcfbb8a..e8ffe4afa2c 100644 --- a/libbeat/_meta/config.reference.yml.tmpl +++ b/libbeat/_meta/config.reference.yml.tmpl @@ -669,6 +669,8 @@ output.elasticsearch: # The list of Redis servers to connect to. If load-balancing is enabled, the # events are distributed to the servers in the list. If one server becomes # unreachable, the events are distributed to the reachable servers only. + # The hosts setting supports redis and rediss urls with custom password like + # redis://:password@localhost:6379. #hosts: ["localhost:6379"] # The name of the Redis list or channel the events are published to. The diff --git a/libbeat/outputs/redis/docs/redis.asciidoc b/libbeat/outputs/redis/docs/redis.asciidoc index 0d7dde88bfc..5a8a730e018 100644 --- a/libbeat/outputs/redis/docs/redis.asciidoc +++ b/libbeat/outputs/redis/docs/redis.asciidoc @@ -45,6 +45,12 @@ distributed to the servers in the list. If one server becomes unreachable, the e distributed to the reachable servers only. You can define each Redis server by specifying `HOST` or `HOST:PORT`. For example: `"192.15.3.2"` or `"test.redis.io:12345"`. If you don't specify a port number, the value configured by `port` is used. +Configure each Redis server with an `IP:PORT` pair or with a `URL`. For +example: `redis://localhost:6379` or `rediss://localhost:6379`. +URLs can include a server-specific password. For example: `redis://:password@localhost:6379`. +The `redis` scheme will disable the `ssl` settings for the host, while `rediss` +will enforce TLS. If `rediss` is specified and no `ssl` settings are +configured, the output uses the system certificate store. ===== `index` diff --git a/metricbeat/metricbeat.reference.yml b/metricbeat/metricbeat.reference.yml index a254561452a..00ae960689a 100644 --- a/metricbeat/metricbeat.reference.yml +++ b/metricbeat/metricbeat.reference.yml @@ -1480,6 +1480,8 @@ output.elasticsearch: # The list of Redis servers to connect to. If load-balancing is enabled, the # events are distributed to the servers in the list. If one server becomes # unreachable, the events are distributed to the reachable servers only. + # The hosts setting supports redis and rediss urls with custom password like + # redis://:password@localhost:6379. #hosts: ["localhost:6379"] # The name of the Redis list or channel the events are published to. The diff --git a/packetbeat/packetbeat.reference.yml b/packetbeat/packetbeat.reference.yml index 6de6530fe94..6c01e7465a8 100644 --- a/packetbeat/packetbeat.reference.yml +++ b/packetbeat/packetbeat.reference.yml @@ -1210,6 +1210,8 @@ output.elasticsearch: # The list of Redis servers to connect to. If load-balancing is enabled, the # events are distributed to the servers in the list. If one server becomes # unreachable, the events are distributed to the reachable servers only. + # The hosts setting supports redis and rediss urls with custom password like + # redis://:password@localhost:6379. #hosts: ["localhost:6379"] # The name of the Redis list or channel the events are published to. The diff --git a/winlogbeat/winlogbeat.reference.yml b/winlogbeat/winlogbeat.reference.yml index df9f38ad64c..e4a29910e56 100644 --- a/winlogbeat/winlogbeat.reference.yml +++ b/winlogbeat/winlogbeat.reference.yml @@ -711,6 +711,8 @@ output.elasticsearch: # The list of Redis servers to connect to. If load-balancing is enabled, the # events are distributed to the servers in the list. If one server becomes # unreachable, the events are distributed to the reachable servers only. + # The hosts setting supports redis and rediss urls with custom password like + # redis://:password@localhost:6379. #hosts: ["localhost:6379"] # The name of the Redis list or channel the events are published to. The diff --git a/x-pack/auditbeat/auditbeat.reference.yml b/x-pack/auditbeat/auditbeat.reference.yml index 2f4c6c3ffd1..9f337ec4c8c 100644 --- a/x-pack/auditbeat/auditbeat.reference.yml +++ b/x-pack/auditbeat/auditbeat.reference.yml @@ -839,6 +839,8 @@ output.elasticsearch: # The list of Redis servers to connect to. If load-balancing is enabled, the # events are distributed to the servers in the list. If one server becomes # unreachable, the events are distributed to the reachable servers only. + # The hosts setting supports redis and rediss urls with custom password like + # redis://:password@localhost:6379. #hosts: ["localhost:6379"] # The name of the Redis list or channel the events are published to. The diff --git a/x-pack/filebeat/filebeat.reference.yml b/x-pack/filebeat/filebeat.reference.yml index 8ffb84c3a70..448f1500c00 100644 --- a/x-pack/filebeat/filebeat.reference.yml +++ b/x-pack/filebeat/filebeat.reference.yml @@ -2039,6 +2039,8 @@ output.elasticsearch: # The list of Redis servers to connect to. If load-balancing is enabled, the # events are distributed to the servers in the list. If one server becomes # unreachable, the events are distributed to the reachable servers only. + # The hosts setting supports redis and rediss urls with custom password like + # redis://:password@localhost:6379. #hosts: ["localhost:6379"] # The name of the Redis list or channel the events are published to. The diff --git a/x-pack/metricbeat/metricbeat.reference.yml b/x-pack/metricbeat/metricbeat.reference.yml index c521e6b81e7..897422c625f 100644 --- a/x-pack/metricbeat/metricbeat.reference.yml +++ b/x-pack/metricbeat/metricbeat.reference.yml @@ -1713,6 +1713,8 @@ output.elasticsearch: # The list of Redis servers to connect to. If load-balancing is enabled, the # events are distributed to the servers in the list. If one server becomes # unreachable, the events are distributed to the reachable servers only. + # The hosts setting supports redis and rediss urls with custom password like + # redis://:password@localhost:6379. #hosts: ["localhost:6379"] # The name of the Redis list or channel the events are published to. The diff --git a/x-pack/winlogbeat/winlogbeat.reference.yml b/x-pack/winlogbeat/winlogbeat.reference.yml index 9bcc352079c..85322288964 100644 --- a/x-pack/winlogbeat/winlogbeat.reference.yml +++ b/x-pack/winlogbeat/winlogbeat.reference.yml @@ -714,6 +714,8 @@ output.elasticsearch: # The list of Redis servers to connect to. If load-balancing is enabled, the # events are distributed to the servers in the list. If one server becomes # unreachable, the events are distributed to the reachable servers only. + # The hosts setting supports redis and rediss urls with custom password like + # redis://:password@localhost:6379. #hosts: ["localhost:6379"] # The name of the Redis list or channel the events are published to. The