-
Notifications
You must be signed in to change notification settings - Fork 110
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
kunisen
wants to merge
18
commits into
main
Choose a base branch
from
kunisen-docpr-stl1586
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+59
−11
Open
Changes from all commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
2f9e518
Clarify hardware profile and instance configuration related docs
kunisen 9d7cb96
Update ec-change-hardware-profile.md
kunisen 2c5fafc
Update ec-change-hardware-profile.md
kunisen f5afb2b
Merge branch 'main' into kunisen-docpr-stl1586
kunisen b4ad1c5
Merge branch 'kunisen-docpr-stl1586' of https://github.com/elastic/do…
kunisen 2749011
Update ec-change-hardware-profile.md
kunisen 6f22fe1
Update deploy-manage/deploy/elastic-cloud/change-hardware.md
kunisen ba8353d
Update deploy-manage/deploy/elastic-cloud/change-hardware.md
kunisen 17d4bd1
Merge branch 'main' into kunisen-docpr-stl1586
kunisen 81b349c
Update change-hardware.md
kunisen 6d6357e
Update change-hardware.md
kunisen 66988bf
Update deploy-manage/deploy/elastic-cloud/change-hardware.md
kunisen 0f55f2d
Update deploy-manage/deploy/elastic-cloud/ec-change-hardware-profile.md
kunisen 306a288
Update deploy-manage/deploy/elastic-cloud/ec-change-hardware-profile.md
kunisen 036fb53
Update deploy-manage/deploy/elastic-cloud/change-hardware.md
kunisen 0876281
Update deploy-manage/deploy/elastic-cloud/change-hardware.md
kunisen 0f73c89
Update change-hardware.md
kunisen d64924d
Update change-hardware.md
kunisen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -8,9 +8,13 @@ products: | |||||
- id: cloud-hosted | ||||||
--- | ||||||
|
||||||
# Change hardware [ec-change-hardware-for-a-specific-resource] | ||||||
# Customize instance configuration [ec-change-instance-configuration] | ||||||
eedugon marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
The virtual hardware on which {{stack}} deployments run is defined by instance configurations. To learn more about what an instance configuration is, refer to [Instance configurations](cloud://reference/cloud-hosted/hardware.md#ec-getting-started-configurations). | ||||||
This document explains how to modify the instance configurations used by specific components of your deployment without changing the overall hardware profile assigned to the deployment. This advanced configuration scenario is useful when specific situations in which we may need to migrate an Elasticsearch tier or stateless resource to a different hardware type. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
## Consideration [ec-considerations-on-changing-ic] | ||||||
|
||||||
{{stack}} deployments run on virtual hardware defined by instance configurations. For more details, refer to [Hardware profiles](./ec-change-hardware-profile.md#ec-hardware-profile) and [Instance configurations](cloud://reference/cloud-hosted/hardware.md#ec-getting-started-configurations) documents. | ||||||
|
||||||
When a deployment is created, each {{es}} tier and stateless resource (e.g., Kibana) gets an instance configuration assigned to it, based on the hardware profile used. The combination of instance configurations defined within each hardware profile is designed to provide the best possible outcome for each use case. Therefore, it is not advisable to use instance configurations that are not specified on the hardware profile, except in specific situations in which we may need to migrate an {{es}} tier or stateless resource to a different hardware type. An example of such a scenario is when a cloud provider stops supporting a hardware type in a specific region. | ||||||
|
||||||
|
@@ -89,6 +93,30 @@ Having an instance configuration mismatch between the deployment and the hardwar | |||||
|
||||||
## Deprecated instance configurations (ICs) and deployment templates (DTs) [ec-deprecated-icdt] | ||||||
|
||||||
A list of deprecated and valid ICs/DTs can be found on the [Available regions, deployment templates and instance configurations](cloud://reference/cloud-hosted/ec-regions-templates-instances.md) page, as well as through the API, using `hide_deprecated` to return valid ICs/DTs. For example, to return valid ICs/DTs the following request can be used: `https://api.elastic-cloud.com/api/v1/deployments/templates?region=us-west-2&hide_deprecated=true`. To list only the deprecated ones, this can be used: `https://api.elastic-cloud.com/api/v1/deployments/templates?region=us-west-2&metadata=legacy:true`. | ||||||
Hardware profile is also referenced as deployment templates in {{ecloud}}. | ||||||
|
||||||
You can find a list of deprecated and valid instance configurations (ICs) and deployment templates (DTs) in two ways: | ||||||
|
||||||
### Public documentation page | ||||||
|
||||||
Visit the [Available regions, deployment templates and instance configurations](cloud://reference/cloud-hosted/ec-regions-templates-instances.md) page for detailed information. | ||||||
|
||||||
### API access | ||||||
|
||||||
Use the [Get deployment templates API](https://www.elastic.co/docs/api/doc/cloud/operation/operation-get-deployment-templates-v2) with query parameters like `hide_deprecated` to retrieve valid ICs and DTs. This API request returns a list of DTs along with the respective ICs referenced within each DT. | ||||||
|
||||||
For example, | ||||||
* To return valid ICs/DTs the following request can be used: `https://api.elastic-cloud.com/api/v1/deployments/templates?region=us-west-2&hide_deprecated=true`. | ||||||
* To list only the deprecated ones, this can be used: `https://api.elastic-cloud.com/api/v1/deployments/templates?region=us-west-2&metadata=legacy:true`. | ||||||
|
||||||
If a deprecated IC/DT is already in use, it can continue to be used. However, creating or migrating to a deprecated IC/DT is no longer possible and will result in a plan failing. In order to migrate to a valid IC/DT, navigate to the **Edit hardware profile** option in the Cloud UI or use the [Deployment API](https://www.elastic.co/docs/api/doc/cloud/operation/operation-migrate-deployment-template). | ||||||
|
||||||
::::{note} | ||||||
Deployments using {{stack}} versions prior to 7.10 do not support changing the hardware profile through the {{ecloud}} console or API. To change the hardware profile, first upgrade to version 7.10 or later. | ||||||
:::: | ||||||
|
||||||
In addtion, you can refer to below information about how these terminologies are referenced. | ||||||
* _Deprecated_ is also referenced as _legacy_. | ||||||
* Using the `metadata=legacy:true` query parameter will return only legacy/deprecated DTs. | ||||||
* Using the `hide_deprecated=true` query parameter will return only valid DTs. | ||||||
* Not using any of the query parameters above will return all DTs. In this case, check the presence of `legacy: true` in the `metadata` entries within the API response, to verify if an IC/DT is deprecated or not. |
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
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
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
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.