Document EIS region preferences for 9.5 - #7804
Conversation
charlotte-hoblik
added
documentation
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
🔍 Preview links for changed docs |
✅ Elastic Docs Style Checker (Vale)No issues found on modified lines! The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
kosabogi
left a comment
kosabogi
left a comment
There was a problem hiding this comment.
Looking good! 🍃 I left a few comments and suggestions to consider
| * `us-east5` (Columbus, US) | ||
|
|
||
| All {{infer}} requests sent through EIS are routed to the nearest region, regardless of where your {{es}} deployment or {{serverless-short}} project is hosted. | ||
| {applies_to}`stack: ga 9.5` {applies_to}`serverless: ga` If you configure [region preferences](#inference-region-preferences), EIS routes only within your allowed geographies or regions. |
There was a problem hiding this comment.
| {applies_to}`stack: ga 9.5` {applies_to}`serverless: ga` If you configure [region preferences](#inference-region-preferences), EIS routes only within your allowed geographies or regions. | |
| {applies_to}`stack: ga 9.5` {applies_to}`serverless: ga` If you configure [region preferences](#inference-region-preferences), EIS routes only within your allowed geographies or regions. |
I’d add a blank line here to create some space between them. I think this makes it clearer which sentence the applies_to applies to 🥁
| serverless: ga | ||
| ``` | ||
|
|
||
| Region preferences let administrators restrict where EIS processes {{infer}} requests. |
There was a problem hiding this comment.
| Region preferences let administrators restrict where EIS processes {{infer}} requests. | |
| Region preferences let you restrict where EIS processes {{infer}} requests. |
|
|
||
| You can express preferences in one of two ways: | ||
|
|
||
| * **Geographies**: Broader geographic areas, shown as options such as **North America — All available regions**. |
There was a problem hiding this comment.
| * **Geographies**: Broader geographic areas, shown as options such as **North America — All available regions**. | |
| * **Geographies**: Broader geographic areas, shown as options such as **North America - All available regions**. |
| * **Geographies**: Broader geographic areas, shown as options such as **North America — All available regions**. | ||
| * **Regions**: Specific cloud service provider regions, for example **US East (N. Virginia) - AWS**. | ||
|
|
||
| The picker lists only the geographies and regions currently available for your deployment. |
There was a problem hiding this comment.
I think it would be helpful to include a screenshot of the "Manage region preferences" UI near the beginning, because at this point it’s not yet clear what the picker refers to. Maybe after the intro paragraph:
Region preferences let administrators restrict where EIS processes inference requests. Use them when your organization needs inference to stay within approved geographies for compliance or data residency.
--- image
Or, if we want this section to be agnostic to the configuration method (Kibana vs API) we could simply move the information about the picker to the Kibana-specific section. Maybe that'd be better?
|
|
||
| 1. Go to the **Elastic inference** page by using the navigation menu or the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md). | ||
| 1. Select **Manage regions**. | ||
| 1. In the **Manage region preferences** dialog, review the callout that some models aren't available in every region. |
There was a problem hiding this comment.
I'm not sure this step is necessary
|
|
||
| * **Geographies**: Select one or more geographic areas. | ||
| * **Regions**: Expand a geography and select one or more cloud provider regions. | ||
| 1. Before you save, open any models you rely on and check **Regions** in the model details. |
There was a problem hiding this comment.
open any models you rely on and check Regions in the model details
I might be missing something, but at this point I’m not quite sure where in the UI I’m supposed to do this. Would it maybe make sense to move this information before the steps and present it in an important or note callout?
| * **Geographies**: Select one or more geographic areas. | ||
| * **Regions**: Expand a geography and select one or more cloud provider regions. | ||
| 1. Before you save, open any models you rely on and check **Regions** in the model details. | ||
| If a model isn't available in your allowed locations, it becomes unavailable after you save. |
There was a problem hiding this comment.
Same as above, maybe this could be also moved to that callout
| If a model isn't available in your allowed locations, it becomes unavailable after you save. | ||
| 1. Select **Save preferences**. | ||
| 1. In the confirmation dialog, review your pending allowed geographies or regions. | ||
| Changing the region policy affects all Elastic {{infer-cap}} Service endpoints across all spaces. |
There was a problem hiding this comment.
Changing the region policy affects all Elastic {{infer-cap}} Service endpoints across all spaces.
Same as above
| @@ -12,16 +12,147 @@ This page lists the {{aws}} and {{gcp}} regions where Elastic {{infer-cap}} Serv | |||
|
|
|||
| **{{aws}}:** | |||
There was a problem hiding this comment.
I’m wondering whether, now that this page covers more than just the main regions where Elastic Inference Service is available, it would make sense to add a heading for this for easier scannability
kapiljadhav-eis
left a comment
kapiljadhav-eis
left a comment
There was a problem hiding this comment.
The changes look good to me.
3 participants
Summary
forcedetails in the API reference.Closes #7694