Skip to content
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

[DOC] inconsistency with my_backup examples #30444

Closed
LeeDr opened this issue May 7, 2018 · 2 comments · Fixed by #30480
Closed

[DOC] inconsistency with my_backup examples #30444

LeeDr opened this issue May 7, 2018 · 2 comments · Fixed by #30480
Assignees
Labels
>bug :Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs >docs General docs changes

Comments

@LeeDr
Copy link

LeeDr commented May 7, 2018

Elasticsearch version (bin/elasticsearch --version): Docs issue with
https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html

Description of the problem including expected versus actual behavior:

The Repositories section includes a few examples referencing my_backup like
PUT /_snapshot/my_backup
and
GET /_snapshot/my_backup

But in the Shared File System Repository section it keeps referring to my_backup in the text but isn't using that in the examples so it makes it rather confusing;

"... This location (or one of its parent directories) must be registered in the path.repo setting on all master and data nodes.
Assuming that the shared filesystem is mounted to /mount/backups/my_backup, the following setting should be added to elasticsearch.yml file:"

path.repo: ["/mount/backups", "/mount/longterm_backups"]

And again here. It looks like maybe my_backup was changed to my_fs_backup but I don't know snapshots very well so I could me misinterpreting it.

"After all nodes are restarted, the following command can be used to register the shared file system repository with the name my_backup:"

PUT /_snapshot/my_fs_backup
{

And then a few more examples alternate between my_backup and my_fs_backup;

GET /_snapshot/my_backup/_current
DELETE /_snapshot/my_backup/snapshot_2
DELETE /_snapshot/my_fs_backup
POST /_snapshot/my_backup/snapshot_1/_restore

@LeeDr LeeDr added >bug >docs General docs changes labels May 7, 2018
@colings86 colings86 added the :Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs label May 8, 2018
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-distributed

@tlrx
Copy link
Member

tlrx commented May 9, 2018

Thanks @LeeDr, I created #30480

@tlrx tlrx self-assigned this May 9, 2018
tlrx added a commit to tlrx/elasticsearch that referenced this issue May 17, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>bug :Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs >docs General docs changes
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants