From 30669f63e87622b8b8d21a9d13fc98d5c1fd5f7c Mon Sep 17 00:00:00 2001 From: Clinton Gormley Date: Fri, 4 Mar 2016 13:50:21 +0100 Subject: [PATCH] Document required settings when running the REST test suite --- .../rest-api-spec/test/README.asciidoc | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/rest-api-spec/src/main/resources/rest-api-spec/test/README.asciidoc b/rest-api-spec/src/main/resources/rest-api-spec/test/README.asciidoc index e19b1ebbee9..304d31978cf 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/test/README.asciidoc +++ b/rest-api-spec/src/main/resources/rest-api-spec/test/README.asciidoc @@ -1,6 +1,23 @@ Test Suite: =========== +[NOTE] +.Required settings +======================================= +Certain tests require specific settings to be applied to the +Elasticsearch instance in order to pass. You should run +Elasticsearch as follows: + +[source,sh] +--------------------- +bin/elasticsearch --script.inline true --node.testattr test --path.repo /tmp --repositories.url.allowed_urls 'http://snapshot.*' +--------------------- + +======================================= + +Test file structure +-------------------- + A YAML test file consists of: * an optional `setup` section, followed by * one or more test sections