Skip to content

Clarify hardware profile and instance configuration related docs for ECH #2039

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

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

Conversation

kunisen
Copy link
Contributor

@kunisen kunisen commented Jul 4, 2025

Background

There are a bunch of hardware profile and instance configuration related ECH docs that are not clear enough and have caused some confusions to users and support so far.
After syncing with @yuvielastic @maggieghamry @stefnestor and @jakommo, we decided to make some doc updates to clarify.

Details in this internal ticket (https://github.com/elastic/support-tech-lead/issues/1586). Below is a quick recap of what we would like to change.

For reviewers

Recap of what to change

:: [1]

https://www.elastic.co/docs/deploy-manage/deploy/elastic-cloud/ec-change-hardware-profile

  • Change title to Manage hardware profiles
  • Add that version <= 7.10 can't do hardware profile migration

:: [2]

https://www.elastic.co/docs/deploy-manage/deploy/elastic-cloud/change-hardware

  • Update the doc from mentioning "Change hardware" to "Customize instance configuration" and make this update all through this doc page. <= It's technically more proper to say "instance configuration" but not just "hardware"
  • Add "Hardware profile is also referenced as deployment templates (DTs) in ECH to make it more logically connectable"
  • Add an "In addition" paragraph to explain some details, that has confused users and support so far. We have already confirmed with Yuvi from technical perspective.

:: [3]

https://www.elastic.co/docs/deploy-manage/production-guidance/optimize-performance/search-speed

  • Reference regarding "hardware profile" is not correct. It should be the real hardware profile one as mentioned in [1].

:: [4]

https://www.elastic.co/docs/deploy-manage/production-guidance/optimize-performance/indexing-speed

  • Reference regarding "hardware profile" is not correct. It should be the real hardware profile one as mentioned in [1].

:: [5]

Move https://www.elastic.co/docs/deploy-manage/deploy/elastic-cloud/change-hardware - "customize IC" doc under https://www.elastic.co/docs/deploy-manage/deploy/elastic-cloud/ec-change-hardware-profile "manage hardware profile" to make it more logically clear.


🔍 Preview links for changed docs


cc @maggieghamry @stefnestor @jakommo

@kunisen kunisen self-assigned this Jul 4, 2025
@kunisen kunisen requested a review from a team as a code owner July 4, 2025 13:35
@kunisen kunisen added documentation Improvements or additions to documentation supportability ability enable self-service or support of product labels Jul 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation supportability ability enable self-service or support of product
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant