Skip to content

[DOCS] Add transient settings migration guide#80091

Merged
jrodewig merged 9 commits intoelastic:7.16from
jrodewig:docs__transient-to-persistent-settings
Nov 3, 2021
Merged

[DOCS] Add transient settings migration guide#80091
jrodewig merged 9 commits intoelastic:7.16from
jrodewig:docs__transient-to-persistent-settings

Conversation

@jrodewig
Copy link
Copy Markdown
Contributor

@jrodewig jrodewig commented Oct 29, 2021 •
edited
Loading

Changes:

  • Adds a transient settings migration guide to the 7.16 docs.
  • Updates the related deprecation docs to link to the guide.

Closes #80055

Relates to #79167.

Forwardports

This deprecation is currently in the 7.16 docs only. However, I plan to forwardport to 8.0 and main based on the discussion in #79953.

In the 8.0 and main forwardports, I plan to add the guide and deprecation notice to the 8.0 migration docs. Let me know if there are any objections.

Previews

@jrodewig jrodewig added >docs General docs changes v8.0.0-beta1 v8.1.0 :Core/Infra/Core Core issues without another label labels Oct 29, 2021
@jrodewig jrodewig marked this pull request as ready for review October 29, 2021 15:14
@elasticmachine elasticmachine added Team:Docs Meta label for docs team Team:Core/Infra Meta label for core/infra team labels Oct 29, 2021
@elasticmachine
Copy link
Copy Markdown
Collaborator

elasticmachine commented Oct 29, 2021

Pinging @elastic/es-docs (Team:Docs)

@elasticmachine
Copy link
Copy Markdown
Collaborator

elasticmachine commented Oct 29, 2021

Pinging @elastic/es-core-infra (Team:Core/Infra)

jakelandis
jakelandis reviewed Oct 29, 2021
View reviewed changes
Copy link
Copy Markdown
Contributor

@jakelandis jakelandis left a comment

Choose a reason for hiding this comment

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

@jrodewig - This looks really nice. Thanks for picking this up so fast !

I wonder if there should be a blurb about "Some Elastic products may make use of transient settings and those should not be changed" similar to #79953 (comment)

The hard part for the user will be to know which settings they set vs. the Elastic products, so maybe there be some deliberate wording around setting they or their workflow toolings may have set ?

@jrodewig
Copy link
Copy Markdown
Contributor Author

jrodewig commented Oct 29, 2021

I wonder if there should be a blurb about "Some Elastic products may make use of transient settings and those should not be changed" similar to #79953 (comment)

Thanks for pointing this out. I added a related admon in c4f67aa. However, I raise some concerns below.

The hard part for the user will be to know which settings they set vs. the Elastic products, so maybe there be some deliberate wording around setting they or their workflow toolings may have set ?

Maybe @grcevski can help us out here. AFAIK there's no way to differentiate Elastic- vs user-managed cluster settings. In that case, the user won't know which transient settings are okay to reset vs. not. If we include the above admon or something like it, I feel we also need to include this step too.

grcevski
grcevski approved these changes Nov 1, 2021
View reviewed changes
Copy link
Copy Markdown
Contributor

@grcevski grcevski left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for this great write-up.

@grcevski
Copy link
Copy Markdown
Contributor

grcevski commented Nov 1, 2021

I wonder if there should be a blurb about "Some Elastic products may make use of transient settings and those should not be changed" similar to #79953 (comment)

Thanks for pointing this out. I added a related admon in c4f67aa. However, I raise some concerns below.

The hard part for the user will be to know which settings they set vs. the Elastic products, so maybe there be some deliberate wording around setting they or their workflow toolings may have set ?

Maybe @grcevski can help us out here. AFAIK there's no way to differentiate Elastic- vs user-managed cluster settings. In that case, the user won't know which transient settings are okay to reset vs. not. If we include the above admon or something like it, I feel we also need to include this step too.

Yes, that's right @jrodewig. There's no way to tell which settings are being set by our infrastructure vs. the end user. We don't do any detection on client type for these settings.

jakelandis
jakelandis approved these changes Nov 1, 2021
View reviewed changes
Copy link
Copy Markdown
Contributor

@jakelandis jakelandis left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks for putting this together so quickly!

@jrodewig jrodewig merged commit ff0b01c into elastic:7.16 Nov 3, 2021
@jrodewig jrodewig deleted the docs__transient-to-persistent-settings branch November 3, 2021 13:06
This was referenced Nov 3, 2021
Merged
Merged
jrodewig added a commit that referenced this pull request Nov 3, 2021
@jrodewig
[DOCS] Add transient settings migration guide (#80091) (#80272)
cb6347b 
Changes:

* Adds a transient settings migration guide to the 7.16 docs.
* Updates the related deprecation docs to link to the guide.

Closes #80055

Relates to #79167.
jrodewig added a commit that referenced this pull request Nov 3, 2021
@jrodewig
[DOCS] Add transient settings migration guide (#80091) (#80273)
a790633 
Changes:

* Adds a transient settings migration guide.
* Updates the related deprecation docs to link to the guide.

Closes #80055

Relates to #79167.
@danhermann danhermann added v7.16.0 and removed v7.16.1 labels Nov 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jakelandis jakelandis jakelandis approved these changes

@debadair debadair Awaiting requested review from debadair

+1 more reviewer

@grcevski grcevski grcevski approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

:Core/Infra/Core Core issues without another label >docs General docs changes Team:Core/Infra Meta label for core/infra team Team:Docs Meta label for docs team v7.16.0 v8.0.0-beta1 v8.1.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@jrodewig @elasticmachine @grcevski @jakelandis @danhermann @elasticsearchmachine