Skip to content

[DOCS] Merges list of discovery and cluster formation settings #36909

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
Merged
merged 7 commits into from
Dec 21, 2018
Merged

[DOCS] Merges list of discovery and cluster formation settings #36909

merged 7 commits into from
Dec 21, 2018

Conversation

@lcawl
Copy link
Contributor

@lcawl lcawl commented Dec 20, 2018

Related to #34714
In particular, https://github.com/elastic/elasticsearch/pull/34714/files#r243245830

This PR compiles the lists of settings related to discovery and cluster formation in a single page.

@lcawl lcawl added >docs General docs changes v7.0.0 :Distributed Coordination/Cluster Coordination Cluster formation and cluster state publication, including cluster membership and fault detection. labels Dec 20, 2018
@elasticmachine
Copy link
Collaborator

elasticmachine commented Dec 20, 2018

Pinging @elastic/es-distributed

@lcawl lcawl requested a review from DaveCTurner December 20, 2018 20:21
@lcawl lcawl mentioned this pull request Dec 20, 2018
Merged
@lcawl lcawl changed the title [DOCS] Merges list of settings [DOCS] Merges list of discovery and cluster formation settings Dec 20, 2018
DaveCTurner
DaveCTurner reviewed Dec 21, 2018
View reviewed changes
Copy link
Contributor

@DaveCTurner DaveCTurner left a comment

Choose a reason for hiding this comment

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

Great, thanks. I left a few ideas.

docs/reference/modules/discovery/adding-removing-nodes.asciidoc Outdated
This list is limited in size by the `cluster.max_voting_config_exclusions`
setting, which defaults to `10`. See <<modules-discovery-settings>>.

Since voting configuration exclusions are persistent and limited in number, they
Copy link
Contributor

@DaveCTurner DaveCTurner Dec 21, 2018

Choose a reason for hiding this comment

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

I think it makes sense to join the previous paragraph to this one.

docs/reference/modules/discovery/bootstrapping.asciidoc Outdated
configuration file when starting up a master-eligible node. Once the cluster
has formed this setting is no longer required and is ignored. It need not be set
The initial set of master-eligible nodes is defined in the
<<modules-discovery-settings,`cluster.initial_master_nodes` setting>>. When you
Copy link
Contributor

@DaveCTurner DaveCTurner Dec 21, 2018

Choose a reason for hiding this comment

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

I think it would be friendlier to link to the "important settings" page here, i.e. <<initial_master_nodes>>.

docs/reference/modules/discovery/adding-removing-nodes.asciidoc Outdated
desirable to add or remove some master-eligible nodes to or from a cluster.

==== Adding master-eligible nodes
==== Adding nodes
Copy link
Contributor

@DaveCTurner DaveCTurner Dec 21, 2018

Choose a reason for hiding this comment

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

You're absolutely right that the words in this section apply to master-ineligible nodes too, and we can therefore remove the master-eligible in the next line as well.

However if we make this change then it becomes obvious that we are missing documentation about removing master-ineligible nodes. Perhaps this is the right place to write about that too, but that needs some thought. I would prefer not to make this change now and to follow-up later.

docs/reference/modules/discovery/adding-removing-nodes.asciidoc

During master election or when joining an existing formed cluster, a node
sends a join request to the master in order to be officially added to the
cluster. You can use the `cluster.join.timeout` setting to configure how long a
Copy link
Contributor

@DaveCTurner DaveCTurner Dec 21, 2018

Choose a reason for hiding this comment

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

Could we mention the default (30s) in this paragraph?

@lcawl
Copy link
Contributor Author

lcawl commented Dec 21, 2018

Thanks @DaveCTurner I've implemented the changes and refreshed the preview

DaveCTurner
DaveCTurner approved these changes Dec 21, 2018
View reviewed changes
Copy link
Contributor

@DaveCTurner DaveCTurner left a comment

Choose a reason for hiding this comment

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

Great, LGTM. One whitespace nit.

docs/reference/modules/discovery/adding-removing-nodes.asciidoc Outdated
sends a join request to the master in order to be officially added to the
cluster. You can use the `cluster.join.timeout` setting to configure how long a
node waits after sending a request to join a cluster. Its default value is `30s`
. See <<modules-discovery-settings>>.
Copy link
Contributor

@DaveCTurner DaveCTurner Dec 21, 2018

Choose a reason for hiding this comment

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

Nit: the period at the start of this line should be at the end of the previous.

@lcawl lcawl merged commit 33e9cf3 into elastic:master Dec 21, 2018
@lcawl lcawl deleted the zen2-settings branch December 21, 2018 19:24
jasontedor added a commit to ywelsch/elasticsearch that referenced this pull request Dec 21, 2018
@jasontedor
Merge remote-tracking branch 'elastic/master' into pr/36137
8de54b8 
* elastic/master: (539 commits)
  SQL: documentation improvements and updates (elastic#36918)
  [DOCS] Merges list of discovery and cluster formation settings (elastic#36909)
  Only compress responses if request was compressed (elastic#36867)
  Remove duplicate paragraph (elastic#36942)
  Fix URI to cluster stats endpoint on specific nodes (elastic#36784)
  Fix typo in unitTest task (elastic#36930)
  RecoveryMonitor#lastSeenAccessTime should be volatile (elastic#36781)
  [CCR] Add `ccr.auto_follow_coordinator.wait_for_timeout` setting (elastic#36714)
  Scripting: Remove deprecated params.ctx (elastic#36848)
  Refactor the REST actions to clarify what endpoints are deprecated. (elastic#36869)
  Add JDK 12 to CI rotation (elastic#36915)
  Improve error message for 6.x style realm settings (elastic#36876)
  Send clear session as routable remote request (elastic#36805)
  [DOCS] Remove redundant ILM attributes (elastic#36808)
  SQL: Fix bug regarding histograms usage in scripting (elastic#36866)
  Update index mappings when ccr restore complete (elastic#36879)
  Docs: Bump version to alpha2 after release
  Enable IPv6 URIs in reindex from remote (elastic#36874)
  Watcher: Remove unused local variable in doExecute (elastic#36655)
  [DOCS] Synchs titles of X-Pack APIs
  ...
jasontedor added a commit to jasontedor/elasticsearch that referenced this pull request Dec 21, 2018
@jasontedor
Merge branch 'master' into package-ingest-geoip-as-a-module
30d92d1 
* master: (31 commits)
  Move ingest-geoip default databases out of config (elastic#36949)
  [ILM][DOCS] add extra scenario to policy update docs (elastic#36871)
  [Painless] Add String Casting Tests (elastic#36945)
  SQL: documentation improvements and updates (elastic#36918)
  [DOCS] Merges list of discovery and cluster formation settings (elastic#36909)
  Only compress responses if request was compressed (elastic#36867)
  Remove duplicate paragraph (elastic#36942)
  Fix URI to cluster stats endpoint on specific nodes (elastic#36784)
  Fix typo in unitTest task (elastic#36930)
  RecoveryMonitor#lastSeenAccessTime should be volatile (elastic#36781)
  [CCR] Add `ccr.auto_follow_coordinator.wait_for_timeout` setting (elastic#36714)
  Scripting: Remove deprecated params.ctx (elastic#36848)
  Refactor the REST actions to clarify what endpoints are deprecated. (elastic#36869)
  Add JDK 12 to CI rotation (elastic#36915)
  Improve error message for 6.x style realm settings (elastic#36876)
  Send clear session as routable remote request (elastic#36805)
  [DOCS] Remove redundant ILM attributes (elastic#36808)
  SQL: Fix bug regarding histograms usage in scripting (elastic#36866)
  Update index mappings when ccr restore complete (elastic#36879)
  Docs: Bump version to alpha2 after release
  ...
@ywelsch ywelsch mentioned this pull request Dec 22, 2018
Closed
61 tasks
@jimczi jimczi added v7.0.0-beta1 and removed v7.0.0 labels Feb 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@DaveCTurner DaveCTurner DaveCTurner approved these changes

Assignees

No one assigned

Labels

:Distributed Coordination/Cluster Coordination Cluster formation and cluster state publication, including cluster membership and fault detection. >docs General docs changes v7.0.0-beta1

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@lcawl @elasticmachine @DaveCTurner @jimczi