[DOCS] Add supported ESS settings to ES docs #57953

lockewritesdocs · 2020-06-10T21:33:53Z

This PR includes the following changes:

Adds an ESS icon to supported settings in the ES docs.
Defines ES settings supported by ESS that were previously mentioned but not defined.

7.x backport #57953
7.8 backport #57953

Closes #57486

lockewritesdocs · 2020-06-12T20:23:08Z

@elasticmachine update branch

elasticmachine · 2020-06-12T20:23:10Z

merge conflict between base and head

elasticmachine · 2020-06-24T12:34:25Z

Pinging @elastic/es-docs (>docs)

docs/reference/docs/reindex.asciidoc

gtback

LGTM, but I'd want to make sure another ES writer gave this a 👍 too.

gtback · 2020-06-26T20:01:28Z

docs/reference/warehouse/wh_cloud.asciidoc

@@ -0,0 +1,46 @@
+== Cloud warehouse


Do we still want to keep this file?

@gtback, I intended to keep this file because these settings were not surfaced anywhere specifically in the ES Reference.

This are not cloud-specific settings, so for maintenance purposes I'd prefer to add them to the appropriate settings/modules files and use anchors that do not reference cloud.

@debadair, I moved those settings into a new Index management settings page to house some of these orphan settings that didn't fit well into existing categories. The page is somewhat of a miscellaneous index bucket, but I didn't want to bury these settings or shoehorn them into pages where they don't fit.

Another consideration is adding them to the ILM settings page as Miscellaneous index settings (like in the Cluster-level settings page.

I think having them on a separate page is the right call--they aren't really related to ILM, they are more akin to the cluster-level settings. (In fact, the one is a cluster setting.) Since they affect how you work with indices, though, grouping them under Index management seems reasonable.

debadair

Left some suggestions. In particular, I don't think we should label the missing settings with the cloud prefix, as they are not specific to cloud. Rather than adding a cloud warehouse file, I'd embed them in the relevant existing settings files.

docs/reference/docs/reindex.asciidoc

docs/reference/modules/http.asciidoc

debadair · 2020-06-26T22:53:52Z

docs/reference/warehouse/wh_cloud.asciidoc

@@ -0,0 +1,46 @@
+== Cloud warehouse


This are not cloud-specific settings, so for maintenance purposes I'd prefer to add them to the appropriate settings/modules files and use anchors that do not reference cloud.

docs/reference/warehouse/wh_cloud.asciidoc

* Adding ESS icons to supported ES settings. * Adding new file for supported ESS settings. * Adding supported ESS settings for HTTP and disk-based shard allocation. * Adding more supported settings for ESS. * Adding descriptions for each Cloud section, plus additional settings. * Adding new warehouse file for Cloud, plus additional settings. * Adding node settings for Cloud. * Adding audit settings for Cloud. * Resolving merge conflict. * Adding SAML settings (part 1). * Adding SAML realm encryption and signing settings. * Adding SAML SSL settings. * Adding Kerberos realm settings. * Adding OpenID Connect Realm settings. * Adding OpenID Connect SSL settings. * Resolving leftover Git merge markers. * Removing Cloud settings page and link to it. * Add link to mapping source * Update docs/reference/docs/reindex.asciidoc * Incorporate edit of HTTP settings * Remove "cloud" from tag and ID * Remove "cloud" from tag and update description * Remove "cloud" from tag and ID * Change "whitelists" to "specifies" * Remove "cloud" from end tag * Removing cloud from IDs and tags. * Changing link reference to fix build issue. * Adding index management page for missing settings. * Removing warehouse file for Cloud and moving settings elsewhere. * Clarifying true/false usage of http.detailed_errors.enabled. * Changing underscore to dash in link to fix ci build.

#57953 introduced changes that added ESS icons to many Elasticsearch settings. As part of those changes, the default value for `cluster.indices.close.enable` was indicated as `false`, when it should be `true`. This PR updates the default value to `true`. Closes #78877

* [DOCS] Fix default value for closed indices #57953 introduced changes that added ESS icons to many Elasticsearch settings. As part of those changes, the default value for `cluster.indices.close.enable` was indicated as `false`, when it should be `true`. This PR updates the default value to `true`. Closes #78877 * Update description * Update note to remove outdated claims

* [DOCS] Fix default value for closed indices elastic#57953 introduced changes that added ESS icons to many Elasticsearch settings. As part of those changes, the default value for `cluster.indices.close.enable` was indicated as `false`, when it should be `true`. This PR updates the default value to `true`. Closes elastic#78877 * Update description * Update note to remove outdated claims

* [DOCS] Fix default value for closed indices #57953 introduced changes that added ESS icons to many Elasticsearch settings. As part of those changes, the default value for `cluster.indices.close.enable` was indicated as `false`, when it should be `true`. This PR updates the default value to `true`. Closes #78877 * Update description * Update note to remove outdated claims

Adam Locke added 5 commits June 8, 2020 17:06

Adding ESS icons to supported ES settings.

e618f56

Adding new file for supported ESS settings.

a51aeff

Adding supported ESS settings for HTTP and disk-based shard allocation.

5c341a4

Adding more supported settings for ESS.

0fe6c20

Adding descriptions for each Cloud section, plus additional settings.

d3a31bb

lockewritesdocs self-assigned this Jun 10, 2020

Adam Locke added 3 commits June 11, 2020 17:35

Adding new warehouse file for Cloud, plus additional settings.

a9acebe

Adding node settings for Cloud.

ca25a8a

Adding audit settings for Cloud.

d228d5f

Adam Locke added 8 commits June 12, 2020 16:47

Merge branch 'master' into docs__add-ess-icon-support

9b35c5e

Resolving merge conflict.

735a092

Adding SAML settings (part 1).

a74b072

Adding SAML realm encryption and signing settings.

b40d8c1

Adding SAML SSL settings.

ef0a1f7

Adding Kerberos realm settings.

87dfb98

Adding OpenID Connect Realm settings.

5758c7d

Adding OpenID Connect SSL settings.

6043cbd

lockewritesdocs marked this pull request as ready for review June 24, 2020 12:33

lockewritesdocs requested a review from debadair June 24, 2020 12:34

lockewritesdocs added the >docs General docs changes label Jun 24, 2020

elasticmachine added the Team:Docs Meta label for docs team label Jun 24, 2020

gtback requested changes Jun 24, 2020

View reviewed changes

docs/reference/docs/reindex.asciidoc Outdated Show resolved Hide resolved

Adam Locke added 2 commits June 24, 2020 10:48

Resolving leftover Git merge markers.

6c66d47

Removing Cloud settings page and link to it.

07b4acc

lockewritesdocs requested a review from gtback June 26, 2020 18:13

gtback approved these changes Jun 26, 2020

View reviewed changes

debadair reviewed Jun 26, 2020

View reviewed changes

lockewritesdocs merged commit 3a1258f into elastic:master Jul 2, 2020

lockewritesdocs deleted the docs__add-ess-icon-support branch July 2, 2020 18:13

lockewritesdocs mentioned this pull request Jul 2, 2020

[7.x] [DOCS] Add supported ESS settings to ES docs (#57953) #58981

Merged

lockewritesdocs mentioned this pull request Jul 2, 2020

[7.8] [DOCS] Add supported ESS settings to ES docs (#57953) #58982

Merged

jrodewig mentioned this pull request Sep 15, 2020

[DOCS] Remove redundant index.blocks.read_only_allow_delete setting #62392

Merged

jrodewig mentioned this pull request Oct 8, 2021

[DOCS] cluster.indices.close.enable default is incorrect #78877

Closed

lockewritesdocs mentioned this pull request Oct 11, 2021

[DOCS] Fix default value for closed indices #78924

Merged

henningandersen mentioned this pull request Jul 26, 2022

Introduce max headroom for disk watermark stages #88639

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DOCS] Add supported ESS settings to ES docs #57953

[DOCS] Add supported ESS settings to ES docs #57953

lockewritesdocs commented Jun 10, 2020 •

edited

Loading

lockewritesdocs commented Jun 12, 2020

elasticmachine commented Jun 12, 2020

elasticmachine commented Jun 24, 2020

gtback left a comment

gtback Jun 26, 2020

lockewritesdocs Jun 26, 2020

debadair Jun 26, 2020

lockewritesdocs Jun 30, 2020 •

edited

Loading

debadair Jul 2, 2020

debadair left a comment

debadair Jun 26, 2020

[DOCS] Add supported ESS settings to ES docs #57953

[DOCS] Add supported ESS settings to ES docs #57953

Conversation

lockewritesdocs commented Jun 10, 2020 • edited Loading

lockewritesdocs commented Jun 12, 2020

elasticmachine commented Jun 12, 2020

elasticmachine commented Jun 24, 2020

gtback left a comment

Choose a reason for hiding this comment

gtback Jun 26, 2020

Choose a reason for hiding this comment

lockewritesdocs Jun 26, 2020

Choose a reason for hiding this comment

debadair Jun 26, 2020

Choose a reason for hiding this comment

lockewritesdocs Jun 30, 2020 • edited Loading

Choose a reason for hiding this comment

debadair Jul 2, 2020

Choose a reason for hiding this comment

debadair left a comment

Choose a reason for hiding this comment

debadair Jun 26, 2020

Choose a reason for hiding this comment

lockewritesdocs commented Jun 10, 2020 •

edited

Loading

lockewritesdocs Jun 30, 2020 •

edited

Loading