Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs fixes post 7.3 FF
Browse files Browse the repository at this point in the history
DaveCTurner committed Jul 4, 2019
1 parent c13bf0c commit f76a14e
Showing 2 changed files with 22 additions and 16 deletions.
19 changes: 11 additions & 8 deletions docs/plugins/repository-s3.asciidoc
Original file line number Diff line number Diff line change
@@ -147,14 +147,17 @@ settings belong in the `elasticsearch.yml` file.

`path_style_access`::

Whether to force the use of the path style access pattern. If `true`, the path style access pattern will be used.
If left to`false`, path style access will be automatically determined by the AWS Java SDK
(See https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/s3/AmazonS3Builder.html#setPathStyleAccessEnabled-java.lang.Boolean-[AWS documentation] for details).
Defaults to `false`.

NOTE: In versions `7.0`, 7.1`, and `7.2`, all bucket operations were using the path style access pattern in every situation without an option to
disable it. If your deployment requires path style access to be used you might need to manually configure this setting to `true` when
upgrading.
Whether to force the use of the path style access pattern. If `true`, the
path style access pattern will be used. If `false`, path style access will be
automatically determined by the AWS Java SDK (See
https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/s3/AmazonS3Builder.html#setPathStyleAccessEnabled-java.lang.Boolean-[AWS
documentation] for details). Defaults to `false`.

[[repository-s3-path-style-deprecation]]
NOTE: In versions `7.0`, `7.1`, `7.2` and `7.3` all bucket operations used the
https://aws.amazon.com/blogs/aws/amazon-s3-path-deprecation-plan-the-rest-of-the-story/[now-deprecated]
path style access pattern. If your deployment requires the path style access
pattern then you should set this setting to `true` when upgrading.

[float]
[[repository-s3-compatible-services]]
19 changes: 11 additions & 8 deletions docs/reference/migration/migrate_8_0/snapshots.asciidoc
Original file line number Diff line number Diff line change
@@ -32,11 +32,14 @@ For more information on the compress option, see <<modules-snapshots>>
[float]
==== The S3 repository plugin uses the DNS style access pattern by default

Starting in version 7.3 using the path style access pattern with the S3 repository is not enabled by default.
In versions 7.0, 7.1, and 7.2 the S3 repository plugin was exclusively using the path style access pattern. This is a breaking
change for deployments that do not also allow for the DNS style but are recognized as supporting DNS style access by the AWS SDK.
If your deployment does only support path style access and is affected by this change you must configure the S3 client setting
`path_style_access` to `true` to return to the behaviour of always using path style access.
This breaking change was made necessary by
https://aws.amazon.com/blogs/aws/amazon-s3-path-deprecation-plan-the-rest-of-the-story[AWS's announcement] to no longer support
the path-style API past September 30th, 2020 for newly created buckets.
Starting in version 7.4 the `repository-s3` plugin does not use the
now-deprecated path-style access pattern by default. In versions 7.0, 7.1, 7.2
and 7.3 the `repository-s3` plugin always used the path-style access pattern.
This is a breaking change for deployments that only support path-style access
but which are recognized as supporting DNS-style access by the AWS SDK. If your
deployment only supports path-style access and is affected by this change then
you must configure the S3 client setting `path_style_access` to `true`. This
breaking change was made necessary by
https://aws.amazon.com/blogs/aws/amazon-s3-path-deprecation-plan-the-rest-of-the-story/[AWS's
announcement] that the path-style access pattern is deprecated and will be
unsupported on buckets created after September 30th 2020.

0 comments on commit f76a14e

Please sign in to comment.