Clarify hardware profile and instance configuration related docs for ECH #2039
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,7 +8,9 @@ products: | |
| - id: cloud-hosted | ||
| --- | ||
|
|
||
| # Manage hardware profiles [ec-change-hardware-profile] | ||
|
|
||
| ## Hardware profile [ec-hardware-profile] | ||
|
|
||
| Deployment hardware profiles deploy the {{stack}} on virtual hardware. Each hardware profile has a different blend of storage, RAM, and vCPU. | ||
|
|
||
|
|
@@ -24,6 +26,11 @@ The {{ecloud}} console indicates when a new version of a hardware profile is ava | |
|
|
||
| ## Change the hardware profile using the {{ecloud}} console [ec_change_the_hardware_profile_using_the_elastic_cloud_console] | ||
|
|
||
| ::::{note} | ||
| Deployment with Elastic stack version prior to 7.10 does not support hardware profile change {{ecloud}} console and API. If you want to make change on hardware profile, upgrading to version 7.10 and onwards is required. | ||
|
There was a problem hiding this comment. Just for my understanding: What's causing this behavior? Is this something that's fixable easily? There was a problem hiding this comment.
@yuvielastic it's a product issue that we only support hardware profile migration based on node_roles, where previously in cloud deployment, they use node types and we only introduced node_roles from Elasticsearch 7.10. You can review this KB (external link) for more details: https://support.elastic.co/knowledge/2040b616 (you can also view internal link and I can share it with you internally if you need more history context) Also, @gigerdo and I had a sync recently and he suggested that we should use a more self-explanatory message - which is being handled in CP-11182 (internal ticket). There was a problem hiding this comment. IMHO it's not an easy fix - and we probably want to encourage customer more on upgrading to 7.10+ (preferably the current latest they can upgrade to) instead of fixing this and supporting customers to do HW migration on old versions. (It may cause other issues correspondingly as we didn't handle it very smoothly in earlier versions during node type to node roles migration, and it might be hard to cover all the test cases when we add an additional logic to hardware migration APIs - the most difficult part I can expect is the plan fails in the middle that having a mixed of node roles and types, then it may become technically hard to tackle.) There was a problem hiding this comment. Thanks Kuni for clarifying and agreed that we should encourage customers to upgrade to 7.10+ especially as that version is super old. Also, good to know that we will be updating the message to be more self-explanatory (separately in CP-11182).
kunisen marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| :::: | ||
|
|
||
|
|
||
| ### Upgrade to the newest version of your current hardware profile [ec_upgrade_to_the_newest_version_of_your_current_hardware_profile] | ||
|
|
||
| Note that if there’s no indication that a newer version is available, that means that your deployment is already running on the latest version of that hardware profile. | ||
|
|
@@ -72,6 +79,11 @@ If your deployment is configured for high availability, the hardware profile cha | |
|
|
||
| ## Change the hardware profile using the API [ec_change_the_hardware_profile_using_the_api] | ||
|
|
||
| ::::{note} | ||
| Deployment with Elastic stack version prior to 7.10 does not support hardware profile change {{ecloud}} console and API. If you want to make change on hardware profile, upgrading to version 7.10 and onwards is required. | ||
kunisen marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| :::: | ||
|
|
||
|
|
||
| Prerequisites: | ||
|
|
||
| * A valid {{ecloud}} [API key](../../api-keys/elastic-cloud-api-keys.md) (`$EC_API_KEY`) | ||
|
|
@@ -176,21 +188,28 @@ Consider this configuration for ingestion use cases with 1-4 days of data availa | |
|
|
||
| ### CPU optimized (ARM) [ec-profiles-compute-optimized-arm] | ||
|
|
||
| This profile is similar to CPU optimized profile but powered by ARM instances. Currently, we offer ARM instances on AWS. You can find the exact storage, memory, and vCPU allotment on the [hardware details page](cloud://reference/cloud-hosted/hardware.md#ec-getting-started-configurations) for each cloud provider. | ||
|
|
||
| **Ideal use case** | ||
|
|
||
| Consider this configuration for ingestion use cases with 1-4 days of data available for fast access and for search use cases with indexing and querying workloads. Provides the most CPU resources per unit of RAM. | ||
|
|
||
| ### Vector search optimized [ec-profiles-vector-search] | ||
|
|
||
| This profile is suited for Vector search, Generative AI and Semantic search optimized workloads. You can find the exact storage, memory, and vCPU allotment on the [hardware details page](cloud://reference/cloud-hosted/hardware.md#ec-getting-started-configurations) for each cloud provider. | ||
|
|
||
| **Ideal use case** | ||
|
|
||
| Optimized for applications that leverage Vector Search and/or Generative AI. Also the optimal choice for utilizing ELSER for semantic search applications. Broadly suitable for all semantic search, text embedding, image search, and other Vector Search use cases. | ||
|
|
||
| ### Vector search optimized (ARM) [ec-profiles-vector-search-arm] | ||
|
|
||
| This profile is suited for Vector search, Generative AI and Semantic search optimized workloads powered by ARM instances. Currently, we offer ARM instances on AWS. You can find the exact storage, memory, and vCPU allotment on the [hardware details page](cloud://reference/cloud-hosted/hardware.md#ec-getting-started-configurations) for each cloud provider. | ||
|
|
||
| **Ideal use case** | ||
|
|
||
| Optimized for applications that leverage Vector Search and/or Generative AI. Also the optimal choice for utilizing ELSER for semantic search applications. Broadly suitable for all semantic search, text embedding, image search, and other Vector Search use cases. | ||
|
|
||
|
|
||
| ### General purpose [ec-profiles-general-purpose] | ||
|
|
||
|
|
@@ -203,7 +222,7 @@ Suitable for ingestion use cases with 5-7 days of data available for fast access | |
|
|
||
| ### General purpose (ARM) [ec-profiles-general-purpose-arm] | ||
|
|
||
| This profile is similar to General purpose profile but powered by ARM instances. Currently, we offer ARM instances on AWS. You can find the exact storage, memory, and vCPU allotment on the [hardware details page](cloud://reference/cloud-hosted/hardware.md#ec-getting-started-configurations) for each cloud provider. | ||
|
|
||
| **Ideal use case** | ||
|
|
||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.