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

Reinstate missing documentation #28781

Conversation

DaveCTurner
Copy link
Contributor

The setting index.routing.allocation.enable was documented in v1.7 but lost in the refactoring in f123a53 so has been undocumented since 2.0.

It might also be worth checking if any other settings were lost in the same change. I have not done so yet.

/cc @elastic/es-distributed.

@DaveCTurner DaveCTurner added >bug >docs General docs changes :Distributed Coordination/Allocation All issues relating to the decision making around placing a shard (both master logic & on the nodes) labels Feb 22, 2018
@DaveCTurner DaveCTurner self-assigned this Feb 22, 2018
@DaveCTurner
Copy link
Contributor Author

DaveCTurner commented Mar 15, 2018

The following settings appear on lines removed in f123a53 and not in the docs/ folder of master:

index.cache.filter.expire
index.cache.filter.max_size
index.gateway.snapshot_interval
index.gc_deletes
index.recovery.initial_shards
index.routing.allocation.disable_allocation
index.routing.allocation.disable_new_allocation
index.routing.allocation.disable_replica_allocation
index.routing.allocation.enable
index.routing.rebalance.enable
index.translog.disable_flush
index.translog.flush_threshold_ops
index.translog.flush_threshold_period
index.translog.fs.type
index.ttl.disable_purge
index.warmer.enabled
indices.cache.filter.size
indices.recovery.compress
indices.recovery.concurrent_small_file_streams
indices.recovery.concurrent_streams
indices.recovery.file_chunk_size
indices.recovery.translog_ops
indices.recovery.translog_size
indices.ttl.interval

Of these, the following still seem to be valid settings:

index.gc_deletes
index.routing.allocation.enable
index.routing.rebalance.enable
index.ttl.disable_purge
index.warmer.enabled

The following do not seem to be valid settings, but are still mentioned in a test:

indices.recovery.concurrent_streams
indices.recovery.concurrent_small_file_streams

Settings settings = Settings.builder().put("indices.recovery.concurrent_streams", 1).
put("indices.recovery.concurrent_small_file_streams", 1).build();

DaveCTurner added a commit to DaveCTurner/elasticsearch that referenced this pull request Mar 15, 2018
The settings `indices.recovery.concurrent_streams` and
`indices.recovery.concurrent_small_file_streams` were removed in
f5e4cd4. This commit removes their last traces
from the codebase.

Relates elastic#28781
@DaveCTurner
Copy link
Contributor Author

@Sue-Gallagher @debadair I'm happy to try and resurrect these lost docs, but I'm not sure where in the docs tree they should go, as things seem to have moved around quite a lot since 1.7. Your guidance would be appreciated.

@debadair
Copy link
Contributor

It looks like the missing settings should be added to https://www.elastic.co/guide/en/elasticsearch/reference/6.2/index-modules.html#index-modules-settings.

If you want to open a PR for that, that would be most awesome.

The documentation for settings index.routing.allocation.enable,
index.routing.rebalance.enable and index.gc_deletes was lost in a previous
refactoring. This change reinstates it.
@DaveCTurner DaveCTurner changed the title Undocumented index routing settings Reinstate missing documentation Apr 16, 2018
@DaveCTurner
Copy link
Contributor Author

I reinstated docs for index.gc_deletes, index.routing.allocation.enable and index.routing.rebalance.enable here.

Setting index.ttl.disable_purge is unused so I opened #29526 and #29527 to remove it.

Setting index.warmer.enabled requires knowledge that I do not have so I opened #29529 about this one.

@ywelsch ywelsch self-requested a review April 17, 2018 15:58
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

@DaveCTurner DaveCTurner merged commit 05ef601 into elastic:master Apr 26, 2018
DaveCTurner added a commit that referenced this pull request Apr 26, 2018
The documentation for settings index.routing.allocation.enable,
index.routing.rebalance.enable and index.gc_deletes was lost in
f123a53. This change reinstates it.
DaveCTurner added a commit that referenced this pull request Apr 26, 2018
The documentation for settings index.routing.allocation.enable,
index.routing.rebalance.enable and index.gc_deletes was lost in
f123a53. This change reinstates it.
DaveCTurner added a commit that referenced this pull request Apr 26, 2018
The documentation for settings index.routing.allocation.enable,
index.routing.rebalance.enable and index.gc_deletes was lost in
f123a53. This change reinstates it.
DaveCTurner added a commit that referenced this pull request Apr 26, 2018
The documentation for settings index.routing.allocation.enable,
index.routing.rebalance.enable and index.gc_deletes was lost in
f123a53. This change reinstates it.
DaveCTurner added a commit that referenced this pull request Apr 26, 2018
The documentation for settings index.routing.allocation.enable,
index.routing.rebalance.enable and index.gc_deletes was lost in
f123a53. This change reinstates it.
dnhatn added a commit that referenced this pull request Apr 27, 2018
* 6.x:
  Watcher: Ensure mail message ids are unique per watch action (#30112)
  SQL: Correct error message (#30138)
  SQL: Add BinaryMathProcessor to named writeables list (#30127)
  Tests: Use buildDir as base for generated-resources (#30191)
  Fix SliceBuilderTests#testRandom failures
  Fix edge cases in CompositeKeyExtractorTests (#30175)
  Document time unit limitations for date histograms (#30177)
  Remove licenses missed by the migration
  [DOCS] Updates docker installation package details (#30110)
  Fix TermsSetQueryBuilder.doEquals() method (#29629)
  [Monitoring] Remove unhelpful Monitoring tests (#30144)
  [Test] Fix RenameProcessorTests.testRenameExistingFieldNullValue() (#29655)
  [test] include oss tar in packaging tests (#30155)
  TEST: Update settings should go through cluster state (#29682)
  Add additional shards routing info in ShardSearchRequest (#29533)
  Reinstate missing documentation (#28781)
  Clarify documentation of scroll_id (#29424)
  Fixes Eclipse build for sql jdbc project (#30114)
  Watcher: Fold two smoke test projects into smoke-test-watcher (#30137)
@DaveCTurner DaveCTurner deleted the 2018-04-14-issue-28781-missing-settings branch July 23, 2022 10:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>bug :Distributed Coordination/Allocation All issues relating to the decision making around placing a shard (both master logic & on the nodes) >docs General docs changes v6.0.3 v6.1.5 v6.2.5 v6.3.0 v6.4.0 v7.0.0-beta1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants