[DOCS] Rewrite of sizing your shards, port from 8.x docs #716
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
❌ Author of the following commits did not sign a Contributor Agreement: Please, read and sign the above mentioned agreement if you want to contribute to this project |
leemthompo
reviewed
Mar 10, 2025
deploy-manage/production-guidance/optimize-performance/size-shards.md
Outdated
Show resolved
Hide resolved
|
Hey @thekofimensah please try make PR titles clearer, e.g. "Port sharding size guidelines changes from 8.x docs" |
For sure, my bad |
|
@thekofimensah looks like you need to sign the CLA for this repo, and the link should work with my latest suggestion. |
Co-authored-by: Liam Thompson <[email protected]>
leemthompo
changed the title
leemthompo
approved these changes
Mar 12, 2025
I've done it twice already for this one... I'll try again. |
|
@georgewallace, any idea why the CLA isn't working for me |
|
I fixed this up to be more scannable and concise as discussed in the backport . Still don't know why the CLA is failing @georgewallace |
thekofimensah
changed the title
georgewallace
approved these changes
Mar 19, 2025
deploy-manage/production-guidance/optimize-performance/size-shards.md
Outdated
Show resolved
Hide resolved
Landing page for elastic/docs-projects#346 --------- Co-authored-by: florent-leborgne <[email protected]>
Corresponding code change: elastic/apm-server#15976 Issue elastic/apm-server#15965
Correct typo samling->sampling --------- Co-authored-by: Colleen McGinnis <[email protected]>
Addresses part of #559 by doing the following: - Removes raw migrated Serverless files that are no longer being used. - Adds anchors where missing and updates anchors that start with an underscore. - Makes minor inline adjustments to the files that were labeled as "lift-and-shift" where appropriate. Affected pages: - [About building block rules](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/566/solutions/security/detect-and-alert/about-building-block-rules) - [About detection rules](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/566/solutions/security/detect-and-alert/about-detection-rules) - [Add detection alerts to cases](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/566/solutions/security/detect-and-alert/add-detection-alerts-to-cases) - [Create a detection rule](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/566/solutions/security/detect-and-alert/create-detection-rule) - [Detections requirements](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/566/solutions/security/detect-and-alert/detections-requirements) - [Install and manage Elastic prebuilt rules](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/566/solutions/security/detect-and-alert/install-manage-elastic-prebuilt-rules) - [Launch Timeline from investigation guides](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/566/solutions/security/detect-and-alert/launch-timeline-from-investigation-guides) - [Manage detection alerts](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/566/solutions/security/detect-and-alert/manage-detection-alerts) - [Manage detection rules](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/566/solutions/security/detect-and-alert/manage-detection-rules) - [MITRE ATT&CK® coverage](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/566/solutions/security/detect-and-alert/mitre-attandckr-coverage) - [Using logsdb index mode with Elastic Security](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/566/solutions/security/detect-and-alert/using-logsdb-index-mode-with-elastic-security) - [View detection alert details](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/566/solutions/security/detect-and-alert/view-detection-alert-details) - [Visualize detection alerts](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/566/solutions/security/detect-and-alert/visualize-detection-alerts) - [Alert suppression](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/566/solutions/security/detect-and-alert/suppress-detection-alerts) - [Reduce alerts and notifications](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/566/solutions/security/detect-and-alert/reduce-notifications-alerts) - [Query alert indices](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/566/solutions/security/detect-and-alert/query-alert-indices) - [Tune detection rules](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/566/solutions/security/detect-and-alert/tune-detection-rules) --------- Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
The subscription page is getting updated to contain an entry for `Custom routing on sort fields for logsdb`, limited to enterprise licenses.
## Description Related to #673 This PR updates the links that point to the `cloud-on-k8s` repo from `asciidocalypse://docs/cloud-on-k8s/docs/reference/` to `cloud-on-k8s://reference/`. I ran a full local build to test the changes without any errors. <img width="529" alt="Screenshot 2025-03-10 at 15 00 55" src="https://github.com/user-attachments/assets/c5e8d575-cfa1-43b6-bfb8-e4469ee2fd2e" />
## Overview Related to elastic/stack-docs#2987 and elastic/search-docs-team#269 This PR updates the steps to add & configure dashboard for the ML`Security: Host` OOTB module. ## Related Issue - https://github.com/elastic/security-team/issues/10414
Update supported stack version in the doc
Related: #583
Contributes to elastic/docs-projects#247 and elastic/docs-projects#355. I'll update the `toc.yml` files in another PR.
## What is this? - Second cut at landing page for elastic/docs-projects#346, because the first draft started to disgust me almost immediately. - (first cut: #703) ## Summary - Intro rewrite - Replaced generic intro with specific bullet points explaining exactly what's on the page - Restructured security features section - Changed from vertical comparison tables to tab-based organization by deployment type - Security topics simplified - Cleaned up redundant descriptions in the four main security topic areas - Added "Next steps" section - New conclusion with clear paths to deployment-specific documentation - Removed "Using this documentation" section - Integrated essential guidance into a brief note under Security topics Consolidated ECE/ECK information - Combined identical deployment types to reduce redundancy --------- Co-authored-by: florent-leborgne <[email protected]>
This updates the "Manage data" → "Ingest data from applications" section with a few leftovers from our initial migration: - Adds versioning tags to the files (I used `applies_to: stack ga` for these, since, to my knowledge, they haven't been tested to work in a Serverless environment). stack: ga - Removes the "What to do" comments - Removes the ECE versions of the files from the 'raw migrated files' section so that the docs can build cleanly.
^^ To consider: - Where to locate traffic filtering pages (under this page, or under secure cluster/deployment) --------- Co-authored-by: Liam Thompson <[email protected]>
### [Preview](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/702/deploy-manage/upgrade/orchestrator/upgrade-cloud-on-k8s) This PR updates the Upgrade Elastic Cloud on Kubernetes page. Related issue: elastic/docs-projects#460 --------- Co-authored-by: Janeen Mikell Roberts <[email protected]>
^^ to simplify the overall structure instead of having a nearly empty page with just a link.
Contributes to #347. Updates Osquery docs to reflect that the maximum query timeout has been increased to 86400 seconds (24 hours). Previews: - [Osquery](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/726/solutions/security/investigate/osquery) - [Add Osquery Response Actions](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/726/solutions/security/investigate/add-osquery-response-actions) - [Run Osquery from investigation guides](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/726/solutions/security/investigate/run-osquery-from-investigation-guides) - [Run Osquery from alerts](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/726/solutions/security/investigate/run-osquery-from-alerts) Corresponding PR for 8.x Security docs: elastic/security-docs#6590 Corresponding PR for 8.x Kibana docs: elastic/kibana#213918
Related to https://github.com/elastic/integration-docs/pull/688 Updates links to the integration-docs repo, to resolve inbound link errors in https://github.com/elastic/integration-docs/actions/runs/13790529387/job/38568927787?pr=688#step:13:103.
Fixes #514. Minor edit.
Second version of #564. Cleans up the AI for security section. Content has already been reviewed and approved.
We haven't yet included the Universal Profiling endpoints in the ECE documentation, despite Universal Profiling being GA since a while. This PR adds documentation to include the domains. Co-authored-by: Edu González de la Herrán <[email protected]>
^^ as discussed in Slack
Fixes #267 by removing an outdated reference to an AI Assistant tab in Timeline.
This PR adds the **"Upgrade Elastic Cloud Enterprise"** page and the **"Re-running the ECE upgrade"** page as a child page. We still have a few outstanding questions that need to be addressed, as outlined in [this Google document](https://docs.google.com/document/d/1eixiQ0FB9kGQIk3DZ8kBGk9RtFmqBEpcUfs483jl4Ns/edit): - We need to **verify the accuracy of the Version matrix table**. - Based on [this comment](https://docs.google.com/document/d/1eixiQ0FB9kGQIk3DZ8kBGk9RtFmqBEpcUfs483jl4Ns/edit?disco=AAABeKRE6w8), I have added a new section titled **"Preserve installation flags during upgrade,"** including guidance from the linked Slack thread. Could you confirm if this is the correct approach and if it is technically accurate? - [Should we](https://docs.google.com/document/d/1eixiQ0FB9kGQIk3DZ8kBGk9RtFmqBEpcUfs483jl4Ns/edit?disco=AAABeKnblcs) keep this note: _"If you are upgrading to ECE versions 2.10, 2.11, or 2.12, refer to the ECE version 2.12 [upgrade steps](https://www.elastic.co/guide/en/cloud-enterprise/2.12/ece-upgrade.html#ece-upgrade-system-deployments) for guidance about certain default ECE visualizations not working."_ - We need clarification on [this question](https://docs.google.com/document/d/1eixiQ0FB9kGQIk3DZ8kBGk9RtFmqBEpcUfs483jl4Ns/edit?disco=AAABeJ7YFVw). @yang-wei, could you please provide guidance? - Regarding this statement: _"Note that the only exception to that rule is when you’re upgrading to ECE 3.6.0 and your system deployments are at a version lower than 7.17.0."_, we should clarify [this](https://docs.google.com/document/d/1eixiQ0FB9kGQIk3DZ8kBGk9RtFmqBEpcUfs483jl4Ns/edit?disco=AAABfWCby0g) and [this](https://docs.google.com/document/d/1eixiQ0FB9kGQIk3DZ8kBGk9RtFmqBEpcUfs483jl4Ns/edit?disco=AAABeyPEvbA) question. Rel: https://elasticco.atlassian.net/browse/CP-10312 --------- Co-authored-by: Edu González de la Herrán <[email protected]>
Audit logging content moved from `monitor > logging configuration > audit logs` to `security > secure your cluster > audit logs`. For reviewing and consideration. cc: @shainaraskas / @florent-leborgne / @leemthompo
## Overview Related to https://github.com/elastic/ml-team/issues/1500 This PR adds a blurb about how we calculate VCUs for ML: - Trained Models are mostly based on vCPU consumed, 1 allocation * 1 thread = 1 vCPU = 8 VCU - Jobs are mostly based on memory consumed, 1 GB = 1 VCU
Updated docs, see elastic/elasticsearch#123000 This change is needed for 9.1+ only. --------- Co-authored-by: David Kilfoyle <[email protected]>
Updated the links for plugin management reference content to reflect its new location. PR for moving content: elastic/elasticsearch#124578 Task: #689
… models (#751) ## Overview Adds the changes of elastic/elasticsearch#124061 to 9.0.0 docs.
Update Plugin Management link connected to [this pull request](elastic/elasticsearch#124578).
Signed-off-by: bmorelli25 <[email protected]>
…on docs (#757) As title states.
## Description Related to #673 This PR updates the links that point to the `apm-agent-rum-js` repo from `asciidocalypse://docs/apm-agent-rum-js/docs/reference/` to `apm-agent-rum-js://reference/`.
Minor edits to clean up AI pages: automatic import, AI Assistant, AI Assistant knowledge base.
Adds the `title` argument to resize large icons in Security docs.
…ards.md Co-authored-by: George Wallace <[email protected]>
thekofimensah
force-pushed
the
size-shards-rewrite-v9
branch
from
ca000d5 to
c189e08
Compare
|
Messed it up with the rebase to try and adjust author. I'll close this in favor of a new one |
thekofimensah
added a commit
that referenced
this pull request
Mar 21, 2025
leemthompo
pushed a commit
that referenced
this pull request
Mar 21, 2025
) This is a dupe of #716. Fixing authorship for CLA.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a v9 rewrite of the approved doc in 124444
Something to double check:
I'm not sure if this is a bug or just a problem with the docs-builder, but when I click on the data streams link in the "Sizing Shard Guidelines" section it doesn't redirect to the top of the page. Is that expected?