Skip to content

Commit

Permalink
Merge pull request #422 from untergeek/repo_validation_docs
Browse files Browse the repository at this point in the history
Somehow I forgot to add this into the docs
  • Loading branch information
untergeek committed Jun 26, 2015
2 parents 04dbfe6 + 272b325 commit edf9071
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/asciidoc/commands/snapshot.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Options:
--partial Do not fail if primary shard is unavailable.
--request_timeout INTEGER Allow this many seconds before the
transaction times out. [default: 21600]
--skip-repo-validation Skip repository access validation.
--help Show this message and exit.
Commands:
Expand Down
5 changes: 5 additions & 0 deletions docs/asciidoc/flags/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ _Snapshot selection only_
* <<snapshot_flag,--snapshot>>
* <<all-snapshots,--all-snapshots>>
* <<repository,--repository>>

_Command flags_

* <<skip-repo-validation,--skip-repo-validation>>
--

include::debug.asciidoc[]
Expand Down Expand Up @@ -68,3 +72,4 @@ include::all-indices.asciidoc[]
include::snapshot_flag.asciidoc[]
include::all-snapshots.asciidoc[]
include::repository.asciidoc[]
include::skip-repo-validation.asciidoc[]
37 changes: 37 additions & 0 deletions docs/asciidoc/flags/skip-repo-validation.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
[[skip-repo-validation]]
== --skip-repo-validation

[float]
Summary
~~~~~~~

New feature added in Curator 3.2.0

IMPORTANT: This flag only functions within the scope of the <<snapshot>> command.

Skip {ref}/modules-snapshots.html#_repository_verification[repository access validation].
This is useful in cases where your shared filesystem (local or remote) is
functional but slow enough to respond that Elasticsearch yields a false-positive
test result. This condition is also usually intermittent, rather than constant.

WARNING: Repository validation is performed in order to ensure your snapshots
will all be able to write to the repository. It is recommended that you let
Curator perform this valuable check each time a snapshot is created unless you
are experiencing the intermittent timeouts described.

[float]
Flags
~~~~~

* `--skip-repo-validation` Skip repository access validation.

[float]
Examples
~~~~~~~~

Snapshot indices matching the selection parameters to the named repository,
skipping repository validation:

----------------------------------------------------------------------------------------------------------
curator snapshot --skip-repo-validation --repository REPOSITORY_NAME indices <<index selection paramters>>
----------------------------------------------------------------------------------------------------------

0 comments on commit edf9071

Please sign in to comment.