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

Revises 8.x-8.x upgrade guide #5830

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

natasha-moore-elastic
Copy link
Contributor

Contributes to #5302.

Revises the instructions for upgrading from an 8.x to an 8.x version. Mostly reuses the content from the 7.17 to 8.x upgrade guide, but without the 7.17-specific information.

@natasha-moore-elastic natasha-moore-elastic added Feature: Upgrading Priority: Medium Issues that have relevance, but aren't urgent v8.10.0 Effort: Small Issues that can be resolved quickly v8.11.0 Docset: ESS Issues that apply to docs in the Stack release v8.12.0 v8.13.0 v8.14.0 v8.15.0 v8.16.0 labels Sep 13, 2024
@natasha-moore-elastic natasha-moore-elastic self-assigned this Sep 13, 2024
Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

joepeeples
joepeeples previously approved these changes Sep 16, 2024
Copy link
Contributor

@joepeeples joepeeples left a comment

Choose a reason for hiding this comment

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

Just a few optional suggestions, so went ahead and approved in case you want to merge now. Ping again if you need re-approval!


Take these extra steps to ensure you are ready for migration.
Follow this guide to upgrade from an 8.x to an 8.x version.
Copy link
Contributor

Choose a reason for hiding this comment

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

"Upgrade from 8.x to 8.x" sounds redundant even though I know it's not really. At the risk of over-explaining:

Suggested change
Follow this guide to upgrade from an 8.x to an 8.x version.
Follow this guide to upgrade from an earlier 8.x version to a later 8.x version.

... Ensure that the index and search rate are close to what they were before upgrading. Go to **Stack Monitoring** -> **{es}** -> **Overview**.
+
TIP: You can also check the index document count using the {ref}/cat-indices.html[cat index API].
... Verify that SLM is taking snapshots by {ref}/snapshots-take-snapshot.html#check-slm-history[checking the SLM history].
Copy link
Contributor

Choose a reason for hiding this comment

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

I know we already established what SLM means earlier in the page, but it's a different section and this page is pretty dense. Wouldn't hurt to spell it out again.


. Upgrade your ingest components (such as {ls}, {fleet} and {agent}, {beats}, etc.). For details, refer to the {stack-ref}/upgrading-elastic-stack.html[Elastic Stack upgrade docs].

. Validate that Ingest is operating correctly.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
. Validate that Ingest is operating correctly.
. Validate that ingest is operating correctly.

.. Open *Discover*, go through data views for each of your expected ingest data streams, and ensure that data is being ingested in the expected format and volume.

. Validate that {elastic-sec} is operating correctly.
.. Re-enable your desired SIEM detection rules (rule management), and ensure that enabled rules are running without errors or warnings (rule monitoring).
Copy link
Contributor

@joepeeples joepeeples Sep 16, 2024

Choose a reason for hiding this comment

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

Seems like these might be references to specific UI tabs on the Rules page, so capitalize:

Suggested change
.. Re-enable your desired SIEM detection rules (rule management), and ensure that enabled rules are running without errors or warnings (rule monitoring).
.. Re-enable your desired SIEM detection rules (Rule Management), and ensure that enabled rules are running without errors or warnings (Rule Monitoring).

Or maybe even more clarity:

Suggested change
.. Re-enable your desired SIEM detection rules (rule management), and ensure that enabled rules are running without errors or warnings (rule monitoring).
.. On the Rules page, re-enable your desired SIEM detection rules (Rule Management tab), and ensure that enabled rules are running without errors or warnings (Rule Monitoring tab).

joepeeples
joepeeples previously approved these changes Sep 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docset: ESS Issues that apply to docs in the Stack release Effort: Small Issues that can be resolved quickly Feature: Upgrading Priority: Medium Issues that have relevance, but aren't urgent v8.10.0 v8.11.0 v8.12.0 v8.13.0 v8.14.0 v8.15.0 v8.16.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants