From 3f8379d07d65a89493e0d68f78e0206a7fb0c675 Mon Sep 17 00:00:00 2001 From: Aditya Manthramurthy Date: Tue, 9 Jan 2018 19:50:42 -0800 Subject: [PATCH] Update Elasticsearch documentation with authentication information (#5381) - Add documentation to show how to supply credential to access a secured elasticsearch server. Fixes #5329 --- docs/bucket/notifications/README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/bucket/notifications/README.md b/docs/bucket/notifications/README.md index 63396357d..34dc4e229 100644 --- a/docs/bucket/notifications/README.md +++ b/docs/bucket/notifications/README.md @@ -271,7 +271,7 @@ The default location of Minio server configuration file is ``~/.minio/config.jso |:---|:---|:---| | `enable` | _bool_ | (Required) Is this server endpoint configuration active/enabled? | | `format` | _string_ | (Required) Either `namespace` or `access`. | -| `url` | _string_ | (Required) The Elasticsearch server's address. For example: `http://localhost:9200`. | +| `url` | _string_ | (Required) The Elasticsearch server's address, with optional authentication info. For example: `http://localhost:9200` or with authentication info `http://elastic:MagicWord@127.0.0.1:9200`. | | `index` | _string_ | (Required) The name of an Elasticsearch index in which Minio will store documents. | An example of Elasticsearch configuration is as follows: @@ -287,6 +287,8 @@ An example of Elasticsearch configuration is as follows: }, ``` +If Elasticsearch has authentication enabled, the credentials can be supplied to Minio via the `url` parameter formatted as `PROTO://USERNAME:PASSWORD@ELASTICSEARCH_HOST:PORT`. + After updating the configuration file, restart the Minio server to put the changes into effect. The server will print a line like `SQS ARNs: arn:minio:sqs::1:elasticsearch` at start-up if there were no errors. Note that, you can add as many Elasticsearch server endpoint configurations as needed by providing an identifier (like "1" in the example above) for the Elasticsearch instance and an object of per-server configuration parameters. @@ -529,8 +531,8 @@ Minio server also supports [NATS Streaming mode](http://nats.io/documentation/st } } }, -``` -Read more about sections `clusterID`, `clientID` on [NATS documentation](https://github.com/nats-io/nats-streaming-server/blob/master/README.md). Section `maxPubAcksInflight` is explained [here](https://github.com/nats-io/go-nats-streaming#publisher-rate-limiting). +``` +Read more about sections `clusterID`, `clientID` on [NATS documentation](https://github.com/nats-io/nats-streaming-server/blob/master/README.md). Section `maxPubAcksInflight` is explained [here](https://github.com/nats-io/go-nats-streaming#publisher-rate-limiting). ### Step 2: Enable bucket notification using Minio client @@ -629,7 +631,7 @@ func main() { ``` ``` -go run nats.go +go run nats.go 2017/07/07 11:47:40 Connected 2017/07/07 11:47:40 Subscribing to subject 'bucketevents' ```