Skip to content

[Docs] Clarify Shared file system repository location setting #97339

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
a03nikki opened this issue Jul 3, 2023 · 3 comments · Fixed by #108267
Closed

[Docs] Clarify Shared file system repository location setting #97339

a03nikki opened this issue Jul 3, 2023 · 3 comments · Fixed by #108267
Assignees
Labels
:Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs >docs General docs changes >enhancement Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. Team:Docs Meta label for docs team

Comments

@a03nikki
Copy link
Contributor

a03nikki commented Jul 3, 2023

Description

The documentation could be more explicit that the location value is expected to be a single file path, not an array of values.

This has caused user confusion because path.repo is an array of path values but settings.location in a single path value.

location
(Required, string) Location of the shared filesystem used to store and retrieve snapshots. This location must be registered in the path.repo setting on all master and data nodes in the cluster.

Documentation for version 8.8 accessed July 3rd, 2023 from https://www.elastic.co/guide/en/elasticsearch/reference/8.8/snapshots-filesystem-repository.html#snapshots-filesystem-repository.

If one attempts to provide an array of values, it turns into a string used for a new directory created in the first entry of the path.repo value as it is treated as a relative path value.

@a03nikki a03nikki added >enhancement >docs General docs changes :Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs needs:triage Requires assignment of a team area label labels Jul 3, 2023
@elasticsearchmachine elasticsearchmachine added Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. Team:Docs Meta label for docs team labels Jul 3, 2023
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticsearchmachine elasticsearchmachine removed the needs:triage Requires assignment of a team area label label Jul 3, 2023
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-distributed (Team:Distributed)

@DaveCTurner
Copy link
Contributor

It's a bug that we accept a list here, specifically #33135. Really we should fix this bug, or else we will end up needing to document our way around it for every Setting<String>.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs >docs General docs changes >enhancement Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. Team:Docs Meta label for docs team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants