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

Add note about license to "Restore an Entire Cluster" docs #87485

Merged
merged 3 commits into from
May 3, 2024

Conversation

TheRiffRafi
Copy link
Contributor

@TheRiffRafi TheRiffRafi commented Jun 7, 2022

One user reached out mentioning that it would be a good idea to remind users to re-upload the license after full cluster recovery from snapshot as one can easily miss this when trying to figure out why some features aren't working after the restore.

One customer reached out mentioning that it would be a good idea to remind users to re-upload the license after full cluster receovery from snapshot as one ca easily miss this when trying to figure out why some features aren't working after the restore.
@elasticsearchmachine
Copy link
Collaborator

@TheRiffRafi please enable the option "Allow edits and access to secrets by maintainers" on your PR. For more information, see the documentation.

@elasticsearchmachine elasticsearchmachine added v8.4.0 external-contributor Pull request authored by a developer outside the Elasticsearch team labels Jun 7, 2022
@gwbrown gwbrown added >docs General docs changes :Security/License License functionality for commercial features labels Jun 13, 2022
@elasticmachine elasticmachine added Team:Docs Meta label for docs team Team:Security Meta label for security team labels Jun 13, 2022
@elasticmachine
Copy link
Collaborator

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

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-security (Team:Security)

@gwbrown gwbrown self-requested a review June 13, 2022 21:57
@gwbrown gwbrown self-assigned this Jun 13, 2022
@bytebilly
Copy link
Contributor

Thanks @gwbrown for opening this issue.
Would it be better to load the license before restoring data? I'm not sure if this has drawbacks and it's possible in general, but I think that it may be safer in case of paid features use.
What do you think?

@gwbrown
Copy link
Contributor

gwbrown commented Jun 13, 2022

@bytebilly To be clear, I didn't open this issue; this is a community PR that I decided to shepherd. To add some context to this, the license is kept in the cluster state, which is overwritten when a snapshot is restored with include_global_state: true (the default is false), which also overwrites all index templates, ILM policies, and everything else stored in cluster state.

The issue is that restoring the snapshotted cluster state may restore an old license (or at least so it appears from this contribution and reading the relevant code). I agree that it would be best to address this with a technical solution - it's weird that restoring a snapshot restores the license - but doing so will take time as we'll have to build new functionality to do that, so adding a note to the documentation here might not be a bad idea until we can do so. I do have some thoughts about the wording that I'll write up soon as a proper review.

@tvernum
Copy link
Contributor

tvernum commented Jun 16, 2022

it's weird that restoring a snapshot restores the license

I can understand that it might be surprising in some cases, but if you are using snapshot + restore to migrate a cluster (e.g. to move to a different cloud provider) then having everything come along with you (including the license) is exactly the right behaviour. "weird" is going to be in the eye of the beholder.

@elasticsearchmachine elasticsearchmachine changed the base branch from master to main July 22, 2022 23:06
@mark-vieira mark-vieira added v8.5.0 and removed v8.4.0 labels Jul 27, 2022
@csoulios csoulios added v8.6.0 and removed v8.5.0 labels Sep 21, 2022
@kingherc kingherc added v8.7.0 and removed v8.6.0 labels Nov 16, 2022
@rjernst rjernst added v8.8.0 and removed v8.7.0 labels Feb 8, 2023
@gmarouli gmarouli added v8.9.0 and removed v8.8.0 labels Apr 26, 2023
@quux00 quux00 added v8.11.0 and removed v8.10.0 labels Aug 16, 2023
@gwbrown gwbrown added auto-merge-without-approval Automatically merge pull request when CI checks pass (NB doesn't wait for reviews!) auto-backport-and-merge v8.14.1 v8.13.4 labels May 3, 2024
Copy link
Contributor

@gwbrown gwbrown left a comment

Choose a reason for hiding this comment

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

Apologies for kind of losing track of this one - it would definitely be good to have this note in the docs, so I've cleaned up the wording a little and moved it to the top of the list of features to start up again after restoring and this should be merged shortly. Thanks!!

@gwbrown gwbrown changed the title Upload license reminder Add note about license to "Restore an Entire Cluster" docs May 3, 2024
@elasticsearchmachine elasticsearchmachine merged commit 295fba3 into main May 3, 2024
6 checks passed
@elasticsearchmachine elasticsearchmachine deleted the TheRiffRafi-patch-2 branch May 3, 2024 23:23
gwbrown pushed a commit to gwbrown/elasticsearch that referenced this pull request May 8, 2024
…7485)

One user reached out mentioning that it would be a good idea to remind
users to re-upload the license after full cluster recovery from snapshot
as one can easily miss this when trying to figure out why some features
aren't working after the restore.

(cherry picked from commit 295fba3)
gwbrown pushed a commit to gwbrown/elasticsearch that referenced this pull request May 8, 2024
…7485)

One user reached out mentioning that it would be a good idea to remind
users to re-upload the license after full cluster recovery from snapshot
as one can easily miss this when trying to figure out why some features
aren't working after the restore.

(cherry picked from commit 295fba3)
gwbrown pushed a commit to gwbrown/elasticsearch that referenced this pull request May 8, 2024
…7485)

One user reached out mentioning that it would be a good idea to remind
users to re-upload the license after full cluster recovery from snapshot
as one can easily miss this when trying to figure out why some features
aren't working after the restore.

(cherry picked from commit 295fba3)
@gwbrown
Copy link
Contributor

gwbrown commented May 8, 2024

💚 All backports created successfully

Status Branch Result
8.14
8.13
7.17

Questions ?

Please refer to the Backport tool documentation

elasticsearchmachine pushed a commit that referenced this pull request May 8, 2024
…108436)

One user reached out mentioning that it would be a good idea to remind
users to re-upload the license after full cluster recovery from snapshot
as one can easily miss this when trying to figure out why some features
aren't working after the restore.

(cherry picked from commit 295fba3)

Co-authored-by: Rafi Estrada <62263912+TheRiffRafi@users.noreply.github.com>
elasticsearchmachine pushed a commit that referenced this pull request May 8, 2024
…108437)

One user reached out mentioning that it would be a good idea to remind
users to re-upload the license after full cluster recovery from snapshot
as one can easily miss this when trying to figure out why some features
aren't working after the restore.

(cherry picked from commit 295fba3)

Co-authored-by: Rafi Estrada <62263912+TheRiffRafi@users.noreply.github.com>
elasticsearchmachine pushed a commit that referenced this pull request May 8, 2024
…108435)

One user reached out mentioning that it would be a good idea to remind
users to re-upload the license after full cluster recovery from snapshot
as one can easily miss this when trying to figure out why some features
aren't working after the restore.

(cherry picked from commit 295fba3)

Co-authored-by: Rafi Estrada <62263912+TheRiffRafi@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-merge-without-approval Automatically merge pull request when CI checks pass (NB doesn't wait for reviews!) >docs General docs changes external-contributor Pull request authored by a developer outside the Elasticsearch team :Security/License License functionality for commercial features Team:Docs Meta label for docs team Team:Security Meta label for security team v7.17.22 v8.13.4 v8.14.1 v8.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.