From f978974bc656e883814d9d97bc11314cf082b9fa Mon Sep 17 00:00:00 2001 From: Ryan Ernst Date: Tue, 1 Aug 2017 19:13:45 -0400 Subject: [PATCH] Docs: Remove s3 repository integ test documentation (#26005) The s3 repository plugin has "third party" integ tests which rely on external service and configuration setup. These tests are really internal verification of the plugin (and should be moved to real integ tests). Running them is not something a user should do, and the documentation has been out of date for all of 5.x. This commit removes the docs, removing potential confusion for users. --- docs/plugins/repository-s3.asciidoc | 45 ----------------------------- 1 file changed, 45 deletions(-) diff --git a/docs/plugins/repository-s3.asciidoc b/docs/plugins/repository-s3.asciidoc index a0fe757ab40..9041ef2de96 100644 --- a/docs/plugins/repository-s3.asciidoc +++ b/docs/plugins/repository-s3.asciidoc @@ -375,48 +375,3 @@ See <> for details. AWS instances resolve S3 endpoints to a public IP. If the elasticsearch instances reside in a private subnet in an AWS VPC then all traffic to S3 will go through that VPC's NAT instance. If your VPC's NAT instance is a smaller instance size (e.g. a t1.micro) or is handling a high volume of network traffic your bandwidth to S3 may be limited by that NAT instance's networking bandwidth limitations. Instances residing in a public subnet in an AWS VPC will connect to S3 via the VPC's internet gateway and not be bandwidth limited by the VPC's NAT instance. - -[[repository-s3-testing]] -==== Testing AWS - -Integrations tests in this plugin require working AWS configuration and therefore disabled by default. Three buckets -and two iam users have to be created. The first iam user needs access to two buckets in different regions and the final -bucket is exclusive for the other iam user. To enable tests prepare a config file elasticsearch.yml with the following -content: - -[source,yaml] ----- -cloud: - aws: - access_key: AKVAIQBF2RECL7FJWGJQ - secret_key: vExyMThREXeRMm/b/LRzEB8jWwvzQeXgjqMX+6br - -repositories: - s3: - bucket: "bucket_name" - region: "us-west-2" - private-bucket: - bucket: - access_key: - secret_key: - remote-bucket: - bucket: - region: - external-bucket: - bucket: - access_key: - secret_key: - endpoint: - protocol: - ----- - -Replace all occurrences of `access_key`, `secret_key`, `endpoint`, `protocol`, `bucket` and `region` with your settings. -Please, note that the test will delete all snapshot/restore related files in the specified buckets. - -To run test: - -[source,sh] ----- -mvn -Dtests.aws=true -Dtests.config=/path/to/config/file/elasticsearch.yml clean test -----