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.

Sign up for GitHub

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

Jump to bottom

[DOCS] Document common settings for snapshot repository plugins #40475

Merged
merged 3 commits into from
Mar 28, 2019
Merged

[DOCS] Document common settings for snapshot repository plugins #40475

merged 3 commits into from
Mar 28, 2019

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Mar 26, 2019 •
edited
Loading

Adds documentation for the max_snapshot_bytes_per_sec, max_restore_bytes_per_sec, and readonly settings to the following plugins:

Reuses definitions from the Snapshot and Restore docs.

Closes #25522

@jrodewig jrodewig added the :Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs label Mar 26, 2019
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-distributed

@ywelsch
Copy link
Contributor

ywelsch commented Mar 27, 2019

Instead of copying definitions across the docs, could we perhaps link to a section on common repository settings? The same settings mentioned here can also be used for GCS, Azure and other repository types.

The settings that are common to all repositories are readonly, max_snapshot_bytes_per_sec and max_restore_bytes_per_sec.

@jrodewig
Copy link
Contributor Author

@ywelsch Thanks for your feedback.

Rather than use a link, I set up a partial file that's then included in the settings documentation for each plugin. That should allow us to reuse the content from a single source without making users click another link.

Related changes are in f22f38b.

@jrodewig jrodewig changed the title [DOCS] Document max bytes per sec settings for S3 repositories [DOCS] Document common settings for snapshot repository plugins Mar 27, 2019
ywelsch
ywelsch approved these changes Mar 28, 2019
View reviewed changes
Copy link
Contributor

@ywelsch ywelsch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jrodewig jrodewig merged commit a58a829 into elastic:master Mar 28, 2019
@jrodewig jrodewig deleted the doc-max-byte-settings-s3 branch March 28, 2019 18:39
This was referenced Mar 28, 2019
Merged
Merged
Merged
jrodewig added a commit that referenced this pull request Mar 28, 2019
@jrodewig
[DOCS] Document common settings for snapshot repository plugins (#40475…
0ea67aa 
…) (#40607)
jrodewig added a commit that referenced this pull request Mar 28, 2019
@jrodewig
[DOCS] Document common settings for snapshot repository plugins (#40475…
6f26156 
…) (#40606)
jrodewig added a commit that referenced this pull request Mar 28, 2019
@jrodewig
[DOCS] Document common settings for snapshot repository plugins (#40475…
fc9eaaa 
…) (#40608)
jasontedor added a commit to rjernst/elasticsearch that referenced this pull request Mar 28, 2019
@jasontedor
Merge branch 'master' into pr/40576
828ac34 
* master: (25 commits)
  [DOCS] Correct keystore commands for Email and Jira actions in Watcher (elastic#40417)
  [DOCS] Document common settings for snapshot repository plugins (elastic#40475)
  Remove with(out)-system-key tests (elastic#40547)
  Geo Point parse error fix (elastic#40447)
  Handle null retention leases in WaitForNoFollowersStep (elastic#40477)
  [DOCS] Adds anchors for ruby client (elastic#39867)
  Mute DataFrameAuditorIT#testAuditorWritesAudits
  Disable integTest when Docker is not available (elastic#40585)
  Add randomScore function in script_score query (elastic#40186)
  Test fixtures krb5 (elastic#40297)
  Correct ILM metadata minimum compatibility version (elastic#40569)
  SQL: Centralize SQL test dependencies version handling (elastic#40551)
  Mute testTracerLog
  Mute testHttpInput
  Include functions' aliases in the list of functions (elastic#40584)
  Optimise rejection of out-of-range `long` values (elastic#40325)
  Add docs for cluster.remote.*.proxy setting (elastic#40281)
  Migrate systemd packaging tests from bats to java (elastic#39954)
  Move top-level pipeline aggs out of QuerySearchResult (elastic#40319)
  Use openjdk 12 in packer cache script (elastic#40498)
  ...
jasontedor added a commit to jasontedor/elasticsearch that referenced this pull request Mar 29, 2019
@jasontedor
Merge remote-tracking branch 'elastic/master' into bundled-usage
1694311 
* elastic/master: (77 commits)
  Update ingest jdocs that a null return value will drop the current document. (elastic#40359)
  Remove -Xlint exclusions in the ingest-common module. (elastic#40505)
  Update docs for the DFR similarity (elastic#40579)
  Fix merging of search_as_you_type field mapper (elastic#40593)
  Support roles with application privileges against wildcard applications (elastic#40398)
  Remove obsolete security settings (elastic#40496)
  Remove Gradle deprecation warnings (elastic#40449)
  Run the build integ test in parallel (elastic#39788)
  Fix 3rd pary S3 tests (elastic#40588)
  lower bwc skip for search as you type (elastic#40599)
  Muting XContentParserTests#testSubParserArray
  Fixing typo in test error message (elastic#40611)
  Update max dims for vectors to 1024. (elastic#40597)
  Add start and stop time to cat recovery API (elastic#40378)
  [DOCS] Correct keystore commands for Email and Jira actions in Watcher (elastic#40417)
  [DOCS] Document common settings for snapshot repository plugins (elastic#40475)
  Remove with(out)-system-key tests (elastic#40547)
  Geo Point parse error fix (elastic#40447)
  Handle null retention leases in WaitForNoFollowersStep (elastic#40477)
  [DOCS] Adds anchors for ruby client (elastic#39867)
  ...
jasontedor added a commit to jasontedor/elasticsearch that referenced this pull request Mar 29, 2019
@jasontedor
Merge remote-tracking branch 'elastic/master' into cat-recovery-bytes
f999a77 
* elastic/master: (129 commits)
  Update ingest jdocs that a null return value will drop the current document. (elastic#40359)
  Remove -Xlint exclusions in the ingest-common module. (elastic#40505)
  Update docs for the DFR similarity (elastic#40579)
  Fix merging of search_as_you_type field mapper (elastic#40593)
  Support roles with application privileges against wildcard applications (elastic#40398)
  Remove obsolete security settings (elastic#40496)
  Remove Gradle deprecation warnings (elastic#40449)
  Run the build integ test in parallel (elastic#39788)
  Fix 3rd pary S3 tests (elastic#40588)
  lower bwc skip for search as you type (elastic#40599)
  Muting XContentParserTests#testSubParserArray
  Fixing typo in test error message (elastic#40611)
  Update max dims for vectors to 1024. (elastic#40597)
  Add start and stop time to cat recovery API (elastic#40378)
  [DOCS] Correct keystore commands for Email and Jira actions in Watcher (elastic#40417)
  [DOCS] Document common settings for snapshot repository plugins (elastic#40475)
  Remove with(out)-system-key tests (elastic#40547)
  Geo Point parse error fix (elastic#40447)
  Handle null retention leases in WaitForNoFollowersStep (elastic#40477)
  [DOCS] Adds anchors for ruby client (elastic#39867)
  ...
jasontedor added a commit to jasontedor/elasticsearch that referenced this pull request Mar 29, 2019
@jasontedor
Merge remote-tracking branch 'elastic/7.0' into notable-highlights-7.0
9fa73db 
* elastic/7.0: (50 commits)
  Fix more broken links in plugins docs
  Fix archives links in plugins docs
  Disable integTest when Docker is not available (elastic#40585)
  Add docs for bundled jdk (elastic#40487)
  [DOCS] Correct keystore commands for Email and Jira actions in Watcher (elastic#40417) (elastic#40613)
  Add usage indicators for the bundled JDK (elastic#40616)
  Add ability to mute and mute flaky fixture (elastic#40630)
  Test fixtures krb5 (elastic#40297)
  Update docs for the DFR similarity (elastic#40579)
  Update ingest jdocs that a null return value will drop the current document. (elastic#40359)
  [DOCS] Document common settings for snapshot repository plugins (elastic#40475) (elastic#40607)
  [DOCS] Fixes formatting in breaking changes
  Handle null retention leases in WaitForNoFollowersStep (elastic#40477)
  Correct ILM metadata minimum compatibility version (elastic#40569)
  Mute SpecificMasterNodesIT.testElectOnlyBetweenMasterNodes()
  Mute testHttpInput
  Include functions' aliases in the list of functions (elastic#40584)
  Optimise rejection of out-of-range `long` values (elastic#40325)
  Add docs for cluster.remote.*.proxy setting (elastic#40281)
  Mute WatchAckTests.testAckAllActions
  ...
@jakelandis jakelandis removed the v7.0.0 label Apr 3, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ywelsch ywelsch ywelsch approved these changes

@debadair debadair Awaiting requested review from debadair

@n0othing n0othing Awaiting requested review from n0othing

@kat257 kat257 Awaiting requested review from kat257

Assignees
No one assigned
Labels
:Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs >docs General docs changes v7.0.0-rc2 v7.2.0 v8.0.0-alpha1
Projects
None yet
Milestone
No milestone
4 participants
@jrodewig @elasticmachine @ywelsch @jakelandis