From 177132e72b2258ca612f016cc97bf775cc5a4dd7 Mon Sep 17 00:00:00 2001 From: Florent Le Borgne Date: Thu, 20 Feb 2025 15:16:17 +0100 Subject: [PATCH 01/11] Deploy Elastic Cloud --- deploy-manage/deploy/elastic-cloud.md | 75 +++--------- .../elastic-cloud/add-plugins-extensions.md | 8 +- .../elastic-cloud/available-stack-versions.md | 8 +- .../deploy/elastic-cloud/aws-marketplace.md | 24 ++-- .../azure-marketplace-pricing.md | 4 + .../elastic-cloud/azure-native-isv-service.md | 20 ++-- .../deploy/elastic-cloud/change-hardware.md | 2 +- ...eate-an-elastic-cloud-hosted-deployment.md | 4 +- .../elastic-cloud/create-an-organization.md | 98 +++++++++++++++- ...-you-go-subscription-on-aws-marketplace.md | 4 + ...-you-go-subscription-on-gcp-marketplace.md | 4 + .../ec-configure-deployment-settings.md | 10 +- .../ec-customize-deployment-components.md | 6 +- .../elastic-cloud/ec-customize-deployment.md | 8 +- .../ech-aws-instance-configuration.md | 2 +- .../ech-azure-instance-configuration.md | 2 +- .../ech-gcp-instance-configuration.md | 2 +- .../deploy/elastic-cloud/ech-get-help.md | 2 +- .../elastic-cloud/ech-getting-started.md | 4 +- .../deploy/elastic-cloud/ech-restrictions.md | 2 +- .../elastic-cloud/ech-version-policy.md | 2 +- .../deploy/elastic-cloud/find-cloud-id.md | 16 +-- .../google-cloud-platform-marketplace.md | 26 +++-- deploy-manage/deploy/elastic-cloud/heroku.md | 11 +- ...age-deployments-using-elastic-cloud-api.md | 8 +- .../manage-integrations-server.md | 4 +- .../manage-plugins-extensions-through-api.md | 2 +- .../restrictions-known-problems.md | 54 +++++---- .../subscribe-from-marketplace.md | 16 ++- ...from-apm-to-integrations-server-payload.md | 2 +- .../deploy/elastic-cloud/tools-apis.md | 109 +++++++++++++++++- deploy-manage/toc.yml | 28 +++-- .../ec-getting-started-existing-email.md | 17 --- raw-migrated-files/toc.yml | 1 - 34 files changed, 378 insertions(+), 207 deletions(-) delete mode 100644 raw-migrated-files/cloud/cloud/ec-getting-started-existing-email.md diff --git a/deploy-manage/deploy/elastic-cloud.md b/deploy-manage/deploy/elastic-cloud.md index f84e351fb2..a8d4aae813 100644 --- a/deploy-manage/deploy/elastic-cloud.md +++ b/deploy-manage/deploy/elastic-cloud.md @@ -1,44 +1,30 @@ --- +applies_to: + serverless: ga + deployment: + ess: ga mapped_pages: - https://www.elastic.co/guide/en/serverless/current/intro.html#general-what-is-serverless-elastic-differences-between-serverless-projects-and-hosted-deployments-on-ecloud --- # Elastic Cloud [intro] -{{serverless-full}} is a fully managed solution that allows you to deploy and use Elastic for your use cases without managing the underlying infrastructure. It represents a shift in how you interact with {{es}} - instead of managing clusters, nodes, data tiers, and scaling, you create **serverless projects** that are fully managed and automatically scaled by Elastic. This abstraction of infrastructure decisions allows you to focus solely on gaining value and insight from your data. +{{ecloud}} allows you to manage [hosted deployments](elastic-cloud/cloud-hosted.md) of the {{stack}} and [serverless projects](elastic-cloud/serverless.md) for your Observability, Security, and Search use cases. -{{serverless-full}} automatically provisions, manages, and scales your {{es}} resources based on your actual usage. Unlike traditional deployments where you need to predict and provision resources in advance, serverless adapts to your workload in real-time, ensuring optimal performance while eliminating the need for manual capacity planning. +These hosted deployments and serverless projects are hosted on Elastic Cloud, through the cloud provider and regions of your choice, and are tied to your organization account. -Serverless projects use the core components of the {{stack}}, such as {{es}} and {{kib}}, and are based on an architecture that decouples compute and storage. Search and indexing operations are separated, which offers high flexibility for scaling your workloads while ensuring a high level of performance. +{{ecloud}} is a service managed by Elastic. You can check its operational status at any time from [status.elastic.co](https://status.elastic.co/). -Elastic provides three serverless solutions available on {{ecloud}}: +## Sign up -* **https://www.elastic.co/guide/en/serverless/current/what-is-elasticsearch-serverless.html[{{es-serverless}}]**: Build powerful applications and search experiences using a rich ecosystem of vector search capabilities, APIs, and libraries. -% See solutions/search/serverless-elasticsearch-get-started.md -* **https://www.elastic.co/guide/en/serverless/current/what-is-observability-serverless.html[{{obs-serverless}}]**: Monitor your own platforms and services using powerful machine learning and analytics tools with your logs, metrics, traces, and APM data. -* **https://www.elastic.co/guide/en/serverless/current/what-is-security-serverless.html[{{sec-serverless}}]**: Detect, investigate, and respond to threats with SIEM, endpoint protection, and AI-powered analytics capabilities. +You can get started by creating an {{ecloud}} organization on [cloud.elastic.co](https://cloud.elastic.co/registration). -[Learn more about {{serverless-full}} in our blog](https://www.elastic.co/blog/elastic-cloud-serverless). +For more details on the available sign up options and trial information, go to [](elastic-cloud/create-an-organization.md). +## Differences between serverless projects and hosted deployments[general-what-is-serverless-elastic-differences-between-serverless-projects-and-hosted-deployments-on-ecloud] -## Benefits of serverless projects [_benefits_of_serverless_projects] +You can have multiple hosted deployments and serverless projects in the same {{ecloud}} organization, and each deployment type has its own specificities. -**Management free.** Elastic manages the underlying Elastic cluster, so you can focus on your data. With serverless projects, Elastic is responsible for automatic upgrades, data backups, and business continuity. - -**Autoscaled.** To meet your performance requirements, the system automatically adjusts to your workloads. For example, when you have a short time spike on the data you ingest, more resources are allocated for that period of time. When the spike is over, the system uses less resources, without any action on your end. - -**Optimized data storage.** Your data is stored in cost-efficient, general storage. A cache layer is available on top of the general storage for recent and frequently queried data that provides faster search speed. The size of the cache layer and the volume of data it holds depend on [settings](elastic-cloud/project-settings.md) that you can configure for each project. - -**Dedicated experiences.** All serverless solutions are built on the Elastic Search Platform and include the core capabilities of the Elastic Stack. They also each offer a distinct experience and specific capabilities that help you focus on your data, goals, and use cases. - -**Pay per usage.** Each serverless project type includes product-specific and usage-based pricing. - -**Data and performance control**. Control your project data and query performance against your project data. * Data. Choose the data you want to ingest and the method to ingest it. By default, data is stored indefinitely in your project, and you define the retention settings for your data streams. * Performance. For granular control over costs and query performance against your project data, serverless projects come with a set of predefined settings you can edit. - - -## Differences between serverless projects and hosted deployments on {{ecloud}} [general-what-is-serverless-elastic-differences-between-serverless-projects-and-hosted-deployments-on-ecloud] - -You can run [hosted deployments](https://www.elastic.co/guide/en/cloud/current/ec-getting-started.html) of the {{stack}} on {{ecloud}}. These hosted deployments provide more provisioning and advanced configuration options. | | | | | --- | --- | --- | @@ -54,39 +40,6 @@ You can run [hosted deployments](https://www.elastic.co/guide/en/cloud/current/e | **Backups** | Projects automatically backed up by Elastic. | Your responsibility with Snapshot & Restore. | | **Data retention** | Editable on data streams. | Index Lifecycle Management. | +## APIs -## Answers to common serverless questions [general-what-is-serverless-elastic-answers-to-common-serverless-questions] - -**Is there migration support between hosted deployments and serverless projects?** - -Migration paths between hosted deployments and serverless projects are currently unsupported. - -**How can I move data to or from serverless projects?** - -We are working on data migration tools! In the interim, [use Logstash](https://www.elastic.co/guide/en/serverless/current/elasticsearch-ingest-data-through-logstash.html) with Elasticsearch input and output plugins to move data to and from serverless projects. - -**How does serverless ensure compatibility between software versions?** - -Connections and configurations are unaffected by upgrades. To ensure compatibility between software versions, quality testing and API versioning are used. - -**Can I convert a serverless project into a hosted deployment, or a hosted deployment into a serverless project?** - -Projects and deployments are based on different architectures, and you are unable to convert. - -**Can I convert a serverless project into a project of a different type?** - -You are unable to convert projects into different project types, but you can create as many projects as you’d like. You will be charged only for your usage. - -**How can I create serverless service accounts?** - -Create API keys for service accounts in your serverless projects. Options to automate the creation of API keys with tools such as Terraform will be available in the future. - -To raise a Support case with Elastic, raise a case for your subscription the same way you do today. In the body of the case, make sure to mention you are working in serverless to ensure we can provide the appropriate support. - -**Where can I learn about pricing for serverless?** - -See serverless pricing information for [Search](https://www.elastic.co/pricing/serverless-search), [Observability](https://www.elastic.co/pricing/serverless-observability), and [Security](https://www.elastic.co/pricing/serverless-security). - -**Can I request backups or restores for my projects?** - -It is not currently possible to request backups or restores for projects, but we are working on data migration tools to better support this. +{{ecloud}} offers APIs to manage your organization and its resources. Check the [{{ecloud}}](https://www.elastic.co/docs/api/doc/cloud/) and [{{ecloud}} serverless](https://www.elastic.co/docs/api/doc/elastic-cloud-serverless/) APIs \ No newline at end of file diff --git a/deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md b/deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md index 4845bc8fc6..8caea9be55 100644 --- a/deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md +++ b/deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md @@ -13,16 +13,16 @@ Plugins extend the core functionality of {{es}}. There are many suitable plugins Plugins can come from different sources: the official ones created or at least maintained by Elastic, community-sourced plugins from other users, and plugins that you provide. Some of the official plugins are always provided with our service, and can be [enabled per deployment](https://www.elastic.co/guide/en/cloud/current/ec-adding-elastic-plugins.html). -There are two ways to add plugins to a deployment in Elasticsearch Service: +There are two ways to add plugins to a hosted deployment in {{ecloud}}: -* [Enable one of the official plugins already available in Elasticsearch Service](https://www.elastic.co/guide/en/cloud/current/ec-adding-elastic-plugins.html). +* [Enable one of the official plugins already available in {{ecloud}}](https://www.elastic.co/guide/en/cloud/current/ec-adding-elastic-plugins.html). * [Upload a custom plugin and then enable it per deployment](upload-custom-plugins-bundles.md). -Custom plugins can include the official {{es}} plugins not provided with Elasticsearch Service, any of the community-sourced plugins, or [plugins that you write yourself](https://www.elastic.co/guide/en/elasticsearch/plugins/current/plugin-authors.html). Uploading custom plugins is available only to Gold, Platinum, and Enterprise subscriptions. For more information, check [Upload custom plugins and bundles](upload-custom-plugins-bundles.md). +Custom plugins can include the official {{es}} plugins not provided with {{ecloud}}, any of the community-sourced plugins, or [plugins that you write yourself](https://www.elastic.co/guide/en/elasticsearch/plugins/current/plugin-authors.html). Uploading custom plugins is available only to Gold, Platinum, and Enterprise subscriptions. For more information, check [Upload custom plugins and bundles](upload-custom-plugins-bundles.md). To learn more about the official and community-sourced plugins, refer to [{{es}} Plugins and Integrations](https://www.elastic.co/guide/en/elasticsearch/plugins/current/index.html). -For a detailed guide with examples of using the Elasticsearch Service API to create, get information about, update, and delete extensions and plugins, check [Managing plugins and extensions through the API](manage-plugins-extensions-through-api.md). +For a detailed guide with examples of using the {{ecloud}} API to create, get information about, update, and delete extensions and plugins, check [Managing plugins and extensions through the API](manage-plugins-extensions-through-api.md). Plugins are not supported for {{kib}}. To learn more, check [Restrictions for {{es}} and {{kib}} plugins](restrictions-known-problems.md#ec-restrictions-plugins). diff --git a/deploy-manage/deploy/elastic-cloud/available-stack-versions.md b/deploy-manage/deploy/elastic-cloud/available-stack-versions.md index 570978c891..c910bdd775 100644 --- a/deploy-manage/deploy/elastic-cloud/available-stack-versions.md +++ b/deploy-manage/deploy/elastic-cloud/available-stack-versions.md @@ -5,7 +5,7 @@ mapped_pages: # Available stack versions [ec-version-policy] -This section describes our version policy for Elasticsearch Service, including: +This section describes our version policy for {{ech}}, including: * [What Elastic Stack versions are available](#ec-version-policy-available) * [When we make new Elastic Stack versions available](#ec-version-policy-new) @@ -18,7 +18,7 @@ This section describes our version policy for Elasticsearch Service, including: Elastic Stack uses a versions code that is constructed of three numbers separated by dots: the leftmost number is the number of the major release, the middle number is the number of the minor release and the rightmost number is the number of the maintenance release (e.g., 8.3.2 means major release 8, minor release 3 and maintenance release 2). -You might sometimes notice additional versions listed in the user interface beyond the versions we currently support and maintain, such as [release candidate builds](#ec-release-builds) and older versions. If a version is listed in the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body), it can be deployed. +You might sometimes notice additional versions listed in the user interface beyond the versions we currently support and maintain, such as [release candidate builds](#ec-release-builds) and older versions. If a version is listed in the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body), it can be deployed. ## New Elastic Stack versions [ec-version-policy-new] @@ -44,7 +44,7 @@ A forced upgrade or restart might become necessary in a situation that: ## Release candidates and cutting-edge releases [ec-release-builds] -Interested in kicking the tires of Elasticsearch releases at the cutting edge? We sometimes make release candidate builds and other cutting-edge releases available in Elasticsearch Service for you to try out. +Interested in kicking the tires of Elasticsearch releases at the cutting edge? We sometimes make release candidate builds and other cutting-edge releases available in {{ecloud}} for you to try out. ::::{warning} Remember that cutting-edge releases are used to test new function fully. These releases might still have issues and might be less stable than the GA version. There’s also no guaranteed upgrade path to the GA version when it becomes available. @@ -58,4 +58,4 @@ Cutting-edge releases do not remain available forever. Once the GA version of El ## Version Policy and Product End of Life [ec-version-policy-eol] -For Elasticsearch Service, we follow the [Elastic Version Maintenance and Support Policy](https://www.elastic.co/support/eol), which defines the support and maintenance policy of the Elastic Stack. +For {{ecloud}}, we follow the [Elastic Version Maintenance and Support Policy](https://www.elastic.co/support/eol), which defines the support and maintenance policy of the Elastic Stack. diff --git a/deploy-manage/deploy/elastic-cloud/aws-marketplace.md b/deploy-manage/deploy/elastic-cloud/aws-marketplace.md index ac3e419d88..044e4dad68 100644 --- a/deploy-manage/deploy/elastic-cloud/aws-marketplace.md +++ b/deploy-manage/deploy/elastic-cloud/aws-marketplace.md @@ -1,27 +1,31 @@ --- +applies_to: + deployment: + ess: ga + serverless: ga mapped_pages: - https://www.elastic.co/guide/en/cloud/current/ec-billing-aws.html --- # AWS Marketplace [ec-billing-aws] -7-Day Free Trial Sign-Up: On the [Elasticsearch Service AWS marketplace page](https://aws.amazon.com/marketplace/pp/prodview-voru33wi6xs7k), click **View purchase options**, sign into your AWS account, then start using Elastic Cloud. +7-Day Free Trial Sign-Up: On the [{{ecloud}} AWS marketplace page](https://aws.amazon.com/marketplace/pp/prodview-voru33wi6xs7k), click **View purchase options**, sign into your AWS account, then start using Elastic Cloud. ::::{tip} The free trial includes provisioning of a single deployment and you are not charged for the first 7 days. Billing starts automatically after the 7-day trial period ends. Get started today! :::: -You can subscribe to Elasticsearch Service directly from the AWS Marketplace. You then have the convenience of viewing your Elasticsearch Service subscription as part of your AWS bill, and you do not have to supply any additional billing information to Elastic. +You can subscribe to {{ecloud}} directly from the AWS Marketplace. You then have the convenience of viewing your {{ecloud}} subscription as part of your AWS bill, and you do not have to supply any additional billing information to Elastic. -Some differences exist when you subscribe to Elasticsearch Service through the AWS Marketplace: +Some differences exist when you subscribe to {{ecloud}} through the AWS Marketplace: * Billing starts automatically after the 7-day trial period. -* Previous Elasticsearch Service accounts cannot be converted to use the AWS Marketplace. If you already have an account, you must use a different email address when you sign up for a subscription through the AWS Marketplace. +* Previous {{ecloud}} accounts cannot be converted to use the AWS Marketplace. If you already have an account, you must use a different email address when you sign up for a subscription through the AWS Marketplace. * Pricing is based on the AWS region, the size of your deployment, as well as some other parameters such as data transfer out, data transfer internode, snapshot storage, and snapshot APIs. For more details, check [Billing Dimensions](../../cloud-organization/billing/cloud-hosted-deployment-billing-dimensions.md). -* The consolidated charges for your Elasticsearch Service subscription display in the AWS Marketplace billing console. It can take a day or two before new charges show up. +* The consolidated charges for your {{ecloud}} subscription display in the AWS Marketplace billing console. It can take a day or two before new charges show up. * Regardless of where your deployment is hosted (visible in the Elastic Cloud console), the AWS Marketplace charges for all AWS regions are metered in US East (Northern Virginia). As a result, US East (Northern Virginia) is listed as the region in the AWS Marketplace console. -* To get a detailed breakdown of your charges by deployment or by product, open the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body) and go to **Account & Billing** > **Usage**. +* To get a detailed breakdown of your charges by deployment or by product, open the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body) and go to **Account & Billing** > **Usage**. * To end your trial or unsubscribe from the service, delete your deployment(s). * Elastic provides different [subscription levels](https://www.elastic.co/subscriptions/cloud). During your 7-day trial you will automatically have an Enterprise level subscription. After the trial you can choose the subscription level. @@ -31,14 +35,14 @@ Some differences exist when you subscribe to Elasticsearch Service through the A Note the following items before you subscribe: * You cannot use an email address that already has an Elastic Cloud account. If you want to use the same account email address with AWS Marketplace billing, you must first change the email address on your existing account before setting up your new AWS Marketplace subscription. For instructions on how to change your email address in Elastic Cloud, check [update your email address](../../../cloud-account/update-your-email-address.md). -* If you want to manage deployments on the existing Elasticsearch Service account with your AWS MP billing account, you must migrate your deployments over to the new MP billing account. To migrate, use a [custom repository](../../tools/snapshot-and-restore/elastic-cloud-hosted.md) to take a snapshot and then restore that snapshot to a new deployment under your AWS Marketplace account. +* If you want to manage deployments on the existing {{ecloud}} account with your AWS MP billing account, you must migrate your deployments over to the new MP billing account. To migrate, use a [custom repository](../../tools/snapshot-and-restore/elastic-cloud-hosted.md) to take a snapshot and then restore that snapshot to a new deployment under your AWS Marketplace account. -## Subscribe to Elasticsearch Service through the AWS Marketplace [ec_subscribe_to_elasticsearch_service_through_the_aws_marketplace] +## Subscribe to {{ecloud}} through the AWS Marketplace [ec_subscribe_to_elasticsearch_service_through_the_aws_marketplace] -To subscribe to Elasticsearch Service through the AWS Marketplace: +To subscribe to {{ecloud}} through the AWS Marketplace: -1. Go to [Elasticsearch Service on the AWS Marketplace](https://aws.amazon.com/marketplace/pp/B01N6YCISK) and click **View purchase options**. +1. Go to [{{ecloud}} on the AWS Marketplace](https://aws.amazon.com/marketplace/pp/B01N6YCISK) and click **View purchase options**. 2. Click **Subscribe** and then **Set Up Your Account** to continue. 3. Follow the steps displayed to complete the signup process. diff --git a/deploy-manage/deploy/elastic-cloud/azure-marketplace-pricing.md b/deploy-manage/deploy/elastic-cloud/azure-marketplace-pricing.md index 75ab51bbdd..d6d381f1d1 100644 --- a/deploy-manage/deploy/elastic-cloud/azure-marketplace-pricing.md +++ b/deploy-manage/deploy/elastic-cloud/azure-marketplace-pricing.md @@ -1,4 +1,8 @@ --- +applies_to: + deployment: + ess: ga + serverless: preview mapped_pages: - https://www.elastic.co/guide/en/cloud/current/ec-azure-marketplace-pricing.html --- diff --git a/deploy-manage/deploy/elastic-cloud/azure-native-isv-service.md b/deploy-manage/deploy/elastic-cloud/azure-native-isv-service.md index d9a5d6f2bd..2b72eae197 100644 --- a/deploy-manage/deploy/elastic-cloud/azure-native-isv-service.md +++ b/deploy-manage/deploy/elastic-cloud/azure-native-isv-service.md @@ -1,4 +1,8 @@ --- +applies_to: + deployment: + ess: ga + serverless: preview mapped_pages: - https://www.elastic.co/guide/en/cloud/current/ec-azure-marketplace-native.html --- @@ -34,7 +38,7 @@ Note the following terms: * **Azure Marketplace SaaS ID**: This is a unique identifier that’s generated one time by Microsoft Commercial Marketplace when a user creates their first Elastic resource (deployment) using the Microsoft Azure (Portal, API, SDK, or Terraform). This is mapped to a User ID and Azure Subscription ID * **{{ecloud}} organization**: An [organization](../../users-roles/cloud-organization.md) is the foundational construct under which everything in {{ecloud}} is grouped and managed. An organization is created as a step during the creation of your first Elastic resource (deployment), whether that’s done through Microsoft Azure (Portal, API, SDK, or Terraform). The initial member of the {{ecloud}} organization can then invite other users. -* **Elastic resource (deployment)**: An {{ecloud}} deployment helps you manage an {{es}} cluster and instances of other Elastic products in one place. You can work with Elastic deployments from within the Azure ecosystem. Multiple users in the {{ecloud}} organization can create different deployments from different Azure subscriptions. They can also create deployments from the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body). +* **Elastic resource (deployment)**: An {{ecloud}} deployment helps you manage an {{es}} cluster and instances of other Elastic products in one place. You can work with Elastic deployments from within the Azure ecosystem. Multiple users in the {{ecloud}} organization can create different deployments from different Azure subscriptions. They can also create deployments from the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body). The following diagram shows the mapping between Microsoft Azure IDs, {{ecloud}} organization IDs, and your Elastic resources (deployments). @@ -185,11 +189,11 @@ $$$azure-integration-prior-cloud-account$$$I already have an {{ecloud}} account, : Yes. If you already have an {{ecloud}} account with the same email address as your Azure account you may need to contact `support@elastic.co`. $$$azure-integration-convert-trial$$$Can I sign up for an {{ecloud}} trial account and then convert to the {{ecloud}} Azure Native ISV Service? -: Yes. You can start a [free Elasticsearch Service trial](https://cloud.elastic.co/registration?page=docs&placement=docs-body) and then convert your account over to Azure. There are a few requirements: +: Yes. You can start a [free {{ecloud}} trial](https://cloud.elastic.co/registration?page=docs&placement=docs-body) and then convert your account over to Azure. There are a few requirements: * Make sure when creating deployments in the trial account you specify Azure as the cloud provider. * To convert your trial to the Azure marketplace you need to create a deployment in the Azure console. Just delete the new deployment if you don’t need it. After you create the new deployment your marketplace subscription is ready. - * Any deployments created during your trial won’t show up in the Azure console, since they weren’t created in Azure, but they are still accessible through the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body) and you are billed for their usage. + * Any deployments created during your trial won’t show up in the Azure console, since they weren’t created in Azure, but they are still accessible through the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body) and you are billed for their usage. $$$azure-integration-azure-tenant$$$Does {{es}} get deployed into my tenant in Azure? @@ -253,7 +257,7 @@ $$$azure-integration-migrate$$$How do I migrate my data from the classic Azure m 6. In the new {{es}} resource, follow the steps in [Restore from a snapshot](../../../manage-data/migrate.md#ec-restore-snapshots) to register the custom snapshot repository from Step 1. 7. In the same set of steps, restore the snapshot data from the snapshot repository that you registered. 8. Confirm the data has moved successfully into your new {{es}} resource on Azure. - 9. To remove the old Azure subscription and the old deployments, go to the [Azure SaaS page](https://portal.azure.com/#blade/HubsExtension/BrowseResourceBlade/resourceType/Microsoft.SaaS%2Fresources) and unsubscribe from the `{{ecloud}} ({{es}})` marketplace subscription. This action triggers the existing deployments termination. + 9. To remove the old Azure subscription and the old deployments, go to the [Azure SaaS page](https://portal.azure.com/#blade/HubsExtension/BrowseResourceBlade/resourceType/Microsoft.SaaS%2Fresources) and unsubscribe from the {{ecloud}} ({{es}}) marketplace subscription. This action triggers the existing deployments termination. $$$azure-integration-no-inbox$$$Can I invite users to my organization, even if they cannot receive emails? @@ -272,7 +276,7 @@ $$$azure-integration-billing-elastic-costs$$$Why can’t I see Elastic resources : The costs associated with Elastic resources (deployments) are reported under unassigned in the Azure Portal. Refer to [Understand your Azure external services charges](https://learn.microsoft.com/en-us/azure/cost-management-billing/understand/understand-azure-marketplace-charges) in the Microsoft Documentation to understand Elastic resources/deployments costs. For granular Elastic resources costs, refer to [Monitor and analyze your acccount usage](../../cloud-organization/billing/monitor-analyze-usage.md). $$$azure-integration-billing-deployments$$$Why don’t I see my individual Elastic resources (deployments) in the Azure Marketplace Invoice? -: The way Azure Marketplace Billing Integration works today, the costs for Elastic resources (deployments) are reported for an {{ecloud}} organization as a single line item, reported against the Marketplace SaaS ID. This includes the Elastic deployments created using the Azure Portal, API, SDK, or CLI, and also the Elastic deployments created directly from the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body) in the respective {{ecloud}} organization. For granular Elastic resources costs refer to [Monitor and analyze your acccount usage](../../cloud-organization/billing/monitor-analyze-usage.md). As well, for more detail refer to [Integrated billing](#ec-azure-integration-billing-summary). +: The way Azure Marketplace Billing Integration works today, the costs for Elastic resources (deployments) are reported for an {{ecloud}} organization as a single line item, reported against the Marketplace SaaS ID. This includes the Elastic deployments created using the Azure Portal, API, SDK, or CLI, and also the Elastic deployments created directly from the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body) in the respective {{ecloud}} organization. For granular Elastic resources costs refer to [Monitor and analyze your acccount usage](../../cloud-organization/billing/monitor-analyze-usage.md). As well, for more detail refer to [Integrated billing](#ec-azure-integration-billing-summary). :::{image} ../../../images/cloud-ec-azure-billing-example.png :alt: Example billing report in the {{ecloud}} console @@ -476,7 +480,7 @@ $$$azure-integration-deployment-failed-traffic-filter$$$My {{ecloud}} deployment Follow these steps to resolve the problem: - 1. Login to the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body). + 1. Login to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body). 2. Go to the [Traffic filters page](https://cloud.elastic.co/deployment-features/traffic-filters). 3. Edit the traffic filter and disable the **Include by default** option. @@ -497,10 +501,10 @@ $$$azure-integration-failed-sso$$$I can’t SSO into my {{ecloud}} deployment. $$$azure-integration-cant-see-deployment$$$I see some deployments in the {{ecloud}} console but not in the Azure Portal. -: Elastic Deployments created using the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body), the [{{es}} Service API](https://www.elastic.co/guide/en/cloud/current/ec-restful-api.html), or the [{{ecloud}} Terraform provider](https://registry.terraform.io/providers/elastic/ec/latest/docs) are only visible through the {{ecloud}} Console. To have the necessary metadata to be visible in the Azure Portal, {{ecloud}} deployments need to be created in Microsoft Azure. +: Elastic Deployments created using the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body), the [{{es}} Service API](https://www.elastic.co/guide/en/cloud/current/ec-restful-api.html), or the [{{ecloud}} Terraform provider](https://registry.terraform.io/providers/elastic/ec/latest/docs) are only visible through the {{ecloud}} Console. To have the necessary metadata to be visible in the Azure Portal, {{ecloud}} deployments need to be created in Microsoft Azure. ::::{note} -Mimicking this metadata by manually adding tags to an {{ecloud}} deployment will not work around this limitation. Instead, it will prevent you from being able to delete the deployment using the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body). +Mimicking this metadata by manually adding tags to an {{ecloud}} deployment will not work around this limitation. Instead, it will prevent you from being able to delete the deployment using the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body). :::: diff --git a/deploy-manage/deploy/elastic-cloud/change-hardware.md b/deploy-manage/deploy/elastic-cloud/change-hardware.md index 85ed6fb9ff..fe313fd819 100644 --- a/deploy-manage/deploy/elastic-cloud/change-hardware.md +++ b/deploy-manage/deploy/elastic-cloud/change-hardware.md @@ -21,7 +21,7 @@ Prerequisites: Follow these steps to migrate to a different instance configuration, replacing the default `$EC_API_KEY` value with your actual API key: 1. From the [list of instance configurations available for each region](https://www.elastic.co/guide/en/cloud/current/ec-regions-templates-instances.html), select the target instance configuration you want to migrate to. -2. Get the deployment update payload from the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body) **Edit** page, by selecting **Equivalent API request**, and store it in a file called `migrate_instance_configuration.json`. +2. Get the deployment update payload from the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body) **Edit** page, by selecting **Equivalent API request**, and store it in a file called `migrate_instance_configuration.json`. Example payload containing relevant data for migrating the hot Elasticsearch tier: diff --git a/deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.md b/deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.md index 189e45bff7..1cc31bd4ff 100644 --- a/deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.md +++ b/deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.md @@ -8,13 +8,13 @@ mapped_pages: An Elastic Cloud deployment includes Elastic Stack components such as Elasticsearch, Kibana, and other features, allowing you to store, search, and analyze your data. You can spin up a proof-of-concept deployment to learn more about what Elastic can do for you. ::::{note} -To explore Elasticsearch Service and its solutions, create your first deployment by following one of these [getting started guides](https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/getting-started-guides.html). If you are instead interested in serverless Elastic Cloud, check the [serverless documentation](https://docs.elastic.co/serverless). +To explore {{ecloud}} and its solutions, create your first deployment by following one of these [getting started guides](https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/getting-started-guides.html). If you are instead interested in serverless Elastic Cloud, check the [serverless documentation](https://docs.elastic.co/serverless). :::: You can also create a deployment using the [Elastic Cloud API](https://www.elastic.co/docs/api/doc/cloud/group/endpoint-deployments). This can be an interesting alternative for more advanced needs, such as for [creating a deployment encrypted with your own key](../../security/encrypt-deployment-with-customer-managed-encryption-key.md). -1. Log in to your [cloud.elastic.co](https://cloud.elastic.co/login) account and select **Create deployment** from the Elasticsearch Service main page: +1. Log in to your [cloud.elastic.co](https://cloud.elastic.co/login) account and select **Create deployment** from the {{ecloud}} main page: :::{image} ../../../images/cloud-ec-login-first-deployment.png :alt: Log in to create a deployment diff --git a/deploy-manage/deploy/elastic-cloud/create-an-organization.md b/deploy-manage/deploy/elastic-cloud/create-an-organization.md index bdbf3f277f..e58731755d 100644 --- a/deploy-manage/deploy/elastic-cloud/create-an-organization.md +++ b/deploy-manage/deploy/elastic-cloud/create-an-organization.md @@ -1,11 +1,16 @@ --- +applies_to: + deployment: + ess: ga + serverless: ga +navigation_title: Sign up mapped_urls: - https://www.elastic.co/guide/en/cloud/current/ec-getting-started-trial.html - https://www.elastic.co/guide/en/serverless/current/general-sign-up-trial.html - https://www.elastic.co/guide/en/cloud/current/ec-getting-started-existing-email.html --- -# Create an organization +# Sign up and create an organization % What needs to be done: Refine @@ -21,4 +26,93 @@ mapped_urls: % Internal links rely on the following IDs being on this page (e.g. as a heading ID, paragraph ID, etc): -$$$general-sign-up-trial-what-is-included-in-my-trial$$$ \ No newline at end of file +$$$general-sign-up-trial-what-is-included-in-my-trial$$$ + +To sign up: + +1. Go to the [Elastic Cloud Sign Up](https://cloud.elastic.co/registration?page=docs&placement=docs-body) page. +2. Choose one of the available sign up methods. You can register with your email address and a password, use a Google or Microsoft account, or [subscribe from a Marketplace](../../../deploy-manage/deploy/elastic-cloud/subscribe-from-marketplace.md). + +:::{note} +You can only belong to one {{ecloud}} organization at a time. If you want to create or join another organization, you must leave the previous one or use a different email address. +::: + +When your first sign up, you create an organization and start with a trial license. + +This organization is the umbrella for all of your Elastic Cloud resources, users, and account settings. Every organization has a unique identifier. Bills are invoiced according to the billing contact and details that you set for your organization. For more details on how to manage your organization, refer to [](/deploy-manage/cloud-organization.md). + + +## Trial information [general-sign-up-trial-what-is-included-in-my-trial] + +Your free 14-day trial includes: + +**One hosted deployment** + +A deployment lets you explore Elastic solutions for Search, Observability, and Security. Trial deployments run on the latest version of the Elastic Stack. They includes 8 GB of RAM spread out over two availability zones, and enough storage space to get you started. If you’re looking to evaluate a smaller workload, you can scale down your trial deployment. Each deployment includes Elastic features such as Maps, SIEM, machine learning, advanced security, and much more. You have some sample data sets to play with and tutorials that describe how to add your own data. + +For more information, check the [{{ech}} documentation](cloud-hosted.md). + +**One serverless project** + +Serverless projects package Elastic Stack features by type of solution: + +* [{{es}}](../../../solutions/search.md) +* [Observability](../../../solutions/observability.md) +* [Security](../../../solutions/security/elastic-security-serverless.md) + +When you create a project, you select the project type applicable to your use case, so only the relevant and impactful applications and features are easily accessible to you. + +::::{note} +During the trial period, you are limited to one active hosted deployment and one active serverless project at a time. When you subscribe, you can create additional deployments and projects. + +:::: + + + +### Trial limitations [general-sign-up-trial-what-limits-are-in-place-during-a-trial] + +During the free 14 day trial, Elastic provides access to one hosted deployment and one serverless project. If all you want to do is try out Elastic, the trial includes more than enough to get you started. During the trial period, some limitations apply. + +**Hosted deployments** + +* You can have one active deployment at a time +* The deployment size is limited to 8GB RAM and approximately 360GB of storage, depending on the specified hardware profile +* Machine learning nodes are available up to 4GB RAM +* Custom {{es}} plugins are not enabled + +For more information, check the [{{ech}} documentation](cloud-hosted.md). + +**Serverless projects** + +* You can have one active serverless project at a time. +* Search Power is limited to 100. This setting only exists in {{es-serverless}} projects +* Search Boost Window is limited to 7 days. This setting only exists in {{es-serverless}} projects +* Scaling is limited for serverless projects in trials. Failures might occur if the workload requires memory or compute beyond what the above search power and search boost window setting limits can provide. + +**Remove limitations** + +Subscribe to [Elastic Cloud](/deploy-manage/cloud-organization/billing/add-billing-details.md) for the following benefits: + +* Increased memory or storage for deployment components, such as {{es}} clusters, machine learning nodes, and APM server. +* As many deployments and projects as you need. +* Third availability zone for your deployments. +* Access to additional features, such as cross-cluster search and cross-cluster replication. + +You can subscribe to Elastic Cloud at any time during your trial. [Billing](../../../deploy-manage/cloud-organization/billing/serverless-project-billing-dimensions.md) starts when you subscribe. To maximize the benefits of your trial, subscribe at the end of the free period. To monitor charges, anticipate future costs, and adjust your usage, check your [account usage](/deploy-manage/cloud-organization/billing/monitor-analyze-usage.md) and [billing history](/deploy-manage/cloud-organization/billing/view-billing-history.md). + + +### Get started with your trial [general-sign-up-trial-how-do-i-get-started-with-my-trial] + +Start by checking out some common approaches for [moving data into Elastic Cloud](https://www.elastic.co/guide/en/cloud/current/ec-cloud-ingest-data.html). + + +### Maintain access to your trial projects and data [general-sign-up-trial-what-happens-at-the-end-of-the-trial] + +When your trial expires, the deployment and project that you created during the trial period are suspended until you subscribe to [Elastic Cloud](/deploy-manage/cloud-organization/billing/add-billing-details.md). When you subscribe, you are able to resume your deployment and serverless project, and regain access to the ingested data. After your trial expires, you have 30 days to subscribe. After 30 days, your deployment, serverless project, and ingested data are permanently deleted. + +If you’re interested in learning more ways to subscribe to Elastic Cloud, don’t hesitate to [contact us](https://www.elastic.co/contact). + + +## How do I get help? [ec_how_do_i_get_help] + +We’re here to help. If you have any questions feel free to reach out to [Support](https://cloud.elastic.co/support). \ No newline at end of file diff --git a/deploy-manage/deploy/elastic-cloud/create-monthly-pay-as-you-go-subscription-on-aws-marketplace.md b/deploy-manage/deploy/elastic-cloud/create-monthly-pay-as-you-go-subscription-on-aws-marketplace.md index 532645aa5e..0c09773676 100644 --- a/deploy-manage/deploy/elastic-cloud/create-monthly-pay-as-you-go-subscription-on-aws-marketplace.md +++ b/deploy-manage/deploy/elastic-cloud/create-monthly-pay-as-you-go-subscription-on-aws-marketplace.md @@ -1,4 +1,8 @@ --- +applies_to: + deployment: + ess: ga + serverless: ga mapped_pages: - https://www.elastic.co/guide/en/cloud/current/ec-aws-marketplace-conversion.html --- diff --git a/deploy-manage/deploy/elastic-cloud/create-monthly-pay-as-you-go-subscription-on-gcp-marketplace.md b/deploy-manage/deploy/elastic-cloud/create-monthly-pay-as-you-go-subscription-on-gcp-marketplace.md index 1569c2dd16..d04022d9bd 100644 --- a/deploy-manage/deploy/elastic-cloud/create-monthly-pay-as-you-go-subscription-on-gcp-marketplace.md +++ b/deploy-manage/deploy/elastic-cloud/create-monthly-pay-as-you-go-subscription-on-gcp-marketplace.md @@ -1,4 +1,8 @@ --- +applies_to: + deployment: + ess: ga + serverless: unavailable mapped_pages: - https://www.elastic.co/guide/en/cloud/current/ec-gcp-marketplace-conversion.html --- diff --git a/deploy-manage/deploy/elastic-cloud/ec-configure-deployment-settings.md b/deploy-manage/deploy/elastic-cloud/ec-configure-deployment-settings.md index 6675c4e493..6b2f9ee6a5 100644 --- a/deploy-manage/deploy/elastic-cloud/ec-configure-deployment-settings.md +++ b/deploy-manage/deploy/elastic-cloud/ec-configure-deployment-settings.md @@ -10,7 +10,7 @@ The following deployment settings are available: ## Cloud provider [ec_cloud_provider] -Selects a cloud platform where your {{es}} clusters and {{kib}} instances will be hosted. Elasticsearch Service currently supports Amazon Web Services (AWS), Google Cloud Platform (GCP), and Microsoft Azure. +Selects a cloud platform where your {{es}} clusters and {{kib}} instances will be hosted. {{ech}} currently supports Amazon Web Services (AWS), Google Cloud Platform (GCP), and Microsoft Azure. ## Region [ec_region] @@ -27,7 +27,7 @@ You can select your cloud platform and region only when you create a new deploym Elastic Cloud deploys Elastic Stack components into a *hardware profile* which provides a unique blend of storage, memory and vCPU. This gives you more flexibility to choose the hardware profile that best fits for your use case. For example, *Compute Optimized* deploys Elasticsearch on virtual hardware that provides high [vCPU](../../monitor/monitoring-data/ec-vcpu-boost-instance.md) which can help search-heavy use cases return queries quickly. -Under the covers, hardware profiles leverage virtualized instances from a cloud provider, such as Amazon Web Services, Google Compute Platform, and Microsoft Azure. You don’t interact with the cloud provider directly, but we do document what we use for your reference. To learn more, check [Elasticsearch Service Hardware](https://www.elastic.co/guide/en/cloud/current/ec-reference-hardware.html). +Under the covers, hardware profiles leverage virtualized instances from a cloud provider, such as Amazon Web Services, Google Compute Platform, and Microsoft Azure. You don’t interact with the cloud provider directly, but we do document what we use for your reference. To learn more, check [{{ech}} Hardware](https://www.elastic.co/guide/en/cloud/current/ec-reference-hardware.html). The components of the Elastic Stack that we support as part of a deployment are called *instances* and include: @@ -49,9 +49,9 @@ Elastic Agent, Beats, and Logstash are components of the Elastic Stack that are Elastic Stack uses a versions code that is constructed of three numbers separated by dots: the leftmost number is the number of the major release, the middle number is the number of the minor release and the rightmost number is the number of the maintenance release (e.g., 8.3.2 means major release 8, minor release 3 and maintenance release 2). -You might sometimes notice additional versions listed in the user interface beyond the versions we currently support and maintain, such as [release candidate builds](available-stack-versions.md#ec-release-builds) and older versions. If a version is listed in the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body), it can be deployed. +You might sometimes notice additional versions listed in the user interface beyond the versions we currently support and maintain, such as [release candidate builds](available-stack-versions.md#ec-release-builds) and older versions. If a version is listed in the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body), it can be deployed. -To learn about how we support {{es}} versions in Elasticsearch Service, check [Version Policy](available-stack-versions.md). +To learn about how we support {{es}} versions in {{ech}}, check [Version Policy](available-stack-versions.md). You can always upgrade {{es}} versions, but you cannot downgrade. To learn more about upgrading versions of {{es}} and best practices for major version upgrades, check [Version Upgrades](../../upgrade/deployment-or-cluster.md). @@ -63,5 +63,5 @@ To create a deployment from a snapshot, select the snapshot source. You need to ## Name [ec_name] -This setting allows you to assign a more human-friendly name to your cluster which will be used for future reference in the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body). Common choices are dev, prod, test, or something more domain specific. +This setting allows you to assign a more human-friendly name to your cluster which will be used for future reference in the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body). Common choices are dev, prod, test, or something more domain specific. diff --git a/deploy-manage/deploy/elastic-cloud/ec-customize-deployment-components.md b/deploy-manage/deploy/elastic-cloud/ec-customize-deployment-components.md index 74ef2a8102..59a672846c 100644 --- a/deploy-manage/deploy/elastic-cloud/ec-customize-deployment-components.md +++ b/deploy-manage/deploy/elastic-cloud/ec-customize-deployment-components.md @@ -15,7 +15,7 @@ Autoscaling reduces some of the manual effort required to manage a deployment by ## {{es}} [ec-cluster-size] -Depending upon how much data you have and what queries you plan to run, you need to select a cluster size that fits your needs. There is no silver bullet for deciding how much memory you need other than simply testing it. The [cluster performance metrics](../../monitor/stack-monitoring.md) in the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body) can tell you if your cluster is sized appropriately. You can also [enable deployment monitoring](../../monitor/stack-monitoring/elastic-cloud-stack-monitoring.md) for more detailed performance metrics. Fortunately, you can change the amount of memory allocated to the cluster later without any downtime for HA deployments. +Depending upon how much data you have and what queries you plan to run, you need to select a cluster size that fits your needs. There is no silver bullet for deciding how much memory you need other than simply testing it. The [cluster performance metrics](../../monitor/stack-monitoring.md) in the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body) can tell you if your cluster is sized appropriately. You can also [enable deployment monitoring](../../monitor/stack-monitoring/elastic-cloud-stack-monitoring.md) for more detailed performance metrics. Fortunately, you can change the amount of memory allocated to the cluster later without any downtime for HA deployments. To change a cluster’s topology, from deployment management, select **Edit deployment** from the **Actions** dropdown. Next, select a storage and RAM setting from the **Size per zone** drop-down list, and save your changes. When downsizing the cluster, make sure to have enough resources to handle the current load, otherwise your cluster will be under stress. @@ -66,7 +66,7 @@ The node capacity you choose is per data center. The reason for this is that the ## Sharding [ec_sharding] -You can review your {{es}} shard activity from Elasticsearch Service. At the bottom of the {{es}} page, you can hover over each part of the shard visualization for specific numbers. +You can review your {{es}} shard activity from the {{ecloud}} Console. When viewing a hosted deployment details, at the bottom of the {{es}} page, you can hover over each part of the shard visualization for specific numbers. :::{image} ../../../images/cloud-ec-shard-activity.gif :alt: Shard activity @@ -82,7 +82,7 @@ Here, you can configure user settings, extensions, and system settings (older v ### User settings [ec-user-settings] -Set specific configuration parameters to change how {{es}} and other Elastic products run. User settings are appended to the appropriate YAML configuration file, but not all settings are supported in Elasticsearch Service. +Set specific configuration parameters to change how {{es}} and other Elastic products run. User settings are appended to the appropriate YAML configuration file, but not all settings are supported in {{ech}} deployments. For more information, refer to [Edit your user settings](edit-stack-settings.md). diff --git a/deploy-manage/deploy/elastic-cloud/ec-customize-deployment.md b/deploy-manage/deploy/elastic-cloud/ec-customize-deployment.md index 09b813ff55..6b6b78e5cd 100644 --- a/deploy-manage/deploy/elastic-cloud/ec-customize-deployment.md +++ b/deploy-manage/deploy/elastic-cloud/ec-customize-deployment.md @@ -11,7 +11,7 @@ You might want to change the configuration of your deployment to: * Increase or decrease capacity by changing the amount of reserved memory and storage for different parts of your deployment. ::::{note} - During the free trial, Elasticsearch Service deployments are restricted to a limited size. You can increase the size of your deployments when your trial is converted to a paid subscription. + During the free trial, {{ech}} deployments are restricted to a limited size. You can increase the size of your deployments when your trial is converted to a paid subscription. :::: * Enable [autoscaling](../../autoscaling.md) so that the available resources for deployment components, such as data tiers and machine learning nodes, adjust automatically as the demands on them change over time. @@ -19,7 +19,7 @@ You might want to change the configuration of your deployment to: * Upgrade to new versions of {{es}}. You can upgrade from one major version to another, such as from 6.8.23 to 7.17.27, or from one minor version to another, such as 6.1 to 6.2. You can’t downgrade versions. * Change what plugins are available on your {{es}} cluster. -With the exception of major version upgrades for Elastic Stack products, Elasticsearch Service can perform configuration changes without having to interrupt your deployment. You can continue searching and indexing. The changes can also be done in bulk. For example: in one action, you can add more memory, upgrade, adjust the number of {{es}} plugins and adjust the number of availability zones. +With the exception of major version upgrades for Elastic Stack products, {{ecloud}} can perform configuration changes without having to interrupt your deployment. You can continue searching and indexing. The changes can also be done in bulk. For example: in one action, you can add more memory, upgrade, adjust the number of {{es}} plugins and adjust the number of availability zones. We perform all of these changes by creating instances with the new configurations that join your existing deployment before removing the old ones. For example: if you are changing your {{es}} cluster configuration, we create new {{es}} nodes, recover your indexes, and start routing requests to the new nodes. Only when all new {{es}} nodes are ready, do we bring down the old ones. @@ -32,8 +32,8 @@ If you use a Platform-as-a-Service provider like Heroku, the administration cons To change your deployment: -1. Log in to the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body). -2. Find your deployment on the home page in the Elasticsearch Service card and select **Manage** to access it directly. Or, select **Hosted deployments** to go to the deployments page to view all of your deployments. +1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body). +2. Find your deployment on the home page in the **Hosted deployments** card and select **Manage** to access it directly. Or, select **Hosted deployments** to go to the deployments page to view all of your deployments. On the deployments page you can narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list. diff --git a/deploy-manage/deploy/elastic-cloud/ech-aws-instance-configuration.md b/deploy-manage/deploy/elastic-cloud/ech-aws-instance-configuration.md index 558752080e..96fc49c0e1 100644 --- a/deploy-manage/deploy/elastic-cloud/ech-aws-instance-configuration.md +++ b/deploy-manage/deploy/elastic-cloud/ech-aws-instance-configuration.md @@ -41,7 +41,7 @@ The new configuration naming convention aligns with the [data tiers](https://www | aws.es.datawarm.i3en, aws.es.datacold.i3en | These configurations maintain the same type of VM configuration as used in the previous config (“aws.data.highstorage.i3en”) but will have a new name (and billing SKU) that is consistent with the new naming. | | aws.es.datafrozen.i3en | This configuration maintains the same type of VM configuration as defined for (“aws.es.datacold.i3en”) config. | -For a detailed price list, check the [Elastic Cloud price list](https://cloud.elastic.co/deployment-pricing-table?provider=aws). For a detailed specification of the new configurations, check [Elasticsearch Service default provider instance configurations](ech-default-aws-configurations.md). +For a detailed price list, check the [Elastic Cloud price list](https://cloud.elastic.co/deployment-pricing-table?provider=aws). For a detailed specification of the new configurations, check [{{ecloud}} default provider instance configurations](ech-default-aws-configurations.md). The benefits of the new configurations are multifold: diff --git a/deploy-manage/deploy/elastic-cloud/ech-azure-instance-configuration.md b/deploy-manage/deploy/elastic-cloud/ech-azure-instance-configuration.md index 01602c7b2a..bf493d15fe 100644 --- a/deploy-manage/deploy/elastic-cloud/ech-azure-instance-configuration.md +++ b/deploy-manage/deploy/elastic-cloud/ech-azure-instance-configuration.md @@ -37,7 +37,7 @@ The new configuration naming convention aligns with the [data tiers](https://www | azure.es.datawarm.edsv4, azure.es.datacold.edsv4 | This is a new configuration that replaces “azure.data.highstorage.e16sv3” config but provides more disk space. | | azure.es.datafrozen.edsv4 | This is a new configuration that replaces “azure.es.datafrozen.lsv2” or “azure.es.datafrozen.esv3” config but provides more disk space. | -For a detailed price list, check the [Elastic Cloud price list](https://cloud.elastic.co/deployment-pricing-table?provider=azure). For a detailed specification of the new configurations, check [Elasticsearch Service default Azure instance configurations](ech-default-azure-configurations.md). +For a detailed price list, check the [Elastic Cloud price list](https://cloud.elastic.co/deployment-pricing-table?provider=azure). For a detailed specification of the new configurations, check [{{ecloud}} default Azure instance configurations](ech-default-azure-configurations.md). The benefits of the new configurations are multifold: diff --git a/deploy-manage/deploy/elastic-cloud/ech-gcp-instance-configuration.md b/deploy-manage/deploy/elastic-cloud/ech-gcp-instance-configuration.md index 732721ef58..6db3a701e4 100644 --- a/deploy-manage/deploy/elastic-cloud/ech-gcp-instance-configuration.md +++ b/deploy-manage/deploy/elastic-cloud/ech-gcp-instance-configuration.md @@ -39,7 +39,7 @@ The new configuration naming convention aligns with the [data tiers](https://www | gcp.es.datawarm.n2.68x10x190, gcp.es.datacold.n2.68x10x190 | These configurations replace “highstorage”, which is based on N1 with 1:160 RAM:disk and similar RAM:CPU ratios. | | gcp.es.datafrozen.n2.68x10x95 | This configuration replaces the (short lived) gcp.es.datafrozen.n2d.64x8x95 configuration we used for the frozen cache tier. n2d was based on the AMC epyc processor but we found that the Intel-based configuration provides a slightly better cost/performance ratio. We also tweaked the RAM/CPU ratios to align to other configurations and benchmarks. | -For a detailed price list, check the [Elastic Cloud deployment pricing table](https://cloud.elastic.co/deployment-pricing-table?provider=gcp). For a detailed specification of the new configurations, check [Elasticsearch Service default GCP instance configurations](ech-default-gcp-configurations.md). +For a detailed price list, check the [Elastic Cloud deployment pricing table](https://cloud.elastic.co/deployment-pricing-table?provider=gcp). For a detailed specification of the new configurations, check [{{ecloud}} default GCP instance configurations](ech-default-gcp-configurations.md). The benefits of the new configurations are multifold: diff --git a/deploy-manage/deploy/elastic-cloud/ech-get-help.md b/deploy-manage/deploy/elastic-cloud/ech-get-help.md index 2b52a94fbf..3c359d9069 100644 --- a/deploy-manage/deploy/elastic-cloud/ech-get-help.md +++ b/deploy-manage/deploy/elastic-cloud/ech-get-help.md @@ -46,7 +46,7 @@ Elasticsearch Add-On for Heroku Gold and Platinum subscriptions : Support is handled by email or through the Elastic Support Portal. Provides guaranteed response times for support issues, better support coverage hours, and support contacts at Elastic. Also includes support for how-to and development questions. The exact support coverage depends on whether you are a Gold or Platinum customer. To learn more, check [Elasticsearch Add-On for Heroku Premium Support Services Policy](https://www.elastic.co/legal/support_policy/cloud_premium). ::::{note} -If you are in free trial, you are also eligible to get the Elasticsearch Service Standard level support for as long as the trial is active. +If you are in free trial, you are also eligible to get the {{ecloud}} Standard level support for as long as the trial is active. :::: diff --git a/deploy-manage/deploy/elastic-cloud/ech-getting-started.md b/deploy-manage/deploy/elastic-cloud/ech-getting-started.md index 0ee816c333..31baccf874 100644 --- a/deploy-manage/deploy/elastic-cloud/ech-getting-started.md +++ b/deploy-manage/deploy/elastic-cloud/ech-getting-started.md @@ -3,11 +3,11 @@ mapped_pages: - https://www.elastic.co/guide/en/cloud-heroku/current/ech-getting-started.html --- -# Introducing Elasticsearch Add-On for Heroku [ech-getting-started] +# Elasticsearch Add-On for Heroku [ech-getting-started] This documentation applies to Heroku users who want to make use of the Elasticsearch Add-On for Heroku that is available from the [Heroku Dashboard](https://dashboard.heroku.com/) or that can be installed from the CLI. -The add-on runs on the Elasticsearch Service and provides access to [Elasticsearch](https://www.elastic.co/products/elasticsearch), the open source, distributed, RESTful search engine. Many other features of the Elastic Stack are also readily available to Heroku users through the [Elasticsearch Add-On for Heroku console](https://cloud.elastic.co?page=docs&placement=docs-body) after you install the add-on. For example, you can use Kibana to visualize your Elasticsearch data. +The add-on runs on {{ecloud}} and provides access to [Elasticsearch](https://www.elastic.co/products/elasticsearch), the open source, distributed, RESTful search engine. Many other features of the Elastic Stack are also readily available to Heroku users through the [Elasticsearch Add-On for Heroku console](https://cloud.elastic.co?page=docs&placement=docs-body) after you install the add-on. For example, you can use Kibana to visualize your Elasticsearch data. [Elasticsearch Machine Learning](https://www.elastic.co/guide/en/machine-learning/current/index.html), [Elastic APM](/solutions/observability/apps/application-performance-monitoring-apm.md) and [Elastic Fleet Server](https://www.elastic.co/guide/en/fleet/current/fleet-overview.html) are not supported by the Elasticsearch Add-On for Heroku. diff --git a/deploy-manage/deploy/elastic-cloud/ech-restrictions.md b/deploy-manage/deploy/elastic-cloud/ech-restrictions.md index 480b776d8e..583fb4fbef 100644 --- a/deploy-manage/deploy/elastic-cloud/ech-restrictions.md +++ b/deploy-manage/deploy/elastic-cloud/ech-restrictions.md @@ -28,7 +28,7 @@ To learn more about the features that are supported by Elasticsearch Add-On for ## Elasticsearch Add-On for Heroku [ech-restrictions-heroku] -Not all features of our Elasticsearch Service are available to Heroku users. Specifically, you cannot create additional deployments or use different deployment templates. +Not all features of {{ecloud}} are available to Heroku users. Specifically, you cannot create additional deployments or use different deployment templates. Generally, if a feature is shown as available in the [Elasticsearch Add-On for Heroku console](https://cloud.elastic.co?page=docs&placement=docs-body), you can use it. diff --git a/deploy-manage/deploy/elastic-cloud/ech-version-policy.md b/deploy-manage/deploy/elastic-cloud/ech-version-policy.md index 2ee4d36e7b..296fab293f 100644 --- a/deploy-manage/deploy/elastic-cloud/ech-version-policy.md +++ b/deploy-manage/deploy/elastic-cloud/ech-version-policy.md @@ -58,4 +58,4 @@ Cutting-edge releases do not remain available forever. Once the GA version of El ## Version Policy and Product End of Life [ech-version-policy-eol] -For Elasticsearch Service, we follow the [Elastic Version Maintenance and Support Policy](https://www.elastic.co/support/eol), which defines the support and maintenance policy of the Elastic Stack. +For {{ecloud}}, we follow the [Elastic Version Maintenance and Support Policy](https://www.elastic.co/support/eol), which defines the support and maintenance policy of the Elastic Stack. diff --git a/deploy-manage/deploy/elastic-cloud/find-cloud-id.md b/deploy-manage/deploy/elastic-cloud/find-cloud-id.md index 1dceab74e5..cb450dedfd 100644 --- a/deploy-manage/deploy/elastic-cloud/find-cloud-id.md +++ b/deploy-manage/deploy/elastic-cloud/find-cloud-id.md @@ -5,15 +5,15 @@ mapped_pages: # Find your Cloud ID [ec-cloud-id] -The Cloud ID reduces the number of steps required to start sending data from Beats or Logstash to your hosted Elasticsearch cluster on Elasticsearch Service. Because we made it easier to send data, you can start exploring visualizations in Kibana on Elasticsearch Service that much more quickly. +The Cloud ID reduces the number of steps required to start sending data from Beats or Logstash to your hosted Elasticsearch cluster on {{ecloud}}. Because we made it easier to send data, you can start exploring visualizations in Kibana on {{ecloud}} that much more quickly. :::{image} ../../../images/cloud-ec-ce-cloud-id-beats-logstash.png :alt: Exploring data from Beats or Logstash in Kibana after sending it to a hosted Elasticsearch cluster ::: -The Cloud ID works by assigning a unique ID to your hosted Elasticsearch cluster on Elasticsearch Service. All deployments automatically get a Cloud ID. +The Cloud ID works by assigning a unique ID to your hosted Elasticsearch cluster on {{ecloud}}. All deployments automatically get a Cloud ID. -You include your Cloud ID along with your Elasticsearch Service user credentials (defined in `cloud.auth`) when you run Beats or Logstash locally, and then let Elasticsearch Service handle all of the remaining connection details to send the data to your hosted cluster on Elasticsearch Service safely and securely. +You include your Cloud ID along with your {{ecloud}} user credentials (defined in `cloud.auth`) when you run Beats or Logstash locally, and then let {{ecloud}} handle all of the remaining connection details to send the data to your hosted cluster on {{ecloud}} safely and securely. :::{image} ../../../images/cloud-ec-ce-cloud-id.png :alt: The Cloud ID and `elastic` user information shown when you create a deployment @@ -24,8 +24,8 @@ You include your Cloud ID along with your Elasticsearch Service user credentials Not sure why you need Beats or Logstash? Here’s what they do: -* [Beats](https://www.elastic.co/products/beats) is our open source platform for single-purpose data shippers. The purpose of Beats is to help you gather data from different sources and to centralize the data by shipping it to Elasticsearch. Beats install as lightweight agents and ship data from hundreds or thousands of machines to your hosted Elasticsearch cluster on Elasticsearch Service. If you want more processing muscle, Beats can also ship to Logstash for transformation and parsing before the data gets stored in Elasticsearch. -* [Logstash](https://www.elastic.co/products/logstash) is an open source, server-side data processing pipeline that ingests data from a multitude of sources simultaneously, transforms it, and then sends it to your favorite place where you stash things, here your hosted Elasticsearch cluster on Elasticsearch Service. Logstash supports a variety of inputs that pull in events from a multitude of common sources — logs, metrics, web applications, data stores, and various AWS services — all in continuous, streaming fashion. +* [Beats](https://www.elastic.co/products/beats) is our open source platform for single-purpose data shippers. The purpose of Beats is to help you gather data from different sources and to centralize the data by shipping it to Elasticsearch. Beats install as lightweight agents and ship data from hundreds or thousands of machines to your hosted Elasticsearch cluster on {{ecloud}}. If you want more processing muscle, Beats can also ship to Logstash for transformation and parsing before the data gets stored in Elasticsearch. +* [Logstash](https://www.elastic.co/products/logstash) is an open source, server-side data processing pipeline that ingests data from a multitude of sources simultaneously, transforms it, and then sends it to your favorite place where you stash things, here your hosted Elasticsearch cluster on {{ecloud}}. Logstash supports a variety of inputs that pull in events from a multitude of common sources — logs, metrics, web applications, data stores, and various AWS services — all in continuous, streaming fashion. ## Before you begin [ec_before_you_begin_3] @@ -45,16 +45,16 @@ To use the Cloud ID, you need: ## Configure Beats with your Cloud ID [ec-cloud-id-beats] -The following example shows how you can send operational data from Metricbeat to Elasticsearch Service by using the Cloud ID. Any of the available Beats will work, but we had to pick one for this example. +The following example shows how you can send operational data from Metricbeat to {{ecloud}} by using the Cloud ID. Any of the available Beats will work, but we had to pick one for this example. ::::{tip} For others, you can learn more about [getting started](https://www.elastic.co/guide/en/beats/libbeat/current/getting-started.html) with each Beat. :::: -To get started with Metricbeat and Elasticsearch Service: +To get started with Metricbeat and {{ecloud}}: -1. Log in to the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body). +1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body). 2. [Create a new deployment](create-an-elastic-cloud-hosted-deployment.md) and copy down the password for the `elastic` user. 3. On the deployment overview page, copy down the Cloud ID. 4. Set up the Beat of your choice, such as [Metricbeat version 7.17](https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-installation-configuration.html). diff --git a/deploy-manage/deploy/elastic-cloud/google-cloud-platform-marketplace.md b/deploy-manage/deploy/elastic-cloud/google-cloud-platform-marketplace.md index 33c5f5b46e..3401b3fd41 100644 --- a/deploy-manage/deploy/elastic-cloud/google-cloud-platform-marketplace.md +++ b/deploy-manage/deploy/elastic-cloud/google-cloud-platform-marketplace.md @@ -1,34 +1,38 @@ --- +applies_to: + deployment: + ess: ga + serverless: unavailable mapped_pages: - https://www.elastic.co/guide/en/cloud/current/ec-billing-gcp.html --- # Google Cloud Platform Marketplace [ec-billing-gcp] -Subscribe to Elasticsearch Service directly from the Google Cloud Platform (GCP). You then have the convenience of viewing your Elasticsearch Service subscription as part of your GCP bill, and you do not have to supply any additional credit card information to Elastic. +Subscribe to {{ecloud}} directly from the Google Cloud Platform (GCP). You then have the convenience of viewing your {{ecloud}} subscription as part of your GCP bill, and you do not have to supply any additional credit card information to Elastic. -Some differences exist when you subscribe to Elasticsearch Service through the GCP Marketplace: +Some differences exist when you subscribe to {{ecloud}} through the GCP Marketplace: -* There is no trial period. Billing starts when you subscribe to Elasticsearch Service. -* Existing Elasticsearch Service organizations cannot be converted to use the GCP Marketplace. -* Pricing for an Elasticsearch Service subscription through the GCP Marketplace follows the pricing outlined on the [Elasticsearch Service on Elastic Cloud](https://console.cloud.google.com/marketplace/product/endpoints/elasticsearch-service.gcpmarketplace.elastic.co) page in the GCP Marketplace. Pricing is based the Elastic Cloud [Billing Dimensions](../../cloud-organization/billing/cloud-hosted-deployment-billing-dimensions.md). +* There is no trial period. Billing starts when you subscribe to {{ecloud}}. +* Existing {{ecloud}} organizations cannot be converted to use the GCP Marketplace. +* Pricing for an {{ecloud}} subscription through the GCP Marketplace follows the pricing outlined on the [Elastic Cloud](https://console.cloud.google.com/marketplace/product/endpoints/elasticsearch-service.gcpmarketplace.elastic.co) page in the GCP Marketplace. Pricing is based the Elastic Cloud [Billing Dimensions](../../cloud-organization/billing/cloud-hosted-deployment-billing-dimensions.md). * To access your billing information at any time go to **Account & Billing**. You can also go to **Account & Billing** and then **Usage** to view your usage hours and units per hour. ::::{important} -Only one Elasticsearch Service organization can be subscribed through GCP Marketplace per GCP billing account. +Only one {{ecloud}} organization can be subscribed through GCP Marketplace per GCP billing account. :::: -To subscribe to Elasticsearch Service through the GCP Marketplace: +To subscribe to {{ecloud}} through the GCP Marketplace: 1. Log in to your Google Cloud Platform account. -2. Go to the [Elastic Cloud (Elasticsearch Service)](https://console.cloud.google.com/marketplace/product/elastic-prod/elastic-cloud) page in the GCP Marketplace. +2. Go to the [Elastic Cloud](https://console.cloud.google.com/marketplace/product/elastic-prod/elastic-cloud) page in the GCP Marketplace. 3. On the Elastic Cloud page select **Subscribe**, where you will be directed to another page. There is only one plan—the Elastic plan—and it’s pre-selected. The billing account you are logged into will be pre-selected for this purchase, though you can change it at this time. 4. Accept the terms of service (TOS) and select **Subscribe**. 5. When you are presented with a pop-up that specifies that "Your order request has been sent to Elastic" choose **Sign up with Elastic** to continue. 6. After choosing to sign up, a new window will appear. Do one of the following: - * Create a new, unique user account for an Elasticsearch Service Elastic Cloud organization. + * Create a new, unique user account for an {{ecloud}} Elastic Cloud organization. * Log in with an existing user account that’s associated with an Elastic Cloud trial. This links the billing account used for the purchase on GCP Marketplace to the existing Elastic organization. 7. After signing up, check your inbox to verify the email address you signed up with. Upon verification, you will be asked to create a password, and once created your organization will be set up and you will be logged into it. @@ -56,12 +60,12 @@ To prevent downtime, do not remove the currently used billing account before the :::: -Elasticsearch Service subscriptions through GCP Marketplace are associated with a GCP billing account. In order to change the billing account associated with an Elasticsearch Service organization: +{{ecloud}} subscriptions through GCP Marketplace are associated with a GCP billing account. In order to change the billing account associated with an {{ecloud}} organization: * for customers under a Private Offer contract: please reach out to Elastic support and provide the GCP Billing Account, as well as the contact of any reseller information for approval. * for pay-as-you-go customers: you need to have purchased and subscribed to Elastic Cloud on the new billing account using the details above—but do not create a new Elastic user or organization (that is, you can skip Steps 5 and 6 in the subscription instructions, above). Once you successfully subscribed with the new billing account, you can contact Elastic support and provide the new billing account ID you wish to move to, which you can find from [GCP’s billing page](https://console.cloud.google.com/billing). The ID is in the format `000000-000000-000000`. -If you cancel your Elasticsearch Service order on GCP through the [marketplace orders page](https://console.cloud.google.com/marketplace/orders) before the switch to the new billing account has been done, any running deployments will immediately enter a degraded state known as maintenance mode and they will be scheduled for termination in five days. +If you cancel your {{ecloud}} order on GCP through the [marketplace orders page](https://console.cloud.google.com/marketplace/orders) before the switch to the new billing account has been done, any running deployments will immediately enter a degraded state known as maintenance mode and they will be scheduled for termination in five days. If you already unsubscribed before the new billing account has been set up, you can subscribe again from the previously used billing account, which will cancel the termination and restore the deployments to a functional state. diff --git a/deploy-manage/deploy/elastic-cloud/heroku.md b/deploy-manage/deploy/elastic-cloud/heroku.md index c5bf8bbe7f..228d0dc7fd 100644 --- a/deploy-manage/deploy/elastic-cloud/heroku.md +++ b/deploy-manage/deploy/elastic-cloud/heroku.md @@ -4,7 +4,7 @@ mapped_urls: - https://www.elastic.co/guide/en/cloud-heroku/current/ech-about.html --- -# Heroku +# Elasticsearch Add-On for Heroku [ech-getting-started] % What needs to be done: Refine @@ -17,9 +17,10 @@ mapped_urls: % - [ ] ./raw-migrated-files/cloud/cloud-heroku/ech-getting-started.md % - [ ] ./raw-migrated-files/cloud/cloud-heroku/ech-about.md -⚠️ **This page is a work in progress.** ⚠️ +This documentation applies to Heroku users who want to make use of the Elasticsearch Add-On for Heroku that is available from the [Heroku Dashboard](https://dashboard.heroku.com/) or that can be installed from the CLI. -The documentation team is working to combine content pulled from the following pages: +The add-on runs on {{ecloud}} and provides access to [Elasticsearch](https://www.elastic.co/products/elasticsearch), the open source, distributed, RESTful search engine. Many other features of the Elastic Stack are also readily available to Heroku users through the [Elasticsearch Add-On for Heroku console](https://cloud.elastic.co?page=docs&placement=docs-body) after you install the add-on. For example, you can use Kibana to visualize your Elasticsearch data. -* [/raw-migrated-files/cloud/cloud-heroku/ech-getting-started.md](/raw-migrated-files/cloud/cloud-heroku/ech-getting-started.md) -* [/raw-migrated-files/cloud/cloud-heroku/ech-about.md](/raw-migrated-files/cloud/cloud-heroku/ech-about.md) \ No newline at end of file +[Elasticsearch Machine Learning](https://www.elastic.co/guide/en/machine-learning/current/index.html), [Elastic APM](/solutions/observability/apps/application-performance-monitoring-apm.md) and [Elastic Fleet Server](https://www.elastic.co/guide/en/fleet/current/fleet-overview.html) are not supported by the Elasticsearch Add-On for Heroku. + +To learn more about what plans are available for Heroku users and their cost, check the [Elasticsearch add-on](https://elements.heroku.com/addons/foundelasticsearch) in the Elements Marketplace. \ No newline at end of file diff --git a/deploy-manage/deploy/elastic-cloud/manage-deployments-using-elastic-cloud-api.md b/deploy-manage/deploy/elastic-cloud/manage-deployments-using-elastic-cloud-api.md index 1de40f136f..5ac6176e1b 100644 --- a/deploy-manage/deploy/elastic-cloud/manage-deployments-using-elastic-cloud-api.md +++ b/deploy-manage/deploy/elastic-cloud/manage-deployments-using-elastic-cloud-api.md @@ -10,7 +10,7 @@ The following examples demonstrate Create, Read, Update and Delete operations on ## Listing your deployments [ec_listing_your_deployments] -List the details about all of your Elasticsearch Service deployments. +List the details about all of your {{ech}} deployments. ```sh curl \ @@ -271,14 +271,14 @@ curl -XPOST \ ::::{tip} -You can get the payload easily from the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body) **Create Deployment** page, customize the regions, zones, memory allocated for each components, and then select **Equivalent API request**. +You can get the payload easily from the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body) **Create Deployment** page, customize the regions, zones, memory allocated for each components, and then select **Equivalent API request**. :::: ## Using the API to create deployment with non EOL versions [ec_using_the_api_to_create_deployment_with_non_eol_versions] -You are able to create deployments with *non* [End-of-life (EOL) versions](available-stack-versions.md#ec-version-policy-eol) via API, which are not selectable in the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body) UI. You can simply replace the version number in the above example. +You are able to create deployments with *non* [End-of-life (EOL) versions](available-stack-versions.md#ec-version-policy-eol) via API, which are not selectable in the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body) UI. You can simply replace the version number in the above example. ## Update a deployment [ec_update_a_deployment] @@ -343,7 +343,7 @@ curl -XPUT \ ::::{tip} -You can get the payload easily from the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body) deployment **Edit** page, customize the zone count, memory allocated for each components, and then select **Equivalent API request**. +You can get the payload easily from the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body) deployment **Edit** page, customize the zone count, memory allocated for each components, and then select **Equivalent API request**. :::: diff --git a/deploy-manage/deploy/elastic-cloud/manage-integrations-server.md b/deploy-manage/deploy/elastic-cloud/manage-integrations-server.md index 7fde6a5748..0b7c9dd6dc 100644 --- a/deploy-manage/deploy/elastic-cloud/manage-integrations-server.md +++ b/deploy-manage/deploy/elastic-cloud/manage-integrations-server.md @@ -20,13 +20,13 @@ From the deployment **Integrations Server** page you can also: * Fully remove the Integrations Server, delete it from the disk, and stop the charges. ::::{important} -The APM secret token can no longer be reset from the Elasticsearch Service UI. Check [Secret token](/solutions/observability/apps/secret-token.md) for instructions on managing a secret token. Note that resetting the token disrupts your APM service and restarts the server. When the server restarts, you’ll need to update all of your agents with the new token. +The APM secret token can no longer be reset from the {{ecloud}} UI. Check [Secret token](/solutions/observability/apps/secret-token.md) for instructions on managing a secret token. Note that resetting the token disrupts your APM service and restarts the server. When the server restarts, you’ll need to update all of your agents with the new token. :::: ## Enable Integrations Server through the API [ec-integrations-server-api-example] -This example demonstrates how to use the Elasticsearch Service RESTful API to create a deployment with Integrations Server enabled. +This example demonstrates how to use the {{ecloud}} RESTful API to create a deployment with Integrations Server enabled. For more information on how to manage Integrations Server from the UI, check [Manage your Integrations Server]() diff --git a/deploy-manage/deploy/elastic-cloud/manage-plugins-extensions-through-api.md b/deploy-manage/deploy/elastic-cloud/manage-plugins-extensions-through-api.md index 53b3e72a4f..021163b7e6 100644 --- a/deploy-manage/deploy/elastic-cloud/manage-plugins-extensions-through-api.md +++ b/deploy-manage/deploy/elastic-cloud/manage-plugins-extensions-through-api.md @@ -5,7 +5,7 @@ mapped_pages: # Manage plugins and extensions through the API [ec-plugins-guide] -This guide provides a full list of tasks for managing [plugins and extensions](add-plugins-extensions.md) in Elasticsearch Service, using the API. +This guide provides a full list of tasks for managing [plugins and extensions](add-plugins-extensions.md) in {{ecloud}}, using the API. * [Create an extension](#ec-extension-guide-create) * [Add an extension to a deployment plan](#ec-extension-guide-add-plan) diff --git a/deploy-manage/deploy/elastic-cloud/restrictions-known-problems.md b/deploy-manage/deploy/elastic-cloud/restrictions-known-problems.md index 0547b1e9a9..c2751f1b82 100644 --- a/deploy-manage/deploy/elastic-cloud/restrictions-known-problems.md +++ b/deploy-manage/deploy/elastic-cloud/restrictions-known-problems.md @@ -1,30 +1,36 @@ --- +applies_to: + deployment: + ess: ga + serverless: ga mapped_pages: - https://www.elastic.co/guide/en/cloud/current/ec-restrictions.html --- # Restrictions and known problems [ec-restrictions] -When using Elasticsearch Service, there are some limitations you should be aware of: +When using {{ecloud}}, there are some limitations you should be aware of: * [Security](#ec-restrictions-security) * [APIs](#ec-restrictions-apis) * [Transport client](#ec-restrictions-transport-client) * [Elasticsearch and Kibana plugins](#ec-restrictions-plugins) * [Watcher](#ec-restrictions-watcher) +* [Private Link and SSO to Kibana URLs](#ec-restrictions-traffic-filters-kibana-sso) +* [PDF report generation using Alerts or Watcher webhooks](#ec-restrictions-traffic-filters-watcher) * [Kibana](#ec-restrictions-kibana) -* [APM Agent central configuration with Private Link or traffic filters](#ec-restrictions-apm-traffic-filters) +% * [APM Agent central configuration with Private Link or traffic filters](#ec-restrictions-apm-traffic-filters) * [Fleet with Private Link or traffic filters](#ec-restrictions-fleet-traffic-filters) * [Restoring a snapshot across deployments](#ec-snapshot-restore-enterprise-search-kibana-across-deployments) * [Migrate Fleet-managed {{agents}} across deployments by restoring a snapshot](#ec-migrate-elastic-agent) * [Regions and Availability Zones](#ec-regions-and-availability-zone) -* [Known problems](#ec-known-problems) +% * [Known problems](#ec-known-problems) For limitations related to logging and monitoring, check the [Restrictions and limitations](../../monitor/stack-monitoring/elastic-cloud-stack-monitoring.md#ec-restrictions-monitoring) section of the logging and monitoring page. -Occasionally, we also publish information about [Known problems](#ec-known-problems) with our Elasticsearch Service or the Elastic Stack. +% Occasionally, we also publish information about [Known problems](#ec-known-problems) with our {{ecloud}} or the Elastic Stack. -To learn more about the features that are supported by Elasticsearch Service, check [Elastic Cloud Subscriptions](https://www.elastic.co/cloud/elasticsearch-service/subscriptions?page=docs&placement=docs-body). +To learn more about the features that are supported by {{ecloud}}, check [Elastic Cloud Subscriptions](https://www.elastic.co/cloud/elasticsearch-service/subscriptions?page=docs&placement=docs-body). ## Security [ec-restrictions-security] @@ -36,36 +42,36 @@ To learn more about the features that are supported by Elasticsearch Service, ch ## APIs [ec-restrictions-apis] -The following restrictions apply when using APIs in Elasticsearch Service: +The following restrictions apply when using APIs in {{ecloud}}: -Elasticsearch Service API -: The Elasticsearch Service API is subject to a restriction on the volume of API requests that can be submitted per user, per second. Check [Rate limiting](https://www.elastic.co/guide/en/cloud/current/ec-api-rate-limiting.html) for details. +{{ecloud}} API +: The {{ecloud}} API is subject to a restriction on the volume of API requests that can be submitted per user, per second. Check [Rate limiting](https://www.elastic.co/guide/en/cloud/current/ec-api-rate-limiting.html) for details. $$$ec-restrictions-apis-elasticsearch$$$ Elasticsearch APIs -: The Elasticsearch APIs do not natively enforce rate limiting. However, all requests to the Elasticsearch cluster are subject to Elasticsearch configuration settings, such as the [network HTTP setting](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-network.html#http-settings) `http:max_content_length` which restricts the maximum size of an HTTP request body. This setting has a default value of 100MB, hence restricting API request payloads to that size. This setting is not currently configurable in Elasticsearch Service. For a list of which Elasticsearch settings are supported on Cloud, check [Add Elasticsearch user settings](edit-stack-settings.md). To learn about using the Elasticsearch APIs in Elasticsearch Service, check [Access the Elasticsearch API console](https://www.elastic.co/guide/en/cloud/current/ec-api-console.html). And, for full details about the Elasticsearch APIs and their endpoints, check the [Elasticsearch API reference documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/rest-apis.html). +: The Elasticsearch APIs do not natively enforce rate limiting. However, all requests to the Elasticsearch cluster are subject to Elasticsearch configuration settings, such as the [network HTTP setting](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-network.html#http-settings) `http:max_content_length` which restricts the maximum size of an HTTP request body. This setting has a default value of 100MB, hence restricting API request payloads to that size. This setting is not currently configurable in {{ecloud}}. For a list of which Elasticsearch settings are supported on Cloud, check [Add Elasticsearch user settings](edit-stack-settings.md). To learn about using the Elasticsearch APIs in {{ecloud}}, check [Access the Elasticsearch API console](https://www.elastic.co/guide/en/cloud/current/ec-api-console.html). And, for full details about the Elasticsearch APIs and their endpoints, check the [Elasticsearch API reference documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/rest-apis.html). $$$ec-restrictions-apis-kibana$$$ Kibana APIs -: There are no rate limits restricting your use of the Kibana APIs. However, Kibana features are affected by the [Kibana configuration settings](../self-managed/configure.md), not all of which are supported in Elasticsearch Service. For a list of what settings are currently supported, check [Add Kibana user settings](edit-stack-settings.md). For all details about using the Kibana APIs, check the [Kibana API reference documentation](https://www.elastic.co/guide/en/kibana/current/api.html). +: There are no rate limits restricting your use of the Kibana APIs. However, Kibana features are affected by the [Kibana configuration settings](../self-managed/configure.md), not all of which are supported in {{ecloud}}. For a list of what settings are currently supported, check [Add Kibana user settings](edit-stack-settings.md). For all details about using the Kibana APIs, check the [Kibana API reference documentation](https://www.elastic.co/guide/en/kibana/current/api.html). ## Transport client [ec-restrictions-transport-client] -* The transport client is not considered thread safe in a cloud environment. We recommend that you use the Java REST client instead. This restriction relates to the fact that your deployments hosted on Elasticsearch Service are behind proxies, which prevent the transport client from communicating directly with Elasticsearch clusters. +* The transport client is not considered thread safe in a cloud environment. We recommend that you use the Java REST client instead. This restriction relates to the fact that your deployments hosted on {{ecloud}} are behind proxies, which prevent the transport client from communicating directly with Elasticsearch clusters. * The transport client is not supported over [private link connections](../../security/aws-privatelink-traffic-filters.md). Use the Java REST client instead, or connect over the public internet. -* The transport client does not work with Elasticsearch clusters at version 7.6 and later that are hosted on Cloud. Transport client continues to work with Elasticsearch clusters at version 7.5 and earlier. Note that the transport client was deprecated with version 7.0 and will be removed with 8.0. +% * The transport client does not work with Elasticsearch clusters at version 7.6 and later that are hosted on Cloud. Transport client continues to work with Elasticsearch clusters at version 7.5 and earlier. Note that the transport client was deprecated with version 7.0 and will be removed with 8.0. ## Elasticsearch and Kibana plugins [ec-restrictions-plugins] * Kibana plugins are not supported. * Elasticsearch plugins, are not enabled by default for security purposes. Please reach out to support if you would like to enable Elasticsearch plugins support on your account. -* Some Elasticsearch plugins do not apply to Elasticsearch Service. For example, you won’t ever need to change discovery, as Elasticsearch Service handles how nodes discover one another. -* In Elasticsearch 5.0 and later, site plugins are no longer supported. This change does not affect the site plugins Elasticsearch Service might provide out of the box, such as Kopf or Head, since these site plugins are serviced by our proxies and not Elasticsearch itself. -* In Elasticsearch 5.0 and later, site plugins such as Kopf and Paramedic are no longer provided. We recommend that you use our [cluster performance metrics](../../monitor/stack-monitoring.md), [X-Pack monitoring features](../../monitor/stack-monitoring.md) and Kibana’s (6.3+) [Index Management UI](https://www.elastic.co/guide/en/elasticsearch/reference/current/index-mgmt.html) if you want more detailed information or perform index management actions. +* Some Elasticsearch plugins do not apply to {{ecloud}}. For example, you won’t ever need to change discovery, as {{ecloud}} handles how nodes discover one another. +% * In Elasticsearch 5.0 and later, site plugins are no longer supported. This change does not affect the site plugins {{ecloud}} might provide out of the box, such as Kopf or Head, since these site plugins are serviced by our proxies and not Elasticsearch itself. +% * In Elasticsearch 5.0 and later, site plugins such as Kopf and Paramedic are no longer provided. We recommend that you use our [cluster performance metrics](../../monitor/stack-monitoring.md), [X-Pack monitoring features](../../monitor/stack-monitoring.md) and Kibana’s (6.3+) [Index Management UI](https://www.elastic.co/guide/en/elasticsearch/reference/current/index-mgmt.html) if you want more detailed information or perform index management actions. ## Watcher [ec-restrictions-watcher] @@ -93,20 +99,20 @@ Currently you can’t use SSO to login directly from {{ecloud}} into Kibana endp ## Kibana [ec-restrictions-kibana] * The maximum size of a single {{kib}} instance is 8GB. This means, {{kib}} instances can be scaled up to 8GB before they are scaled out. For example, when creating a deployment with a {{kib}} instance of size 16GB, then 2x8GB instances are created. If you face performance issues with {{kib}} PNG or PDF reports, the recommendations are to create multiple, smaller dashboards to export the data, or to use a third party browser extension for exporting the dashboard in the format you need. -* Running an external Kibana in parallel to Elasticsearch Service’s Kibana instances may cause errors, for example [`Unable to decrypt attribute`](../../../explore-analyze/alerts-cases/alerts/alerting-common-issues.md#rule-cannot-decrypt-api-key), due to a mismatched [`xpack.encryptedSavedObjects.encryptionKey`](https://www.elastic.co/guide/en/kibana/current/security-settings-kb.html#security-encrypted-saved-objects-settings) as Elasticsearch Service does not [allow users to set](edit-stack-settings.md) nor expose this value. While workarounds are possible, this is not officially supported nor generally recommended. +* Running an external Kibana in parallel to {{ecloud}}’s Kibana instances may cause errors, for example [`Unable to decrypt attribute`](../../../explore-analyze/alerts-cases/alerts/alerting-common-issues.md#rule-cannot-decrypt-api-key), due to a mismatched [`xpack.encryptedSavedObjects.encryptionKey`](https://www.elastic.co/guide/en/kibana/current/security-settings-kb.html#security-encrypted-saved-objects-settings) as {{ecloud}} does not [allow users to set](edit-stack-settings.md) nor expose this value. While workarounds are possible, this is not officially supported nor generally recommended. -## APM Agent central configuration with PrivateLink or traffic filters [ec-restrictions-apm-traffic-filters] +% ## APM Agent central configuration with PrivateLink or traffic filters [ec-restrictions-apm-traffic-filters] -If you are using APM 7.9.0 or older: +% If you are using APM 7.9.0 or older: -* You cannot use [APM Agent central configuration](https://www.elastic.co/guide/en/observability/current/apm-agent-configuration.html) if your deployment is secured by [traffic filters](../../security/traffic-filtering.md). -* If you access your APM deployment over [PrivateLink](../../security/aws-privatelink-traffic-filters.md), to use APM Agent central configuration you need to allow access to the APM deployment over public internet. +% * You cannot use [APM Agent central configuration](https://www.elastic.co/guide/en/observability/current/apm-agent-configuration.html) if your deployment is secured by [traffic filters](../../security/traffic-filtering.md). +% * If you access your APM deployment over [PrivateLink](../../security/aws-privatelink-traffic-filters.md), to use APM Agent central configuration you need to allow access to the APM deployment over public internet. ## Fleet with PrivateLink or traffic filters [ec-restrictions-fleet-traffic-filters] -* You cannot use Fleet 7.13.x if your deployment is secured by [traffic filters](../../security/traffic-filtering.md). Fleet 7.14.0 and later works with traffic filters (both Private Link and IP filters). +% * You cannot use Fleet 7.13.x if your deployment is secured by [traffic filters](../../security/traffic-filtering.md). Fleet 7.14.0 and later works with traffic filters (both Private Link and IP filters). * If you are using Fleet 8.12+, using a remote {{es}} output with a target cluster that has [traffic filters](../../security/traffic-filtering.md) enabled is not currently supported. ## Restoring a snapshot across deployments [ec-snapshot-restore-enterprise-search-kibana-across-deployments] @@ -137,10 +143,10 @@ To make a seamless migration, after restoring from a snapshot there are some add * The AWS `eu-central-2` region is limited to two availability zones for CPU Optimized (ARM) Hardware profile ES data node and warm/cold tier. Deployment creation with three availability zones for Elasticsearch data nodes for hot (for CPU Optimized (ARM) profile), warm and cold tiers is not possible. This includes scaling an existing deployment with one or two AZs to three availability zones. The workaround is to use a different AWS region that allows three availability zones, or to scale existing nodes up within the two availability zones. -## Known problems [ec-known-problems] +% ## Known problems [ec-known-problems] -* There is a known problem affecting clusters with versions 7.7.0 and 7.7.1 due to [a bug in Elasticsearch](https://github.com/elastic/elasticsearch/issues/56739). Although rare, this bug can prevent you from running plans. If this occurs we recommend that you retry the plan, and if that fails please contact support to get your plan through. Because of this bug we recommend you to upgrade to version 7.8 and higher, where the problem has already been addressed. -* A known issue can prevent direct rolling upgrades from Elasticsearch version 5.6.10 to version 6.3.0. As a workaround, we have removed version 6.3.0 from the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body) for new cluster deployments and for upgrading existing ones. If you are affected by this issue, check [Rolling upgrades from 5.6.x to 6.3.0 fails with "java.lang.IllegalStateException: commit doesn’t contain history uuid"](https://elastic.my.salesforce.com/articles/Support_Article/Rolling-upgrades-to-6-3-0-from-5-x-fails-with-java-lang-IllegalStateException-commit-doesn-t-contain-history-uuid?popup=false&id=kA0610000005JFG) in our Elastic Support Portal. If these steps do not work or you do not have access to the Support Portal, you can contact `support@elastic.co`. +% * There is a known problem affecting clusters with versions 7.7.0 and 7.7.1 due to [a bug in Elasticsearch](https://github.com/elastic/elasticsearch/issues/56739). Although rare, this bug can prevent you from running plans. If this occurs we recommend that you retry the plan, and if that fails please contact support to get your plan through. Because of this bug we recommend you to upgrade to version 7.8 and higher, where the problem has already been addressed. +% * A known issue can prevent direct rolling upgrades from Elasticsearch version 5.6.10 to version 6.3.0. As a workaround, we have removed version 6.3.0 from the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body) for new cluster deployments and for upgrading existing ones. If you are affected by this issue, check [Rolling upgrades from 5.6.x to 6.3.0 fails with "java.lang.IllegalStateException: commit doesn’t contain history uuid"](https://elastic.my.salesforce.com/articles/Support_Article/Rolling-upgrades-to-6-3-0-from-5-x-fails-with-java-lang-IllegalStateException-commit-doesn-t-contain-history-uuid?popup=false&id=kA0610000005JFG) in our Elastic Support Portal. If these steps do not work or you do not have access to the Support Portal, you can contact `support@elastic.co`. ## Repository Analysis API is unavailable in Elastic Cloud [ec-repository-analyis-unavailable] diff --git a/deploy-manage/deploy/elastic-cloud/subscribe-from-marketplace.md b/deploy-manage/deploy/elastic-cloud/subscribe-from-marketplace.md index faca749d10..b77eab803b 100644 --- a/deploy-manage/deploy/elastic-cloud/subscribe-from-marketplace.md +++ b/deploy-manage/deploy/elastic-cloud/subscribe-from-marketplace.md @@ -1,18 +1,28 @@ --- +applies_to: + deployment: + ess: ga + serverless: ga mapped_pages: - https://www.elastic.co/guide/en/cloud/current/ec-marketplaces.html --- # Subscribe from a marketplace [ec-marketplaces] -Subscribe to Elasticsearch Service from a marketplace. Your subscription gets billed together with other services that you’re already using, and can contribute towards your spend commitment with cloud providers. You can subcribe to Elasticsearch Service from any of the following: +You can subscribe to {{ecloud}} from a marketplace. Your subscription gets billed together with other services that you’re already using, and can contribute towards your spend commitment with cloud providers. + +Trial availability and duration can vary depending on the marketplace. + +When subscribing from a marketplace, your marketplace email is used for your [Elastic account](../../../cloud-account/update-your-email-address.md). * [AWS Marketplace](aws-marketplace.md) * [Azure Marketplace](azure-native-isv-service.md) * [GCP Marketplace](google-cloud-platform-marketplace.md) +* [Heroku](heroku.md) - - +::::{note} +[Serverless projects](https://docs.elastic.co/serverless) are only available for the AWS Marketplace, and are in technical preview on the Azure Marketplace. Support for GCP Marketplace will be added in the near future. +:::: diff --git a/deploy-manage/deploy/elastic-cloud/switch-from-apm-to-integrations-server-payload.md b/deploy-manage/deploy/elastic-cloud/switch-from-apm-to-integrations-server-payload.md index 04ff45f431..e860f5ed5c 100644 --- a/deploy-manage/deploy/elastic-cloud/switch-from-apm-to-integrations-server-payload.md +++ b/deploy-manage/deploy/elastic-cloud/switch-from-apm-to-integrations-server-payload.md @@ -5,7 +5,7 @@ mapped_pages: # Switch from APM to Integrations Server payload [ec-integrations-server-apm-switch] -This example shows how to use the Elasticsearch Service RESTful API to switch from using [APM & Fleet Server](#ec-manage-apm-and-fleet) to [Integrations Server](manage-integrations-server.md). +This example shows how to use the {{ecloud}} RESTful API to switch from using [APM & Fleet Server](#ec-manage-apm-and-fleet) to [Integrations Server](manage-integrations-server.md). ### Requirements [ec_requirements_3] diff --git a/deploy-manage/deploy/elastic-cloud/tools-apis.md b/deploy-manage/deploy/elastic-cloud/tools-apis.md index 1d32278f75..e54c5f97f7 100644 --- a/deploy-manage/deploy/elastic-cloud/tools-apis.md +++ b/deploy-manage/deploy/elastic-cloud/tools-apis.md @@ -1,4 +1,8 @@ --- +applies_to: + deployment: + ess: ga + serverless: ga mapped_urls: - https://www.elastic.co/guide/en/serverless/current/elasticsearch-http-apis.html - https://www.elastic.co/guide/en/tpec/current/index.html @@ -18,8 +22,107 @@ mapped_urls: % - [ ] https://www.elastic.co/guide/en/tpec/current/index.html % Notes: reference only, this page wasn't migrated, but you can pull from the live URL if needed. -⚠️ **This page is a work in progress.** ⚠️ -The documentation team is working to combine content pulled from the following pages: +## REST APIs to orchestrate {{ecloud}} -* [/raw-migrated-files/docs-content/serverless/elasticsearch-http-apis.md](/raw-migrated-files/docs-content/serverless/elasticsearch-http-apis.md) \ No newline at end of file +The following APIs allow you to manage your {{ecloud}} organization, users, security, billing and resources. + +:::::{tab-set} +:group: serverless-hosted + +::::{tab-item} {{serverless-short}} +:sync: serverless + +You can use the [{{serverless-full}} APIs](https://www.elastic.co/docs/api/doc/elastic-cloud-serverless) to manage your {{serverless-full}} projects, your organization, and its users. + +:::: +::::{tab-item} {{ech}} +:sync: hosted + +You can use the [{{ecloud}} API](https://www.elastic.co/docs/api/doc/cloud/) to manage your hosted deployments and all of the resources associated with them. This includes performing deployment CRUD operations, scaling or autoscaling resources, and managing traffic filters, deployment extensions, remote clusters, and Elastic Stack versions. You can also access cost data by deployment and by organization. + +:::: + +::::: + +## REST APIs to interact with data and solution features + +The following APIs allow you to interact with your {{es}} cluster, its data, and the features available to you in your hosted deployment or serverless project. + +Note that some [restrictions](../deploy/elastic-cloud/restrictions-known-problems.md#ec-restrictions-apis-elasticsearch) apply when using the these APIs on {{ecloud}}. + +:::::{tab-set} +:group: serverless-hosted +::::{tab-item} {{serverless-short}} +:sync: serverless + +**API references** + +The following APIs are available for {{es-serverless}} users. These links will take you to the autogenerated API reference documentation. + +- [Elasticsearch Serverless APIs](https://www.elastic.co/docs/api/doc/elasticsearch-serverless): Use these APIs to index, manage, search, and analyze your data in {{es-serverless}}. Learn how to [connect to your {{es-serverless}} endpoint](/solutions/search/get-started.md). +- [Kibana Serverless APIs](https://www.elastic.co/docs/api/doc/serverless): Use these APIs to manage resources such as connectors, data views, and saved objects for your {{serverless-full}} project. + + +**Additional API information** + +- [{{es}} API conventions](https://www.elastic.co/guide/en/serverless/current/elasticsearch-api-conventions.html): Reference information about headers and request body conventions for {{es-serverless}} REST APIs. +- [Management API conventions](https://www.elastic.co/guide/en/serverless/current/elasticsearch-kibana-api-conventions.html): Reference information about request header conventions for {{serverless-full}} REST APIs. +:::: + +::::{tab-item} {{ech}} +:sync: hosted + +- [Elasticsearch APIs](https://www.elastic.co/docs/api/doc/elasticsearch/): This set of APIs allows you to interact directly with the Elasticsearch nodes in your deployment. You can ingest data, run search queries, check the health of your clusters, manage snapshots, and more. +- [Kibana APIs](https://www.elastic.co/docs/api/doc/kibana/): Many Kibana features can be accessed through these APIs, including Kibana objects, patterns, and dashboards, as well as user roles and user sessions. You can use these APIs to configure alerts and actions, and to access health details for the Kibana Task Manager. +:::: + +::::: + +## {{ecloud}} API Console +```{applies_to} +deployment: + ess: ga +serverless: unavailable +``` + +For each deployment, an **API Console** page is available from the {{ecloud}} Console for you to execute queries using the available APIs. You can find this console when selecting a specific deployment to manage. From there, the API Console is available under the **{{es}}** page. + +:::{note} +This API Console is different from the [Dev Tools Console](/explore-analyze/query-filter/tools/console.md) available in each deployment, from which you can call {{es}} and {{kib}} APIs. On the {{ecloud}} API Console, you cannot run Kibana APIs. +::: + +## ECCTL - Command-line interface for {{ecloud}} + +ecctl is the command-line interface for {{ecloud}} APIs. It wraps typical operations commonly needed by operators within a single command line tool. + +Benefits of ecctl: + +- Easier to use than the Cloud UI or using the RESTful API directly +- Helps you automate the deployment lifecycle +- Provides a foundation for integration with other tools + +Find more details in the [ecctl documentation](https://www.elastic.co/guide/en/ecctl/current/index.html). + +## Monitor your deployments with AutoOps +```{applies_to} +deployment: + ess: ga +serverless: unavailable +``` + +AutoOps significantly simplifies cluster management for your {{ech}} deployments with performance recommendations, resource utilization visibility, real-time issue detection and resolution paths. Find more details in [](/deploy-manage/monitor/autoops.md) + + +## Provision hosted deployments with Terraform +```{applies_to} +deployment: + ess: ga +serverless: unavailable +``` + +The Elastic Cloud Terraform provider allows you to provision {{ech}} deployments on any Elastic Cloud platform, whether it’s {{ecloud}} or Elastic Cloud Enterprise. + +The provider lets you manage Elastic Cloud deployments as code, and introduce DevOps-driven methodologies to manage and deploy the Elastic Stack and solutions. + +To get started, see the [Elastic Cloud Terraform provider documentation](https://registry.terraform.io/providers/elastic/ec/latest/docs). \ No newline at end of file diff --git a/deploy-manage/toc.yml b/deploy-manage/toc.yml index e869e0adda..65ea66a979 100644 --- a/deploy-manage/toc.yml +++ b/deploy-manage/toc.yml @@ -41,22 +41,20 @@ toc: - file: deploy/elastic-cloud/create-monthly-pay-as-you-go-subscription-on-gcp-marketplace.md - file: deploy/elastic-cloud/heroku.md children: - - file: deploy/elastic-cloud/ech-getting-started.md + - file: deploy/elastic-cloud/ech-getting-started-installing.md children: - - file: deploy/elastic-cloud/ech-getting-started-installing.md - children: - - file: deploy/elastic-cloud/ech-getting-started-installing-version.md - - file: deploy/elastic-cloud/ech-getting-started-removing.md - - file: deploy/elastic-cloud/ech-migrating.md - - file: deploy/elastic-cloud/ech-getting-started-accessing.md - children: - - file: deploy/elastic-cloud/ech-access-kibana.md - - file: deploy/elastic-cloud/ech-working-with-elasticsearch.md - - file: deploy/elastic-cloud/ech-api-console.md - - file: deploy/elastic-cloud/ech-getting-started-next-steps.md - - file: deploy/elastic-cloud/ech-migrate-data2.md - children: - - file: deploy/elastic-cloud/ech-migrate-data-internal.md + - file: deploy/elastic-cloud/ech-getting-started-installing-version.md + - file: deploy/elastic-cloud/ech-getting-started-removing.md + - file: deploy/elastic-cloud/ech-migrating.md + - file: deploy/elastic-cloud/ech-getting-started-accessing.md + children: + - file: deploy/elastic-cloud/ech-access-kibana.md + - file: deploy/elastic-cloud/ech-working-with-elasticsearch.md + - file: deploy/elastic-cloud/ech-api-console.md + - file: deploy/elastic-cloud/ech-getting-started-next-steps.md + - file: deploy/elastic-cloud/ech-migrate-data2.md + children: + - file: deploy/elastic-cloud/ech-migrate-data-internal.md - file: deploy/elastic-cloud/ech-about.md children: - file: deploy/elastic-cloud/ech-licensing.md diff --git a/raw-migrated-files/cloud/cloud/ec-getting-started-existing-email.md b/raw-migrated-files/cloud/cloud/ec-getting-started-existing-email.md deleted file mode 100644 index c1b80f4d54..0000000000 --- a/raw-migrated-files/cloud/cloud/ec-getting-started-existing-email.md +++ /dev/null @@ -1,17 +0,0 @@ -# Sign up using an existing email address [ec-getting-started-existing-email] - -Your email address is used to uniquely identify you. It can’t be used for more than one Elastic Cloud account, whether that account is a trial account, a standard Elasticsearch Service account, or a subscription account through a marketplace. - -In some situations you may want to create a new Elastic Cloud account using an email address that is already associated with an existing account. For this procedure, it’s assumed that you no longer want to use the original account. - -To sign up to Elastic Cloud using an email address associated with another Elastic Cloud account: - -1. Use your current email address (for example, `my.preferred.address@foobar.com`) to log in to the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body). -2. Follow the steps to [update that email address](../../../cloud-account/update-your-email-address.md) to another email address, such as `my.alternate.address@gmail.com`. - -You can now use the email address from Step 1 to do the following: - -* Sign up for a new account. -* [Join an existing organization](../../../deploy-manage/cloud-organization.md). - -For questions or any problems, contact us at `support@elastic.co`. diff --git a/raw-migrated-files/toc.yml b/raw-migrated-files/toc.yml index 4dc414acb3..1e65338c94 100644 --- a/raw-migrated-files/toc.yml +++ b/raw-migrated-files/toc.yml @@ -147,7 +147,6 @@ toc: - file: cloud/cloud/ec-faq-getting-started.md - file: cloud/cloud/ec-faq-technical.md - file: cloud/cloud/ec-get-help.md - - file: cloud/cloud/ec-getting-started-existing-email.md - file: cloud/cloud/ec-getting-started-node-js.md - file: cloud/cloud/ec-getting-started-python.md - file: cloud/cloud/ec-getting-started-search-use-cases-beats-logstash.md From 65715598be69d8f1f6947d70b433f76dcaf612dd Mon Sep 17 00:00:00 2001 From: Florent Le Borgne Date: Thu, 20 Feb 2025 15:26:37 +0100 Subject: [PATCH 02/11] make build happy --- .../deploy/elastic-cloud/ech-getting-started.md | 15 --------------- deploy-manage/deploy/elastic-cloud/tools-apis.md | 2 +- 2 files changed, 1 insertion(+), 16 deletions(-) delete mode 100644 deploy-manage/deploy/elastic-cloud/ech-getting-started.md diff --git a/deploy-manage/deploy/elastic-cloud/ech-getting-started.md b/deploy-manage/deploy/elastic-cloud/ech-getting-started.md deleted file mode 100644 index 31baccf874..0000000000 --- a/deploy-manage/deploy/elastic-cloud/ech-getting-started.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -mapped_pages: - - https://www.elastic.co/guide/en/cloud-heroku/current/ech-getting-started.html ---- - -# Elasticsearch Add-On for Heroku [ech-getting-started] - -This documentation applies to Heroku users who want to make use of the Elasticsearch Add-On for Heroku that is available from the [Heroku Dashboard](https://dashboard.heroku.com/) or that can be installed from the CLI. - -The add-on runs on {{ecloud}} and provides access to [Elasticsearch](https://www.elastic.co/products/elasticsearch), the open source, distributed, RESTful search engine. Many other features of the Elastic Stack are also readily available to Heroku users through the [Elasticsearch Add-On for Heroku console](https://cloud.elastic.co?page=docs&placement=docs-body) after you install the add-on. For example, you can use Kibana to visualize your Elasticsearch data. - -[Elasticsearch Machine Learning](https://www.elastic.co/guide/en/machine-learning/current/index.html), [Elastic APM](/solutions/observability/apps/application-performance-monitoring-apm.md) and [Elastic Fleet Server](https://www.elastic.co/guide/en/fleet/current/fleet-overview.html) are not supported by the Elasticsearch Add-On for Heroku. - -To learn more about what plans are available for Heroku users and their cost, check the [Elasticsearch add-on](https://elements.heroku.com/addons/foundelasticsearch) in the Elements Marketplace. - diff --git a/deploy-manage/deploy/elastic-cloud/tools-apis.md b/deploy-manage/deploy/elastic-cloud/tools-apis.md index e54c5f97f7..be50131343 100644 --- a/deploy-manage/deploy/elastic-cloud/tools-apis.md +++ b/deploy-manage/deploy/elastic-cloud/tools-apis.md @@ -49,7 +49,7 @@ You can use the [{{ecloud}} API](https://www.elastic.co/docs/api/doc/cloud/) to The following APIs allow you to interact with your {{es}} cluster, its data, and the features available to you in your hosted deployment or serverless project. -Note that some [restrictions](../deploy/elastic-cloud/restrictions-known-problems.md#ec-restrictions-apis-elasticsearch) apply when using the these APIs on {{ecloud}}. +Note that some [restrictions](/deploy-manage/deploy/elastic-cloud/restrictions-known-problems.md#ec-restrictions-apis-elasticsearch) apply when using the these APIs on {{ecloud}}. :::::{tab-set} :group: serverless-hosted From d9d9e18453a9d36057ec59fa9033249cacba6245 Mon Sep 17 00:00:00 2001 From: Florent Le Borgne Date: Thu, 20 Feb 2025 18:50:56 +0100 Subject: [PATCH 03/11] Elastic Cloud Hosted --- deploy-manage/deploy/elastic-cloud.md | 2 +- .../deploy/elastic-cloud/access-kibana.md | 34 ++- .../elastic-cloud/add-plugins-extensions.md | 4 + ...gins-provided-with-elastic-cloud-hosted.md | 21 -- .../elastic-cloud/available-stack-versions.md | 3 + .../deploy/elastic-cloud/change-hardware.md | 3 + .../deploy/elastic-cloud/cloud-hosted.md | 168 +++++++++++- .../deploy/elastic-cloud/configure.md | 57 +++- ...eate-an-elastic-cloud-hosted-deployment.md | 33 ++- .../elastic-cloud/create-an-organization.md | 6 +- .../elastic-cloud/custom-endpoint-aliases.md | 153 ++++++++++- .../ec-change-hardware-profile.md | 4 + .../ec-configure-deployment-settings.md | 67 ----- .../ec-customize-deployment-components.md | 6 +- .../elastic-cloud/ec-customize-deployment.md | 63 ----- .../ech-configure-deployment-settings.md | 45 ---- .../elastic-cloud/ech-configure-settings.md | 52 ---- .../ech-customize-deployment-components.md | 135 ---------- .../ech-default-aws-configurations.md | 4 +- .../ech-default-azure-configurations.md | 4 +- .../ech-default-gcp-configurations.md | 4 +- .../elastic-cloud/edit-stack-settings.md | 79 +++++- .../deploy/elastic-cloud/find-cloud-id.md | 3 + .../keep-track-of-deployment-activity.md | 32 ++- ...age-deployments-using-elastic-cloud-api.md | 3 + .../elastic-cloud/manage-deployments.md | 15 +- .../manage-integrations-server.md | 3 + .../manage-plugins-extensions-through-api.md | 3 + ...from-apm-to-integrations-server-payload.md | 3 + .../upload-custom-plugins-bundles.md | 245 +++++++++++++++++- deploy-manage/toc.yml | 12 +- .../cloud/cloud/ec-prepare-production.md | 12 - raw-migrated-files/toc.yml | 1 - 33 files changed, 805 insertions(+), 474 deletions(-) delete mode 100644 deploy-manage/deploy/elastic-cloud/add-plugins-provided-with-elastic-cloud-hosted.md delete mode 100644 deploy-manage/deploy/elastic-cloud/ec-configure-deployment-settings.md delete mode 100644 deploy-manage/deploy/elastic-cloud/ec-customize-deployment.md delete mode 100644 deploy-manage/deploy/elastic-cloud/ech-configure-deployment-settings.md delete mode 100644 deploy-manage/deploy/elastic-cloud/ech-configure-settings.md delete mode 100644 deploy-manage/deploy/elastic-cloud/ech-customize-deployment-components.md delete mode 100644 raw-migrated-files/cloud/cloud/ec-prepare-production.md diff --git a/deploy-manage/deploy/elastic-cloud.md b/deploy-manage/deploy/elastic-cloud.md index a8d4aae813..00b9259079 100644 --- a/deploy-manage/deploy/elastic-cloud.md +++ b/deploy-manage/deploy/elastic-cloud.md @@ -42,4 +42,4 @@ You can have multiple hosted deployments and serverless projects in the same {{e ## APIs -{{ecloud}} offers APIs to manage your organization and its resources. Check the [{{ecloud}}](https://www.elastic.co/docs/api/doc/cloud/) and [{{ecloud}} serverless](https://www.elastic.co/docs/api/doc/elastic-cloud-serverless/) APIs \ No newline at end of file +{{ecloud}} offers APIs to manage your organization and its resources. Check the [{{ecloud}}](https://www.elastic.co/docs/api/doc/cloud/) and [{{ecloud}} serverless](https://www.elastic.co/docs/api/doc/elastic-cloud-serverless/) APIs. \ No newline at end of file diff --git a/deploy-manage/deploy/elastic-cloud/access-kibana.md b/deploy-manage/deploy/elastic-cloud/access-kibana.md index 28af45ef25..e7617bbe43 100644 --- a/deploy-manage/deploy/elastic-cloud/access-kibana.md +++ b/deploy-manage/deploy/elastic-cloud/access-kibana.md @@ -1,11 +1,14 @@ --- +applies_to: + deployment: + ess: ga mapped_urls: - https://www.elastic.co/guide/en/cloud/current/ec-access-kibana.html - https://www.elastic.co/guide/en/cloud-heroku/current/ech-access-kibana.html - https://www.elastic.co/guide/en/cloud-heroku/current/ech-enable-kibana2.html --- -# Access Kibana +# Access Kibana [ec-access-kibana] % What needs to be done: Lift-and-shift @@ -20,8 +23,29 @@ mapped_urls: $$$ec-enable-kibana2$$$ -**This page is a work in progress.** The documentation team is working to combine content pulled from the following pages: -* [/raw-migrated-files/cloud/cloud/ec-access-kibana.md](/raw-migrated-files/cloud/cloud/ec-access-kibana.md) -* [/raw-migrated-files/cloud/cloud-heroku/ech-access-kibana.md](/raw-migrated-files/cloud/cloud-heroku/ech-access-kibana.md) -* [/raw-migrated-files/cloud/cloud-heroku/ech-enable-kibana2.md](/raw-migrated-files/cloud/cloud-heroku/ech-enable-kibana2.md) \ No newline at end of file +Kibana is an open source analytics and visualization platform designed to search, view, and interact with data stored in Elasticsearch indices. The use of Kibana is included with your subscription. + +For new Elasticsearch clusters, we automatically create a Kibana instance for you. + +To access Kibana: + +1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body). +2. On the **Deployments** page, select your deployment. + + On the deployments page you can narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list. + +3. Under **Applications**, select the Kibana **Launch** link and wait for Kibana to open. + + ::::{note} + Both ports 443 and 9243 can be used to access Kibana. SSO only works with 9243 on older deployments, where you will see an option in the Cloud UI to migrate the default to port 443. In addition, any version upgrade will automatically migrate the default port to 443. + :::: + +4. Log into Kibana. Single sign-on (SSO) is enabled between your Cloud account and the Kibana instance. If you’re logged in already, then Kibana opens without requiring you to log in again. However, if your token has expired, choose from one of these methods to log in: + + * Select **Login with Cloud**. You’ll need to log in with your Cloud account credentials and then you’ll be redirected to Kibana. + * Log in with the `elastic` superuser. The password was provided when you created your cluster or [can be reset](../../../deploy-manage/users-roles/cluster-or-deployment-auth/built-in-users.md). + * Log in with any users you created in Kibana already. + + +In production systems, you might need to control what Elasticsearch data users can access through Kibana, so you need create credentials that can be used to access the necessary Elasticsearch resources. This means granting read access to the necessary indexes, as well as access to update the `.kibana` index. \ No newline at end of file diff --git a/deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md b/deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md index 8caea9be55..d6a8a1a928 100644 --- a/deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md +++ b/deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md @@ -1,6 +1,10 @@ --- +applies_to: + deployment: + ess: ga mapped_pages: - https://www.elastic.co/guide/en/cloud/current/ec-adding-plugins.html + - https://www.elastic.co/guide/en/cloud-heroku/current/ech-adding-elastic-plugins.html --- # Add plugins and extensions [ec-adding-plugins] diff --git a/deploy-manage/deploy/elastic-cloud/add-plugins-provided-with-elastic-cloud-hosted.md b/deploy-manage/deploy/elastic-cloud/add-plugins-provided-with-elastic-cloud-hosted.md deleted file mode 100644 index f2545619ea..0000000000 --- a/deploy-manage/deploy/elastic-cloud/add-plugins-provided-with-elastic-cloud-hosted.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -mapped_urls: - - https://www.elastic.co/guide/en/cloud-heroku/current/ech-adding-plugins.html - - https://www.elastic.co/guide/en/cloud-heroku/current/ech-adding-elastic-plugins.html ---- - -# Add plugins provided with Elastic Cloud Hosted - -% What needs to be done: Lift-and-shift - -% Use migrated content from existing pages that map to this page: - -% - [ ] ./raw-migrated-files/cloud/cloud-heroku/ech-adding-plugins.md -% - [ ] ./raw-migrated-files/cloud/cloud-heroku/ech-adding-elastic-plugins.md - -⚠️ **This page is a work in progress.** ⚠️ - -The documentation team is working to combine content pulled from the following pages: - -* [/raw-migrated-files/cloud/cloud-heroku/ech-adding-plugins.md](/raw-migrated-files/cloud/cloud-heroku/ech-adding-plugins.md) -* [/raw-migrated-files/cloud/cloud-heroku/ech-adding-elastic-plugins.md](/raw-migrated-files/cloud/cloud-heroku/ech-adding-elastic-plugins.md) \ No newline at end of file diff --git a/deploy-manage/deploy/elastic-cloud/available-stack-versions.md b/deploy-manage/deploy/elastic-cloud/available-stack-versions.md index c910bdd775..085850da56 100644 --- a/deploy-manage/deploy/elastic-cloud/available-stack-versions.md +++ b/deploy-manage/deploy/elastic-cloud/available-stack-versions.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ess: ga mapped_pages: - https://www.elastic.co/guide/en/cloud/current/ec-version-policy.html --- diff --git a/deploy-manage/deploy/elastic-cloud/change-hardware.md b/deploy-manage/deploy/elastic-cloud/change-hardware.md index fe313fd819..649bcee5ce 100644 --- a/deploy-manage/deploy/elastic-cloud/change-hardware.md +++ b/deploy-manage/deploy/elastic-cloud/change-hardware.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ess: ga mapped_pages: - https://www.elastic.co/guide/en/cloud/current/ec-change-hardware-for-a-specific-resource.html --- diff --git a/deploy-manage/deploy/elastic-cloud/cloud-hosted.md b/deploy-manage/deploy/elastic-cloud/cloud-hosted.md index 511e3906a0..83ac9ec5f0 100644 --- a/deploy-manage/deploy/elastic-cloud/cloud-hosted.md +++ b/deploy-manage/deploy/elastic-cloud/cloud-hosted.md @@ -1,13 +1,14 @@ --- +applies_to: + deployment: + ess: ga mapped_urls: - https://www.elastic.co/guide/en/cloud/current/ec-getting-started.html - - https://www.elastic.co/guide/en/cloud/current/ec-prepare-production.html - https://www.elastic.co/guide/en/cloud/current/ec-faq-getting-started.html - https://www.elastic.co/guide/en/cloud/current/ec-about.html - - https://www.elastic.co/guide/en/cloud-heroku/current/ech-configure.html --- -# Cloud Hosted +# Elastic Cloud Hosted % What needs to be done: Refine @@ -50,10 +51,159 @@ $$$faq-where$$$ $$$faq-x-pack$$$ -**This page is a work in progress.** The documentation team is working to combine content pulled from the following pages: +**{{ech}} is the Elastic Stack, managed through {{ecloud}} deployments.** -* [/raw-migrated-files/cloud/cloud/ec-getting-started.md](/raw-migrated-files/cloud/cloud/ec-getting-started.md) -* [/raw-migrated-files/cloud/cloud/ec-prepare-production.md](/raw-migrated-files/cloud/cloud/ec-prepare-production.md) -* [/raw-migrated-files/cloud/cloud/ec-faq-getting-started.md](/raw-migrated-files/cloud/cloud/ec-faq-getting-started.md) -* [/raw-migrated-files/cloud/cloud/ec-about.md](/raw-migrated-files/cloud/cloud/ec-about.md) -* [/raw-migrated-files/cloud/cloud-heroku/ech-configure.md](/raw-migrated-files/cloud/cloud-heroku/ech-configure.md) \ No newline at end of file +It is also formerly known as Elasticsearch Service. + +{{ech}} allows you to manage one or more instances of the Elastic Stack through **deployments**. These deployments are hosted on {{ecloud}}, through the cloud provider and regions of your choice, and are tied to your organization account. + +A **hosted deployment** helps you manage an Elasticsearch cluster and instances of other Elastic products, like Kibana or APM instances, in one place. Spin up, scale, upgrade, and delete your Elastic Stack products without having to manage each one separately. In a deployment, everything works together. + +::::{note} +{{ech}} is one of the two deployment options available on {{ecloud}}. [Depending on your needs](../elastic-cloud.md), you can also run [Elastic Cloud Serverless projects](/deploy-manage/deploy/elastic-cloud/serverless.md). +:::: + + +**Hardware profiles to optimize deployments for your usage.** + +You can optimize the configuration and performance of a deployment by selecting a **hardware profile** that matches your usage. + +*Hardware profiles* are presets that provide a unique blend of storage, memory and vCPU for each component of a deployment. They support a specific purpose, such as a hot-warm architecture that helps you manage your data storage retention. + +You can use these presets, or start from them to get the unique configuration you need. They can vary slightly from one cloud provider or region to another to align with the available virtual hardware. + +**Solutions to help you make the most out of your data in each deployment.** + +Building a rich search experience, gaining actionable insight into your environment, or protecting your systems and endpoints? You can implement each of these major use cases, and more, with the solutions that are pre-built in each Elastic deployment. + +:::{image} ../../../images/cloud-ec-stack-components.png +:alt: Elastic Stack components and solutions with Enterprise Search +:width: 75% +::: + +:::{important} +Enterprise Search is not available in {{stack}} 9.0+. +::: + +These solutions help you accomplish your use cases: Ingest data into the deployment and set up specific capabilities of the Elastic Stack. + +Of course, you can choose to follow your own path and use Elastic components available in your deployment to ingest, visualize, and analyze your data independently from solutions. + + +## How to operate {{ech}}? [ec_how_to_operate_elasticsearch_service] + +**Where to start?** + +* Try one of our solutions by following our [getting started guides](https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/getting-started-guides.html). +* Sign up using your preferred method: + + * [Sign Up for a Trial](/deploy-manage/deploy/elastic-cloud/create-an-organization.md) - Sign up, check what your free trial includes and when we require a credit card. + * [Sign Up from Marketplace](/deploy-manage/deploy/elastic-cloud/subscribe-from-marketplace.md) - Consolidate billing portals by signing up through one of the available marketplaces. + +* Set up your account by [completing your user or organization profile](/deploy-manage/cloud-organization/billing.md) and by [inviting users to your organization](/deploy-manage/cloud-organization.md). +* [Create a deployment](/deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.md) - Get up and running very quickly. Select your desired configuration and let Elastic deploy Elasticsearch, Kibana, and the Elastic products that you need for you. In a deployment, everything works together, everything runs on hardware that is optimized for your use case. +* [Connect your data to your deployment](/manage-data/ingest.md) - Ingest and index the data you want, from a variety of sources, and take action on it. + +**Adjust the capacity and capabilities of your deployments for production** + +There are a few things that can help you make sure that your production deployments remain available, healthy, and ready to handle your data in a scalable way over time, with the expected level of performance. We’ve listed these things for you in [Preparing for production](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md). + +**Secure your environment** + +Control which users and services can access your deployments by [securing your environment](/deploy-manage/users-roles/cluster-or-deployment-auth.md). Add authentication mechanisms, configure [traffic filtering](/deploy-manage/security/traffic-filtering.md) for private link, encrypt your deployment data and snapshots at rest [with your own key](/deploy-manage/security/encrypt-deployment-with-customer-managed-encryption-key.md), manage trust with Elasticsearch clusters from other environments, and more. + +**Monitor your deployments and keep them healthy** + +{{ech}} provides several ways to monitor your deployments, anticipate and prevent issues, or fix them when they occur. Check [Monitoring your deployment](/deploy-manage/monitor/stack-monitoring.md) to get more details. + +**And then?** + +Now is the time for you to work with your data. The content of the {{ech}} section helps you get your environment up and ready to handle your data the way you need. You can always adjust your deployments and their configuration as your usage evolves over time. + +To get the most out of the solutions that the Elastic Stack offers, [log in to {{ecloud}}](https://cloud.elastic.co) or [browse the documentation](https://www.elastic.co/docs). + +## More about {{ech}} [ec-about] + +Find more information about {{ech}} on the following pages: + +* [Subscription Levels](/deploy-manage/license.md) +* [Version Policy](/deploy-manage/deploy/elastic-cloud/available-stack-versions.md) +* [{{ech}} Hardware](https://www.elastic.co/guide/en/cloud/current/ec-reference-hardware.html) +* [{{ech}} Regions](https://www.elastic.co/guide/en/cloud/current/ec-reference-regions.html) +* [Service Status](/deploy-manage/cloud-organization/service-status.md) +* [Getting help](/troubleshoot/index.md) +* [Restrictions and known problems](/deploy-manage/deploy/elastic-cloud/restrictions-known-problems.md) + +:::{dropdown} {{ech}} FAQ + +$$$ec-faq-getting-started$$$ + +This frequently-asked-questions list helps you with common questions while you get {{ech}} up and running for the first time. For questions about {{ech}} configuration options or billing, check the [Technical FAQ](/deploy-manage/index.md) and the [Billing FAQ](/deploy-manage/cloud-organization/billing/billing-faq.md). + +* [What is {{ech}}?](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md#faq-what) +* [Is {{ech}}, formerly known as Elasticsearch Service, the same as Amazon’s {{es}} Service?](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md#faq-aws-difference) +* [Can I run the full Elastic Stack in {{ech}}?](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md#faq-full-stack) +* [Can I try {{ech}} for free?](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md#faq-trial) +* [What if I need to change the size of my {{es}} cluster at a later time?](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md#faq-config) +* [Do you offer support subscriptions?](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md#faq-subscriptions) +* [Where are deployments hosted?](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md#faq-where) +* [What is the difference between {{ech}} and the Amazon {{es}} Service?](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md#faq-vs-aws) +* [Can I use {{ech}} on platforms other than AWS?](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md#faq-aws) +* [Do you offer Elastic’s commercial products?](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md#faq-elastic) +* [Is my {{es}} cluster protected by X-Pack?](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md#faq-x-pack) +* [Is there a limit on the number of documents or indexes I can have in my cluster?](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md#faq-limit) + +$$$faq-what$$$**What is {{ech}}?** +: {{ech}} is hosted and managed {{es}} and {{kib}} brought to you by the creators of {{es}}. {{ech}} is part of Elastic Cloud and ships with features that you can only get from the company behind {{es}}, {{kib}}, {{beats}}, and {{ls}}. {{es}} is a full text search engine that suits a range of uses, from search on websites to big data analytics and more. + +$$$faq-aws-difference$$$**Is {{ech}}, formerly known as Elasticsearch Service, the same as Amazon’s {{es}} Service?** +: {{ech}} is not the same as the Amazon {{es}} service. To learn more about the differences, check our [AWS {{es}} Service](https://www.elastic.co/aws-elasticsearch-service) comparison. + +$$$faq-full-stack$$$**Can I run the full Elastic Stack in {{ech}}?** +: Many of the products that are part of the Elastic Stack are readily available in {{ech}}, including {{es}}, {{kib}}, plugins, and features such as monitoring and security. Use other Elastic Stack products directly with {{ech}}. For example, both Logstash and Beats can send their data to {{ech}}. What is run is determined by the [subscription level](https://www.elastic.co/cloud/as-a-service/subscriptions). + +$$$faq-trial$$$**Can I try {{ech}} for free?** +: Yes, sign up for a 14-day free trial. The trial starts the moment a cluster is created. During the free trial period get access to a deployment to explore Elastic solutions for Search, Observability, Security, or the latest version of the Elastic Stack. + + +$$$faq-config$$$**What if I need to change the size of my {{es}} cluster at a later time?** +: Scale your clusters both up and down from the user console, whenever you like. The resizing of the cluster is transparently done in the background, and highly available clusters are resized without any downtime. If you scale your cluster down, make sure that the downsized cluster can handle your {{es}} memory requirements. Read more about sizing and memory in [Sizing {{es}}](https://www.elastic.co/blog/found-sizing-elasticsearch). + +$$$faq-subscriptions$$$**Do you offer support?** +: Yes, all subscription levels for {{ech}} include support, handled by email or through the Elastic Support Portal. Different subscription levels include different levels of support. For the Standard subscription level, there is no service-level agreement (SLA) on support response times. Gold and Platinum subscription levels include an SLA on response times to tickets and dedicated resources. To learn more, check [Getting Help](/troubleshoot/index.md). + +$$$faq-where$$$**Where are deployments hosted?** +: We host our {{es}} clusters on Amazon Web Services (AWS), Google Cloud Platform (GCP), and Microsoft Azure. Check out which [regions we support](https://www.elastic.co/guide/en/cloud/current/ec-reference-regions.html) and what [hardware we use](https://www.elastic.co/guide/en/cloud/current/ec-reference-hardware.html). New data centers are added all the time. + +$$$faq-vs-aws$$$**What is the difference between {{ech}} and the Amazon {{es}} Service?** +: {{ech}} is the only hosted and managed {{es}} service built, managed, and supported by the company behind {{es}}, {{kib}}, {{beats}}, and {{ls}}. With {{ech}}, you always get the latest versions of the software. Our service is built on best practices and years of experience hosting and managing thousands of {{es}} clusters in the Cloud and on premise. For more information, check the following Amazon and Elastic {{es}} Service [comparison page](https://www.elastic.co/aws-elasticsearch-service). + + Please note that there is no formal partnership between Elastic and Amazon Web Services (AWS), and Elastic does not provide any support on the AWS {{es}} Service. + + +$$$faq-aws$$$**Can I use {{ech}} on platforms other than AWS?** +: Yes, create deployments on the Google Cloud Platform and Microsoft Azure. + +$$$faq-elastic$$$**Do you offer Elastic’s commercial products?** +: Yes, all {{ech}} customers have access to basic authentication, role-based access control, and monitoring. + + {{ecloud}} Gold, Platinum and Enterprise customers get complete access to all the capabilities in X-Pack: + + * Security + * Alerting + * Monitoring + * Reporting + * Graph Analysis & Visualization + + [Contact us](https://www.elastic.co/cloud/contact) to learn more. + + +$$$faq-x-pack$$$**Is my Elasticsearch cluster protected by X-Pack?** +: Yes, X-Pack security features offer the full power to protect your {{ech}} deployment with basic authentication and role-based access control. + +$$$faq-limit$$$**Is there a limit on the number of documents or indexes I can have in my cluster?** +: No. We do not enforce any artificial limit on the number of indexes or documents you can store in your cluster. + + That said, there is a limit to how many indexes Elasticsearch can cope with. Every shard of every index is a separate Lucene index, which in turn comprises several files. A process cannot have an unlimited number of open files. Also, every shard has its associated control structures in memory. So, while we will let you make as many indexes as you want, there are limiting factors. Our larger plans provide your processes with more dedicated memory and CPU-shares, so they are capable of handling more indexes. The number of indexes or documents you can fit in a given plan therefore depends on their structure and use. + +::: \ No newline at end of file diff --git a/deploy-manage/deploy/elastic-cloud/configure.md b/deploy-manage/deploy/elastic-cloud/configure.md index de5a2762d2..99b1115299 100644 --- a/deploy-manage/deploy/elastic-cloud/configure.md +++ b/deploy-manage/deploy/elastic-cloud/configure.md @@ -1,7 +1,11 @@ --- +applies_to: + deployment: + ess: ga mapped_urls: - https://www.elastic.co/guide/en/cloud/current/ec-customize-deployment.html - https://www.elastic.co/guide/en/cloud-heroku/current/ech-configure-settings.html + - https://www.elastic.co/guide/en/cloud-heroku/current/ech-configure.html --- # Configure @@ -13,9 +17,54 @@ mapped_urls: % - [ ] ./raw-migrated-files/cloud/cloud/ec-customize-deployment.md % - [ ] ./raw-migrated-files/cloud/cloud-heroku/ech-configure-settings.md -⚠️ **This page is a work in progress.** ⚠️ +You might want to change the configuration of your deployment to: -The documentation team is working to combine content pulled from the following pages: +* Add features, such as machine learning or APM (application performance monitoring). +* Increase or decrease capacity by changing the amount of reserved memory and storage for different parts of your deployment. -* [/raw-migrated-files/cloud/cloud/ec-customize-deployment.md](/raw-migrated-files/cloud/cloud/ec-customize-deployment.md) -* [/raw-migrated-files/cloud/cloud-heroku/ech-configure-settings.md](/raw-migrated-files/cloud/cloud-heroku/ech-configure-settings.md) \ No newline at end of file + ::::{note} + During the free trial, {{ech}} deployments are restricted to a limited size. You can increase the size of your deployments when your trial is converted to a paid subscription. + :::: + +* Enable [autoscaling](../../../deploy-manage/autoscaling.md) so that the available resources for deployment components, such as data tiers and machine learning nodes, adjust automatically as the demands on them change over time. +* Enable high availability, also known as fault tolerance, by adjusting the number of data center availability zones that parts of your deployment run on. +* Upgrade to new versions of {{es}}. You can upgrade from one major version to another, such as from 6.8.23 to 7.17.27, or from one minor version to another, such as 6.1 to 6.2. You can’t downgrade versions. +* Change what plugins are available on your {{es}} cluster. + +With the exception of major version upgrades for Elastic Stack products, {{ech}} can perform configuration changes without having to interrupt your deployment. You can continue searching and indexing. The changes can also be done in bulk. For example: in one action, you can add more memory, upgrade, adjust the number of {{es}} plugins and adjust the number of availability zones. + +We perform all of these changes by creating instances with the new configurations that join your existing deployment before removing the old ones. For example: if you are changing your {{es}} cluster configuration, we create new {{es}} nodes, recover your indexes, and start routing requests to the new nodes. Only when all new {{es}} nodes are ready, do we bring down the old ones. + +By doing it this way, we reduce the risk of making configuration changes. If any of the new instances have a problems, the old ones are still there, processing requests. + +::::{note} +If you use a Platform-as-a-Service provider like Heroku, the administration console is slightly different and does not allow you to make changes that will affect the price. That must be done in the platform provider’s add-on system. You can still do things like change {{es}} version or plugins. +:::: + + +To change your deployment: + +1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body). +2. Find your deployment on the home page in the **Hosted deployments** card and select **Manage** to access it directly. Or, select **Hosted deployments** to go to the deployments page to view all of your deployments. + + On the deployments page you can narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list. + +3. From the deployment menu, select **Edit**. +4. Let the user interface guide you through the cluster configuration for your cluster. + + If you are changing an existing deployment, you can make multiple changes to your {{es}} cluster with a single configuration update, such as changing the capacity and upgrading to a new {{es}} version in one step. + +5. Save your changes. The new configuration takes a few moments to create. + +Review the changes to your configuration on the **Activity** page, with a tab for {{es}} and one for {{kib}}. + +::::{tip} +If you are creating a new deployment, select **Edit settings** to change the cloud provider, region, hardware profile, and stack version; or select **Advanced settings** for more complex configuration settings. +:::: + + +That’s it! If you haven’t already, [start exploring with {{kib}}](../../../deploy-manage/deploy/elastic-cloud/access-kibana.md), our visualization tool. If you’re not familiar with adding data yet, {{kib}} can show you how to index your data into {{es}}, or try our basic steps for working with [{{es}}](../../../manage-data/data-store/manage-data-from-the-command-line.md). + +::::{tip} +Some features are not available during the 14-day free trial. If a feature is greyed out, [add a credit card](../../../deploy-manage/cloud-organization/billing/add-billing-details.md) to unlock the feature. +:::: diff --git a/deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.md b/deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.md index 1cc31bd4ff..49ed143d6f 100644 --- a/deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.md +++ b/deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.md @@ -1,6 +1,12 @@ --- +applies_to: + deployment: + ess: ga mapped_pages: - https://www.elastic.co/guide/en/cloud/current/ec-create-deployment.html + - https://www.elastic.co/guide/en/cloud/current/ec-prepare-production.html + - https://www.elastic.co/guide/en/cloud/current/ec-configure-deployment-settings.html + - https://www.elastic.co/guide/en/cloud-heroku/current/ech-configure-deployment-settings.html --- # Create an Elastic Cloud Hosted deployment [ec-create-deployment] @@ -29,17 +35,17 @@ Once you are on the **Create deployment** page, you can create the deployment wi :alt: Create deployment ::: - Cloud provider - : The cloud platform where you’ll deploy your deployment. We support: Amazon Web Services (AWS), Google Cloud Platform (GCP), and Microsoft Azure. You do not need to provide your own keys. + **Cloud provider**: The cloud platform where you’ll deploy your deployment. We support: Amazon Web Services (AWS), Google Cloud Platform (GCP), and Microsoft Azure. You do not need to provide your own keys. - Region - : The cloud platform’s region your deployment will live. If you have compliance or latency requirements, you can create your deployment in any of our [supported regions](https://www.elastic.co/guide/en/cloud/current/ec-reference-regions.html). The region should be as close as possible to the location of your data. + **Region**: The cloud platform’s region your deployment will live. If you have compliance or latency requirements, you can create your deployment in any of our [supported regions](https://www.elastic.co/guide/en/cloud/current/ec-reference-regions.html). The region should be as close as possible to the location of your data. - Hardware profile - : This allows you to configure the underlying virtual hardware that you’ll deploy your Elastic Stack on. Each hardware profile provides a unique blend of storage, RAM and vCPU sizes. You can select a hardware profile that’s best suited for your use case. For example CPU Optimized if you have a search-heavy use case that’s bound by compute resources. For more details, check the [hardware profiles](ec-configure-deployment-settings.md#ec-hardware-profiles) section. You can also view the [virtual hardware details](https://www.elastic.co/guide/en/cloud/current/ec-reference-hardware.html) which powers hardware profiles. With the **Advanced settings** option, you can configure the underlying virtual hardware associated with each profile. + **Hardware profile**: This allows you to configure the underlying virtual hardware that you’ll deploy your Elastic Stack on. Each hardware profile provides a unique blend of storage, RAM and vCPU sizes. You can select a hardware profile that’s best suited for your use case. For example CPU Optimized if you have a search-heavy use case that’s bound by compute resources. For more details, check the [hardware profiles](ec-configure-deployment-settings.md#ec-hardware-profiles) section. You can also view the [virtual hardware details](https://www.elastic.co/guide/en/cloud/current/ec-reference-hardware.html) which powers hardware profiles. With the **Advanced settings** option, you can configure the underlying virtual hardware associated with each profile. - Version - : The Elastic Stack version that will get deployed. Defaults to the latest version. Our [version policy](available-stack-versions.md) describes which versions are available to deploy. + **Version**: The Elastic Stack version that will get deployed. Defaults to the latest version. Our [version policy](available-stack-versions.md) describes which versions are available to deploy. + + **Snapshot source**: To create a deployment from a snapshot, select a snapshot source. You need to [configure snapshots](../../tools/snapshot-and-restore.md) and establish a snapshot lifecycle management policy and repository before you can restore from a snapshot. The snapshot options depend on the stack version the deployment is running. + + **Name**: This setting allows you to assign a more human-friendly name to your cluster which will be used for future reference in the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body). Common choices are dev, prod, test, or something more domain specific. 2. Expand **Advanced settings** to configure your deployment for encryption using a customer-managed key, autoscaling, storage, memory, and vCPU. Check [Customize your deployment](configure.md) for more details. @@ -56,4 +62,15 @@ Once you are on the **Create deployment** page, you can create the deployment wi :alt: ESS Deployment main page ::: +## Preparing a deployment for production [ec-prepare-production] + +To make sure you’re all set for production, consider the following actions: + +* [Plan for your expected workloads](/deploy-manage/production-guidance/plan-for-production-elastic-cloud.md) and consider how many availability zones you’ll need. +* [Create a deployment](/deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.md) on the region you need and with a hardware profile that matches your use case. +* [Change your configuration](/deploy-manage/deploy/elastic-cloud/ec-customize-deployment.md) by turning on autoscaling, adding high availability, or adjusting components of the Elastic Stack. +* [Add extensions and plugins](/deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md) to use Elastic supported extensions or add your own custom dictionaries and scripts. +* [Edit settings and defaults](/deploy-manage/deploy/elastic-cloud/edit-stack-settings.md) to fine tune the performance of specific features. +* [Manage your deployment](/deploy-manage/deploy/elastic-cloud/manage-deployments.md) as a whole to restart, upgrade, stop routing, or delete. +* [Set up monitoring](/deploy-manage/monitor/stack-monitoring/elastic-cloud-stack-monitoring.md) to learn how to configure your deployments for observability, which includes metric and log collection, troubleshooting views, and cluster alerts to automate performance monitoring. diff --git a/deploy-manage/deploy/elastic-cloud/create-an-organization.md b/deploy-manage/deploy/elastic-cloud/create-an-organization.md index bf6ea0f340..15ee964e1c 100644 --- a/deploy-manage/deploy/elastic-cloud/create-an-organization.md +++ b/deploy-manage/deploy/elastic-cloud/create-an-organization.md @@ -62,11 +62,7 @@ Serverless projects package Elastic Stack features by type of solution: When you create a project, you select the project type applicable to your use case, so only the relevant and impactful applications and features are easily accessible to you. -::::{note} -During the trial period, you are limited to one active hosted deployment and one active serverless project at a time. When you subscribe, you can create additional deployments and projects. - -:::: - +For more information, check the [{{serverless-short}} documentation](serverless.md). ### Trial limitations [general-sign-up-trial-what-limits-are-in-place-during-a-trial] diff --git a/deploy-manage/deploy/elastic-cloud/custom-endpoint-aliases.md b/deploy-manage/deploy/elastic-cloud/custom-endpoint-aliases.md index e463ea00d5..ba9f9ce4d5 100644 --- a/deploy-manage/deploy/elastic-cloud/custom-endpoint-aliases.md +++ b/deploy-manage/deploy/elastic-cloud/custom-endpoint-aliases.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ess: ga mapped_urls: - https://www.elastic.co/guide/en/cloud/current/ec-regional-deployment-aliases.html - https://www.elastic.co/guide/en/cloud-heroku/current/ech-regional-deployment-aliases.html @@ -13,9 +16,151 @@ mapped_urls: % - [ ] ./raw-migrated-files/cloud/cloud/ec-regional-deployment-aliases.md % - [ ] ./raw-migrated-files/cloud/cloud-heroku/ech-regional-deployment-aliases.md -⚠️ **This page is a work in progress.** ⚠️ -The documentation team is working to combine content pulled from the following pages: +Custom aliases for your deployment endpoints on {{ech}} allow you to have predictable, human-readable URLs that can be shared easily. An alias is unique to only one deployment within a region. + + +## Create a custom endpoint alias for a deployment [ec-create-regional-deployment-alias] + +::::{note} +New deployments are assigned a default alias derived from the deployment name. This alias can be modified later, if needed. +:::: + + +To add an alias to an existing deployment: + +1. From the **Deployments** menu, select a deployment. +2. Under **Custom endpoint alias**, select **Edit**. +3. Define a new alias. Make sure you choose something meaningful to you. + + ::::{tip} + Make the alias as unique as possible to avoid collisions. Aliases might have been already claimed by other users for deployments in the region. + :::: + +4. Select **Update alias**. + + +## Remove a custom endpoint alias [ec-delete-regional-deployment-alias] + +To remove an alias from your deployment, or if you want to re-assign an alias to another deployment, follow these steps: + +1. From the **Deployments** menu, select a deployment. +2. Under **Custom endpoint alias**, select **Edit**. +3. Remove the text from the **Custom endpoint alias** text box. +4. Select **Update alias**. + +::::{note} +After removing an alias, your organisation’s account will hold a claim on it for 30 days. After that period, other users can re-use this alias. +:::: + + + +## Using the custom endpoint URL [ec-using-regional-deployment-alias] + +To use your new custom endpoint URL to access your Elastic products, note that each has its own alias to use in place of the default application UUID. For example, if you configured the custom endpoint alias for your deployment to be `test-alias`, the corresponding alias for the Elasticsearch cluster in that deployment is `test-alias.es`. + +::::{note} +You can get the application-specific custom endpoint alias by selecting **Copy endpoint** for that product. It should contain a subdomain for each application type, for example `es`, `kb`, `apm`, or `ent`. +:::: + + + +### With the REST Client [ec-rest-regional-deployment-alias] + +* As part of the host name: + + After configuring your custom endpoint alias, select **Copy endpoint** on the deployment overview page, which gives you the fully qualified custom endpoint URL for that product. + +* As an HTTP request header: + + Alternatively, you can reach your application by passing the application-specific custom endpoint alias, for example, `test-alias.es`, as the value for the `X-Found-Cluster` HTTP header. + + + +### With the `TransportClient` [ec-transport-regional-deployment-alias] + +While the `TransportClient` is deprecated, your custom endpoint aliases still work with it. Similar to the REST Client, there are two ways to use your custom endpoint alias with the `TransportClient`: + +* As part of the host name: + + Similar to HTTP, you can find the fully qualified host on the deployment overview page by selecting **Copy endpoint** next to Elasticsearch. Make sure to remove the unnecessary `https://` prefix as well as the trailing HTTP port. + +* As part of the **Settings**: + + Include the application-specific custom endpoint alias as the value for `request.headers.X-Found-Cluster` setting in place of the `clusterId`: + + ```java + // Build the settings for our client. + String alias = "test-alias.es"; // Your application-specific custom endpoint alias here + String region = "us-east-1"; // Your region here + boolean enableSsl = true; + + Settings settings = Settings.settingsBuilder() + .put("transport.ping_schedule", "5s") + //.put("transport.sniff", false) // Disabled by default and *must* be disabled. + .put("action.bulk.compress", false) + .put("shield.transport.ssl", enableSsl) + .put("request.headers.X-Found-Cluster", alias) + .put("shield.user", "username:password") // your shield username and password + .build(); + + String hostname = alias + "." + region + ".aws.found.io"; + // Instantiate a TransportClient and add the cluster to the list of addresses to connect to. + // Only port 9343 (SSL-encrypted) is currently supported. + Client client = TransportClient.builder() + .addPlugin(ShieldPlugin.class) + .settings(settings) + .build() + .addTransportAddress(new InetSocketTransportAddress(InetAddress.getByName(hostname), 9343)); + ``` + + +For more information on configuring the `TransportClient`, see + + +## Create a custom domain with NGINX [ec-custom-domains-with-nginx] + +If you don’t get the level of domain customization you’re looking for by using the [custom endpoint aliases](../../../deploy-manage/deploy/elastic-cloud/custom-endpoint-aliases.md), you might consider creating a CNAME record that points to your Elastic Cloud endpoints. However, that can lead to some issues. Instead, setting up your own proxy could provide the desired level of customization. + +::::{important} +The setup described in the following sections is not supported by Elastic, and if your proxy cannot connect to the endpoint, but curl can, we may not be able to help. +:::: + + + +### Avoid creating CNAMEs [ec_avoid_creating_cnames] + +To achieve a fully custom domain, you can add a CNAME that points to your Elastic Cloud endpoint. However, this will lead to invalid certificate errors, and moreover, may simply not work. Your Elastic Cloud endpoints already point to a proxy internal to Elastic Cloud, which may not resolve your configured CNAME in the desired way. + +So what to do, instead? + + +### Setting up a proxy [ec_setting_up_a_proxy] + +Here we’ll show you an example of proxying with NGINX, but this can be extrapolated to HAProxy or some other proxy server. + +You need to set `proxy_pass` and `proxy_set_header`, and include the `X-Found-Cluster` header with the cluster’s UUID. You can get the cluster ID by clicking the `Copy cluster ID` link on your deployment’s main page. + +``` +server { + listen 443 ssl; + server_name elasticsearch.example.com; + + include /etc/nginx/tls.conf; + + location / { + proxy_pass https://.eu-west-1.aws.elastic-cloud.com/; + proxy_set_header X-Found-Cluster ; + } +} +``` + +This should work for all of your applications, not just {{es}}. To set it up for {{kib}}, for example, you can select `Copy cluster ID` next to {{kib}} on your deployment’s main page to get the correct UUID. + +::::{note} +Doing this for {{kib}} won't work with Cloud SSO. +:::: + + +To configure `tls.conf in this example, check out [https://ssl-config.mozilla.org/](https://ssl-config.mozilla.org/) for more fields. -* [/raw-migrated-files/cloud/cloud/ec-regional-deployment-aliases.md](/raw-migrated-files/cloud/cloud/ec-regional-deployment-aliases.md) -* [/raw-migrated-files/cloud/cloud-heroku/ech-regional-deployment-aliases.md](/raw-migrated-files/cloud/cloud-heroku/ech-regional-deployment-aliases.md) \ No newline at end of file diff --git a/deploy-manage/deploy/elastic-cloud/ec-change-hardware-profile.md b/deploy-manage/deploy/elastic-cloud/ec-change-hardware-profile.md index 28e198d3d6..ecb8b77bb0 100644 --- a/deploy-manage/deploy/elastic-cloud/ec-change-hardware-profile.md +++ b/deploy-manage/deploy/elastic-cloud/ec-change-hardware-profile.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ess: ga mapped_pages: - https://www.elastic.co/guide/en/cloud/current/ec-change-hardware-profile.html --- @@ -27,6 +30,7 @@ Note that if there’s no indication that a newer version is available, that mea :::{image} ../../../images/cloud-ec-new-hardware-profile-version.png :alt: Badge indicating new hardware profile version + :width: 50% ::: 2. Preview the changes for the new hardware profile version. diff --git a/deploy-manage/deploy/elastic-cloud/ec-configure-deployment-settings.md b/deploy-manage/deploy/elastic-cloud/ec-configure-deployment-settings.md deleted file mode 100644 index 6b2f9ee6a5..0000000000 --- a/deploy-manage/deploy/elastic-cloud/ec-configure-deployment-settings.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -mapped_pages: - - https://www.elastic.co/guide/en/cloud/current/ec-configure-deployment-settings.html ---- - -# What deployment settings are available? [ec-configure-deployment-settings] - -The following deployment settings are available: - - -## Cloud provider [ec_cloud_provider] - -Selects a cloud platform where your {{es}} clusters and {{kib}} instances will be hosted. {{ech}} currently supports Amazon Web Services (AWS), Google Cloud Platform (GCP), and Microsoft Azure. - - -## Region [ec_region] - -Regions represent data centers in a geographic location, where your deployment will be located. When choosing a region, the general rule is to choose one as close to your application servers as possible in order to minimize network delays. - -::::{tip} -You can select your cloud platform and region only when you create a new deployment, so pick ones that works for you. They cannot be changed later. Different deployments can use different platforms and regions. -:::: - - - -## Hardware profile [ec-hardware-profiles] - -Elastic Cloud deploys Elastic Stack components into a *hardware profile* which provides a unique blend of storage, memory and vCPU. This gives you more flexibility to choose the hardware profile that best fits for your use case. For example, *Compute Optimized* deploys Elasticsearch on virtual hardware that provides high [vCPU](../../monitor/monitoring-data/ec-vcpu-boost-instance.md) which can help search-heavy use cases return queries quickly. - -Under the covers, hardware profiles leverage virtualized instances from a cloud provider, such as Amazon Web Services, Google Compute Platform, and Microsoft Azure. You don’t interact with the cloud provider directly, but we do document what we use for your reference. To learn more, check [{{ech}} Hardware](https://www.elastic.co/guide/en/cloud/current/ec-reference-hardware.html). - -The components of the Elastic Stack that we support as part of a deployment are called *instances* and include: - -* Elasticsearch data tiers and master nodes -* Machine Learning (ML) nodes -* Kibana instances -* APM and Fleet instances -* Integrations Server instances - -When you [create your deployment](create-an-elastic-cloud-hosted-deployment.md), you can choose the hardware profile that best fits your needs, and configure it with the **Advanced settings** option. Depending on the cloud provider that you select, you can adjust the size of Elasticsearch nodes, or configure your Kibana and APM & Fleet instances. As your usage evolves, you can [change the hardware profile](ec-change-hardware-profile.md) of your deployment. - -::::{note} -Elastic Agent, Beats, and Logstash are components of the Elastic Stack that are not included in the hardware profiles as they are installed outside of Elastic Cloud. -:::: - - - -## Version [ec_version] - -Elastic Stack uses a versions code that is constructed of three numbers separated by dots: the leftmost number is the number of the major release, the middle number is the number of the minor release and the rightmost number is the number of the maintenance release (e.g., 8.3.2 means major release 8, minor release 3 and maintenance release 2). - -You might sometimes notice additional versions listed in the user interface beyond the versions we currently support and maintain, such as [release candidate builds](available-stack-versions.md#ec-release-builds) and older versions. If a version is listed in the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body), it can be deployed. - -To learn about how we support {{es}} versions in {{ech}}, check [Version Policy](available-stack-versions.md). - -You can always upgrade {{es}} versions, but you cannot downgrade. To learn more about upgrading versions of {{es}} and best practices for major version upgrades, check [Version Upgrades](../../upgrade/deployment-or-cluster.md). - - -## Snapshot source [ec_snapshot_source] - -To create a deployment from a snapshot, select the snapshot source. You need to [configure snapshots](../../tools/snapshot-and-restore.md) and establish a snapshot lifecycle management policy and repository before you can restore from a snapshot. The snapshot options depend on the stack version the deployment is running. - - -## Name [ec_name] - -This setting allows you to assign a more human-friendly name to your cluster which will be used for future reference in the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body). Common choices are dev, prod, test, or something more domain specific. - diff --git a/deploy-manage/deploy/elastic-cloud/ec-customize-deployment-components.md b/deploy-manage/deploy/elastic-cloud/ec-customize-deployment-components.md index 59a672846c..0f429ec480 100644 --- a/deploy-manage/deploy/elastic-cloud/ec-customize-deployment-components.md +++ b/deploy-manage/deploy/elastic-cloud/ec-customize-deployment-components.md @@ -1,9 +1,13 @@ --- +applies_to: + deployment: + ess: ga mapped_pages: - https://www.elastic.co/guide/en/cloud/current/ec-customize-deployment-components.html + - https://www.elastic.co/guide/en/cloud-heroku/current/ech-customize-deployment-components.html --- -# How can I customize the components of my deployment? [ec-customize-deployment-components] +# Customize deployment components [ec-customize-deployment-components] When you create or edit an existing deployment, you can fine-tune the capacity, add extensions, and select additional features. diff --git a/deploy-manage/deploy/elastic-cloud/ec-customize-deployment.md b/deploy-manage/deploy/elastic-cloud/ec-customize-deployment.md deleted file mode 100644 index 6b6b78e5cd..0000000000 --- a/deploy-manage/deploy/elastic-cloud/ec-customize-deployment.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -mapped_pages: - - https://www.elastic.co/guide/en/cloud/current/ec-customize-deployment.html ---- - -# Change your configuration [ec-customize-deployment] - -You might want to change the configuration of your deployment to: - -* Add features, such as machine learning or APM (application performance monitoring). -* Increase or decrease capacity by changing the amount of reserved memory and storage for different parts of your deployment. - - ::::{note} - During the free trial, {{ech}} deployments are restricted to a limited size. You can increase the size of your deployments when your trial is converted to a paid subscription. - :::: - -* Enable [autoscaling](../../autoscaling.md) so that the available resources for deployment components, such as data tiers and machine learning nodes, adjust automatically as the demands on them change over time. -* Enable high availability, also known as fault tolerance, by adjusting the number of data center availability zones that parts of your deployment run on. -* Upgrade to new versions of {{es}}. You can upgrade from one major version to another, such as from 6.8.23 to 7.17.27, or from one minor version to another, such as 6.1 to 6.2. You can’t downgrade versions. -* Change what plugins are available on your {{es}} cluster. - -With the exception of major version upgrades for Elastic Stack products, {{ecloud}} can perform configuration changes without having to interrupt your deployment. You can continue searching and indexing. The changes can also be done in bulk. For example: in one action, you can add more memory, upgrade, adjust the number of {{es}} plugins and adjust the number of availability zones. - -We perform all of these changes by creating instances with the new configurations that join your existing deployment before removing the old ones. For example: if you are changing your {{es}} cluster configuration, we create new {{es}} nodes, recover your indexes, and start routing requests to the new nodes. Only when all new {{es}} nodes are ready, do we bring down the old ones. - -By doing it this way, we reduce the risk of making configuration changes. If any of the new instances have a problems, the old ones are still there, processing requests. - -::::{note} -If you use a Platform-as-a-Service provider like Heroku, the administration console is slightly different and does not allow you to make changes that will affect the price. That must be done in the platform provider’s add-on system. You can still do things like change {{es}} version or plugins. -:::: - - -To change your deployment: - -1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body). -2. Find your deployment on the home page in the **Hosted deployments** card and select **Manage** to access it directly. Or, select **Hosted deployments** to go to the deployments page to view all of your deployments. - - On the deployments page you can narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list. - -3. From the deployment menu, select **Edit**. -4. Let the user interface guide you through the cluster configuration for your cluster. For a full list of the supported settings, check [What Deployment Settings Are Available?](ec-configure-deployment-settings.md) - - If you are changing an existing deployment, you can make multiple changes to your {{es}} cluster with a single configuration update, such as changing the capacity and upgrading to a new {{es}} version in one step. - -5. Save your changes. The new configuration takes a few moments to create. - -Review the changes to your configuration on the **Activity** page, with a tab for {{es}} and one for {{kib}}. - -::::{tip} -If you are creating a new deployment, select **Edit settings** to change the cloud provider, region, hardware profile, and stack version; or select **Advanced settings** for more complex configuration settings. -:::: - - -That’s it! If you haven’t already, [start exploring with {{kib}}](access-kibana.md), our visualization tool. If you’re not familiar with adding data yet, {{kib}} can show you how to index your data into {{es}}, or try our basic steps for working with [{{es}}](../../../manage-data/data-store/manage-data-from-the-command-line.md). - -::::{tip} -Some features are not available during the 14-day free trial. If a feature is greyed out, [add a credit card](../../cloud-organization/billing/add-billing-details.md) to unlock the feature. -:::: - - - - - diff --git a/deploy-manage/deploy/elastic-cloud/ech-configure-deployment-settings.md b/deploy-manage/deploy/elastic-cloud/ech-configure-deployment-settings.md deleted file mode 100644 index 7ea48596af..0000000000 --- a/deploy-manage/deploy/elastic-cloud/ech-configure-deployment-settings.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -mapped_pages: - - https://www.elastic.co/guide/en/cloud-heroku/current/ech-configure-deployment-settings.html ---- - -# What deployment settings are available? [ech-configure-deployment-settings] - -The following deployment settings are available: - - -## Cloud provider [echcloud_provider] - -Selects a cloud platform where your {{es}} clusters, {{kib}} instance, and other {{stack}} components will be hosted. Elasticsearch Add-On for Heroku currently supports Amazon Web Services (AWS), Google Cloud Platform (GCP), and Microsoft Azure. - - -## Region [echregion] - -Regions represent data centers in a geographic location, where your deployment will be located. When choosing a region, the general rule is to choose one as close to your application servers as possible in order to minimize network delays. - -::::{tip} -You can select your cloud platform and region only when you create a new deployment, so pick ones that works for you. They cannot be changed later. Different deployments can use different platforms and regions. -:::: - - - -## Version [echversion] - -Elastic Stack uses a versions code that is constructed of three numbers separated by dots: the leftmost number is the number of the major release, the middle number is the number of the minor release and the rightmost number is the number of the maintenance release (e.g., 8.3.2 means major release 8, minor release 3 and maintenance release 2). - -You might sometimes notice additional versions listed in the user interface beyond the versions we currently support and maintain, such as [release candidate builds](ech-version-policy.md#ech-release-builds) and older versions. If a version is listed in the [Elasticsearch Add-On for Heroku console](https://cloud.elastic.co?page=docs&placement=docs-body), it can be deployed. - -To learn about how we support {{es}} versions in Elasticsearch Add-On for Heroku, check [Version Policy](ech-version-policy.md). - -You can always upgrade {{es}} versions, but you cannot downgrade. To learn more about upgrading versions of {{es}} and best practices for major version upgrades, check [Version Upgrades](../../upgrade/deployment-or-cluster.md). - - -## Snapshot source [echsnapshot_source] - -To create a deployment from a snapshot, select the snapshot source. You need to [configure snapshots](../../tools/snapshot-and-restore.md) and establish a snapshot lifecycle management policy and repository before you can restore from a snapshot. The snapshot options depend on the stack version the deployment is running. - - -## Name [echname] - -This setting allows you to assign a more human-friendly name to your cluster which will be used for future reference in the [Elasticsearch Add-On for Heroku console](https://cloud.elastic.co?page=docs&placement=docs-body). Common choices are dev, prod, test, or something more domain specific. - diff --git a/deploy-manage/deploy/elastic-cloud/ech-configure-settings.md b/deploy-manage/deploy/elastic-cloud/ech-configure-settings.md deleted file mode 100644 index 6f932bfe3e..0000000000 --- a/deploy-manage/deploy/elastic-cloud/ech-configure-settings.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -mapped_pages: - - https://www.elastic.co/guide/en/cloud-heroku/current/ech-configure-settings.html ---- - -# Configure your deployment [ech-configure-settings] - -You might want to change the configuration of your deployment to: - -* Add features, such as machine learning or APM (application performance monitoring). -* Increase or decrease capacity by changing the amount of reserved memory and storage for different parts of your deployment. -* Enable [autoscaling](../../autoscaling.md) so that the available resources for deployment components, such as data tiers and machine learning nodes, adjust automatically as the demands on them change over time. -* Enable high availability by adjusting the number of availability zones that parts of your deployment run on. -* Upgrade to new versions of {{es}}. You can upgrade from one major version to another, such as from 7.17.27 to 8.17.1, or from one minor version to another, such as 8.6 to 8.7. You can’t downgrade versions. -* Change what plugins are available on your {{es}} cluster. - -::::{note} -During the free trial, {{ess}} deployments are restricted to a fixed size. You can resize your deployments when your trial is converted into a paid subscription. -:::: - - -You can change the configuration of a running deployment from the **Configuration** pane in the [Elasticsearch Add-On for Heroku console](https://cloud.elastic.co?page=docs&placement=docs-body). - -With the exception of major version upgrades for Elastic Stack products, Elasticsearch Add-On for Heroku can perform configuration changes without having to interrupt your deployment. You can continue searching and indexing. The changes can also be done in bulk. For example: in one action you can add more memory, upgrade, adjust the number of {{es}} plugins and adjust the number of availability zones. - -We perform all of these changes by creating instances with the new configurations that join your existing deployment before removing the old ones. For example: if you are changing your {{es}} cluster configuration, we create new {{es}} nodes, recover your indexes, and start routing requests to the new nodes. Only when all new {{es}} nodes are ready, do we bring down the old ones. - -By doing it this way, we reduce the risk of making configuration changes. If any of the new instances have a problems, the old ones are still there, processing requests. - -::::{note} -If you use a Platform-as-a-Service provider like Heroku, the administration console is slightly different and does not allow you to make changes that will affect the price. That must be done in the platform provider’s add-on system. You can still do things like change {{es}} version or plugins. -:::: - - -To change the {{es}} cluster in your deployment: - -1. Log in to the [Elasticsearch Add-On for Heroku console](https://cloud.elastic.co?page=docs&placement=docs-body). -2. On the deployments page, select your deployment. - - Narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list. - -3. From your deployment menu, select **{{es}}** and then **Edit**. -4. Let the user interface guide you through the cluster configuration for your cluster. For a full list of the supported settings, check [What Deployment Settings Are Available?](ech-configure-deployment-settings.md) - - If you are changing an existing deployment, you can make multiple changes to your {{es}} cluster with a single configuration update, such as changing the capacity and upgrading to a new {{es}} version in one step. - -5. Save your changes. The new configuration takes a few moments to create. - -Review the changes to your configuration on the **Activity** page, with a tab for {{es}} and one for {{kib}}. - - - diff --git a/deploy-manage/deploy/elastic-cloud/ech-customize-deployment-components.md b/deploy-manage/deploy/elastic-cloud/ech-customize-deployment-components.md deleted file mode 100644 index b734038a9f..0000000000 --- a/deploy-manage/deploy/elastic-cloud/ech-customize-deployment-components.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -mapped_pages: - - https://www.elastic.co/guide/en/cloud-heroku/current/ech-customize-deployment-components.html ---- - -# How can I customize the components of my deployment? [ech-customize-deployment-components] - -When you create or edit an existing deployment, you can fine-tune the capacity, add extensions, and select additional features. - - -### Autoscaling [ech-customize-autoscaling] - -Autoscaling reduces some of the manual effort required to manage a deployment by adjusting the capacity as demands on the deployment change. Currently, autoscaling is supported to scale {{es}} data tiers upwards, and to scale machine learning nodes both upwards and downwards. Check [Deployment autoscaling](../../autoscaling.md) to learn more. - - -### {{es}} [ech-cluster-size] - -Depending upon how much data you have and what queries you plan to run, you need to select a cluster size that fits your needs. There is no silver bullet for deciding how much memory you need other than simply testing it. The [cluster performance metrics](../../monitor/stack-monitoring/elastic-cloud-stack-monitoring.md) in the [Elasticsearch Add-On for Heroku console](https://cloud.elastic.co?page=docs&placement=docs-body) can tell you if your cluster is sized appropriately. You can also [enable deployment monitoring](../../monitor/stack-monitoring/elastic-cloud-stack-monitoring.md) for more detailed performance metrics. Fortunately, you can change the amount of memory allocated to the cluster later without any downtime for HA deployments. - -To change a cluster’s topology, from deployment management, select **Edit deployment** from the **Actions** dropdown. Next, select a storage and RAM setting from the **Size per zone** drop-down list, and save your changes. When downsizing the cluster, make sure to have enough resources to handle the current load, otherwise your cluster will be under stress. - -:::{image} ../../../images/cloud-heroku-ec-capacity.png -:alt: Capacity slider to adjust {{es}} cluster size -::: - -Currently, half the memory is assigned to the JVM heap (a bit less when monitoring is activated). For example, on a 32 GB cluster, 16 GB are allotted to heap. The disk-to-RAM ratio currently is 1:24, meaning that you get 24 GB of storage space for each 1 GB of RAM. All clusters are backed by SSD drives. - -::::{tip} -For production systems, we recommend not using less than 4 GB of RAM for your cluster, which assigns 2 GB to the JVM heap. -:::: - - -The CPU resources assigned to a cluster are relative to the size of your cluster, meaning that a 32 GB cluster gets twice as much CPU resources as a 16 GB cluster. All clusters are guaranteed their share of CPU resources, as we do not overcommit resources. Smaller clusters up to and including 8 GB of RAM benefit from temporary CPU boosting to improve performance when needed most. - - -### Fault tolerance [ech-high-availability] - -High availability is achieved by running a cluster with replicas in multiple data centers (availability zones), to prevent against downtime when infrastructure problems occur or when resizing or upgrading deployments. We offer the options of running in one, two, or three data centers. - -:::{image} ../../../images/cloud-heroku-ec-fault-tolerance.png -:alt: High availability features -::: - -Running in two data centers or availability zones is our default high availability configuration. It provides reasonably high protection against infrastructure failures and intermittent network problems. You might want three data centers if you need even higher fault tolerance. Just one zone might be sufficient, if the cluster is mainly used for testing or development. - -::::{important} -Some [regions](ech-reference-regions.md) might have only two availability zones. -:::: - - -Like many other changes, you change the level of fault tolerance while the cluster is running. For example, when you prepare a new cluster for production use, you can first run it in a single data center and then add another data center right before deploying to production. - -While multiple data centers or availability zones increase a cluster’s fault tolerance, they do not protect against problematic searches that cause nodes to run out of memory. For a cluster to be highly reliable and available, it is also important to [have enough memory](../../../troubleshoot/monitoring/high-memory-pressure.md). - -The node capacity you choose is per data center. The reason for this is that there is no point in having two data centers if the failure of one will result in a cascading error because the remaining data center cannot handle the total load. Through the allocation awareness in {{es}}, we configure the nodes so that your {{es}} cluster will automatically allocate replicas between each availability zone. - - -### Sharding [echsharding] - -You can get an at-a-glance status of all the shards in the deployment on the **{{es}}** page. - -:::{image} ../../../images/cloud-heroku-ec-shard-activity.gif -:alt: Shard activity -::: - -We recommend that you read [Size your shards](../../production-guidance/optimize-performance/size-shards.md) before you change the number of shards. - -## Manage user settings and extensions [echmanage_user_settings_and_extensions] - -Here, you can configure user settings, extensions, and system settings (older versions only). - -### User settings [ech-user-settings] - -Set specific configuration parameters to change how {{es}} and other Elastic products run. User settings are appended to the appropriate YAML configuration file, but not all settings are supported in Elasticsearch Add-On for Heroku. - -For more information, refer to [Edit your user settings](edit-stack-settings.md). - - -#### Extensions [echextensions] - -Lists the official plugins available for your selected {{es}} version, as well as any custom plugins and user bundles with dictionaries or scripts. - -The reason we do not list the version chosen on this page is because we reserve the option to change it when necessary. That said, we will not force a cluster restart for a simple plugin upgrade unless there are severe issues with the current version. In most cases, plugin upgrades are applied lazily, in other words when something else forces a restart like you changing the plan or {{es}} runs out of memory. - -::::{tip} -Only Gold and Platinum subscriptions have access to uploading custom plugins. All subscription levels, including Standard, can upload scripts and dictionaries. -:::: - - - -### {{kib}} [echkib] - -A {{kib}} instance is created automatically as part of every deployment. - -::::{tip} -If you use a version before 5.0 or if your deployment didn’t include a {{kib}} instance initially, there might not be a {{kib}} endpoint URL shown, yet. To enable {{kib}}, select **Enable**. Enabling {{kib}} provides you with an endpoint URL, where you can access {{kib}}. It can take a short while to provision {{kib}} right after you select **Enable**, so if you get an error message when you first access the endpoint URL, try again. -:::: - - -Selecting **Open** will log you in to {{kib}} using single sign-on (SSO). For versions older than 7.9.2, you need to log in to {{kib}} with the `elastic` superuser. The password was provided when you created your deployment or [can be reset](../../users-roles/cluster-or-deployment-auth/built-in-users.md). - -In production systems, you might need to control what {{es}} data users can access through {{kib}}. Refer to [Securing your deployment](../../security.md) to learn more. - - -### {{integrations-server}} [echintegrations_server] - -{{integrations-server}} connects observability and security data from Elastic Agents and APM to Elasticsearch. An {{integrations-server}} instance is created automatically as part of every deployment. - - -### Security [echsecurity] - -Here, you can configure features that keep your deployment secure: reset the password for the `elastic` user, set up traffic filters, and add settings to the {{es}} keystore. You can also set up remote connections to other deployments. - - -### Maintenance mode [ech-maintenance-mode] - -In maintenance mode, requests to your cluster are blocked during configuration changes. You use maintenance mode to perform corrective actions that might otherwise be difficult to complete. Maintenance mode lasts for the duration of a configuration change and is turned off after the change completes. - -We strongly recommend that you use maintenance mode when your cluster is overwhelmed by requests and you need to increase capacity. If your cluster is being overwhelmed because it is undersized for its workload, nodes might not respond to efforts to resize. Putting the cluster into maintenance mode as part of the configuration change can stop the cluster from becoming completely unresponsive during the configuration change, so that you can resolve the capacity issue. Without this option, configuration changes for clusters that are overwhelmed can take longer and are more likely to fail. - - -### Actions [echactions] - -There are a few actions you can perform from the **Actions** dropdown: - -* Restart {{es}} - Needed only rarely, but full cluster restarts can help with a suspected operational issue before reaching out to Elastic for help. -* Delete your deployment - For deployment that you no longer need and don’t want to be charged for any longer. Deleting a deployment removes the {{es}} cluster and all your data permanently. - -::::{important} -Use these actions with care. Deployments are not available while they restart and deleting a deployment does really remove the {{es}} cluster and all your data permanently. -:::: - - - - diff --git a/deploy-manage/deploy/elastic-cloud/ech-default-aws-configurations.md b/deploy-manage/deploy/elastic-cloud/ech-default-aws-configurations.md index ade66cfc97..7d010e4525 100644 --- a/deploy-manage/deploy/elastic-cloud/ech-default-aws-configurations.md +++ b/deploy-manage/deploy/elastic-cloud/ech-default-aws-configurations.md @@ -5,7 +5,7 @@ mapped_pages: # Elasticsearch Add-On for Heroku AWS default provider instance configurations [ech-default-aws-configurations] -Following are the preferred instance types / machine configurations, storage types, disk to memory ratios, and virtual CPU to RAM ratios for all instance configurations available on {{ess}} and provided by AWS. +Following are the preferred instance types / machine configurations, storage types, disk to memory ratios, and virtual CPU to RAM ratios for all instance configurations available on {{ech}} and provided by AWS. | Instance configuration | Preferred Instance Type or Machine Configuration1 | Storage Type1 | Disk:Memory Ratio2 | vCPU/RAM Ratio | | --- | --- | --- | --- | --- | @@ -27,7 +27,7 @@ Following are the preferred instance types / machine configurations, storage typ ## Additional instances [ech-aws-additional-instances] -Following are the preferred instance type / configuration and virtual CPU to RAM ratios for additional instance configurations available on {{ess}} and provided by AWS. +Following are the preferred instance type / configuration and virtual CPU to RAM ratios for additional instance configurations available on {{ech}} and provided by AWS. | Instance configuration | Preferred Instance Type or Machine Configuration1 | vCPU/RAM Ratio | | --- | --- | --- | diff --git a/deploy-manage/deploy/elastic-cloud/ech-default-azure-configurations.md b/deploy-manage/deploy/elastic-cloud/ech-default-azure-configurations.md index 0c841b2a98..fc9c5755f0 100644 --- a/deploy-manage/deploy/elastic-cloud/ech-default-azure-configurations.md +++ b/deploy-manage/deploy/elastic-cloud/ech-default-azure-configurations.md @@ -5,7 +5,7 @@ mapped_pages: # Elasticsearch Add-On for Heroku Azure default provider instance configurations [ech-default-azure-configurations] -Following are the preferred instance types / machine configurations, storage types, disk to memory ratios, and virtual CPU to RAM ratios for all instance configurations available on {{ess}} and provided by Azure. +Following are the preferred instance types / machine configurations, storage types, disk to memory ratios, and virtual CPU to RAM ratios for all instance configurations available on {{ech}} and provided by Azure. | Instance configuration | Preferred Instance Type or Machine Configuration1 | Storage Type1 | Disk:Memory Ratio2 | vCPU/RAM Ratio | | --- | --- | --- | --- | --- | @@ -20,7 +20,7 @@ Following are the preferred instance types / machine configurations, storage typ ## Additional instances [ech-additional-instances] -Following are the preferred instance type / configuration and virtual CPU to RAM ratios for additional instance configurations available on {{ess}} and provided by Azure. +Following are the preferred instance type / configuration and virtual CPU to RAM ratios for additional instance configurations available on {{ech}} and provided by Azure. | Instance configuration | Preferred Instance Type or Machine Configuration1 | vCPU/RAM Ratio | | --- | --- | --- | diff --git a/deploy-manage/deploy/elastic-cloud/ech-default-gcp-configurations.md b/deploy-manage/deploy/elastic-cloud/ech-default-gcp-configurations.md index c6433a3db7..44eb14bd4e 100644 --- a/deploy-manage/deploy/elastic-cloud/ech-default-gcp-configurations.md +++ b/deploy-manage/deploy/elastic-cloud/ech-default-gcp-configurations.md @@ -5,7 +5,7 @@ mapped_pages: # Elasticsearch Add-On for Heroku GCP default provider instance configurations [ech-default-gcp-configurations] -Following are the preferred instance types / machine configurations, storage types, disk to memory ratios, and virtual CPU to RAM ratios for all instance configurations available on {{ess}} and provided by GCP. +Following are the preferred instance types / machine configurations, storage types, disk to memory ratios, and virtual CPU to RAM ratios for all instance configurations available on {{ech}} and provided by GCP. | Instance configuration | Preferred Instance Type or Machine Configuration1 | Storage Type1 | Disk:Memory Ratio2 | vCPU/RAM Ratio | | --- | --- | --- | --- | --- | @@ -21,7 +21,7 @@ Following are the preferred instance types / machine configurations, storage typ ## Additional instances [ech-gcp-additional-instances] -Following are the preferred instance configuration and virtual CPU to RAM ratios for additional instance configurations available on {{ess}} and provided by GCP. +Following are the preferred instance configuration and virtual CPU to RAM ratios for additional instance configurations available on {{ech}} and provided by GCP. | Instance configuration | Preferred Instance Type or Machine Configuration1 | vCPU/RAM Ratio | | --- | --- | --- | diff --git a/deploy-manage/deploy/elastic-cloud/edit-stack-settings.md b/deploy-manage/deploy/elastic-cloud/edit-stack-settings.md index 31734e24ea..d004ba6a27 100644 --- a/deploy-manage/deploy/elastic-cloud/edit-stack-settings.md +++ b/deploy-manage/deploy/elastic-cloud/edit-stack-settings.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ess: ga mapped_urls: - https://www.elastic.co/guide/en/cloud/current/ec-add-user-settings.html - https://www.elastic.co/guide/en/cloud/current/ec-editing-user-settings.html @@ -12,7 +15,7 @@ mapped_urls: - https://www.elastic.co/guide/en/cloud/current/ec-manage-enterprise-search-settings.html --- -# Edit stack settings +# Edit {{stack}} settings % What needs to be done: Refine @@ -47,15 +50,65 @@ $$$ec-appsearch-settings$$$ $$$ec-es-elasticsearch-settings$$$ -**This page is a work in progress.** The documentation team is working to combine content pulled from the following pages: - -* [/raw-migrated-files/cloud/cloud/ec-add-user-settings.md](/raw-migrated-files/cloud/cloud/ec-add-user-settings.md) -* [/raw-migrated-files/cloud/cloud/ec-editing-user-settings.md](/raw-migrated-files/cloud/cloud/ec-editing-user-settings.md) -* [/raw-migrated-files/cloud/cloud-heroku/ech-add-user-settings.md](/raw-migrated-files/cloud/cloud-heroku/ech-add-user-settings.md) -* [/raw-migrated-files/cloud/cloud/ec-manage-kibana-settings.md](/raw-migrated-files/cloud/cloud/ec-manage-kibana-settings.md) -* [/raw-migrated-files/cloud/cloud-heroku/ech-manage-kibana-settings.md](/raw-migrated-files/cloud/cloud-heroku/ech-manage-kibana-settings.md) -* [/raw-migrated-files/cloud/cloud-heroku/ech-editing-user-settings.md](/raw-migrated-files/cloud/cloud-heroku/ech-editing-user-settings.md) -* [/raw-migrated-files/cloud/cloud/ec-manage-apm-settings.md](/raw-migrated-files/cloud/cloud/ec-manage-apm-settings.md) -* [/raw-migrated-files/cloud/cloud-heroku/ech-manage-apm-settings.md](/raw-migrated-files/cloud/cloud-heroku/ech-manage-apm-settings.md) -* [/raw-migrated-files/cloud/cloud/ec-manage-appsearch-settings.md](/raw-migrated-files/cloud/cloud/ec-manage-appsearch-settings.md) -* [/raw-migrated-files/cloud/cloud/ec-manage-enterprise-search-settings.md](/raw-migrated-files/cloud/cloud/ec-manage-enterprise-search-settings.md) \ No newline at end of file +From the {{ecloud}} Console you can customize {{es}}, {{kib}}, and related products to suit your needs. These editors append your changes to the appropriate YAML configuration file and they affect all users of that cluster. In each editor you can: + + +## Edit {{es}} user settings [ec-add-user-settings] + +Change how {{es}} runs by providing your own user settings. {{ech}} appends these settings to each node’s `elasticsearch.yml` configuration file. + +{{ech}} automatically rejects `elasticsearch.yml` settings that could break your cluster. + +For a list of supported settings, check [Supported {{es}} settings](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/configuration-reference/elastic-cloud-hosted-elasticsearch-settings.md). + +::::{warning} +You can also update [dynamic cluster settings](../../../deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting) using {{es}}'s [update cluster settings API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings). However, {{ech}} doesn’t reject unsafe setting changes made using this API. Use it with caution. +:::: + + +To add or edit user settings: + +1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body). +2. Find your deployment on the home page in the **Hosted deployments** card and select **Manage** to access it directly. Or, select **Hosted deployments** to go to the deployments page to view all of your deployments. + + On the deployments page you can narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list. + +3. From your deployment menu, go to the **Edit** page. +4. In the **Elasticsearch** section, select **Manage user settings and extensions**. +5. Update the user settings. +6. Select **Save changes**. + +::::{note} +In some cases, you may get a warning saying "User settings are different across Elasticsearch instances". To fix this issue, ensure that your user settings (including the comments sections and whitespaces) are identical across all Elasticsearch nodes (not only the data tiers, but also the Master, Machine Learning, and Coordinating nodes). +:::: + +## Edit Kibana user settings [ec-manage-kibana-settings] + +{{ech}} supports most of the standard Kibana and X-Pack settings. Through a YAML editor in the console, you can append Kibana properties to the `kibana.yml` file. Your changes to the configuration file are read on startup. + +Be aware that some settings that could break your cluster if set incorrectly and that the syntax might change between major versions. + +For a list of supported settings, check [Kibana settings](asciidocalypse://docs/kibana/docs/reference/cloud/elastic-cloud-kibana-settings.md). + +To change Kibana settings: + +1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body). +2. Find your deployment on the home page in the **Hosted deployments** card and select **Manage** to access it directly. Or, select **Hosted deployments** to go to the deployments page to view all of your deployments. + + On the deployments page you can narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list. + +3. From your deployment menu, go to the **Edit** page. +4. In the **Kibana** section, select **Edit user settings**. For deployments with existing user settings, you may have to expand the **Edit kibana.yml** caret instead. +5. Update the user settings. +6. Select **Save changes**. + +Saving your changes initiates a configuration plan change that restarts Kibana automatically for you. + +::::{note} +If a setting is not supported by {{ech}}, you will get an error message when you try to save. +:::: + +## Edit APM user settings [ec-manage-apm-settings] + +Change how Elastic APM runs by providing your own user settings. +Check [APM configuration reference](/solutions/observability/apps/configure-apm-server.md) for information on how to configure the {{fleet}}-managed APM integration. \ No newline at end of file diff --git a/deploy-manage/deploy/elastic-cloud/find-cloud-id.md b/deploy-manage/deploy/elastic-cloud/find-cloud-id.md index cb450dedfd..dca77a44ae 100644 --- a/deploy-manage/deploy/elastic-cloud/find-cloud-id.md +++ b/deploy-manage/deploy/elastic-cloud/find-cloud-id.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ess: ga mapped_pages: - https://www.elastic.co/guide/en/cloud/current/ec-cloud-id.html --- diff --git a/deploy-manage/deploy/elastic-cloud/keep-track-of-deployment-activity.md b/deploy-manage/deploy/elastic-cloud/keep-track-of-deployment-activity.md index dae450e0d4..08adf046f9 100644 --- a/deploy-manage/deploy/elastic-cloud/keep-track-of-deployment-activity.md +++ b/deploy-manage/deploy/elastic-cloud/keep-track-of-deployment-activity.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ess: ga mapped_urls: - https://www.elastic.co/guide/en/cloud/current/ec-activity-page.html - https://www.elastic.co/guide/en/cloud-heroku/current/ech-activity-page.html @@ -15,9 +18,30 @@ mapped_urls: % - [ ] ./raw-migrated-files/cloud/cloud/ec-activity-page.md % - [ ] ./raw-migrated-files/cloud/cloud-heroku/ech-activity-page.md -⚠️ **This page is a work in progress.** ⚠️ +The deployment **Activity** page gives you a convenient way to follow all configuration changes that have been applied to your deployment, including which resources were affected, when the changes were applied, who initiated the changes, and whether or not the changes were successful. You can also select **Details** for an expanded, step-by-step view of each change applied to each deployment resource. -The documentation team is working to combine content pulled from the following pages: +To view the activity for a deployment: -* [/raw-migrated-files/cloud/cloud/ec-activity-page.md](/raw-migrated-files/cloud/cloud/ec-activity-page.md) -* [/raw-migrated-files/cloud/cloud-heroku/ech-activity-page.md](/raw-migrated-files/cloud/cloud-heroku/ech-activity-page.md) \ No newline at end of file +1. Log in to the [{{ech}} Console](https://cloud.elastic.co?page=docs&placement=docs-body). +2. On the **Deployments** page, select your deployment. + + On the deployments page you can narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list. + +3. In your deployment menu, select **Activity**. +4. You can: + + 1. View the activity for all deployment resources (the default). + 2. Use one of the available filters to view configuration changes by status or type. You can use the query field to create a custom search. Select the filter buttons to get examples of the query format. + 3. Select one of the resource filters to view activity for only that resource type. + + +:::{image} ../../../images/cloud-ec-ce-activity-page.png +:alt: The Activity page +::: + +In the table columns you find the following information: + +- **Change**: Which deployment resource the configuration change was applied to. +- **Summary**: A summary of what change was applied, when the change was performed, and how long it took. +- **Applied by**: The user who submitted the configuration change. `System` indicates configuration changes initiated automatically by the {{ecloud}} platform. +- **Actions**: Select **Details** for an expanded view of each step in the configuration change, including the start time, end time, and duration. You can select **Reapply** to re-run the configuration change. \ No newline at end of file diff --git a/deploy-manage/deploy/elastic-cloud/manage-deployments-using-elastic-cloud-api.md b/deploy-manage/deploy/elastic-cloud/manage-deployments-using-elastic-cloud-api.md index 5ac6176e1b..631bef6068 100644 --- a/deploy-manage/deploy/elastic-cloud/manage-deployments-using-elastic-cloud-api.md +++ b/deploy-manage/deploy/elastic-cloud/manage-deployments-using-elastic-cloud-api.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ess: ga mapped_pages: - https://www.elastic.co/guide/en/cloud/current/ec-api-deployment-crud.html --- diff --git a/deploy-manage/deploy/elastic-cloud/manage-deployments.md b/deploy-manage/deploy/elastic-cloud/manage-deployments.md index 85e86038af..7b3b078b81 100644 --- a/deploy-manage/deploy/elastic-cloud/manage-deployments.md +++ b/deploy-manage/deploy/elastic-cloud/manage-deployments.md @@ -1,17 +1,22 @@ --- +applies_to: + deployment: + ess: ga mapped_pages: - https://www.elastic.co/guide/en/cloud/current/ec-manage-deployment.html --- # Manage deployments [ec-manage-deployment] -Sometimes you might need to make changes to the entire deployment, a specific component, or just a single data tier. +{{ech}} allows you to configure and maintain your deployments with a high level of control on every component of the {{stack}}. You can adjust the settings of any of your deployments at any time. -* Make adjustments to specific deployment components, such as an [Integrations Server](manage-integrations-server.md), [APM & Fleet Server](switch-from-apm-to-integrations-server-payload.md#ec-manage-apm-and-fleet), [Watcher](../../../explore-analyze/alerts-cases/watcher.md), or [Kibana](access-kibana.md#ec-enable-kibana2). -* [Enable logging and monitoring](../../monitor/stack-monitoring/elastic-cloud-stack-monitoring.md) of the deployment performance. +* Define the [core configuration](configure.md) of your deployment, including available features, hardware settings and capacity, autoscaling, and high availability. +* [Upgrade your deployment](/deploy-manage/upgrade/deployment-or-cluster.md) and its component to a newer version of the {{stack}}. +* Make adjustments to specific deployment components, such as an [Integrations Server](manage-integrations-server.md) or [APM & Fleet Server](switch-from-apm-to-integrations-server-payload.md#ec-manage-apm-and-fleet). +* [Keep track of your deployment's activity](keep-track-of-deployment-activity.md) or [Enable logging and monitoring](../../monitor/stack-monitoring/elastic-cloud-stack-monitoring.md) of the deployment performance. * [Disable a data tier](../../../manage-data/lifecycle/index-lifecycle-management.md). -* [Restart](../../maintenance/start-stop-services/restart-cloud-hosted-deployment.md), [stop routing](../../maintenance/ece/start-stop-routing-requests.md), or [delete your deployment](../../uninstall/delete-a-cloud-deployment.md). -* [Upgrade the Elastic Stack version](../../upgrade/deployment-or-cluster.md) for the deployment. +* Perform maintenance operations to ensure the health of your deployment, such as [restarting your deployment](../../maintenance/start-stop-services/restart-cloud-hosted-deployment.md), [stop routing](../../maintenance/ece/start-stop-routing-requests.md) +* [Delete your deployment](../../uninstall/delete-a-cloud-deployment.md). diff --git a/deploy-manage/deploy/elastic-cloud/manage-integrations-server.md b/deploy-manage/deploy/elastic-cloud/manage-integrations-server.md index b354ce6433..04579eef3a 100644 --- a/deploy-manage/deploy/elastic-cloud/manage-integrations-server.md +++ b/deploy-manage/deploy/elastic-cloud/manage-integrations-server.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ess: ga mapped_pages: - https://www.elastic.co/guide/en/cloud/current/ec-manage-integrations-server.html --- diff --git a/deploy-manage/deploy/elastic-cloud/manage-plugins-extensions-through-api.md b/deploy-manage/deploy/elastic-cloud/manage-plugins-extensions-through-api.md index 021163b7e6..bde4104df9 100644 --- a/deploy-manage/deploy/elastic-cloud/manage-plugins-extensions-through-api.md +++ b/deploy-manage/deploy/elastic-cloud/manage-plugins-extensions-through-api.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ess: ga mapped_pages: - https://www.elastic.co/guide/en/cloud/current/ec-plugins-guide.html --- diff --git a/deploy-manage/deploy/elastic-cloud/switch-from-apm-to-integrations-server-payload.md b/deploy-manage/deploy/elastic-cloud/switch-from-apm-to-integrations-server-payload.md index e860f5ed5c..0ab90fa9da 100644 --- a/deploy-manage/deploy/elastic-cloud/switch-from-apm-to-integrations-server-payload.md +++ b/deploy-manage/deploy/elastic-cloud/switch-from-apm-to-integrations-server-payload.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ess: ga mapped_pages: - https://www.elastic.co/guide/en/cloud/current/ec-integrations-server-apm-switch.html --- diff --git a/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md b/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md index de4ef30bf2..8e112fa742 100644 --- a/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md +++ b/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ess: ga mapped_urls: - https://www.elastic.co/guide/en/cloud/current/ec-custom-bundles.html - https://www.elastic.co/guide/en/cloud-heroku/current/ech-custom-bundles.html @@ -27,7 +30,243 @@ $$$ech-update-bundles-and-plugins$$$ $$$ech-update-bundles$$$ -**This page is a work in progress.** The documentation team is working to combine content pulled from the following pages: +There are several cases where you might need your own files to be made available to your {{es}} cluster’s nodes: -* [/raw-migrated-files/cloud/cloud/ec-custom-bundles.md](/raw-migrated-files/cloud/cloud/ec-custom-bundles.md) -* [/raw-migrated-files/cloud/cloud-heroku/ech-custom-bundles.md](/raw-migrated-files/cloud/cloud-heroku/ech-custom-bundles.md) \ No newline at end of file +* Your own custom plugins, or third-party plugins that are not amongst the [officially available plugins](../../../deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md). +* Custom dictionaries, such as synonyms, stop words, compound words, and so on. +* Cluster configuration files, such as an Identity Provider metadata file used when you [secure your clusters with SAML](../../../deploy-manage/users-roles/cluster-or-deployment-auth/saml.md). + +To facilitate this, we make it possible to upload a ZIP file that contains the files you want to make available. Uploaded files are stored using Amazon’s highly-available S3 service. This is necessary so we do not have to rely on the availability of third-party services, such as the official plugin repository, when provisioning nodes. + +Custom plugins and bundles are collectively referred to as extensions. + +## Before you begin [ec_before_you_begin_7] + +The selected plugins/bundles are downloaded and provided when a node starts. Changing a plugin does not change it for nodes already running it. Refer to [Updating Plugins and Bundles](../../../deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md#ec-update-bundles-and-plugins). + +With great power comes great responsibility: your plugins can extend your deployment with new functionality, but also break it. Be careful. We obviously cannot guarantee that your custom code works. + +::::{important} +You cannot edit or delete a custom extension after it has been used in a deployment. To remove it from your deployment, you can disable the extension and update your deployment configuration. +:::: + + +Uploaded files cannot be bigger than 20MB for most subscription levels, for Platinum and Enterprise the limit is 8GB. + +It is important that plugins and dictionaries that you reference in mappings and configurations are available at all times. For example, if you try to upgrade {{es}} and de-select a dictionary that is referenced in your mapping, the new nodes will be unable to recover the cluster state and function. This is true even if the dictionary is referenced by an empty index you do not actually use. + + +## Prepare your files for upload [ec-prepare-custom-bundles] + +Plugins are uploaded as ZIP files. You need to choose whether your uploaded file should be treated as a *plugin* or as a *bundle*. Bundles are not installed as plugins. If you need to upload both a custom plugin and custom dictionaries, upload them separately. + +To prepare your files, create one of the following: + +Plugins +: A plugin is a ZIP file that contains a plugin descriptor file and binaries. + + The plugin descriptor file is called either `stable-plugin-descriptor.properties` for plugins built against the stable plugin API, or `plugin-descriptor.properties` for plugins built against the classic plugin API. A plugin ZIP file should only contain one plugin descriptor file. + + {{es}} assumes that the uploaded ZIP file contains binaries. If it finds any source code, it fails with an error message, causing provisioning to fail. Make sure you upload binaries, and not source code. + + ::::{note} + Plugins larger than 5GB should have the plugin descriptor file at the top of the archive. This order can be achieved by specifying at time of creating the ZIP file: + + ```sh + zip -r name-of-plugin.zip name-of-descriptor-file.properties * + ``` + + :::: + + +Bundles +: The entire content of a bundle is made available to the node by extracting to the {{es}} container’s `/app/config` directory. This is useful to make custom dictionaries available. Dictionaries should be placed in a `/dictionaries` folder in the root path of your ZIP file. + + Here are some examples of bundles: + + **Script** + + ```text + $ tree . + . + └── scripts + └── test.js + ``` + + The script `test.js` can be referred in queries as `"script": "test"`. + + **Dictionary of synonyms** + + ```text + $ tree . + . + └── dictionaries + └── synonyms.txt + ``` + + The dictionary `synonyms.txt` can be used as `synonyms.txt` or using the full path `/app/config/synonyms.txt` in the `synonyms_path` of the `synonym-filter`. + + To learn more about analyzing with synonyms, check [Synonym token filter](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-tokenfilter.html) and [Formatting Synonyms](https://www.elastic.co/guide/en/elasticsearch/guide/2.x/synonym-formats.html). + + **GeoIP database bundle** + + ```text + $ tree . + . + └── ingest-geoip + └── MyGeoLite2-City.mmdb + ``` + + Note that the extension must be `-(City|Country|ASN).mmdb`, and it must be a different name than the original file name `GeoLite2-City.mmdb` which already exists in {{ech}}. To use this bundle, you can refer it in the GeoIP ingest pipeline as `MyGeoLite2-City.mmdb` under `database_file`. + + + +## Add your extension [ec-add-your-plugin] + +You must upload your files before you can apply them to your cluster configuration: + +1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body). +2. Find your deployment on the home page in the **Hosted deployments** card and select **Manage** to access it directly. Or, select **Hosted deployments** to go to the deployments page to view all of your deployments. +3. Under **Features**, select **Extensions**. +4. Select **Upload extension**. +5. Complete the extension fields, including the {{es}} version. + + * Plugins must use full version notation down to the patch level, such as `7.10.1`. You cannot use wildcards. This version notation should match the version in your plugin’s plugin descriptor file. For classic plugins, it should also match the target deployment version. + * Bundles should specify major or minor versions with wildcards, such as `7.*` or `*`. Wildcards are recommended to ensure the bundle is compatible across all versions of these releases. + +6. Select the extension **Type**. +7. Under **Plugin file**, choose the file to upload. +8. Select **Create extension**. + +After creating your extension, you can [enable them for existing {{es}} deployments](../../../deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md#ec-update-bundles) or enable them when creating new deployments. + +::::{note} +Creating extensions larger than 200MB should be done through the extensions API. + +Refer to [Managing plugins and extensions through the API](../../../deploy-manage/deploy/elastic-cloud/manage-plugins-extensions-through-api.md) for more details. + +:::: + + + +## Update your deployment configuration [ec-update-bundles] + +After uploading your files, you can select to enable them when creating a new {{es}} deployment. For existing deployments, you must update your deployment configuration to use the new files: + +1. Log in to the [{{ech}} Console](https://cloud.elastic.co?page=docs&placement=docs-body). +2. Find your deployment on the home page in the **Hosted deployments** card and select **Manage** to access it directly. Or, select **Hosted deployments** to go to the deployments page to view all of your deployments. + + On the deployments page you can narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list. + +3. From the **Actions** dropdown, select **Edit deployment**. +4. Select **Manage user settings and extensions**. +5. Select the **Extensions** tab. +6. Select the custom extension. +7. Select **Back**. +8. Select **Save**. The {{es}} cluster is then updated with new nodes that have the plugin installed. + + +## Update your extension [ec-update-bundles-and-plugins] + +While you can update the ZIP file for any plugin or bundle, these are downloaded and made available only when a node is started. + +You should be careful when updating an extension. If you update an existing extension with a new file, and if the file is broken for some reason, all the nodes could be in trouble, as a restart or move node could make even HA clusters non-available. + +If the extension is not in use by any deployments, then you are free to update the files or extension details as much as you like. However, if the extension is in use, and if you need to update it with a new file, it is recommended to [create a new extension](../../../deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md#ec-add-your-plugin) rather than updating the existing one that is in use. + +By following this method, only the one node would be down even if the extension file is faulty. This would ensure that HA clusters remain available. + +This method also supports having a test/staging deployment to test out the extension changes before applying them on a production deployment. + +You may delete the old extension after updating the deployment successfully. + +To update an extension with a new file version, + +1. Prepare a new plugin or bundle. +2. On the **Extensions** page, [upload a new extension](../../../deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md#ec-add-your-plugin). +3. Make your new files available by uploading them. +4. Find your deployment on the home page in the **Hosted deployments** card and select **Manage** to access it directly. Or, select **Hosted deployments** to go to the deployments page to view all of your deployments. + + On the deployments page you can narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list. + +5. From the **Actions** dropdown, select **Edit deployment**. +6. Select **Manage user settings and extensions**. +7. Select the **Extensions** tab. +8. Select the new extension and de-select the old one. +9. Select **Back**. +10. Select **Save**. + + +## How to use the extensions API [ec-extension-api-usage-guide] + +::::{note} +For a full set of examples, check [Managing plugins and extensions through the API](../../../deploy-manage/deploy/elastic-cloud/manage-plugins-extensions-through-api.md). +:::: + + +If you don’t already have one, create an [API key](../../../deploy-manage/api-keys/elastic-cloud-api-keys.md) + +There are ways that you can use the extensions API to upload a file. + +### Method 1: Use HTTP `POST` to create metadata and then upload the file using HTTP `PUT` [ec_method_1_use_http_post_to_create_metadata_and_then_upload_the_file_using_http_put] + +Step 1: Create metadata + +```text +curl -XPOST \ +-H "Authorization: ApiKey $EC_API_KEY" \ +-H 'content-type:application/json' \ +https://api.elastic-cloud.com/api/v1/deployments/extensions \ +-d'{ + "name" : "synonyms-v1", + "description" : "The best synonyms ever", + "extension_type" : "bundle", + "version" : "7.*" +}' +``` + +Step 2: Upload the file + +```text +curl -XPUT \ +-H "Authorization: ApiKey $EC_API_KEY" \ +"https://api.elastic-cloud.com/api/v1/deployments/extensions/$extension_id" \ +-T /tmp/synonyms.zip +``` + +If you are using a client that does not have native `application/zip` handling like `curl`, be sure to use the equivalent of the following with `content-type: multipart/form-data`: + +```text +curl -XPUT \ +-H 'Expect:' \ +-H 'content-type: multipart/form-data' \ +-H "Authorization: ApiKey $EC_API_KEY" \ +"https://api.elastic-cloud.com/api/v1/deployments/extensions/$extension_id" -F "file=@/tmp/synonyms.zip" +``` + +For example, using the Python `requests` module, the `PUT` request would be as follows: + +```text +import requests +files = {'file': open('/tmp/synonyms.zip','rb')} +r = requests.put('https://api.elastic-cloud.com/api/v1/deployments/extensions/{}'.format(extension_id), files=files, headers= {'Authorization': 'ApiKey {}'.format(EC_API_KEY)}) +``` + + +### Method 2: Single step. Use a `download_url` so that the API server downloads the object at the specified URL [ec_method_2_single_step_use_a_download_url_so_that_the_api_server_downloads_the_object_at_the_specified_url] + +```text +curl -XPOST \ +-H "Authorization: ApiKey $EC_API_KEY" \ +-H 'content-type:application/json' \ +https://api.elastic-cloud.com/api/v1/deployments/extensions \ +-d'{ + "name" : "anylysis_icu", + "description" : "Helpful description", + "extension_type" : "plugin", + "version" : "7.13.2", + "download_url": "https://artifacts.elastic.co/downloads/elasticsearch-plugins/analysis-icu/analysis-icu-7.13.2.zip" +}' +``` + +Please refer to the [Extensions API reference](https://www.elastic.co/docs/api/doc/cloud/group/endpoint-extensions) for the complete set of HTTP methods and payloads. diff --git a/deploy-manage/toc.yml b/deploy-manage/toc.yml index 65ea66a979..666dafa1cc 100644 --- a/deploy-manage/toc.yml +++ b/deploy-manage/toc.yml @@ -91,19 +91,11 @@ toc: children: - file: deploy/elastic-cloud/configure.md children: - - file: deploy/elastic-cloud/ec-customize-deployment.md - children: - - file: deploy/elastic-cloud/ec-configure-deployment-settings.md - - file: deploy/elastic-cloud/ec-change-hardware-profile.md - - file: deploy/elastic-cloud/ec-customize-deployment-components.md - - file: deploy/elastic-cloud/ech-configure-settings.md - children: - - file: deploy/elastic-cloud/ech-configure-deployment-settings.md - - file: deploy/elastic-cloud/ech-customize-deployment-components.md + - file: deploy/elastic-cloud/ec-change-hardware-profile.md + - file: deploy/elastic-cloud/ec-customize-deployment-components.md - file: deploy/elastic-cloud/edit-stack-settings.md - file: deploy/elastic-cloud/add-plugins-extensions.md children: - - file: deploy/elastic-cloud/add-plugins-provided-with-elastic-cloud-hosted.md - file: deploy/elastic-cloud/upload-custom-plugins-bundles.md - file: deploy/elastic-cloud/manage-plugins-extensions-through-api.md - file: deploy/elastic-cloud/custom-endpoint-aliases.md diff --git a/raw-migrated-files/cloud/cloud/ec-prepare-production.md b/raw-migrated-files/cloud/cloud/ec-prepare-production.md deleted file mode 100644 index 00c9d42260..0000000000 --- a/raw-migrated-files/cloud/cloud/ec-prepare-production.md +++ /dev/null @@ -1,12 +0,0 @@ -# Preparing a deployment for production [ec-prepare-production] - -To make sure you’re all set for production, consider the following actions: - -* [Plan for your expected workloads](../../../deploy-manage/production-guidance/plan-for-production-elastic-cloud.md) and consider how many availability zones you’ll need. -* [Create a deployment](../../../deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.md) on the region you need and with a hardware profile that matches your use case. -* [Change your configuration](../../../deploy-manage/deploy/elastic-cloud/ec-customize-deployment.md) by turning on autoscaling, adding high availability, or adjusting components of the Elastic Stack. -* [Add extensions and plugins](../../../deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md) to use Elastic supported extensions or add your own custom dictionaries and scripts. -* [Edit settings and defaults](../../../deploy-manage/deploy/elastic-cloud/edit-stack-settings.md) to fine tune the performance of specific features. -* [Manage your deployment](../../../deploy-manage/deploy/elastic-cloud/manage-deployments.md) as a whole to restart, upgrade, stop routing, or delete. -* [Set up monitoring](../../../deploy-manage/monitor/stack-monitoring/elastic-cloud-stack-monitoring.md) to learn how to configure your deployments for observability, which includes metric and log collection, troubleshooting views, and cluster alerts to automate performance monitoring. - diff --git a/raw-migrated-files/toc.yml b/raw-migrated-files/toc.yml index c90f9623df..c3eb4c2aed 100644 --- a/raw-migrated-files/toc.yml +++ b/raw-migrated-files/toc.yml @@ -164,7 +164,6 @@ toc: - file: cloud/cloud/ec-monitoring.md - file: cloud/cloud/ec-password-reset.md - file: cloud/cloud/ec-planning.md - - file: cloud/cloud/ec-prepare-production.md - file: cloud/cloud/ec-regional-deployment-aliases.md - file: cloud/cloud/ec-restore-across-clusters.md - file: cloud/cloud/ec-restoring-snapshots.md From 536d78cdcdd7b6be837b0fe9ac2d25b2e82c86fe Mon Sep 17 00:00:00 2001 From: Florent Le Borgne Date: Thu, 20 Feb 2025 19:13:15 +0100 Subject: [PATCH 04/11] links --- .../create-an-elastic-cloud-hosted-deployment.md | 4 ++-- .../deploy/elastic-cloud/ec-change-hardware-profile.md | 2 +- raw-migrated-files/cloud/cloud-heroku/ech-adding-plugins.md | 4 ++-- .../cloud/cloud-heroku/ech-configure-settings.md | 2 +- raw-migrated-files/cloud/cloud-heroku/ech-configure.md | 2 +- raw-migrated-files/cloud/cloud-heroku/ech-custom-bundles.md | 2 +- .../cloud/cloud-heroku/ech-saas-metrics-accessing.md | 2 +- .../cloud/cloud-heroku/ech-secure-clusters-oidc.md | 4 ++-- .../cloud/cloud-heroku/ech-securing-clusters-SAML.md | 2 +- raw-migrated-files/cloud/cloud/ec-customize-deployment.md | 2 +- raw-migrated-files/cloud/cloud/ec-saas-metrics-accessing.md | 2 +- solutions/observability/apps/processing-performance.md | 2 +- troubleshoot/observability/apm/processing-performance.md | 2 +- 13 files changed, 16 insertions(+), 16 deletions(-) diff --git a/deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.md b/deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.md index 726d5ed811..1ebbc6f478 100644 --- a/deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.md +++ b/deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.md @@ -39,7 +39,7 @@ Once you are on the **Create deployment** page, you can create the deployment wi **Region**: The cloud platform’s region your deployment will live. If you have compliance or latency requirements, you can create your deployment in any of our [supported regions](asciidocalypse://docs/cloud/docs/reference/cloud/cloud-hosted/regions.md). The region should be as close as possible to the location of your data. - **Hardware profile**: This allows you to configure the underlying virtual hardware that you’ll deploy your Elastic Stack on. Each hardware profile provides a unique blend of storage, RAM and vCPU sizes. You can select a hardware profile that’s best suited for your use case. For example CPU Optimized if you have a search-heavy use case that’s bound by compute resources. For more details, check the [hardware profiles](ec-configure-deployment-settings.md#ec-hardware-profiles) section. You can also view the [virtual hardware details](asciidocalypse://docs/cloud/docs/reference/cloud/cloud-hosted/hardware.md) which powers hardware profiles. With the **Advanced settings** option, you can configure the underlying virtual hardware associated with each profile. + **Hardware profile**: This allows you to configure the underlying virtual hardware that you’ll deploy your Elastic Stack on. Each hardware profile provides a unique blend of storage, RAM and vCPU sizes. You can select a hardware profile that’s best suited for your use case. For example CPU Optimized if you have a search-heavy use case that’s bound by compute resources. For more details, check the [hardware profiles](ec-change-hardware-profile.md) section. You can also view the [virtual hardware details](asciidocalypse://docs/cloud/docs/reference/cloud/cloud-hosted/hardware.md) which powers hardware profiles. With the **Advanced settings** option, you can configure the underlying virtual hardware associated with each profile. **Version**: The Elastic Stack version that will get deployed. Defaults to the latest version. Our [version policy](available-stack-versions.md) describes which versions are available to deploy. @@ -68,7 +68,7 @@ To make sure you’re all set for production, consider the following actions: * [Plan for your expected workloads](/deploy-manage/production-guidance/plan-for-production-elastic-cloud.md) and consider how many availability zones you’ll need. * [Create a deployment](/deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.md) on the region you need and with a hardware profile that matches your use case. -* [Change your configuration](/deploy-manage/deploy/elastic-cloud/ec-customize-deployment.md) by turning on autoscaling, adding high availability, or adjusting components of the Elastic Stack. +* [Change your configuration](/deploy-manage/deploy/elastic-cloud/ec-customize-deployment-components.md) by turning on autoscaling, adding high availability, or adjusting components of the Elastic Stack. * [Add extensions and plugins](/deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md) to use Elastic supported extensions or add your own custom dictionaries and scripts. * [Edit settings and defaults](/deploy-manage/deploy/elastic-cloud/edit-stack-settings.md) to fine tune the performance of specific features. * [Manage your deployment](/deploy-manage/deploy/elastic-cloud/manage-deployments.md) as a whole to restart, upgrade, stop routing, or delete. diff --git a/deploy-manage/deploy/elastic-cloud/ec-change-hardware-profile.md b/deploy-manage/deploy/elastic-cloud/ec-change-hardware-profile.md index c2c5d45575..8b04623387 100644 --- a/deploy-manage/deploy/elastic-cloud/ec-change-hardware-profile.md +++ b/deploy-manage/deploy/elastic-cloud/ec-change-hardware-profile.md @@ -8,7 +8,7 @@ mapped_pages: # Change hardware profiles [ec-change-hardware-profile] -Deployment [hardware profiles](ec-configure-deployment-settings.md#ec-hardware-profiles) deploy the Elastic Stack on virtual hardware. Each hardware profile has a different blend of storage, RAM, and vCPU. +Deployment hardware profiles deploy the Elastic Stack on virtual hardware. Each hardware profile has a different blend of storage, RAM, and vCPU. Elastic Cloud regularly introduces new hardware profiles to provide: diff --git a/raw-migrated-files/cloud/cloud-heroku/ech-adding-plugins.md b/raw-migrated-files/cloud/cloud-heroku/ech-adding-plugins.md index 6e9ff42b24..b99ea71cc1 100644 --- a/raw-migrated-files/cloud/cloud-heroku/ech-adding-plugins.md +++ b/raw-migrated-files/cloud/cloud-heroku/ech-adding-plugins.md @@ -6,11 +6,11 @@ Plugins extend the core functionality of {{es}}. There are many suitable plugins * Analysis plugins, to provide analyzers targeted at languages other than English. * Scripting plugins, to provide additional scripting languages. -Plugins can come from different sources: the official ones created or at least maintained by Elastic, community-sourced plugins from other users, and plugins that you provide. Some of the official plugins are always provided with our service, and can be [enabled per deployment](../../../deploy-manage/deploy/elastic-cloud/add-plugins-provided-with-elastic-cloud-hosted.md). +Plugins can come from different sources: the official ones created or at least maintained by Elastic, community-sourced plugins from other users, and plugins that you provide. Some of the official plugins are always provided with our service, and can be [enabled per deployment](../../../deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md). There are two ways to add plugins to a deployment in Elasticsearch Add-On for Heroku: -* [Enable one of the official plugins already available in Elasticsearch Add-On for Heroku](../../../deploy-manage/deploy/elastic-cloud/add-plugins-provided-with-elastic-cloud-hosted.md). +* [Enable one of the official plugins already available in Elasticsearch Add-On for Heroku](../../../deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md). * [Upload a custom plugin and then enable it per deployment](../../../deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md). Custom plugins can include the official {{es}} plugins not provided with Elasticsearch Add-On for Heroku, any of the community-sourced plugins, or [plugins that you write yourself](asciidocalypse://docs/elasticsearch/docs/extend/create-elasticsearch-plugins/index.md). Uploading custom plugins is available only to Gold, Platinum, and Enterprise subscriptions. For more information, check [Upload custom plugins and bundles](../../../deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md). diff --git a/raw-migrated-files/cloud/cloud-heroku/ech-configure-settings.md b/raw-migrated-files/cloud/cloud-heroku/ech-configure-settings.md index 23f101ef58..b740c27763 100644 --- a/raw-migrated-files/cloud/cloud-heroku/ech-configure-settings.md +++ b/raw-migrated-files/cloud/cloud-heroku/ech-configure-settings.md @@ -35,7 +35,7 @@ To change the {{es}} cluster in your deployment: Narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list. 3. From your deployment menu, select **{{es}}** and then **Edit**. -4. Let the user interface guide you through the cluster configuration for your cluster. For a full list of the supported settings, check [What Deployment Settings Are Available?](../../../deploy-manage/deploy/elastic-cloud/ech-configure-deployment-settings.md) +4. Let the user interface guide you through the cluster configuration for your cluster. For a full list of the supported settings, check [What Deployment Settings Are Available?](../../../deploy-manage/deploy/elastic-cloud/configure.md) If you are changing an existing deployment, you can make multiple changes to your {{es}} cluster with a single configuration update, such as changing the capacity and upgrading to a new {{es}} version in one step. diff --git a/raw-migrated-files/cloud/cloud-heroku/ech-configure.md b/raw-migrated-files/cloud/cloud-heroku/ech-configure.md index 87dadfc137..40c4dcfa61 100644 --- a/raw-migrated-files/cloud/cloud-heroku/ech-configure.md +++ b/raw-migrated-files/cloud/cloud-heroku/ech-configure.md @@ -3,7 +3,7 @@ The information in this section covers: * [Plan for production](../../../deploy-manage/production-guidance/plan-for-production-elastic-cloud.md) - Plan for a highly available and scalable deployment. -* [Configure your deployment](../../../deploy-manage/deploy/elastic-cloud/ech-configure-settings.md) - Customize your cluster through a full list of settings. +* [Configure your deployment](../../../deploy-manage/deploy/elastic-cloud/configure.md) - Customize your cluster through a full list of settings. * [Enable Kibana](../../../deploy-manage/deploy/elastic-cloud/access-kibana.md) - Explore your data with the Elastic Stack visualization platform. * [Enable Logging and Monitoring](../../../deploy-manage/monitor/stack-monitoring/elastic-cloud-stack-monitoring.md) - Monitor your cluster’s health and performance and ingest your deployment’s logs. * [Upgrade versions](../../../deploy-manage/upgrade/deployment-or-cluster.md) - Stay current with the latest Elastic Stack versions. diff --git a/raw-migrated-files/cloud/cloud-heroku/ech-custom-bundles.md b/raw-migrated-files/cloud/cloud-heroku/ech-custom-bundles.md index c4c6dccf14..bee7801490 100644 --- a/raw-migrated-files/cloud/cloud-heroku/ech-custom-bundles.md +++ b/raw-migrated-files/cloud/cloud-heroku/ech-custom-bundles.md @@ -2,7 +2,7 @@ There are several cases where you might need your own files to be made available to your {{es}} cluster’s nodes: -* Your own custom plugins, or third-party plugins that are not amongst the [officially available plugins](../../../deploy-manage/deploy/elastic-cloud/add-plugins-provided-with-elastic-cloud-hosted.md). +* Your own custom plugins, or third-party plugins that are not amongst the [officially available plugins](../../../deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md). * Custom dictionaries, such as synonyms, stop words, compound words, and so on. * Cluster configuration files, such as an Identity Provider metadata file used when you [secure your clusters with SAML](../../../deploy-manage/users-roles/cluster-or-deployment-auth/saml.md). diff --git a/raw-migrated-files/cloud/cloud-heroku/ech-saas-metrics-accessing.md b/raw-migrated-files/cloud/cloud-heroku/ech-saas-metrics-accessing.md index b1003f5699..78a47d1e04 100644 --- a/raw-migrated-files/cloud/cloud-heroku/ech-saas-metrics-accessing.md +++ b/raw-migrated-files/cloud/cloud-heroku/ech-saas-metrics-accessing.md @@ -116,7 +116,7 @@ Cluster performance metrics are shown per node and are color-coded to indicate w For clusters that suffer out-of-memory failures, it can be difficult to determine whether the clusters are in a completely healthy state afterwards. For this reason, Elasticsearch Add-On for Heroku automatically reboots clusters that suffer out-of-memory failures. -You will receive an email notification to let you know that a restart occurred. For repeated alerts, the emails are aggregated so that you do not receive an excessive number of notifications. Either [resizing your cluster to reduce memory pressure](../../../deploy-manage/deploy/elastic-cloud/ech-customize-deployment-components.md#ech-cluster-size) or reducing the workload that a cluster is being asked to handle can help avoid these cluster restarts. +You will receive an email notification to let you know that a restart occurred. For repeated alerts, the emails are aggregated so that you do not receive an excessive number of notifications. Either [resizing your cluster to reduce memory pressure](../../../deploy-manage/deploy/elastic-cloud/configure.md) or reducing the workload that a cluster is being asked to handle can help avoid these cluster restarts. diff --git a/raw-migrated-files/cloud/cloud-heroku/ech-secure-clusters-oidc.md b/raw-migrated-files/cloud/cloud-heroku/ech-secure-clusters-oidc.md index 860f44920d..5506684f97 100644 --- a/raw-migrated-files/cloud/cloud-heroku/ech-secure-clusters-oidc.md +++ b/raw-migrated-files/cloud/cloud-heroku/ech-secure-clusters-oidc.md @@ -152,7 +152,7 @@ The Elasticsearch cluster needs to be configured to use the OpenID Connect realm This bundle allows all Elasticsearch containers to access the metadata file. - 2. Update your Elasticsearch cluster on the [deployments page](../../../deploy-manage/deploy/elastic-cloud/add-plugins-provided-with-elastic-cloud-hosted.md) to use the bundle you prepared in the previous step. + 2. Update your Elasticsearch cluster on the [deployments page](../../../deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md) to use the bundle you prepared in the previous step. Custom bundles are unzipped under the path `/app/config/BUNDLE_DIRECTORY_STRUCTURE`, where `BUNDLE_DIRECTORY_STRUCTURE` is the directory structure in the ZIP file. Make sure to save the file location where custom bundles get unzipped, as you will need it in the next step. @@ -190,7 +190,7 @@ OpenID Connect depends on TLS to provider security properties such as encryption However, if your OP uses a certificate that is issued for instance, by a CA used only in your Organization, you must configure Elasticsearch Add-On for Heroku to trust that CA. 1. Prepare a ZIP file with a [custom bundle](../../../deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md) that contains the CA certificate (`company-ca.pem`) that signed the certificate your OpenID Connect Provider uses for TLS inside of an `oidc-tls` folder -2. Update your Elasticsearch cluster on the [deployments page](../../../deploy-manage/deploy/elastic-cloud/add-plugins-provided-with-elastic-cloud-hosted.md) to use the bundle you prepared in the previous step. +2. Update your Elasticsearch cluster on the [deployments page](../../../deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md) to use the bundle you prepared in the previous step. Custom bundles are unzipped under the path `/app/config/BUNDLE_DIRECTORY_STRUCTURE`, where `BUNDLE_DIRECTORY_STRUCTURE` is the directory structure in the ZIP file. Make sure to save the file location where custom bundles get unzipped, as you will need it in the next step. diff --git a/raw-migrated-files/cloud/cloud-heroku/ech-securing-clusters-SAML.md b/raw-migrated-files/cloud/cloud-heroku/ech-securing-clusters-SAML.md index 94470d3f3f..f4f90e69b0 100644 --- a/raw-migrated-files/cloud/cloud-heroku/ech-securing-clusters-SAML.md +++ b/raw-migrated-files/cloud/cloud-heroku/ech-securing-clusters-SAML.md @@ -142,7 +142,7 @@ curl -X GET -H "Content-Type: application/json" -u user_name:password https:// Date: Thu, 20 Feb 2025 20:04:56 +0100 Subject: [PATCH 05/11] Update deploy-manage/deploy/elastic-cloud/manage-deployments.md --- deploy-manage/deploy/elastic-cloud/manage-deployments.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deploy-manage/deploy/elastic-cloud/manage-deployments.md b/deploy-manage/deploy/elastic-cloud/manage-deployments.md index 7b3b078b81..38ad18dd35 100644 --- a/deploy-manage/deploy/elastic-cloud/manage-deployments.md +++ b/deploy-manage/deploy/elastic-cloud/manage-deployments.md @@ -15,7 +15,7 @@ mapped_pages: * Make adjustments to specific deployment components, such as an [Integrations Server](manage-integrations-server.md) or [APM & Fleet Server](switch-from-apm-to-integrations-server-payload.md#ec-manage-apm-and-fleet). * [Keep track of your deployment's activity](keep-track-of-deployment-activity.md) or [Enable logging and monitoring](../../monitor/stack-monitoring/elastic-cloud-stack-monitoring.md) of the deployment performance. * [Disable a data tier](../../../manage-data/lifecycle/index-lifecycle-management.md). -* Perform maintenance operations to ensure the health of your deployment, such as [restarting your deployment](../../maintenance/start-stop-services/restart-cloud-hosted-deployment.md), [stop routing](../../maintenance/ece/start-stop-routing-requests.md) +* Perform maintenance operations to ensure the health of your deployment, such as [restarting your deployment](../../maintenance/start-stop-services/restart-cloud-hosted-deployment.md) or [stopping routing](../../maintenance/ece/start-stop-routing-requests.md). * [Delete your deployment](../../uninstall/delete-a-cloud-deployment.md). From 27acd4d8a837764c59e6515612b0fb7de8aa8eaf Mon Sep 17 00:00:00 2001 From: shainaraskas Date: Mon, 24 Feb 2025 22:10:59 -0500 Subject: [PATCH 06/11] remove some used up files --- .../deploy/elastic-cloud/configure.md | 7 - .../upload-custom-plugins-bundles.md | 21 --- .../ech-adding-elastic-plugins.md | 25 --- .../cloud/cloud-heroku/ech-adding-plugins.md | 23 --- .../cloud-heroku/ech-configure-settings.md | 47 ----- .../cloud/cloud-heroku/ech-configure.md | 11 -- .../cloud/cloud-heroku/ech-custom-bundles.md | 167 ------------------ .../cloud/cloud/ec-customize-deployment.md | 58 ------ raw-migrated-files/toc.yml | 6 - 9 files changed, 365 deletions(-) delete mode 100644 raw-migrated-files/cloud/cloud-heroku/ech-adding-elastic-plugins.md delete mode 100644 raw-migrated-files/cloud/cloud-heroku/ech-adding-plugins.md delete mode 100644 raw-migrated-files/cloud/cloud-heroku/ech-configure-settings.md delete mode 100644 raw-migrated-files/cloud/cloud-heroku/ech-configure.md delete mode 100644 raw-migrated-files/cloud/cloud-heroku/ech-custom-bundles.md delete mode 100644 raw-migrated-files/cloud/cloud/ec-customize-deployment.md diff --git a/deploy-manage/deploy/elastic-cloud/configure.md b/deploy-manage/deploy/elastic-cloud/configure.md index 99b1115299..94fc582f61 100644 --- a/deploy-manage/deploy/elastic-cloud/configure.md +++ b/deploy-manage/deploy/elastic-cloud/configure.md @@ -10,13 +10,6 @@ mapped_urls: # Configure -% What needs to be done: Refine - -% Use migrated content from existing pages that map to this page: - -% - [ ] ./raw-migrated-files/cloud/cloud/ec-customize-deployment.md -% - [ ] ./raw-migrated-files/cloud/cloud-heroku/ech-configure-settings.md - You might want to change the configuration of your deployment to: * Add features, such as machine learning or APM (application performance monitoring). diff --git a/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md b/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md index 8e112fa742..5810ddfd7d 100644 --- a/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md +++ b/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md @@ -9,27 +9,6 @@ mapped_urls: # Upload custom plugins and bundles -% What needs to be done: Lift-and-shift - -% Use migrated content from existing pages that map to this page: - -% - [ ] ./raw-migrated-files/cloud/cloud/ec-custom-bundles.md -% - [ ] ./raw-migrated-files/cloud/cloud-heroku/ech-custom-bundles.md - -% Internal links rely on the following IDs being on this page (e.g. as a heading ID, paragraph ID, etc): - -$$$ec-add-your-plugin$$$ - -$$$ec-update-bundles-and-plugins$$$ - -$$$ec-update-bundles$$$ - -$$$ech-add-your-plugin$$$ - -$$$ech-update-bundles-and-plugins$$$ - -$$$ech-update-bundles$$$ - There are several cases where you might need your own files to be made available to your {{es}} cluster’s nodes: * Your own custom plugins, or third-party plugins that are not amongst the [officially available plugins](../../../deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md). diff --git a/raw-migrated-files/cloud/cloud-heroku/ech-adding-elastic-plugins.md b/raw-migrated-files/cloud/cloud-heroku/ech-adding-elastic-plugins.md deleted file mode 100644 index 5ef4c99dcd..0000000000 --- a/raw-migrated-files/cloud/cloud-heroku/ech-adding-elastic-plugins.md +++ /dev/null @@ -1,25 +0,0 @@ -# Add plugins provided with Elasticsearch Add-On for Heroku [ech-adding-elastic-plugins] - -You can use a variety of official plugins that are compatible with your version of {{es}}. When you upgrade to a new {{es}} version, these plugins are simply upgraded with the rest of your deployment. - -## Before you begin [echbefore_you_begin_4] - -Some restrictions apply when adding plugins. To learn more, check [Restrictions for {{es}} and {{kib}} plugins](../../../deploy-manage/deploy/elastic-cloud/ech-restrictions.md#ech-restrictions-plugins). - -Only Gold, Platinum, Enterprise and Private subscriptions, running version 2.4.6 or later, have access to uploading custom plugins. All subscription levels, including Standard, can upload scripts and dictionaries. - -To enable a plugin for a deployment: - -1. Log in to the [Elasticsearch Add-On for Heroku console](https://cloud.elastic.co?page=docs&placement=docs-body). -2. On the deployments page, select your deployment. - - Narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list. - -3. From the **Actions** dropdown, select **Edit deployment**. -4. Select **Manage user settings and extensions**. -5. Select the **Extensions** tab. -6. Select the plugins that you want to enable. -7. Select **Back**. -8. Select **Save**. The {{es}} cluster is then updated with new nodes that have the plugin installed. - - diff --git a/raw-migrated-files/cloud/cloud-heroku/ech-adding-plugins.md b/raw-migrated-files/cloud/cloud-heroku/ech-adding-plugins.md deleted file mode 100644 index b99ea71cc1..0000000000 --- a/raw-migrated-files/cloud/cloud-heroku/ech-adding-plugins.md +++ /dev/null @@ -1,23 +0,0 @@ -# Add plugins and extensions [ech-adding-plugins] - -Plugins extend the core functionality of {{es}}. There are many suitable plugins, including: - -* Discovery plugins, such as the cloud AWS plugin that allows discovering nodes on EC2 instances. -* Analysis plugins, to provide analyzers targeted at languages other than English. -* Scripting plugins, to provide additional scripting languages. - -Plugins can come from different sources: the official ones created or at least maintained by Elastic, community-sourced plugins from other users, and plugins that you provide. Some of the official plugins are always provided with our service, and can be [enabled per deployment](../../../deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md). - -There are two ways to add plugins to a deployment in Elasticsearch Add-On for Heroku: - -* [Enable one of the official plugins already available in Elasticsearch Add-On for Heroku](../../../deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md). -* [Upload a custom plugin and then enable it per deployment](../../../deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md). - -Custom plugins can include the official {{es}} plugins not provided with Elasticsearch Add-On for Heroku, any of the community-sourced plugins, or [plugins that you write yourself](asciidocalypse://docs/elasticsearch/docs/extend/create-elasticsearch-plugins/index.md). Uploading custom plugins is available only to Gold, Platinum, and Enterprise subscriptions. For more information, check [Upload custom plugins and bundles](../../../deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md). - -To learn more about the official and community-sourced plugins, refer to [{{es}} Plugins and Integrations](https://www.elastic.co/guide/en/elasticsearch/plugins/current/index.html). - -Plugins are not supported for {{kib}}. To learn more, check [Restrictions for {{es}} and {{kib}} plugins](../../../deploy-manage/deploy/elastic-cloud/ech-restrictions.md#ech-restrictions-plugins). - - - diff --git a/raw-migrated-files/cloud/cloud-heroku/ech-configure-settings.md b/raw-migrated-files/cloud/cloud-heroku/ech-configure-settings.md deleted file mode 100644 index b740c27763..0000000000 --- a/raw-migrated-files/cloud/cloud-heroku/ech-configure-settings.md +++ /dev/null @@ -1,47 +0,0 @@ -# Configure your deployment [ech-configure-settings] - -You might want to change the configuration of your deployment to: - -* Add features, such as machine learning or APM (application performance monitoring). -* Increase or decrease capacity by changing the amount of reserved memory and storage for different parts of your deployment. -* Enable [autoscaling](../../../deploy-manage/autoscaling.md) so that the available resources for deployment components, such as data tiers and machine learning nodes, adjust automatically as the demands on them change over time. -* Enable high availability by adjusting the number of availability zones that parts of your deployment run on. -* Upgrade to new versions of {{es}}. You can upgrade from one major version to another, such as from 7.17.27 to 8.17.1, or from one minor version to another, such as 8.6 to 8.7. You can’t downgrade versions. -* Change what plugins are available on your {{es}} cluster. - -::::{note} -During the free trial, {{ess}} deployments are restricted to a fixed size. You can resize your deployments when your trial is converted into a paid subscription. -:::: - - -You can change the configuration of a running deployment from the **Configuration** pane in the [Elasticsearch Add-On for Heroku console](https://cloud.elastic.co?page=docs&placement=docs-body). - -With the exception of major version upgrades for Elastic Stack products, Elasticsearch Add-On for Heroku can perform configuration changes without having to interrupt your deployment. You can continue searching and indexing. The changes can also be done in bulk. For example: in one action you can add more memory, upgrade, adjust the number of {{es}} plugins and adjust the number of availability zones. - -We perform all of these changes by creating instances with the new configurations that join your existing deployment before removing the old ones. For example: if you are changing your {{es}} cluster configuration, we create new {{es}} nodes, recover your indexes, and start routing requests to the new nodes. Only when all new {{es}} nodes are ready, do we bring down the old ones. - -By doing it this way, we reduce the risk of making configuration changes. If any of the new instances have a problems, the old ones are still there, processing requests. - -::::{note} -If you use a Platform-as-a-Service provider like Heroku, the administration console is slightly different and does not allow you to make changes that will affect the price. That must be done in the platform provider’s add-on system. You can still do things like change {{es}} version or plugins. -:::: - - -To change the {{es}} cluster in your deployment: - -1. Log in to the [Elasticsearch Add-On for Heroku console](https://cloud.elastic.co?page=docs&placement=docs-body). -2. On the deployments page, select your deployment. - - Narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list. - -3. From your deployment menu, select **{{es}}** and then **Edit**. -4. Let the user interface guide you through the cluster configuration for your cluster. For a full list of the supported settings, check [What Deployment Settings Are Available?](../../../deploy-manage/deploy/elastic-cloud/configure.md) - - If you are changing an existing deployment, you can make multiple changes to your {{es}} cluster with a single configuration update, such as changing the capacity and upgrading to a new {{es}} version in one step. - -5. Save your changes. The new configuration takes a few moments to create. - -Review the changes to your configuration on the **Activity** page, with a tab for {{es}} and one for {{kib}}. - - - diff --git a/raw-migrated-files/cloud/cloud-heroku/ech-configure.md b/raw-migrated-files/cloud/cloud-heroku/ech-configure.md deleted file mode 100644 index 40c4dcfa61..0000000000 --- a/raw-migrated-files/cloud/cloud-heroku/ech-configure.md +++ /dev/null @@ -1,11 +0,0 @@ -# Configuring your deployment [ech-configure] - -The information in this section covers: - -* [Plan for production](../../../deploy-manage/production-guidance/plan-for-production-elastic-cloud.md) - Plan for a highly available and scalable deployment. -* [Configure your deployment](../../../deploy-manage/deploy/elastic-cloud/configure.md) - Customize your cluster through a full list of settings. -* [Enable Kibana](../../../deploy-manage/deploy/elastic-cloud/access-kibana.md) - Explore your data with the Elastic Stack visualization platform. -* [Enable Logging and Monitoring](../../../deploy-manage/monitor/stack-monitoring/elastic-cloud-stack-monitoring.md) - Monitor your cluster’s health and performance and ingest your deployment’s logs. -* [Upgrade versions](../../../deploy-manage/upgrade/deployment-or-cluster.md) - Stay current with the latest Elastic Stack versions. -* [Delete your deployment](../../../deploy-manage/uninstall/delete-a-cloud-deployment.md) - No undo. Data is lost and billing stops. - diff --git a/raw-migrated-files/cloud/cloud-heroku/ech-custom-bundles.md b/raw-migrated-files/cloud/cloud-heroku/ech-custom-bundles.md deleted file mode 100644 index bee7801490..0000000000 --- a/raw-migrated-files/cloud/cloud-heroku/ech-custom-bundles.md +++ /dev/null @@ -1,167 +0,0 @@ -# Upload custom plugins and bundles [ech-custom-bundles] - -There are several cases where you might need your own files to be made available to your {{es}} cluster’s nodes: - -* Your own custom plugins, or third-party plugins that are not amongst the [officially available plugins](../../../deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md). -* Custom dictionaries, such as synonyms, stop words, compound words, and so on. -* Cluster configuration files, such as an Identity Provider metadata file used when you [secure your clusters with SAML](../../../deploy-manage/users-roles/cluster-or-deployment-auth/saml.md). - -To facilitate this, we make it possible to upload a ZIP file that contains the files you want to make available. Uploaded files are stored using Amazon’s highly-available S3 service. This is necessary so we do not have to rely on the availability of third-party services, such as the official plugin repository, when provisioning nodes. - -Custom plugins and bundles are collectively referred to as extensions. - -## Before you begin [echbefore_you_begin_5] - -The selected plugins/bundles are downloaded and provided when a node starts. Changing a plugin does not change it for nodes already running it. Refer to [Updating Plugins and Bundles](../../../deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md#ech-update-bundles-and-plugins). - -With great power comes great responsibility: your plugins can extend your deployment with new functionality, but also break it. Be careful. We obviously cannot guarantee that your custom code works. - -::::{important} -You cannot edit or delete a custom extension after it has been used in a deployment. To remove it from your deployment, you can disable the extension and update your deployment configuration. -:::: - - -Uploaded files cannot be bigger than 20MB for most subscription levels, for Platinum and Enterprise the limit is 8GB. - -It is important that plugins and dictionaries that you reference in mappings and configurations are available at all times. For example, if you try to upgrade {{es}} and de-select a dictionary that is referenced in your mapping, the new nodes will be unable to recover the cluster state and function. This is true even if the dictionary is referenced by an empty index you do not actually use. - - -## Prepare your files for upload [ech-prepare-custom-bundles] - -Plugins are uploaded as ZIP files. You need to choose whether your uploaded file should be treated as a *plugin* or as a *bundle*. Bundles are not installed as plugins. If you need to upload both a custom plugin and custom dictionaries, upload them separately. - -To prepare your files, create one of the following: - -Plugins -: A plugin is a ZIP file that contains a plugin descriptor file and binaries. - - The plugin descriptor file is called either `stable-plugin-descriptor.properties` for plugins built against the stable plugin API, or `plugin-descriptor.properties` for plugins built against the classic plugin API. A plugin ZIP file should only contain one plugin descriptor file. - - {{es}} assumes that the uploaded ZIP file contains binaries. If it finds any source code, it fails with an error message, causing provisioning to fail. Make sure you upload binaries, and not source code. - - ::::{note} - Plugins larger than 5GB should have the plugin descriptor file at the top of the archive. This order can be achieved by specifying at time of creating the ZIP file: - - ```sh - zip -r name-of-plugin.zip name-of-descriptor-file.properties * - ``` - - :::: - - -Bundles -: The entire content of a bundle is made available to the node by extracting to the {{es}} container’s `/app/config` directory. This is useful to make custom dictionaries available. Dictionaries should be placed in a `/dictionaries` folder in the root path of your ZIP file. - - Here are some examples of bundles: - - **Script** - - ```text - $ tree . - . - └── scripts - └── test.js - ``` - - The script `test.js` can be referred in queries as `"script": "test"`. - - **Dictionary of synonyms** - - ```text - $ tree . - . - └── dictionaries - └── synonyms.txt - ``` - - The dictionary `synonyms.txt` can be used as `synonyms.txt` or using the full path `/app/config/synonyms.txt` in the `synonyms_path` of the `synonym-filter`. - - To learn more about analyzing with synonyms, check [Synonym token filter](asciidocalypse://docs/elasticsearch/docs/reference/data-analysis/text-analysis/analysis-synonym-tokenfilter.md) and [Formatting Synonyms](https://www.elastic.co/guide/en/elasticsearch/guide/2.x/synonym-formats.html). - - **GeoIP database bundle** - - ```text - $ tree . - . - └── ingest-geoip - └── MyGeoLite2-City.mmdb - ``` - - Note that the extension must be `-(City|Country|ASN).mmdb`, and it must be a different name than the original file name `GeoLite2-City.mmdb` which already exists in Elasticsearch Add-On for Heroku. To use this bundle, you can refer it in the GeoIP ingest pipeline as `MyGeoLite2-City.mmdb` under `database_file`. - - - -## Add your extension [ech-add-your-plugin] - -You must upload your files before you can apply them to your cluster configuration: - -1. Log in to the [Elasticsearch Add-On for Heroku console](https://cloud.elastic.co?page=docs&placement=docs-body). -2. On the deployments page, select your deployment. -3. Under **Features**, select **Extensions**. -4. Select **Upload extension**. -5. Complete the extension fields, including the {{es}} version. - - * Plugins must use full version notation down to the patch level, such as `7.10.1`. You cannot use wildcards. This version notation should match the version in your plugin’s plugin descriptor file. For classic plugins, it should also match the target deployment version. - * Bundles should specify major or minor versions with wildcards, such as `7.*` or `*`. Wildcards are recommended to ensure the bundle is compatible across all versions of these releases. - -6. Select the extension **Type**. -7. Under **Plugin file**, choose the file to upload. -8. Select **Create extension**. - -After creating your extension, you can [enable them for existing {{es}} deployments](../../../deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md#ech-update-bundles) or enable them when creating new deployments. - -::::{note} -Creating extensions larger than 200MB should be done through the extensions API. - -:::: - - - -## Update your deployment configuration [ech-update-bundles] - -After uploading your files, you can select to enable them when creating a new {{es}} deployment. For existing deployments, you must update your deployment configuration to use the new files: - -1. Log in to the [Elasticsearch Add-On for Heroku console](https://cloud.elastic.co?page=docs&placement=docs-body). -2. On the deployments page, select your deployment. - - Narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list. - -3. From the **Actions** dropdown, select **Edit deployment**. -4. Select **Manage user settings and extensions**. -5. Select the **Extensions** tab. -6. Select the custom extension. -7. Select **Back**. -8. Select **Save**. The {{es}} cluster is then updated with new nodes that have the plugin installed. - - -## Update your extension [ech-update-bundles-and-plugins] - -While you can update the ZIP file for any plugin or bundle, these are downloaded and made available only when a node is started. - -You should be careful when updating an extension. If you update an existing extension with a new file, and if the file is broken for some reason, all the nodes could be in trouble, as a restart or move node could make even HA clusters non-available. - -If the extension is not in use by any deployments, then you are free to update the files or extension details as much as you like. However, if the extension is in use, and if you need to update it with a new file, it is recommended to [create a new extension](../../../deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md#ech-add-your-plugin) rather than updating the existing one that is in use. - -By following this method, only the one node would be down even if the extension file is faulty. This would ensure that HA clusters remain available. - -This method also supports having a test/staging deployment to test out the extension changes before applying them on a production deployment. - -You may delete the old extension after updating the deployment successfully. - -To update an extension with a new file version, - -1. Prepare a new plugin or bundle. -2. On the **Extensions** page, [upload a new extension](../../../deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md#ech-add-your-plugin). -3. Make your new files available by uploading them. -4. On the deployments page, select your deployment. - - Narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list. - -5. From the **Actions** dropdown, select **Edit deployment**. -6. Select **Manage user settings and extensions**. -7. Select the **Extensions** tab. -8. Select the new extension and de-select the old one. -9. Select **Back**. -10. Select **Save**. - - diff --git a/raw-migrated-files/cloud/cloud/ec-customize-deployment.md b/raw-migrated-files/cloud/cloud/ec-customize-deployment.md deleted file mode 100644 index b78a4e34e8..0000000000 --- a/raw-migrated-files/cloud/cloud/ec-customize-deployment.md +++ /dev/null @@ -1,58 +0,0 @@ -# Change your configuration [ec-customize-deployment] - -You might want to change the configuration of your deployment to: - -* Add features, such as machine learning or APM (application performance monitoring). -* Increase or decrease capacity by changing the amount of reserved memory and storage for different parts of your deployment. - - ::::{note} - During the free trial, Elasticsearch Service deployments are restricted to a limited size. You can increase the size of your deployments when your trial is converted to a paid subscription. - :::: - -* Enable [autoscaling](../../../deploy-manage/autoscaling.md) so that the available resources for deployment components, such as data tiers and machine learning nodes, adjust automatically as the demands on them change over time. -* Enable high availability, also known as fault tolerance, by adjusting the number of data center availability zones that parts of your deployment run on. -* Upgrade to new versions of {{es}}. You can upgrade from one major version to another, such as from 6.8.23 to 7.17.27, or from one minor version to another, such as 6.1 to 6.2. You can’t downgrade versions. -* Change what plugins are available on your {{es}} cluster. - -With the exception of major version upgrades for Elastic Stack products, Elasticsearch Service can perform configuration changes without having to interrupt your deployment. You can continue searching and indexing. The changes can also be done in bulk. For example: in one action, you can add more memory, upgrade, adjust the number of {{es}} plugins and adjust the number of availability zones. - -We perform all of these changes by creating instances with the new configurations that join your existing deployment before removing the old ones. For example: if you are changing your {{es}} cluster configuration, we create new {{es}} nodes, recover your indexes, and start routing requests to the new nodes. Only when all new {{es}} nodes are ready, do we bring down the old ones. - -By doing it this way, we reduce the risk of making configuration changes. If any of the new instances have a problems, the old ones are still there, processing requests. - -::::{note} -If you use a Platform-as-a-Service provider like Heroku, the administration console is slightly different and does not allow you to make changes that will affect the price. That must be done in the platform provider’s add-on system. You can still do things like change {{es}} version or plugins. -:::: - - -To change your deployment: - -1. Log in to the [Elasticsearch Service Console](https://cloud.elastic.co?page=docs&placement=docs-body). -2. Find your deployment on the home page in the Elasticsearch Service card and select **Manage** to access it directly. Or, select **Hosted deployments** to go to the deployments page to view all of your deployments. - - On the deployments page you can narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list. - -3. From the deployment menu, select **Edit**. -4. Let the user interface guide you through the cluster configuration for your cluster. For a full list of the supported settings, check [What Deployment Settings Are Available?](../../../deploy-manage/deploy/elastic-cloud/ec-change-hardware-profile.md) - - If you are changing an existing deployment, you can make multiple changes to your {{es}} cluster with a single configuration update, such as changing the capacity and upgrading to a new {{es}} version in one step. - -5. Save your changes. The new configuration takes a few moments to create. - -Review the changes to your configuration on the **Activity** page, with a tab for {{es}} and one for {{kib}}. - -::::{tip} -If you are creating a new deployment, select **Edit settings** to change the cloud provider, region, hardware profile, and stack version; or select **Advanced settings** for more complex configuration settings. -:::: - - -That’s it! If you haven’t already, [start exploring with {{kib}}](../../../deploy-manage/deploy/elastic-cloud/access-kibana.md), our visualization tool. If you’re not familiar with adding data yet, {{kib}} can show you how to index your data into {{es}}, or try our basic steps for working with [{{es}}](../../../manage-data/data-store/manage-data-from-the-command-line.md). - -::::{tip} -Some features are not available during the 14-day free trial. If a feature is greyed out, [add a credit card](../../../deploy-manage/cloud-organization/billing/add-billing-details.md) to unlock the feature. -:::: - - - - - diff --git a/raw-migrated-files/toc.yml b/raw-migrated-files/toc.yml index b19577b48b..90a265e5f2 100644 --- a/raw-migrated-files/toc.yml +++ b/raw-migrated-files/toc.yml @@ -87,13 +87,8 @@ toc: - file: cloud/cloud-heroku/ech-access-kibana.md - file: cloud/cloud-heroku/ech-activity-page.md - file: cloud/cloud-heroku/ech-add-user-settings.md - - file: cloud/cloud-heroku/ech-adding-elastic-plugins.md - - file: cloud/cloud-heroku/ech-adding-plugins.md - file: cloud/cloud-heroku/ech-autoscaling.md - - file: cloud/cloud-heroku/ech-configure-settings.md - - file: cloud/cloud-heroku/ech-configure.md - file: cloud/cloud-heroku/ech-configuring-keystore.md - - file: cloud/cloud-heroku/ech-custom-bundles.md - file: cloud/cloud-heroku/ech-custom-repository.md - file: cloud/cloud-heroku/ech-delete-deployment.md - file: cloud/cloud-heroku/ech-editing-user-settings.md @@ -138,7 +133,6 @@ toc: - file: cloud/cloud/ec-configuring-keystore.md - file: cloud/cloud/ec-custom-bundles.md - file: cloud/cloud/ec-custom-repository.md - - file: cloud/cloud/ec-customize-deployment.md - file: cloud/cloud/ec-delete-deployment.md - file: cloud/cloud/ec-editing-user-settings.md - file: cloud/cloud/ec-enable-logging-and-monitoring.md From 980a5ea88c5013efe127db03321583ff75eb3557 Mon Sep 17 00:00:00 2001 From: florent-leborgne Date: Tue, 25 Feb 2025 10:32:04 +0100 Subject: [PATCH 07/11] Update deploy-manage/deploy/elastic-cloud/manage-deployments.md Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com> --- deploy-manage/deploy/elastic-cloud/manage-deployments.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deploy-manage/deploy/elastic-cloud/manage-deployments.md b/deploy-manage/deploy/elastic-cloud/manage-deployments.md index 38ad18dd35..a0d3f0b462 100644 --- a/deploy-manage/deploy/elastic-cloud/manage-deployments.md +++ b/deploy-manage/deploy/elastic-cloud/manage-deployments.md @@ -11,7 +11,7 @@ mapped_pages: {{ech}} allows you to configure and maintain your deployments with a high level of control on every component of the {{stack}}. You can adjust the settings of any of your deployments at any time. * Define the [core configuration](configure.md) of your deployment, including available features, hardware settings and capacity, autoscaling, and high availability. -* [Upgrade your deployment](/deploy-manage/upgrade/deployment-or-cluster.md) and its component to a newer version of the {{stack}}. +* [Upgrade your deployment](/deploy-manage/upgrade/deployment-or-cluster.md) and its components to a newer version of the {{stack}}. * Make adjustments to specific deployment components, such as an [Integrations Server](manage-integrations-server.md) or [APM & Fleet Server](switch-from-apm-to-integrations-server-payload.md#ec-manage-apm-and-fleet). * [Keep track of your deployment's activity](keep-track-of-deployment-activity.md) or [Enable logging and monitoring](../../monitor/stack-monitoring/elastic-cloud-stack-monitoring.md) of the deployment performance. * [Disable a data tier](../../../manage-data/lifecycle/index-lifecycle-management.md). From fc69dee1ccdb55c90d76a815ae0209626786c618 Mon Sep 17 00:00:00 2001 From: florent-leborgne Date: Tue, 25 Feb 2025 10:32:41 +0100 Subject: [PATCH 08/11] Update deploy-manage/deploy/elastic-cloud/cloud-hosted.md Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com> --- deploy-manage/deploy/elastic-cloud/cloud-hosted.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deploy-manage/deploy/elastic-cloud/cloud-hosted.md b/deploy-manage/deploy/elastic-cloud/cloud-hosted.md index 83ac9ec5f0..4e1dc3f65b 100644 --- a/deploy-manage/deploy/elastic-cloud/cloud-hosted.md +++ b/deploy-manage/deploy/elastic-cloud/cloud-hosted.md @@ -110,7 +110,7 @@ There are a few things that can help you make sure that your production deployme **Secure your environment** -Control which users and services can access your deployments by [securing your environment](/deploy-manage/users-roles/cluster-or-deployment-auth.md). Add authentication mechanisms, configure [traffic filtering](/deploy-manage/security/traffic-filtering.md) for private link, encrypt your deployment data and snapshots at rest [with your own key](/deploy-manage/security/encrypt-deployment-with-customer-managed-encryption-key.md), manage trust with Elasticsearch clusters from other environments, and more. +Control which users and services can access your deployments by [securing your environment](/deploy-manage/security/secure-your-cluster-deployment.md). [Add authentication mechanisms](/deploy-manage/users-roles.md), configure [traffic filtering](/deploy-manage/security/traffic-filtering.md) for private link, encrypt your deployment data and snapshots at rest [with your own key](/deploy-manage/security/encrypt-deployment-with-customer-managed-encryption-key.md), [manage trust](/deploy-manage/remote-clusters.md) with {{es}} clusters from other environments, and more. **Monitor your deployments and keep them healthy** From 2458ddbff5db27b9a1b43f2a49a23e997ce3a56a Mon Sep 17 00:00:00 2001 From: Florent Le Borgne Date: Tue, 25 Feb 2025 12:40:48 +0100 Subject: [PATCH 09/11] include feedback from review --- deploy-manage/deploy/elastic-cloud.md | 18 ++++++++++++++++-- .../deploy/elastic-cloud/cloud-hosted.md | 17 +++++------------ ...eate-an-elastic-cloud-hosted-deployment.md | 11 +++++------ .../elastic-cloud/manage-deployments.md | 19 +++++++++++++------ deploy-manage/toc.yml | 13 +++++-------- 5 files changed, 44 insertions(+), 34 deletions(-) diff --git a/deploy-manage/deploy/elastic-cloud.md b/deploy-manage/deploy/elastic-cloud.md index b254f43abd..c5e1ccfc00 100644 --- a/deploy-manage/deploy/elastic-cloud.md +++ b/deploy-manage/deploy/elastic-cloud.md @@ -9,11 +9,11 @@ mapped_pages: # Elastic Cloud [intro] -{{ecloud}} allows you to manage [hosted deployments](elastic-cloud/cloud-hosted.md) of the {{stack}} and [serverless projects](elastic-cloud/serverless.md) for your Observability, Security, and Search use cases. +{{ecloud}} allows you to centrally manage [hosted deployments](elastic-cloud/cloud-hosted.md) of the {{stack}} and [serverless projects](elastic-cloud/serverless.md) for your Observability, Security, and Search use cases. These hosted deployments and serverless projects are hosted on Elastic Cloud, through the cloud provider and regions of your choice, and are tied to your organization account. -{{ecloud}} is a service managed by Elastic. You can check its operational status at any time from [status.elastic.co](https://status.elastic.co/). +You can check the operational status of {{ecloud}} at any time from [status.elastic.co](https://status.elastic.co/). ## Sign up @@ -21,6 +21,18 @@ You can get started by creating an {{ecloud}} organization on [cloud.elastic.co] For more details on the available sign up options and trial information, go to [](elastic-cloud/create-an-organization.md). +## Benefits of {{ecloud}} + +Some of the unique benefits of {{ecloud}} include: + +- Regular updates and improvements automatically deployed or made available. +- Built-in security, including encryption at rest. +- Central management of billing and licensing. +- Built-in tools for monitoring and scaling your {{ecloud}} resources. +- Central management of users, roles, and authentication, including integration with SSO providers. + +For more information, refer to [](/deploy-manage/cloud-organization.md). + ## Differences between serverless projects and hosted deployments[general-what-is-serverless-elastic-differences-between-serverless-projects-and-hosted-deployments-on-ecloud] You can have multiple hosted deployments and serverless projects in the same {{ecloud}} organization, and each deployment type has its own specificities. @@ -43,3 +55,5 @@ You can have multiple hosted deployments and serverless projects in the same {{e ## APIs {{ecloud}} offers APIs to manage your organization and its resources. Check the [{{ecloud}}](https://www.elastic.co/docs/api/doc/cloud/) and [{{ecloud}} serverless](https://www.elastic.co/docs/api/doc/elastic-cloud-serverless/) APIs. + +More tools are available for you to make the most of your {{ecloud}} organization and {{es}}. Refer to [](/deploy-manage/deploy/elastic-cloud/tools-apis.md). \ No newline at end of file diff --git a/deploy-manage/deploy/elastic-cloud/cloud-hosted.md b/deploy-manage/deploy/elastic-cloud/cloud-hosted.md index be95bc17b9..10957ea8dd 100644 --- a/deploy-manage/deploy/elastic-cloud/cloud-hosted.md +++ b/deploy-manage/deploy/elastic-cloud/cloud-hosted.md @@ -95,19 +95,18 @@ Of course, you can choose to follow your own path and use Elastic components ava **Where to start?** -* Try one of our solutions by following our [getting started guides](https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/getting-started-guides.html). +* Learn the basics of {{es}}, the {{stack}}, and its solutions in [Get started](/get-started/index.md). * Sign up using your preferred method: * [Sign Up for a Trial](/deploy-manage/deploy/elastic-cloud/create-an-organization.md) - Sign up, check what your free trial includes and when we require a credit card. * [Sign Up from Marketplace](/deploy-manage/deploy/elastic-cloud/subscribe-from-marketplace.md) - Consolidate billing portals by signing up through one of the available marketplaces. -* Set up your account by [completing your user or organization profile](/deploy-manage/cloud-organization/billing.md) and by [inviting users to your organization](/deploy-manage/cloud-organization.md). * [Create a deployment](/deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.md) - Get up and running very quickly. Select your desired configuration and let Elastic deploy Elasticsearch, Kibana, and the Elastic products that you need for you. In a deployment, everything works together, everything runs on hardware that is optimized for your use case. * [Connect your data to your deployment](/manage-data/ingest.md) - Ingest and index the data you want, from a variety of sources, and take action on it. **Adjust the capacity and capabilities of your deployments for production** -There are a few things that can help you make sure that your production deployments remain available, healthy, and ready to handle your data in a scalable way over time, with the expected level of performance. We’ve listed these things for you in [Preparing for production](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md). +There are a few things that can help you make sure that your production deployments remain available, healthy, and ready to handle your data in a scalable way over time, with the expected level of performance. Check [](/deploy-manage/production-guidance/plan-for-production-elastic-cloud.md). **Secure your environment** @@ -115,13 +114,7 @@ Control which users and services can access your deployments by [securing your e **Monitor your deployments and keep them healthy** -{{ech}} provides several ways to monitor your deployments, anticipate and prevent issues, or fix them when they occur. Check [Monitoring your deployment](/deploy-manage/monitor/stack-monitoring.md) to get more details. - -**And then?** - -Now is the time for you to work with your data. The content of the {{ech}} section helps you get your environment up and ready to handle your data the way you need. You can always adjust your deployments and their configuration as your usage evolves over time. - -To get the most out of the solutions that the Elastic Stack offers, [log in to {{ecloud}}](https://cloud.elastic.co) or [browse the documentation](https://www.elastic.co/docs). +{{ech}} provides several ways to monitor your deployments, anticipate and prevent issues, or fix them when they occur. Check [Monitoring your deployment](/deploy-manage/monitor.md) to get more details. ## More about {{ech}} [ec-about] @@ -129,8 +122,8 @@ Find more information about {{ech}} on the following pages: * [Subscription Levels](/deploy-manage/license.md) * [Version Policy](/deploy-manage/deploy/elastic-cloud/available-stack-versions.md) -* [{{ech}} Hardware](https://www.elastic.co/guide/en/cloud/current/ec-reference-hardware.html) -* [{{ech}} Regions](https://www.elastic.co/guide/en/cloud/current/ec-reference-regions.html) +* [{{ech}} Hardware](asciidocalypse://docs/cloud/docs/reference/cloud/cloud-hosted/hardware.md) +* [{{ech}} Regions](asciidocalypse://docs/cloud/docs/reference/cloud/cloud-hosted/regions.md) * [Service Status](/deploy-manage/cloud-organization/service-status.md) * [Getting help](/troubleshoot/index.md) * [Restrictions and known problems](/deploy-manage/deploy/elastic-cloud/restrictions-known-problems.md) diff --git a/deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.md b/deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.md index 1ebbc6f478..e76ce4be19 100644 --- a/deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.md +++ b/deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.md @@ -13,12 +13,9 @@ mapped_pages: An Elastic Cloud deployment includes Elastic Stack components such as Elasticsearch, Kibana, and other features, allowing you to store, search, and analyze your data. You can spin up a proof-of-concept deployment to learn more about what Elastic can do for you. -::::{note} -To explore {{ecloud}} and its solutions, create your first deployment by following one of these [getting started guides](https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/getting-started-guides.html). If you are instead interested in serverless Elastic Cloud, check the [serverless documentation](https://docs.elastic.co/serverless). -:::: - - +:::{note} You can also create a deployment using the [Elastic Cloud API](https://www.elastic.co/docs/api/doc/cloud/group/endpoint-deployments). This can be an interesting alternative for more advanced needs, such as for [creating a deployment encrypted with your own key](../../security/encrypt-deployment-with-customer-managed-encryption-key.md). +::: 1. Log in to your [cloud.elastic.co](https://cloud.elastic.co/login) account and select **Create deployment** from the {{ecloud}} main page: @@ -26,13 +23,15 @@ You can also create a deployment using the [Elastic Cloud API](https://www.elast :alt: Log in to create a deployment ::: +1. Select a solution view for your deployment. Solution views define the navigation and set of features that will be first available in your deployment. You can change it later, or [create different spaces](/deploy-manage/manage-spaces.md) with different solution views within your deployment. -Once you are on the **Create deployment** page, you can create the deployment with the defaults assigned, where you can edit the basic settings, or configure more advanced settings. + To learn more about what each solution offers, check [Elasticsearch](/solutions/search/get-started.md), [Observability](/solutions/observability/get-started.md), and [Security](/solutions/security/get-started.md). 1. From the main **Settings**, you can change the cloud provider and region that host your deployment, the stack version, and the hardware profile, or restore data from another deployment (**Restore snapshot data**): :::{image} ../../../images/cloud-ec-create-deployment.png :alt: Create deployment + :width: 50% ::: **Cloud provider**: The cloud platform where you’ll deploy your deployment. We support: Amazon Web Services (AWS), Google Cloud Platform (GCP), and Microsoft Azure. You do not need to provide your own keys. diff --git a/deploy-manage/deploy/elastic-cloud/manage-deployments.md b/deploy-manage/deploy/elastic-cloud/manage-deployments.md index a0d3f0b462..7eea735082 100644 --- a/deploy-manage/deploy/elastic-cloud/manage-deployments.md +++ b/deploy-manage/deploy/elastic-cloud/manage-deployments.md @@ -11,12 +11,19 @@ mapped_pages: {{ech}} allows you to configure and maintain your deployments with a high level of control on every component of the {{stack}}. You can adjust the settings of any of your deployments at any time. * Define the [core configuration](configure.md) of your deployment, including available features, hardware settings and capacity, autoscaling, and high availability. -* [Upgrade your deployment](/deploy-manage/upgrade/deployment-or-cluster.md) and its components to a newer version of the {{stack}}. -* Make adjustments to specific deployment components, such as an [Integrations Server](manage-integrations-server.md) or [APM & Fleet Server](switch-from-apm-to-integrations-server-payload.md#ec-manage-apm-and-fleet). -* [Keep track of your deployment's activity](keep-track-of-deployment-activity.md) or [Enable logging and monitoring](../../monitor/stack-monitoring/elastic-cloud-stack-monitoring.md) of the deployment performance. -* [Disable a data tier](../../../manage-data/lifecycle/index-lifecycle-management.md). -* Perform maintenance operations to ensure the health of your deployment, such as [restarting your deployment](../../maintenance/start-stop-services/restart-cloud-hosted-deployment.md) or [stopping routing](../../maintenance/ece/start-stop-routing-requests.md). -* [Delete your deployment](../../uninstall/delete-a-cloud-deployment.md). + * Select a [hardware profile](/deploy-manage/deploy/elastic-cloud/ec-change-hardware-profile.md) optimized for your use case. + * Make adjustments to specific [deployment components](/deploy-manage/deploy/elastic-cloud/ec-customize-deployment-components.md), such as the {{es}} cluster or an Integrations Server. + * [Manage data tiers](/manage-data/lifecycle/data-tiers.md). + +* Ensure the health of your deployment over time + + * [Keep track of your deployment's activity](keep-track-of-deployment-activity.md) or [Enable logging and monitoring](../../monitor/stack-monitoring/elastic-cloud-stack-monitoring.md) of the deployment performance. + * Perform maintenance operations to ensure the health of your deployment, such as [restarting your deployment](../../maintenance/start-stop-services/restart-cloud-hosted-deployment.md) or [stopping routing](../../maintenance/ece/start-stop-routing-requests.md). + +* Manage the lifecycle of your deployment: + + * [Upgrade your deployment](/deploy-manage/upgrade/deployment-or-cluster.md) and its components to a newer version of the {{stack}}. + * [Delete your deployment](../../uninstall/delete-a-cloud-deployment.md). diff --git a/deploy-manage/toc.yml b/deploy-manage/toc.yml index 7ffd23180f..a2b3e63601 100644 --- a/deploy-manage/toc.yml +++ b/deploy-manage/toc.yml @@ -31,15 +31,12 @@ toc: children: - file: deploy/elastic-cloud/subscribe-from-marketplace.md children: + - hidden: deploy/elastic-cloud/create-monthly-pay-as-you-go-subscription-on-aws-marketplace.md + - hidden: deploy/elastic-cloud/azure-marketplace-pricing.md + - hidden: deploy/elastic-cloud/create-monthly-pay-as-you-go-subscription-on-gcp-marketplace.md - file: deploy/elastic-cloud/aws-marketplace.md - children: - - file: deploy/elastic-cloud/create-monthly-pay-as-you-go-subscription-on-aws-marketplace.md - - file: deploy/elastic-cloud/azure-native-isv-service.md - children: - - file: deploy/elastic-cloud/azure-marketplace-pricing.md - - file: deploy/elastic-cloud/google-cloud-platform-marketplace.md - children: - - file: deploy/elastic-cloud/create-monthly-pay-as-you-go-subscription-on-gcp-marketplace.md + - file: deploy/elastic-cloud/azure-native-isv-service.md + - file: deploy/elastic-cloud/google-cloud-platform-marketplace.md - file: deploy/elastic-cloud/heroku.md children: - file: deploy/elastic-cloud/ech-getting-started-installing.md From 45af061e0e6966bf3a07a390d1f0ed3a871a4348 Mon Sep 17 00:00:00 2001 From: Florent Le Borgne Date: Tue, 25 Feb 2025 13:04:02 +0100 Subject: [PATCH 10/11] redirect --- redirects.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/redirects.yml b/redirects.yml index 30a048c13e..433a8c70b0 100644 --- a/redirects.yml +++ b/redirects.yml @@ -1,2 +1,3 @@ redirects: - 'get-started/installing-elastic-stack.md': '!deploy-manage/deploy/self-managed.md' \ No newline at end of file + 'get-started/installing-elastic-stack.md': '!deploy-manage/deploy/self-managed.md' + 'deploy-manage/deploy/elastic-cloud/ec-configure-deployment-settings.md': '!deploy-manage/deploy/elastic-cloud/ec-customize-deployment-components.md' \ No newline at end of file From c086e272b742e468a55dba5e0e62b49a489d1e69 Mon Sep 17 00:00:00 2001 From: Florent Le Borgne Date: Tue, 25 Feb 2025 13:09:52 +0100 Subject: [PATCH 11/11] link --- raw-migrated-files/cloud/cloud-heroku/ech-upgrade-deployment.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/raw-migrated-files/cloud/cloud-heroku/ech-upgrade-deployment.md b/raw-migrated-files/cloud/cloud-heroku/ech-upgrade-deployment.md index 32d45a69c8..9858ecdc39 100644 --- a/raw-migrated-files/cloud/cloud-heroku/ech-upgrade-deployment.md +++ b/raw-migrated-files/cloud/cloud-heroku/ech-upgrade-deployment.md @@ -30,7 +30,7 @@ When upgrading from one recent major Elasticsearch version to the next, we recom * [Upgrade to Elasticsearch 5.x](https://www.elastic.co/guide/en/cloud-heroku/current/ech-upgrading-v5.html) ::::{warning} -If you have a custom plugin installed, you must [update the plugin](../../../deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md#ech-update-bundles-and-plugins) so that it matches the Elasticsearch version that you are upgrading to. When the custom plugin does not match the Elasticsearch version, the upgrade fails. +If you have a custom plugin installed, you must [update the plugin](../../../deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md) so that it matches the Elasticsearch version that you are upgrading to. When the custom plugin does not match the Elasticsearch version, the upgrade fails. ::::