Skip to content

Commit

Permalink
Add note about base_path and ECE to the snapshot repository docs (ela…
Browse files Browse the repository at this point in the history
…stic#83526) (elastic#83537)

Elastic Cloud Enterprise (ECE) shares snapshot repositories across multiple deployments. As a result, the `base_path` is generated by ECE, and the `base_path` setting is not allowed.  This PR adds a note to the S3, Azure, and GCS snapshot repository docs.

(cherry picked from commit 302ce75)

Co-authored-by: Dan Roscigno <dan@roscigno.com>
  • Loading branch information
jrodewig and DanRoscigno authored Feb 4, 2022
1 parent bca01b0 commit 4061be3
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/reference/snapshot-restore/repository-azure.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,10 @@ The Azure repository supports following settings:

Specifies the path within container to repository data. Defaults to empty
(root directory).
+
NOTE: Don't set `base_path` when configuring a snapshot repository for {ECE}.
{ECE} automatically generates the `base_path` for each deployment so that
multiple deployments may share the same bucket.

`chunk_size`::

Expand Down
4 changes: 4 additions & 0 deletions docs/reference/snapshot-restore/repository-gcs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,10 @@ The following settings are supported:

Specifies the path within bucket to repository data. Defaults to
the root of the bucket.
+
NOTE: Don't set `base_path` when configuring a snapshot repository for {ECE}.
{ECE} automatically generates the `base_path` for each deployment so that
multiple deployments may share the same bucket.

`chunk_size`::

Expand Down
4 changes: 4 additions & 0 deletions docs/reference/snapshot-restore/repository-s3.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,10 @@ bucket naming rules].
Specifies the path to the repository data within its bucket. Defaults to an
empty string, meaning that the repository is at the root of the bucket. The
value of this setting should not start or end with a `/`.
+
NOTE: Don't set `base_path` when configuring a snapshot repository for {ECE}.
{ECE} automatically generates the `base_path` for each deployment so that
multiple deployments may share the same bucket.

`chunk_size`::

Expand Down

0 comments on commit 4061be3

Please sign in to comment.