diff --git a/deploy-manage/deploy/cloud-enterprise.md b/deploy-manage/deploy/cloud-enterprise.md index 3590745244..2c547dbbfe 100644 --- a/deploy-manage/deploy/cloud-enterprise.md +++ b/deploy-manage/deploy/cloud-enterprise.md @@ -11,7 +11,7 @@ mapped_urls: {{ece}} (ECE) is an Elastic self-managed solution for deploying, orchestrating, and managing {{es}} clusters at scale. It provides a centralized platform that allows organizations to run {{es}}, {{kib}}, and other {{stack}} components across multiple machines. -ECE evolves from the Elastic hosted Cloud SaaS offering into a standalone product. You can deploy ECE on public or private clouds, virtual machines, or your own premises. +ECE evolves from the [{{ech}}](./elastic-cloud.md) offering into a standalone product. You can deploy ECE on public or private clouds, virtual machines, or your own premises. With {{ece}}, you can: @@ -51,7 +51,7 @@ The section covers the following tasks: * [Work with deployments](./cloud-enterprise/working-with-deployments.md) - Use [](./cloud-enterprise/deployment-templates.md) to [](./cloud-enterprise/create-deployment.md) - [](./cloud-enterprise/customize-deployment.md) - - Use the deployment [Cloud ID](./cloud-enterprise/find-cloud-id.md) and [Endpoint URLs](./cloud-enterprise/find-endpoint-url.md) for clients connection + - [Connect your applications to {{es}}](./cloud-enterprise/connect-elasticsearch.md) * Learn about [](./cloud-enterprise/tools-apis.md) that you can use with ECE diff --git a/deploy-manage/deploy/cloud-enterprise/access-kibana.md b/deploy-manage/deploy/cloud-enterprise/access-kibana.md new file mode 100644 index 0000000000..0cf330bb65 --- /dev/null +++ b/deploy-manage/deploy/cloud-enterprise/access-kibana.md @@ -0,0 +1,42 @@ +--- +applies_to: + deployment: + ece: all +mapped_pages: + - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-access-kibana.html + - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-manage-kibana.html +--- + +# Access Kibana [ece-access-kibana] + +Kibana is an open source analytics and visualization platform designed to search, view, and interact with data stored in Elasticsearch indices. + +::::{tip} +Most deployment templates include a Kibana instance, but if it wasn’t part of the initial deployment you can [customize your deployment components](./customize-deployment.md) to add {{kib}}. +:::: + +To access Kibana: + +1. [Log into the Cloud UI](../../../deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md). +2. On the **Deployments** page, select your deployment. + + Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters. + +3. Under **Applications**, select the Kibana **Open** 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 {{ece}} 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 an [ECE account](/deploy-manage/users-roles/cloud-enterprise-orchestrator/manage-users-roles.md) credentials and then you’ll be redirected to Kibana. + * Log in with the `elastic` superuser. The password was provided when you created your cluster and [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](/deploy-manage/users-roles/cluster-or-deployment-auth/user-roles.md). + + ::::{tip} + On AWS and not able to access Kibana? [Check if you need to update your endpoint URL first](../../../troubleshoot/deployments/cloud-enterprise/common-issues.md#ece-aws-private-ip). + :::: + +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. Refer to [](/deploy-manage/users-roles/cluster-or-deployment-auth.md) for more information. + diff --git a/deploy-manage/deploy/cloud-enterprise/add-custom-bundles-plugins.md b/deploy-manage/deploy/cloud-enterprise/add-custom-bundles-plugins.md index d97006ba14..36df3185c6 100644 --- a/deploy-manage/deploy/cloud-enterprise/add-custom-bundles-plugins.md +++ b/deploy-manage/deploy/cloud-enterprise/add-custom-bundles-plugins.md @@ -1,7 +1,7 @@ --- mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-add-custom-bundle-plugin.html -navigation_title: "Custom bundles and plugins" +navigation_title: "Add custom bundles and plugins" applies_to: deployment: ece: @@ -9,17 +9,28 @@ applies_to: # Add custom bundles and plugins to your deployment [ece-add-custom-bundle-plugin] -Follow these steps to upload custom bundles and plugins to your Elasticsearch clusters, so that it uses your custom bundles or plugins. +ECE allows you to add custom plugins or external files as bundled ZIP files to your {{es}} instances. These ZIP files must be referenced through an HTTP or HTTPS URL. -* Update your Elasticsearch cluster in the [advanced configuration editor](../../../deploy-manage/deploy/cloud-enterprise/advanced-cluster-configuration.md): -* For bundles, modify the `resources.elasticsearch.plan.elasticsearch.user_bundles` JSON attribute. -* For plugins, modify the `resources.elasticsearch.plan.elasticsearch.user_plugins` JSON attribute. +::::{important} +* When referencing plugins or bundles, URLs using `https` with a certificate signed by an internal Certificate Authority (CA) are **not supported**. Either use a publicly trusted certificate, or fall back to the `http` scheme. +* Avoid using the same URL to serve newer versions of a plugin or bundle, as this may cause different nodes within the same cluster to run different plugin versions. Whenever you update the content of the bundle or plugin, use a new URL in the deployment configuration as well. +* If the URL becomes unreachable (if the URL changes at remote end, or connectivity to the remote web server has issues) you might encounter boot loops if {{es}} instances are restarted. +:::: -We’ve provided some examples, including [LDAP bundles](../../../solutions/search/full-text/search-with-synonyms.md#ece-add-custom-bundle-example-LDAP), [SAML bundles](../../../solutions/search/full-text/search-with-synonyms.md#ece-add-custom-bundle-example-SAML), [synonym bundles](../../../solutions/search/full-text/search-with-synonyms.md#ece-add-custom-bundle-example-synonyms), and adding a [JVM trustore](../../../solutions/search/full-text/search-with-synonyms.md#ece-add-custom-bundle-example-cacerts). +Follow these steps to configure custom bundles and plugins to your {{es}} clusters, making them available to all {{es}} instances: -::::{tip} -As part of the ECE [high availability](../../../deploy-manage/deploy/cloud-enterprise/ece-ha.md) strategy, it’s a good idea to make sure that any web servers hosting custom bundles or plugins required by ECE are available to all allocators, so that they can continue to be accessed in the event of a network partition or zone outage. An instance that requires custom bundles or plugins will be unable to start in the event that it can’t access the plugin web server. -:::: +* Update your Elasticsearch cluster using the [advanced configuration editor](../../../deploy-manage/deploy/cloud-enterprise/advanced-cluster-configuration.md): + * For bundles, modify the `resources.elasticsearch.plan.elasticsearch.user_bundles` JSON attribute. + * For plugins, modify the `resources.elasticsearch.plan.elasticsearch.user_plugins` JSON attribute. + +Here are some examples of custom bundles you can add: + +- [Custom plugin](#ece-add-custom-plugin) +- [LDAP bundles](#ece-add-custom-bundle-example-LDAP) +- [SAML bundles](#ece-add-custom-bundle-example-SAML) +- [JVM truststore cacerts](#ece-add-custom-bundle-example-cacerts) +- [GeoIP database bundle](#ece-add-custom-bundle-example-geoip) +- [Synonym bundles](#ece-add-custom-bundle-example-synonyms) ## Add custom plugins to your deployment [ece-add-custom-plugin] @@ -65,32 +76,16 @@ Custom plugins can include the official Elasticsearch plugins not provided with ] } ``` - 1. The URL for the plugin must be always available. Make sure you host the plugin artifacts internally in a highly available environment. The URL must use the scheme `http` or `https` 2. The version must match exactly your Elasticsearch version, such as `7.17.1`. Wildcards (*) are not allowed. - - ::::{important} - If the plugin URL becomes unreachable (if the URL changes at remote end, or connectivity to the remote web server has issues) you might encounter boot loops. - :::: - - - ::::{important} - Don’t use the same URL to serve newer versions of the plugin. This may result in different nodes of the same cluster running different plugin versions. - :::: - - - ::::{important} - A plugin URL that uses an `https` endpoint with a certificate signed by an internal Certificate Authority (CA) is not supported. Either use a publicly trusted certificate, or fall back to the `http` scheme. - :::: - 5. Save your changes. 6. To verify that all nodes have the plugins installed, use one of these commands: `GET /_nodes/plugins?filter_path=nodes.*.plugins` or `GET _cat/plugins?v` ## Example: Custom LDAP bundle [ece-add-custom-bundle-example-LDAP] -This example adds a custom LDAP bundle for deployment level role-based access control (RBAC). To set platform level RBAC, check [Configure RBAC](../../../deploy-manage/users-roles/cloud-enterprise-orchestrator/manage-users-roles.md). +This example adds a custom LDAP bundle for deployment level role-based access control (RBAC). To set platform level RBAC, check [](../../../deploy-manage/users-roles/cloud-enterprise-orchestrator/manage-users-roles.md). 1. Prepare a custom bundle as a ZIP file that contains your keystore file with the private key and certificate inside of a `truststore` folder [in the same way that you would on Elastic Cloud](/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md). This bundle allows all Elasticsearch containers to access the same keystore file through your `ssl.truststore` settings. 2. In the [advanced configuration editor](../../../deploy-manage/deploy/cloud-enterprise/advanced-cluster-configuration.md), update your new Elasticsearch cluster with the custom bundle you have just created. Modify the `user_bundles` JSON attribute of **each** Elasticsearch instance type as shown in the following example: @@ -118,16 +113,6 @@ This example adds a custom LDAP bundle for deployment level role-based access co 1. The URLs for the bundle ZIP files (`ldapcert.zip`) must be always available. Make sure you host the plugin artifacts internally in a highly available environment. - - ::::{important} - If the bundle URL becomes unreachable (if the URL changes at remote end, or connectivity to the remote web server has issues) you might encounter boot loops. - :::: - - - ::::{important} - Don’t use the same URL to serve newer versions of the bundle. This may result in different nodes of the same cluster running different bundle versions. - :::: - 3. Custom bundles are unzipped in `/app/config/BUNDLE_DIRECTORY_STRUCTURE`, where `BUNDLE_DIRECTORY_STRUCTURE` is the directory structure within the bundle ZIP file itself. These file locations are needed in the next step. ```sh @@ -139,73 +124,61 @@ This example adds a custom LDAP bundle for deployment level role-based access co In this example, the unzipped keystore file gets placed under `/app/config/truststore/keystore.ks`. - - ## Example: Custom SAML bundle [ece-add-custom-bundle-example-SAML] -This example adds a custom SAML bundle for deployment level role-based access control (RBAC). To set platform level RBAC, check [Configure RBAC](../../../deploy-manage/users-roles/cloud-enterprise-orchestrator/manage-users-roles.md). +This example adds a custom SAML bundle for deployment level role-based access control (RBAC). To set platform level RBAC, check [](../../../deploy-manage/users-roles/cloud-enterprise-orchestrator/manage-users-roles.md). -1. If your Identity Provider doesn’t publish its SAML metadata at an HTTP URL, or if your Elasticsearch cluster cannot reach that URL, you can upload the SAML metadata as a file. +In this example, we assume the Identity Provider does not publish its SAML metadata at an HTTP URL, so we provide it through a custom bundle. - 1. Prepare a ZIP file with a [custom bundle](../../../solutions/search/full-text/search-with-synonyms.md) that contains your Identity Provider’s metadata (`metadata.xml`) and store it in the `saml` folder. +1. Prepare a ZIP file with a custom bundle that contains your Identity Provider’s metadata (`metadata.xml`). Place the file inside a `saml` folder within the ZIP (`saml/metadata.xml`). - This bundle allows all Elasticsearch containers to access the metadata file. + This bundle will allow all Elasticsearch containers to access the metadata file. - 2. In the [advanced configuration editor](../../../deploy-manage/deploy/cloud-enterprise/advanced-cluster-configuration.md), update your Elasticsearch cluster configuration with the bundle you prepared in the previous step. Modify the `user_bundles` JSON attribute of **each** Elasticsearch instance type as shown in the following example: +2. In the [advanced configuration editor](../../../deploy-manage/deploy/cloud-enterprise/advanced-cluster-configuration.md), update your Elasticsearch cluster configuration with the bundle you prepared in the previous step. Modify the `user_bundles` JSON attribute of **each** Elasticsearch instance type as shown in the following example: - ```text - { - ... - "resources": { - "elasticsearch": [ - ... - "plan": { - ... - "elasticsearch": { - ... - "user_bundles": [ - { - "name": "saml-metadata", - "url": "http://www.MYURL.com/saml-metadata.zip", <1> - "elasticsearch_version": "*" - } - ] - } + ```text + { + ... + "resources": { + "elasticsearch": [ + ... + "plan": { + ... + "elasticsearch": { ... - ``` - - 1. The URL for the bundle ZIP file must be always available. Make sure you host the plugin artifacts internally in a highly available environment.::::{important} - If the bundle URL becomes unreachable (if the URL changes at remote end, or connectivity to the remote web server has issues) you might encounter boot loops. - :::: - - - - - ::::{important} - Don’t use the same URL to serve newer versions of the bundle. This may result in different nodes of the same cluster running different bundle versions. - :::: - + "user_bundles": [ + { + "name": "saml-metadata", + "url": "http://www.MYURL.com/saml-metadata.zip", <1> + "elasticsearch_version": "*" + } + ] + } + ... + ``` - Custom bundles are unzipped in `/app/config/BUNDLE_DIRECTORY_STRUCTURE`, where `BUNDLE_DIRECTORY_STRUCTURE` is the directory structure within the ZIP file itself. These file locations are needed in the next step. + 1. The URL for the bundle ZIP file must be always available. Make sure you host the plugin artifacts internally in a highly available environment. - In this example, the SAML metadata file is located in the path `/app/config/saml/metadata.xml`: + Custom bundles are unzipped in `/app/config/BUNDLE_DIRECTORY_STRUCTURE`, where `BUNDLE_DIRECTORY_STRUCTURE` is the directory structure within the ZIP file itself. These file locations are needed in the next step. - ```sh - $ tree . - . - └── saml - └── metadata.xml - ``` + In this example, the SAML metadata file is located in the path `/app/config/saml/metadata.xml`: - 3. Adjust your `saml` realm configuration accordingly: + ```sh + $ tree . + . + └── saml + └── metadata.xml + ``` - ```sh - idp.metadata.path: /app/config/saml/metadata.xml <1> - ``` +3. Adjust your `saml` realm configuration accordingly through [](./edit-stack-settings.md): - 1. The path to the SAML metadata file that was uploaded + ```sh + idp.metadata.path: /app/config/saml/metadata.xml <1> + ``` + 1. The path to the SAML metadata file that was uploaded + Refer to [](../../users-roles/cluster-or-deployment-auth/saml.md) for more details on SAML authentication. ## Example: Custom JVM trust store bundle [ece-add-custom-bundle-example-cacerts] @@ -250,15 +223,13 @@ To import a JVM trust store: We recommend that you keep file name and password for the trust store as JVM defaults (`cacerts` and `changeit` respectively). If you need to use different values, you need to add extra configuration, as detailed later in this document, in addition to adding the bundle. :::: - - You can have multiple certificates to the trust store, repeating the same command. There is only one trust store per cluster currently supported. You cannot, for example, add multiple bundles with different trust stores to the same cluster, they will not get merged. Add all certificates to be trusted to the same trust store + You can have multiple certificates to the trust store, repeating the same command. There is only one JVM trust store per cluster currently supported. You cannot, for example, add multiple bundles with different JVM trust stores to the same cluster, they will not get merged. Add all certificates to be trusted to the same trust store 2. Create the bundle: ```sh zip cacerts.zip cacerts <1> ``` - 1. The name of the zip archive is not significant @@ -288,45 +259,28 @@ To import a JVM trust store: } ... ``` - 1. The URL for the bundle ZIP file must be always available. Make sure you host the plugin artefacts internally in a highly available environment. 2. Wildcards are allowed here, since the certificates are independent from the Elasticsearch version. - - ::::{important} - If the bundle URL becomes unreachable (if the URL changes at remote end, or connectivity to the remote web server has issues) you might encounter boot loops. - :::: - - -::::{important} -Don’t use the same URL to serve newer versions of the bundle, i.e. when updating certificates. This may result in different nodes of the same cluster running different bundle versions. -:::: - - -1. If you prefer to use a different file name and/or password for the trust store, you also need to add an additional configuration section to the cluster metadata before adding the bundle. This configuration should be added to the `Elasticsearch cluster data` section of the page: +4. (Optional) If you prefer to use a different file name and/or password for the trust store, you also need to add an additional configuration section to the cluster metadata before adding the bundle. This configuration should be added to the `Elasticsearch cluster data` section of the [advanced configuration](./advanced-cluster-configuration.md) page: ```sh "jvm_trust_store": { - "name": "", - "password": "" + "name": "", <1> + "password": "" <2> } ``` + 1. The name of the trust store must match the filename included into the archive + 2. Password used to create the trust store - -1. The name of the trust store must match the filename included into the archive -2. Password used to create the trust store::::{important} -Use only alphanumeric characters, dashes, and underscores in both file name and password. -:::: - - -You do not need to do this step if you are using default filename and password (`cacerts` and `changeit` respectively) in your bundle. - - - + ::::{important} + * Use only alphanumeric characters, dashes, and underscores in both file name and password. + * You do not need to do this step if you are using default filename and password (`cacerts` and `changeit` respectively) in your bundle. + :::: ## Example: Custom GeoIP database bundle [ece-add-custom-bundle-example-geoip] -1. Prepare a ZIP file with a [custom bundle](../../../solutions/search/full-text/search-with-synonyms.md) that contains a: [GeoLite2 database](https://dev.maxmind.com/geoip/geoip2/geolite2). The folder has to be named `ingest-geoip`, and the file name can be anything that is appended `-(City|Country|ASN)` with the `mmdb` file extension, and it must have a different name than the original name `GeoLite2-City.mmdb`. +1. Prepare a ZIP file with a custom bundle that contains a: [GeoLite2 database](https://dev.maxmind.com/geoip/geoip2/geolite2). The folder has to be named `ingest-geoip`, and the file name can be anything that is appended `-(City|Country|ASN)` with the `mmdb` file extension, and it must have a different name than the original name `GeoLite2-City.mmdb`. The file `my-geoip-file.zip` should look like this: @@ -374,11 +328,9 @@ You do not need to do this step if you are using default filename and password ( ... ``` - - ## Example: Custom synonyms bundle [ece-add-custom-bundle-example-synonyms] -1. Prepare a ZIP file with a [custom bundle](../../../solutions/search/full-text/search-with-synonyms.md) that contains a dictionary of synonyms in a text file. +1. Prepare a ZIP file with a custom bundle that contains a dictionary of synonyms in a text file. The file `synonyms.zip` should look like this: @@ -412,4 +364,3 @@ You do not need to do this step if you are using default filename and password ( } ``` - diff --git a/deploy-manage/deploy/cloud-enterprise/add-plugins.md b/deploy-manage/deploy/cloud-enterprise/add-plugins.md index 8d267c7b05..773003eb9d 100644 --- a/deploy-manage/deploy/cloud-enterprise/add-plugins.md +++ b/deploy-manage/deploy/cloud-enterprise/add-plugins.md @@ -1,4 +1,5 @@ --- +navigation_title: Configure plugins and extensions applies_to: deployment: ece: @@ -8,6 +9,10 @@ applies_to: Plugins extend the core functionality of {{es}}. {{ece}} makes it easy to add plugins to your deployment by providing a number of plugins that work with your version of {{es}}. One advantage of these plugins is that you generally don’t have to worry about upgrading plugins when upgrading to a new {{es}} version, unless there are breaking changes. The plugins are upgraded along with the rest of your deployment. +::::{note} +This page refers to {{es}} plugins that come built-in with the {{ece}} platform. For details on adding other plugins, refer to [](./add-custom-bundles-plugins.md). +:::: + Adding plugins to a deployment is as simple as selecting it from the list of available plugins, but different versions of {{es}} support different plugins. Plugins are available for different purposes, such as: * National language support, phonetic analysis, and extended unicode support @@ -21,7 +26,7 @@ You can also [create](elasticsearch://extend/index.md) and add custom plugins. To add plugins when creating a new deployment: 1. [Log into the Cloud UI](/deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md) and select **Create deployment**. -2. Make your initial deployment selections, then select **Customize Deployment**. +2. Make your initial deployment selections, then select **Advanced settings**. 3. Beneath the {{es}} master node, expand the **Manage plugins and settings** caret. 4. Select the plugins you want. 5. Select **Create deployment**. diff --git a/deploy-manage/deploy/cloud-enterprise/advanced-cluster-configuration.md b/deploy-manage/deploy/cloud-enterprise/advanced-cluster-configuration.md index 9f873a1d04..a3c4df4dc0 100644 --- a/deploy-manage/deploy/cloud-enterprise/advanced-cluster-configuration.md +++ b/deploy-manage/deploy/cloud-enterprise/advanced-cluster-configuration.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-advanced-configuration.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/change-endpoint-urls.md b/deploy-manage/deploy/cloud-enterprise/change-endpoint-urls.md index 034a7637ce..ccaf2d0891 100644 --- a/deploy-manage/deploy/cloud-enterprise/change-endpoint-urls.md +++ b/deploy-manage/deploy/cloud-enterprise/change-endpoint-urls.md @@ -8,45 +8,36 @@ mapped_pages: # Change endpoint URLs [ece-administering-endpoints] -For applications without SSL or HTTPS protocol support, you can use a local endpoint with the HTTP protocol, which in turn connects to your Elasticsearch cluster or to Kibana either using the HTTP or the HTTPS protocol. +{{es}} and {{kib}} endpoint URLs are constructed using the `CLUSTER_ID` of the component ({{es}} or {{kib}}), and the domain name (`CNAME`) configured in the **Deployment Endpoints** section of the **Platform > Settings** UI. -By default, cluster and Kibana endpoint URLs are constructed according to the following pattern, where `CLUSTER_ID` and `LOCAL_HOST_IP` are values that depend on your specific installation: +By default, the deployments `CNAME` is set to `LOCAL_HOST_IP.ip.es.io`, where `LOCAL_HOST_IP` is the IP address of the first installed ECE host. This results in the following default endpoint URLs: ```sh http://CLUSTER_ID.LOCAL_HOST_IP.ip.es.io:9200 https://CLUSTER_ID.LOCAL_HOST_IP.ip.es.io:9243 ``` -For example: - -```sh -http://2882c82e54d4361.us-west-5.aws.found.io:9200 -https://2882c82e54d4361.us-west-5.aws.found.io:9243 -``` - -::::{tip} -To find your endpoints, select a deployment review the information on the **Elasticsearch** and **Kibana** pages. +::::{important} +If your application does not support HTTPS, you can connect to the HTTP endpoint on port 9200. However, for security reasons, it is recommended to use **HTTPS (9243)** whenever possible. :::: To change endpoints in the Cloud UI: 1. [Log into the Cloud UI](log-into-cloud-ui.md). 2. From the **Platform** menu, select **Settings**. -3. Specify the deployment domain name value for your cluster and Kibana endpoints. +3. Specify the deployment domain name (`CNAME`) value for your cluster and Kibana endpoints. 4. Select **Update Deployment endpoints**. The new endpoint becomes effective immediately. +To find your deployment endpoints, select a deployment and review the information on the **Elasticsearch** and **Kibana** pages. + ::::{tip} If you install Elastic Cloud Enterprise on AWS, you likely need to modify the cluster endpoint. To learn more, check [Endpoint URLs Inaccessible on AWS](../../../troubleshoot/deployments/cloud-enterprise/common-issues.md#ece-aws-private-ip). :::: - ::::{tip} If you have an App Search instance, after specifying a new deployment domain name value you need to reapply the App Search [cluster configuration](advanced-cluster-configuration.md), either with or without any changes. :::: - ::::{note} The built-in Proxy Certificate only validates against the default endpoint format described on this page. Once you change it, it is necessary to upload a new Proxy Certificate as described in [Manage security certificates](/deploy-manage/security/secure-your-elastic-cloud-enterprise-installation/manage-security-certificates.md). For test only, clients can be configured with hostname verification disabled until the new certificate is uploaded. :::: - - diff --git a/deploy-manage/deploy/cloud-enterprise/configure-deployment-templates.md b/deploy-manage/deploy/cloud-enterprise/configure-deployment-templates.md index 81ae3dddf2..ebc80e6503 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-deployment-templates.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-deployment-templates.md @@ -6,7 +6,7 @@ mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configuring-ece-templates.html --- -# Configure deployment templates [ece-configuring-ece-templates] +# Manage deployment templates [ece-configuring-ece-templates] Deployment templates combine components of the Elastic Stack, such as Elasticsearch nodes and Kibana instances, for different use cases. Compared to a one-size-fits-all approach to deploying the Elastic Stack, templates provide much greater flexibility and ensure that your deployments have the resources they need to support your use cases. To make the most of deployment templates, you must configure ECE for them. diff --git a/deploy-manage/deploy/cloud-enterprise/configure-deployment.md b/deploy-manage/deploy/cloud-enterprise/configure-deployment.md new file mode 100644 index 0000000000..e750a577b3 --- /dev/null +++ b/deploy-manage/deploy/cloud-enterprise/configure-deployment.md @@ -0,0 +1,46 @@ +--- +navigation_title: Configure +applies_to: + deployment: + ece: all +mapped_pages: + - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-change-deployment.html +--- + +% document scope: introduction to deployment configuration use cases + +# Configure your deployment [ece-change-deployment] + +You can modify your deployment to adjust resources, enable additional features, or optimize performance. To make sure you’re all set for production, consider the following actions: + +* [](./customize-deployment.md): Learn how to change your deployment architecture, configure resources, autoscaling, data tiers, and other {{stack}} components, from the **Edit** deployment view. +* [](./edit-stack-settings.md): Add, remove, or update {{es}} or {{kib}} YML configuration settings. +* [](./resize-deployment.md): Learn how to scale a deployment, including important considerations, and a practical example. +* [](./add-plugins.md): Enable or disable plugins from the list of available extensions in ECE. +* [](./add-custom-bundles-plugins.md): Add custom plugins or external configuration files to your {{es}} instances. +* [](./ece-regional-deployment-aliases.md): Configure custom aliases to create predictable and human-readable URLs for your {{stack}} components, making them easier to share and use. +* [](./resource-overrides.md): Temporary extend cluster capacity to improve stability. + +Refer to [](./working-with-deployments.md) for additional actions and configurable features for your deployments, such as snapshots, secure settings, and monitoring. + +## When to modify your deployment [ece-prepare-production] + +You might want to change the configuration of your deployment to: + +* Add features, such as [machine learning](/explore-analyze/machine-learning.md) or [APM (application performance monitoring)](/solutions/observability/apps/application-performance-monitoring-apm.md). +* [Increase or decrease capacity](./resize-deployment.md) by changing the amount of reserved memory and storage for different parts of your deployment. +* Enable [autoscaling](/deploy-manage/autoscaling/autoscaling-in-ece-and-ech.md) so that the available resources for deployment components, such as [data tiers](/manage-data/lifecycle/data-tiers.md) and machine learning nodes, adjust automatically as the demands on them change over time. +* Enable [high availability](./ece-ha.md), also known as fault tolerance, by adjusting the number of availability zones that parts of your deployment run on. +* [Upgrade](../../upgrade/deployment-or-cluster/upgrade-on-ece.md) to new versions of {{es}}. You can upgrade from one major version to another, such as from 8.18 to 9.0, or from one minor version to another, such as 8.16 to 8.17. You can’t downgrade versions. +* Change what plugins are available on your deployment. +* Update {{es}}, {{kib}}, or other stack application YML configuration settings. + +## Applying deployment changes + +When you modify a deployment and select **Save changes**, {{ece}} prepares and executes a **plan** to apply the requested updates and bring the deployment to the desired state. The type of plan depends on the nature of the changes and the selected [configuration strategy](./customize-deployment.md#configuration-strategies). Some plans involve creating new instances and migrating data, while others may require restarting certain components of the deployment. + +For single availability zone deployments, there is downtime to portions of your cluster when changes are applied. For [high availability](./ece-ha.md) deployments, with the exception of major version upgrades, we these changes can be made without interrupting your deployment. While these changes are being applied, you can continue to search and index. + +::::{note} +When applying changes, existing data may be migrated to new nodes. For clusters containing large amounts of data, this migration can take some time, especially if your deployment is under a heavy workload. Refer to [Configuration strategies](./customize-deployment.md#configuration-strategies) to learn about the different ways ECE applies changes. +:::: diff --git a/deploy-manage/deploy/cloud-enterprise/connect-elasticsearch.md b/deploy-manage/deploy/cloud-enterprise/connect-elasticsearch.md new file mode 100644 index 0000000000..c84dfb9c6f --- /dev/null +++ b/deploy-manage/deploy/cloud-enterprise/connect-elasticsearch.md @@ -0,0 +1,114 @@ +--- +navigation_title: Connect to Elasticsearch +applies_to: + deployment: + ece: all +mapped_pages: + - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-cloud-id.html + - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-connect.html +--- + +# Connect to Elasticsearch [ece-connect] + +This section explains how to connect client applications to an {{es}} deployment running on ECE. You can use the [endpoint URL](#ece-connect-endpoint) available in the deployment UI, or the [Cloud ID](#ece-cloud-id) for a simplified setup with compatible clients such as Beats and Logstash. + +% TBD - not sure if this is totally accurate +% {{ece}} clusters running on ECE only support connections over **HTTP/HTTPS** through the RESTful API. Direct connections to the transport port are not supported. + +To successfully connect to a deployment, you need both the connection details and valid authentication credentials for an authorized user in the target deployment. For more details on authentication and authorization mechanisms in ECE, refer to [Users and roles](../../users-roles.md#orchestrator-level). + +## Connect using the endpoint URL [ece-connect-endpoint] + +To connect to your {{es}} cluster, copy the **{{es}} endpoint** from the deployment page in the [Cloud UI](./log-into-cloud-ui.md). + +::::{important} +Application endpoints in ECE are generated based on the domain name configured in **Platform > Settings**. To learn how to modify these endpoints, refer to [Change endpoint URLs](./change-endpoint-urls.md). +:::: + +Once you have the endpoint, use it in your client application. To test connectivity, you can: +* Open the endpoint in your browser and enter authentication details when prompted. +* Modify the following `curl` example to fit your environment by replacing the URL and proxy CA certificate with your own values. + + ```sh + curl --cacert /path/to/elastic-ece-ca-cert.pem -u elastic https://f76e96da2a7f4d3f8f3ee25d686b879c.HOST-IP-ADDRESS.ip.es.io:9243 + { + "name" : "instance-0000000000", + "cluster_name" : "f76e96da2a7f4d3f8f3ee25d686b879c", + "cluster_uuid" : "w2SXqdACQCy5AAixXRxeXg", + "version" : { + "number" : "8.17.3", + "build_flavor" : "default", + "build_type" : "docker", + "build_hash" : "a091390de485bd4b127884f7e565c0cad59b10d2", + "build_date" : "2025-02-28T10:07:26.089129809Z", + "build_snapshot" : false, + "lucene_version" : "9.12.0", + "minimum_wire_compatibility_version" : "7.17.0", + "minimum_index_compatibility_version" : "7.0.0" + }, + "tagline" : "You Know, for Search" + } + ``` + + The previous example authenticates to the cluster using the default `elastic` user. For more information on authentication and authorization in {{es}}, refer to [](../../users-roles.md). + + ::::{note} + When connecting to {{es}}, you can use one of the following ports: + * Port 9243 – Secure HTTPS (**recommended**). + * Port 9200 – Plaintext HTTP (**not recommended**). + :::: + +## Connect using Cloud ID [ece-cloud-id] + +The Cloud ID reduces the number of steps required to start sending data from [Beats](https://www.elastic.co/guide/en/beats/libbeat/current/index.html) or [Logstash](https://www.elastic.co/guide/en/logstash/current/index.html) to your hosted {{es}} cluster on ECE, by assigning a unique ID to your cluster. + +::::{note} +Connections through Cloud IDs are only supported in Beats and Logstash. +:::: + + +Cloud IDs are available in every deployment page, as showed below: + +:::{image} ../../../images/cloud-enterprise-ec-ce-cloud-id.png +:alt: The Cloud ID and `elastic` user information shown when you create a deployment +::: + +Include this ID along with your user credentials (defined in `cloud.auth`) in your Beat or Logstash configuration. ECE will handle the remaining connection details, ensuring secure data transfer to your hosted cluster. + +### Before you begin [ece_before_you_begin_16] + +To use the Cloud ID, you need: + +* A deployment with an {{es}} cluster to send data to. +* Beats or Logstash, installed locally wherever you want to send data from. +* To configure Beats or Logstash, you need: + * The unique Cloud ID for your deployment, available from the deployment overview page. + * A user ID and password that has permission to send data to your {{es}} cluster. + +::::{important} + In our examples, we use the `elastic` superuser that every {{es}} cluster comes with. The password for the `elastic` user is provided when you create a deployment (and can also be [reset](../../users-roles/cluster-or-deployment-auth/built-in-users.md) if you forget it). On a production system, you should adapt these examples by creating a user that can write to and access only the minimally required indices. For each Beat, review the specific feature and role table, similar to the one in [Metricbeat](asciidocalypse://docs/beats/docs/reference/metricbeat/feature-roles.md) documentation. +:::: + +### Example: Configure Beats with your Cloud ID [ece-cloud-id-beats] + +The following example shows how you can send operational data from Metricbeat to a new ECE deployment by using the Cloud ID. While this example uses Metricbeat, the same approach applies to other Beats. + +::::{tip} +For others, you can learn more about [getting started](asciidocalypse://docs/beats/docs/reference/index.md) with each Beat. +:::: + +To get started with Metricbeat and {{ece}}: + +1. [Log into the Cloud UI](log-into-cloud-ui.md). +2. [Create a new deployment](create-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](asciidocalypse://docs/beats/docs/reference/metricbeat/metricbeat-installation-configuration.md). +5. [Configure the Beat output to send to Elastic Cloud](asciidocalypse://docs/beats/docs/reference/metricbeat/configure-cloud-id.md). + + ::::{note} + Make sure you replace the values for `cloud.id` and `cloud.auth` with your own information. + :::: + +6. Open Kibana and explore! + +Metricbeat creates a data view (formerly *index pattern*) with defined fields, searches, visualizations, and dashboards that you can start exploring in Kibana. Look for information related to system metrics, such as CPU usage, utilization rates for memory and disk, and details for processes. \ No newline at end of file diff --git a/deploy-manage/deploy/cloud-enterprise/create-deployment.md b/deploy-manage/deploy/cloud-enterprise/create-deployment.md index 5c2b4ee197..5f0c64e486 100644 --- a/deploy-manage/deploy/cloud-enterprise/create-deployment.md +++ b/deploy-manage/deploy/cloud-enterprise/create-deployment.md @@ -1,28 +1,56 @@ --- +applies_to: + deployment: + ece: all mapped_urls: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-create-deployment.html - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-access-kibana.html - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-manage-kibana.html --- # Create a deployment -% What needs to be done: Refine +An ECE deployment is a fully managed Elastic Stack environment running on {{ece}}. It includes {{es}}, {{kib}}, and optional features like Machine Learning or an Integrations (Fleet & APM) Server. -% GitHub issue: https://github.com/elastic/docs-projects/issues/339 +Each deployment is based on a [deployment template](./deployment-templates.md), which defines its resources, default topology, scaling policies, and available features. Deployments can be customized based on workload requirements, snapshot settings, and security configurations. -% Scope notes: create then access. and then link to add data +To create a deployment in ECE: -% Use migrated content from existing pages that map to this page: +1. From the Cloud UI **Deployments** view, select **Create deployment**. -% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-create-deployment.md -% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-access-kibana.md -% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-manage-kibana.md + You can quickly create a deployment by setting the basic parameters shown in the UI. If you need more control, select **Advanced settings** to configure additional options, as detailed below. -⚠️ **This page is a work in progress.** ⚠️ + :::{image} ../../../images/cloud-enterprise-ece-create-deployment.png + :alt: Create a deployment + ::: -The documentation team is working to combine content pulled from the following pages: +2. Set a name for your deployment. -* [/raw-migrated-files/cloud/cloud-enterprise/ece-create-deployment.md](/raw-migrated-files/cloud/cloud-enterprise/ece-create-deployment.md) -* [/raw-migrated-files/cloud/cloud-enterprise/ece-access-kibana.md](/raw-migrated-files/cloud/cloud-enterprise/ece-access-kibana.md) -* [/raw-migrated-files/cloud/cloud-enterprise/ece-manage-kibana.md](/raw-migrated-files/cloud/cloud-enterprise/ece-manage-kibana.md) \ No newline at end of file +3. Select a deployment template. + For a description of the available system templates, refer to [](./deployment-templates.md). + + If the system templates do not meet your requirements, you can [modify them](./ece-configuring-ece-configure-system-templates.md) or [create your own custom templates](../../../deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-create-templates.md). + +4. Choose your {{stack}} version. To manage available versions at platform level, refer to [](./manage-elastic-stack-versions.md). + +5. Optionally, [use snapshots](../../tools/snapshot-and-restore/cloud-enterprise.md) to back up your data, or [restore data from another deployment](../../tools/snapshot-and-restore/ece-restore-across-clusters.md). + + ::::{tip} + Restoring a snapshot can help with major version upgrades by creating a separate, non-production deployment where you can test, for example. Or, make life easier for your developers by providing them with a development environment that is populated with real data. + :::: + +6. Select **Advanced settings** if you want to configure [autoscaling](/deploy-manage/autoscaling/autoscaling-in-ece-and-ech.md), adjust resources, [select plugins](./add-plugins.md), or customize [data tiers](/manage-data/lifecycle/data-tiers.md). Refer to [Customize your deployment](../../../deploy-manage/deploy/cloud-enterprise/customize-deployment.md) for more details on the available options. + +7. Select **Create deployment**. It takes a few minutes before your deployment gets created. + + While you're waiting, you will be prompted to save the admin credentials for your deployment, which grant superuser access to Elasticsearch. Write down the password for the `elastic` user and keep it somewhere safe. These credentials also help you [add data using Kibana](../../../manage-data/ingest.md). If you need to refresh these credentials, you can [reset the password](../../../deploy-manage/users-roles/cluster-or-deployment-auth/manage-elastic-user-cloud.md) at any time. + +8. Once the deployment is ready, select **Continue** to open the deployment’s main page. + +After a deployment is spun up, you can scale the size and add other features; however, the instance configuration and computing ratios cannot be changed. If you need to change an existing deployment to another template, we recommend [migrating your data](../../../manage-data/migrate.md). + +## Next steps + +That’s it! Now that you are up and running, you may want to: + +* [Start exploring with {{kib}}](./access-kibana.md), our open-source visualization tool. If you’re not familiar with adding data, yet, {{kib}} can show you how to index your data into {{es}}. +* [Connect your applications to {{es}}](./connect-elasticsearch.md) to start [ingesting data](../../../manage-data/ingest.md) +* Learn how to configure and [manage your deployment](./working-with-deployments.md) diff --git a/deploy-manage/deploy/cloud-enterprise/customize-deployment.md b/deploy-manage/deploy/cloud-enterprise/customize-deployment.md index db8c411bdc..33afd1de6f 100644 --- a/deploy-manage/deploy/cloud-enterprise/customize-deployment.md +++ b/deploy-manage/deploy/cloud-enterprise/customize-deployment.md @@ -1,16 +1,48 @@ --- +navigation_title: Customize deployment components +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-customize-deployment.html --- -# Customize your deployment [ece-customize-deployment] +% document scope: this document focuses on the Deployment -> Edit page, how ECE applies changes, and links to other configurable features -You can either customize a new deployment, or customize an existing one. On the **Create a deployment** page, select **Edit settings** to change the cloud provider, region, hardware profile, and stack version; or select **Advanced settings** for more complex configuration settings. +# Customize your deployment components [ece-customize-deployment] -On the **Advanced settings** page, you can change the following settings: +In ECE, you can customize your deployment at any time by selecting **Edit** from the deployment page. This allows you to fine-tune its capacity and architecture, adjust configuration settings, availability zones, and enable or disable [data tiers](/manage-data/lifecycle/data-tiers.md). -* Enable [autoscaling](../../autoscaling.md) so that the available resources adjust automatically as demands on the deployment change. -* If you don’t want to autoscale your deployment, you can manually increase or decrease capacity by adjusting the size of hot, warm, cold, and frozen [data tiers](../../../manage-data/lifecycle/data-tiers.md) nodes. For example, you might want to add warm tier nodes if you have time series data that is accessed less-frequently and rarely needs to be updated. Alternatively, you might need cold tier nodes if you have time series data that is accessed occasionally and not normally updated. +::::{note} +The configurable components and allowed values available on the Edit page depend on the [deployment template](./deployment-templates.md) and [instance configurations](./ece-configuring-ece-instance-configurations-default.md) associated with the deployment. +:::: + +To customize your deployment: + +1. [Log into the Cloud UI](./log-into-cloud-ui.md). +2. On the **Deployments** page, select your deployment. + + Narrow the list by name, ID, or choose from several other [filters](./search-filter-deployments.md). To further define the list, use a combination of filters. + +3. From your deployment menu, go to the **Edit** page. + +4. Let the user interface guide you through the cluster configuration for your cluster. Refer to [](#ece-edit-deployment) for more details. + + ::::{tip} + When updating an existing deployment, you can make multiple changes to your {{es}} cluster with a single configuration update. + :::: + +5. Select a [configuration strategy](#configuration-strategies) and save your changes. The orchestrator will prepare and execute a plan to apply the requested changes. + +Review the changes to your configuration on the **Activity** page, with a tab for {{es}} and one for {{kib}}. + +## Editing deployment [ece-edit-deployment] + +In the deployment edit page, you can configure the following settings and features: + +* Enable [autoscaling](/deploy-manage/autoscaling/autoscaling-in-ece-and-ech.md) so that the available resources adjust automatically as demands on the deployment change. + +* If you don’t want to autoscale your deployment, you can manually increase or decrease capacity of each [data tier](../../../manage-data/lifecycle/data-tiers.md) and component. For example, you might add warm or cold tier nodes for time series data that is accessed infrequently, or expand {{kib}} capacity to handle higher workloads. * From the **Size per zone** drop-down menu, select what best fits your requirements. @@ -18,20 +50,41 @@ On the **Advanced settings** page, you can change the following settings: :alt: Customize hot data and content tier nodes ::: - Tiers increase in size before they increase the number of nodes. Based on the size that you select, the number of nodes is calculated for you automatically. Each node can be scaled up to 58GB RAM for Azure or 64GB RAM for GCP and AWS. The **Architecture** summary displays the total number of nodes per zone, where each circle color represents a different node type. + Based on the size you select for a tier, ECE automatically calculates the required number of nodes. Before adding additional nodes, the system scales up existing nodes to the maximum size allowed by their instance configuration, as defined in the deployment template. The maximum size for an {{es}} instance using the default templates typically ranges between 58GB and 64GB RAM. + + The **Architecture** summary displays the total number of nodes per zone, where each circle color represents a different node type: :::{image} ../../../images/cloud-enterprise-ec-number-of-nodes.png :alt: Number of nodes per deployment size ::: - * Adjust the number of **Availability zones** to increase fault tolerance for the deployment. +* Adjust the number of **Availability zones** for each component to enhance [fault tolerance](./ece-ha.md) in your deployment. + +* Enable additional components, such as [Machine Learning](../../../explore-analyze/machine-learning.md) nodes or an [Integrations server](./manage-integrations-server.md). + +* Select **Manage user settings and extensions** at {{es}} level, or **Edit user settings** for other components, to customize the YML configuration settings and plugin extensions. For more details, refer to [](edit-stack-settings.md) and [](./add-plugins.md). + +* Select the **Advanced edit** link at the bottom of the page to access the [](./advanced-cluster-configuration.md) view. + + ::::{warning} + You can break things when using the advanced cluster configuration editor. Use this functionality only if you know what you are doing or if you are being directed by someone from Elastic. + :::: + +## Configuration strategies [configuration-strategies] + +When you select **Save changes** on the **Edit deployment** page, the orchestrator initiates a plan to apply the new configuration to your deployment. You can control how these changes are applied to minimize disruption and ensure a smooth transition. + +* **Autodetect strategy** (recommended): Let ECE determine the strategy depending on the type changes to apply. +* **Rolling change per node**: One instance at a time. This strategy performs inline, rolling configuration changes that mutate existing containers. Recommended for most configuration changes. If the required resources are unavailable on the ECE nodes handling the existing instances, it falls back to grow and shrink. +* **Grow and shrink**: The orchestrator creates new instances with the new configuration, then migrates the data, and eventually deletes the original ones. This strategy is automatically selected when adding or removing master-eligible instances. +* **Rolling grow and shrink**: Similar to grow and shrink, but creating one instance at a time. This strategy can take a lot longer than grow and shrink. -* Open **Edit user settings** to change the YML configuration file to further customize how you run {{es}}. +The `Extended maintenance` optional flag will make ECE to [stop routing requests](../../maintenance/ece/start-stop-routing-requests.md) to all instances during the plan execution. The cluster will be unavailable for external connections while the configuration changes are in progress. -For more information, refer to [Editing your user settings](edit-stack-settings.md). +::::{note} +If you enable the **Extended maintenance** optional flag, ECE will [stop routing requests](../../maintenance/ece/start-stop-routing-requests.md) to all instances during the plan execution, making the cluster unavailable for external connections while configuration changes are in progress. -* Enable specific {{es}} plugins which are not enabled by default. -* Enable additional features, such as Machine Learning or coordinating nodes. -* Set specific configuration parameters for your {{es}} nodes or {{kib}} instances. +This option introduces downtime and is rarely needed. Use it only when you need to block all traffic to the cluster during the update. +:::: -That’s it! Now that you are up and running, [start exploring with {{kib}}](create-deployment.md), our open-source visualization tool. If you’re not familiar with adding data, yet, {{kib}} can show you how to index your data into {{es}}. +When executing plans, always review the reported configuration changes and track progress on the **Activity** page of the deployment, which includes separate tabs for {{es}}, {{kib}}, and other {{stack}} components. diff --git a/deploy-manage/deploy/cloud-enterprise/deployment-templates.md b/deploy-manage/deploy/cloud-enterprise/deployment-templates.md index 917f5309f1..54b6536f02 100644 --- a/deploy-manage/deploy/cloud-enterprise/deployment-templates.md +++ b/deploy-manage/deploy/cloud-enterprise/deployment-templates.md @@ -1,22 +1,25 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-deployment-templates.html --- # Deployment templates [ece-deployment-templates] -Deployment templates deploy the Elastic Stack on virtual hardware. Each template has a different blend of RAM, storage, and vCPU. This allows you to configure the Elastic Stack for different use cases, giving your deployments the resources they need. +Deployment templates deploy the {{stack}} on virtual hardware. Each template has a different blend of RAM, storage, and vCPU. This allows you to configure the {{stack}} for different use cases, giving your deployments the resources they need. -The components of the Elastic Stack that we support as part of a deployment are called *instances* and include: +The components of the {{stack}} that we support as part of a deployment are called *instances* and include: -* Elasticsearch data tiers and master nodes +* {{es}} data tiers and master nodes * Machine Learning (ML) nodes -* Kibana instances +* {{kib}} instances * APM and Fleet instances -Elastic Cloud Enterprise comes with some deployment templates already built in, but you can [create new deployment templates](ece-configuring-ece-create-templates.md) to address a particular use case you might have. To make the most out of your hardware, we also recommend that you [configure deployment templates](configure-deployment-templates.md), so that ECE knows where to deploy components of the Elastic Stack. +{{ece}} comes with some system deployment templates already built in, but you can [create new deployment templates](ece-configuring-ece-create-templates.md) to address a particular use case you might have. To make the most out of your hardware, we also recommend that you tag your allocators and follow the instructions from [](configure-deployment-templates.md), so that ECE knows where to deploy components of the {{stack}}. -The deployment templates available are: +The system deployment templates available by default are: * **Default template** @@ -24,15 +27,15 @@ The deployment templates available are: The default template is suitable for search and general all-purpose workloads that don’t require more specialized resources. - Existing deployments that were created in an ECE version before 2.0 are switched to this template automatically, if you edit their deployment configuration. The template is fully backwards compatible and enables you to add Elastic Stack features such as machine learning and dedicated master nodes to existing deployments. + Existing deployments that were created in an ECE version before 2.0 are switched to this template automatically, if you edit their deployment configuration. The template is fully backwards compatible and enables you to add {{stack}} features such as machine learning and dedicated master nodes to existing deployments. ::::{tip} - To use this template effectively, you must [tag your allocators](ece-configuring-ece-tag-allocators.md) and [edit the default instance configurations](ece-configuring-ece-instance-configurations-edit.md), so that ECE knows where to host the Elastic Stack products that are part of your deployment. + To use this template effectively, you must [tag your allocators](ece-configuring-ece-tag-allocators.md) and [edit the default instance configurations](ece-configuring-ece-instance-configurations-edit.md), so that ECE knows where to host the {{stack}} products that are part of your deployment. :::: * **Cross-cluster search template** - This template manages remote connections for running Elasticsearch queries across multiple deployments and indices. These federated searches make it possible to break up large deployments into smaller, more resilient Elasticsearch clusters. You can organize deployments by departments or projects for example, but still have the ability to aggregate query results and get visibility into your Elastic Cloud Enterprise infrastructure. You can add remote connections either when you create your deployment or when you customize it. To know more about cross-cluster search, check [Enable cross-cluster search](/deploy-manage/remote-clusters/ec-enable-ccs.md). + This template manages remote connections for running {{es}} queries across multiple deployments and indices. These federated searches make it possible to break up large deployments into smaller, more resilient {{es}} clusters. You can organize deployments by departments or projects for example, but still have the ability to aggregate query results and get visibility into your ECE infrastructure. You can add remote connections either when you create your deployment or when you customize it. To know more about cross-cluster search, check [Enable cross-cluster search](/deploy-manage/remote-clusters/ec-enable-ccs.md). * **Elastic Security template** @@ -42,13 +45,10 @@ The deployment templates available are: This template allows you to consolidate your logs, metrics, application traces, and system availability with purpose-built UIs. Check the [**Elastic Observability**](../../../solutions/observability/get-started/what-is-elastic-observability.md) documentation for more information. - - ## Instance configurations [ece-getting-started-instance-configurations] -For instances to run well when they are used in your Elastic Cloud Enterprise deployment, they need the right hardware that supports their intended purpose. For that, Elastic Cloud Enterprise uses *instance configurations*. Instance configurations match the Elastic Stack components to allocators for deployment, and indicate how memory and storage resources get sized relative to each other, and what sizes are available. For example: If you have a logging use case that needs lots of storage space, you probably want your instance configuration to use at least some storage with large spindle drives rather than fast but more expensive SSD storage. - -To determine where ECE should place specific components of the Elastic Stack for deployment, instance configurations match suitable allocators by filtering for tags with queries. You can edit instance configurations to change what allocators get matched by the queries, which in turn changes what components of the Elastic Stack get hosted on matching allocators when creating or changing a deployment. +For instances to run well when they are used in your ECE deployment, they need the right hardware that supports their intended purpose. For that, {{ece}} uses *instance configurations*. Instance configurations match the {{stack}} components to allocators for deployment, and indicate how memory and storage resources get sized relative to each other, and what sizes are available. For example: If you have a logging use case that needs lots of storage space, you probably want your instance configuration to use at least some storage with large spindle drives rather than fast but more expensive SSD storage. -Elastic Cloud Enterprise comes with a number of [default instance configurations](ece-configuring-ece-instance-configurations-default.md) built in, but just like new templates, you can [create instance configurations](ece-configuring-ece-instance-configurations-create.md) if you need additional ones. +To determine where ECE should place specific components of the {{stack}} for deployment, instance configurations match suitable allocators by filtering for tags with queries. You can edit instance configurations to change what allocators get matched by the queries, which in turn changes what components of the {{stack}} get hosted on matching allocators when creating or changing a deployment. +{{ece}} comes with a number of [default instance configurations](ece-configuring-ece-instance-configurations-default.md) built in, but just like new templates, you can [create instance configurations](ece-configuring-ece-instance-configurations-create.md) if you need additional ones. diff --git a/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-configure-system-templates.md b/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-configure-system-templates.md index 4d93ffff94..1c244f7a86 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-configure-system-templates.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-configure-system-templates.md @@ -11,7 +11,7 @@ mapped_pages: While you can create new deployment templates for some use cases, if the default system templates meet your needs but require minor adjustments, you may choose to configure or modify them. -For example, you want to use autoscaling with the system templates, but want to modify some of the default values for autoscaling in those templates. You might want to enable autoscaling by default for new deployments, or adjust the default value of the autoscaling maximum for the hot tier. +For example, you want to use [Autoscaling](/deploy-manage/autoscaling/autoscaling-in-ece-and-ech.md) with the system templates, but want to modify some of the default values for autoscaling in those templates. You might want to enable autoscaling by default for new deployments, or adjust the default value of the autoscaling maximum for the hot tier. ::::{note} You cannot edit system templates through the UI; they can only be configured through the API. diff --git a/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-create-templates.md b/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-create-templates.md index f1ff134bf5..c838a8d1e0 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-create-templates.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-create-templates.md @@ -26,7 +26,7 @@ Before you start creating your own deployment templates, you should have: [tagge 3. Select **Create template**. 4. Give your template a name and include a description that reflects its intended use. 5. Select **Create template**. The **Configure instances** page opens. -6. Choose whether or not [autoscaling](../../autoscaling.md) is enabled by default for deployments created using the template. Autoscaling adjusts resources available to the deployment automatically as loads change over time. +6. Choose whether or not [autoscaling](/deploy-manage/autoscaling/autoscaling-in-ece-and-ech.md) is enabled by default for deployments created using the template. Autoscaling adjusts resources available to the deployment automatically as loads change over time. :::{image} ../../../images/cloud-enterprise-ece-create-template-autoscaling.png :alt: screencapture of the "Enable autoscaling by default" switch diff --git a/raw-migrated-files/cloud/cloud-enterprise/ece-integrations-server-api-example.md b/deploy-manage/deploy/cloud-enterprise/ece-integrations-server-api-example.md similarity index 96% rename from raw-migrated-files/cloud/cloud-enterprise/ece-integrations-server-api-example.md rename to deploy-manage/deploy/cloud-enterprise/ece-integrations-server-api-example.md index 5a3fb63c47..03d57e0daf 100644 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-integrations-server-api-example.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-integrations-server-api-example.md @@ -1,8 +1,16 @@ +--- +applies_to: + deployment: + ece: all +mapped_urls: + - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-integrations-server-api-example.html +--- + # Enable Integrations Server through the API [ece-integrations-server-api-example] This example demonstrates how to use the Elastic Cloud Enterprise 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](../../../deploy-manage/deploy/cloud-enterprise/manage-integrations-server.md) +For more information on how to manage Integrations Server from the UI, check [Manage your Integrations Server](manage-integrations-server.md) ## Requirements [ece_requirements_4] diff --git a/deploy-manage/deploy/cloud-enterprise/ece-regional-deployment-aliases.md b/deploy-manage/deploy/cloud-enterprise/ece-regional-deployment-aliases.md index 77a19aea3f..9d0118dd31 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-regional-deployment-aliases.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-regional-deployment-aliases.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-regional-deployment-aliases.html --- @@ -7,8 +10,9 @@ mapped_pages: Custom aliases for your deployment endpoints on Elastic Cloud Enterprise allow you to have predictable, human-readable URLs that can be shared easily. +::::{important} Before setting up your custom alias, your platform administrator must enable the feature. Check [Enable custom endpoint aliases](enable-custom-endpoint-aliases.md) for more information. - +:::: ## Create a custom endpoint alias for a deployment [ece-create-regional-deployment-alias] @@ -25,7 +29,6 @@ To add an alias to an existing deployment: 5. Select **Update alias**. - ## Remove a custom endpoint alias [ece-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: @@ -36,7 +39,6 @@ To remove an alias from your deployment, or if you want to re-assign an alias to 4. Remove the text from the **Custom endpoint alias** text box. 5. Select **Update alias**. - ## Using the custom endpoint URL [ece-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`. @@ -45,8 +47,6 @@ To use your new custom endpoint URL to access your Elastic products, note that e 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 [ece-rest-regional-deployment-alias] * As part of the host name: @@ -81,7 +81,7 @@ While the `TransportClient` is deprecated, your custom endpoint aliases still wo Settings settings = Settings.settingsBuilder() .put("transport.ping_schedule", "5s") - //.put("transport.sniff", false) // Disabled by default and *must* be disabled. + //.put("transport.sniff", false) // Disabled by default and must be kept disabled. .put("action.bulk.compress", false) .put("shield.transport.ssl", enableSsl) .put("request.headers.X-Found-Cluster", alias) diff --git a/deploy-manage/deploy/cloud-enterprise/ece-wildcard-dns.md b/deploy-manage/deploy/cloud-enterprise/ece-wildcard-dns.md index 4755820873..16d9788ba2 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-wildcard-dns.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-wildcard-dns.md @@ -12,7 +12,6 @@ mapped_pages: We do not recommend using `ip.es.io` for production systems. Please set up your own domain name and DNS resolver for production. We do not guarantee uptime with `ip.es.io`. :::: - By default, Elastic Cloud Enterprise uses the external `ip.es.io` service provided by Elastic to resolve virtual Elasticsearch cluster host names in compliance with RFC1918. The service works by resolving host names of the form `.ip.es.io` to ``. In the case of Elastic Cloud Enterprise, each cluster is assigned a virtual host name of the form `..ip.es.io:`, such as `6dfc65aae62341e18a8b7692dcc97186.10.8.156.132.ip.es.io:9243`. The `ip.es.io` service simply resolves the virtual host name of the cluster to the proxy address which is specified during installation, `10.8.156.132` in our example, so that client requests are sent to the proxy. The proxy then extracts the cluster ID from the virtual host name of the cluster and uses its internal routing table to route the request to the right allocator. The `ip.es.io` service is provided to help you evaluate Elastic Cloud Enterprise without having to set up DNS records for your environment. You must set up a wildcard DNS record for your production system. You typically set up a wildcard DNS record that resolves to the proxy host or to a load balancer if you set up multiple proxies fronted by a load balancer. You can create both a wildcard DNS entry for your endpoints and a wildcard TLS/SSL certificate, so that you can create multiple clusters without the need for further DNS or TSL/SSL modifications. Simply configure your DNS to point to your load balancers and install your certificates on them, so that communication with the cluster is secure. diff --git a/raw-migrated-files/cloud/cloud-enterprise/ece-manage-apm-settings.md b/deploy-manage/deploy/cloud-enterprise/edit-stack-settings-apm.md similarity index 91% rename from raw-migrated-files/cloud/cloud-enterprise/ece-manage-apm-settings.md rename to deploy-manage/deploy/cloud-enterprise/edit-stack-settings-apm.md index 6cc885008f..020ad34113 100644 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-manage-apm-settings.md +++ b/deploy-manage/deploy/cloud-enterprise/edit-stack-settings-apm.md @@ -1,3 +1,12 @@ +--- +navigation_title: APM user settings +applies_to: + deployment: + ece: all +mapped_urls: + - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-manage-apm-settings.html +--- + # Add APM user settings [ece-manage-apm-settings] Starting in {{stack}} version 8.0, how you change APM settings and the settings that are available to you depend on how you spin up Elastic APM. There are two modes: @@ -5,14 +14,14 @@ Starting in {{stack}} version 8.0, how you change APM settings and the settings {{fleet}}-managed APM integration : New deployments created in {{stack}} version 8.0 and later will be managed by {{fleet}}. - * This mode requires SSL/TLS configuration. Check [TLS configuration for {{fleet}}-managed mode](../../../deploy-manage/deploy/cloud-enterprise/edit-stack-settings.md#ece-edit-apm-fleet-tls) for details. + * This mode requires SSL/TLS configuration. Check [TLS configuration for {{fleet}}-managed mode](#ece-edit-apm-fleet-tls) for details. * Check [APM integration input settings](/solutions/observability/apps/configure-apm-server.md) for all other Elastic APM configuration options in this mode. Standalone APM Server (legacy) : Deployments created prior to {{stack}} version 8.0 are in legacy mode. Upgrading to or past {{stack}} 8.0 does not remove you from legacy mode. - Check [Edit standalone APM settings (legacy)](../../../deploy-manage/deploy/cloud-enterprise/edit-stack-settings.md#ece-edit-apm-standalone-settings-ece)for information on how to configure Elastic APM in this mode. + Check [Edit standalone APM settings (legacy)](#ece-edit-apm-standalone-settings-ece)for information on how to configure Elastic APM in this mode. To learn more about the differences between these modes, or to switch from Standalone APM Server (legacy) mode to {{fleet}}-managed, check [Switch to the Elastic APM integration](/solutions/observability/apps/switch-to-elastic-apm-integration.md). @@ -90,3 +99,4 @@ If the size of the HTTP request frequently exceeds the maximum, you might need t apm-server: max_event_size: 407200 ``` + diff --git a/raw-migrated-files/cloud/cloud-enterprise/ece-add-user-settings.md b/deploy-manage/deploy/cloud-enterprise/edit-stack-settings-elasticsearch.md similarity index 56% rename from raw-migrated-files/cloud/cloud-enterprise/ece-add-user-settings.md rename to deploy-manage/deploy/cloud-enterprise/edit-stack-settings-elasticsearch.md index e73b0991b4..030e1a8cb4 100644 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-add-user-settings.md +++ b/deploy-manage/deploy/cloud-enterprise/edit-stack-settings-elasticsearch.md @@ -1,21 +1,29 @@ +--- +navigation_title: Elasticsearch user settings +applies_to: + deployment: + ece: all +mapped_urls: + - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-add-user-settings.html +--- + # Add Elasticsearch user settings [ece-add-user-settings] Change how Elasticsearch runs by providing your own user settings. User settings are appended to the `elasticsearch.yml` configuration file for your cluster and provide custom configuration options. Elastic Cloud Enterprise supports many of the user settings for the version of Elasticsearch that your cluster is running. -::::{tip} -Some settings that could break your cluster if set incorrectly are blocked, such as certain zen discovery and security settings. For examples of a few of the settings that are generally safe in cloud environments, check [Additional Examples of Supported User Settings](https://www.elastic.co/guide/en/cloud-enterprise/current/ece-change-user-settings-examples.html) and [Editing Your User Settings](/deploy-manage/deploy/elastic-cloud/edit-stack-settings.md) that can be enabled on our Elastic Cloud hosted offering. +::::{note} +ECE blocks the configuration of certain settings that could break your cluster if misconfigured, including some zen discovery and security settings. For a list of settings that are generally safe in cloud environments, refer to the [Elasticsearch configuration reference](elasticsearch://reference/elasticsearch/configuration-reference/index.md). :::: +To change {{es}} user settings: -To add user settings: - -1. [Log into the Cloud UI](../../../deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md). +1. [Log into the Cloud UI](./log-into-cloud-ui.md). 2. On the **Deployments** page, select your deployment. Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters. 3. From your deployment menu, go to the **Edit** page. -4. In the **Elasticsearch** section, select **Edit elasticsearch.yml**. For deployments with existing user settings, you may have to expand the **User setting overrides** caret for each node type instead. +4. In the **Elasticsearch** section, select **Manage user settings and extensions**. For deployments with existing user settings, you may have to expand the **User setting overrides** caret for each node type instead. 5. Update the user settings. 6. Select **Save changes**. @@ -23,12 +31,10 @@ To add user settings: If you encounter the **Edit elasticsearch.yml** carets, be sure to make your changes on all Elasticsearch node types. :::: - - -## Enable email notifications from Gmail [ece_enable_email_notifications_from_gmail] +## Example: enable email notifications from Gmail [ece_enable_email_notifications_from_gmail] You can configure email notifications to Gmail for a user that you specify. For details, refer to [Configuring email actions](../../../explore-analyze/alerts-cases/watcher/actions-email.md). -::::{warning} +::::{important} Before you add the `xpack.notification.email*` setting in Elasticsearch user settings, make sure you add the account SMTP password to the keystore as a [secret value](../../../deploy-manage/security/secure-settings.md). :::: diff --git a/raw-migrated-files/cloud/cloud-enterprise/ece-manage-enterprise-search-settings.md b/deploy-manage/deploy/cloud-enterprise/edit-stack-settings-enterprise.md similarity index 85% rename from raw-migrated-files/cloud/cloud-enterprise/ece-manage-enterprise-search-settings.md rename to deploy-manage/deploy/cloud-enterprise/edit-stack-settings-enterprise.md index 461f2a4a61..16ede35b35 100644 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-manage-enterprise-search-settings.md +++ b/deploy-manage/deploy/cloud-enterprise/edit-stack-settings-enterprise.md @@ -1,3 +1,12 @@ +--- +navigation_title: Enterprise search user settings +applies_to: + deployment: + ece: all +mapped_urls: + - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-manage-enterprise-search-settings.html +--- + # Add Enterprise Search user settings [ece-manage-enterprise-search-settings] :::{important} @@ -6,7 +15,7 @@ Enterprise Search is not available in {{stack}} 9.0+. Change how Enterprise Search runs by providing your own user settings. User settings are appended to the `ent-search.yml` configuration file for your instance and provide custom configuration options. -Refer to the [Configuration settings reference](https://www.elastic.co/guide/en/enterprise-search/current/configuration.html#configuration-file) in the Enterprise Search documentation for a full list of configuration settings. Settings supported on Elastic Cloud Enterprise are indicated by an {{ecloud}} icon (![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ecloud}}")). Be sure to refer to the documentation version that matches the Elastic Stack version used in your deployment. +Refer to the [Configuration settings reference](https://www.elastic.co/guide/en/enterprise-search/current/configuration.html#configuration-file) in the Enterprise Search documentation for a full list of configuration settings. Settings supported on Elastic Cloud Enterprise are indicated by an {{ecloud}} icon (![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ecloud}}")). To add user settings: @@ -25,3 +34,6 @@ If a setting is not supported by Elastic Cloud Enterprise, an error message disp :::: + + + diff --git a/raw-migrated-files/cloud/cloud-enterprise/ece-manage-kibana-settings.md b/deploy-manage/deploy/cloud-enterprise/edit-stack-settings-kibana.md similarity index 85% rename from raw-migrated-files/cloud/cloud-enterprise/ece-manage-kibana-settings.md rename to deploy-manage/deploy/cloud-enterprise/edit-stack-settings-kibana.md index 32ae76d993..b7fc953934 100644 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-manage-kibana-settings.md +++ b/deploy-manage/deploy/cloud-enterprise/edit-stack-settings-kibana.md @@ -1,12 +1,20 @@ +--- +navigation_title: Kibana user settings +applies_to: + deployment: + ece: all +mapped_urls: + - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-manage-kibana-settings.html +--- + # Add Kibana user settings [ece-manage-kibana-settings] -Elastic Cloud Enterprise 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. +Elastic Cloud Enterprise supports most of the standard Kibana 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. ::::{important} Be aware that some settings that could break your cluster if set incorrectly and that the syntax might change between major versions. Before upgrading, be sure to review the full list of the [latest Kibana settings and syntax](kibana://reference/configuration-reference/general-settings.md). :::: - To change Kibana settings: 1. [Log into the Cloud UI](../../../deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md). @@ -31,7 +39,6 @@ If you have a license from 2018 or earlier, you might receive a warning that you :::: - ## Example: Increase the timeout for creating reports [ece_example_increase_the_timeout_for_creating_reports] When creating reports, you can adjust the number of milliseconds before a worker times out. This is particularly helpful for instances with a slow or heavy load. @@ -49,4 +56,3 @@ If large exports are causing performance or storage issues, you can increase the xpack.reporting.csv.maxSizeBytes: "20971520" ``` - diff --git a/deploy-manage/deploy/cloud-enterprise/edit-stack-settings.md b/deploy-manage/deploy/cloud-enterprise/edit-stack-settings.md index e12f50cc92..fc845604a4 100644 --- a/deploy-manage/deploy/cloud-enterprise/edit-stack-settings.md +++ b/deploy-manage/deploy/cloud-enterprise/edit-stack-settings.md @@ -1,41 +1,27 @@ --- +navigation_title: Edit stack settings +applies_to: + deployment: + ece: all mapped_urls: - https://www.elastic.co/guide/en/cloud-enterprise/current/editing-user-settings.html - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-add-user-settings.html - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-manage-kibana-settings.html - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-manage-apm-settings.html - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-manage-enterprise-search-settings.html --- -# Edit stack settings +# Edit stack user settings [editing-user-settings] -% What needs to be done: Refine +From the {{ece}} console you can customize settings for {{es}}, {{kib}}, and other {{stack}} components by applying **user settings** to your deployments. These settings are internally mapped to the appropriate YAML configuration files, such as `elasticsearch.yml` and `kibana.yml`, and they affect all users of that cluster. -% GitHub issue: https://github.com/elastic/docs-projects/issues/339 +To customize the settings of a deployment's {{stack}} components: -% Use migrated content from existing pages that map to this page: +1. Open your deployment page in the ECE [Cloud UI](./log-into-cloud-ui.md). +2. In the left navigation menu, select **Edit**. +3. Look for the **Manage user settings and extensions** and **Edit user settings** links for each deployment, and select the one corresponding to the component you want to update, such as {{es}} or {{kib}}. +4. Apply the necessary settings in the **Users Settings** tab of the editor and select **Back** when finished. +5. Select **Save** to apply the changes to the deployment. Saving your changes initiates a configuration plan change that restarts the affected components for you. -% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/editing-user-settings.md -% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-add-user-settings.md -% Notes: instructions only, link to reference -% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-manage-kibana-settings.md -% Notes: instructions only, link to reference -% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-manage-apm-settings.md -% Notes: instructions only, link to reference -% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-manage-enterprise-search-settings.md +The following sections provide extra details and examples for different components: -% Internal links rely on the following IDs being on this page (e.g. as a heading ID, paragraph ID, etc): - -$$$ece-edit-apm-fleet-tls$$$ - -$$$ece-edit-apm-standalone-settings-ece$$$ - - - -**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-enterprise/editing-user-settings.md](/raw-migrated-files/cloud/cloud-enterprise/editing-user-settings.md) -* [/raw-migrated-files/cloud/cloud-enterprise/ece-add-user-settings.md](/raw-migrated-files/cloud/cloud-enterprise/ece-add-user-settings.md) -* [/raw-migrated-files/cloud/cloud-enterprise/ece-manage-kibana-settings.md](/raw-migrated-files/cloud/cloud-enterprise/ece-manage-kibana-settings.md) -* [/raw-migrated-files/cloud/cloud-enterprise/ece-manage-apm-settings.md](/raw-migrated-files/cloud/cloud-enterprise/ece-manage-apm-settings.md) -* [/raw-migrated-files/cloud/cloud-enterprise/ece-manage-enterprise-search-settings.md](/raw-migrated-files/cloud/cloud-enterprise/ece-manage-enterprise-search-settings.md) \ No newline at end of file +* [](./edit-stack-settings-elasticsearch.md) +* [](./edit-stack-settings-kibana.md) +* [](./edit-stack-settings-apm.md) +* [](./edit-stack-settings-enterprise.md) diff --git a/deploy-manage/deploy/cloud-enterprise/find-cloud-id.md b/deploy-manage/deploy/cloud-enterprise/find-cloud-id.md deleted file mode 100644 index 15cd0a4bc0..0000000000 --- a/deploy-manage/deploy/cloud-enterprise/find-cloud-id.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -navigation_title: Connect to your deployment using Cloud ID -applies_to: - deployment: - ece: all -mapped_pages: - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-cloud-id.html ---- - -# Find your Cloud ID [ece-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 {{ece}}. Because we made it easier to send data, you can start exploring visualizations in Kibana on {{ece}} that much more quickly. - -:::{image} ../../../images/cloud-enterprise-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 {{ece}}. All deployments automatically get a Cloud ID. - -You include your Cloud ID along with your {{ece}} user credentials (defined in `cloud.auth`) when you run Beats or Logstash locally, and then let {{ece}} handle all of the remaining connection details to send the data to your hosted cluster on {{ece}} safely and securely. - -:::{image} ../../../images/cloud-enterprise-ec-ce-cloud-id.png -:alt: The Cloud ID and `elastic` user information shown when you create a deployment -::: - -## What are Beats and Logstash? [ece_what_are_beats_and_logstash] - -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 {{ece}}. 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 {{ece}}. 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 [ece_before_you_begin_16] - -To use the Cloud ID, you need: - -* A deployment with an Elasticsearch cluster to send data to. -* Beats or Logstash, installed locally wherever you want to send data from. -* To configure Beats or Logstash, you need: - - * The unique Cloud ID for your deployment, available from the deployment overview page. - * A user ID and password that has permission to send data to your cluster. - - In our examples, we use the `elastic` superuser that every Elasticsearch cluster comes with. The password for the `elastic` user is provided when you create a deployment (and can also be [reset](../../users-roles/cluster-or-deployment-auth/built-in-users.md) if you forget it). On a production system, you should adapt these examples by creating a user that can write to and access only the minimally required indices. For each Beat, review the specific feature and role table, similar to the one in [Metricbeat](asciidocalypse://docs/beats/docs/reference/metricbeat/feature-roles.md) documentation. - -## Configure Beats with your Cloud ID [ece-cloud-id-beats] - -The following example shows how you can send operational data from Metricbeat to {{ece}} 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](asciidocalypse://docs/beats/docs/reference/index.md) with each Beat. -:::: - -To get started with Metricbeat and {{ece}}: - -1. [Log into the Cloud UI](log-into-cloud-ui.md). -2. [Create a new deployment](create-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](asciidocalypse://docs/beats/docs/reference/metricbeat/metricbeat-installation-configuration.md). -5. [Configure the Beat output to send to Elastic Cloud](asciidocalypse://docs/beats/docs/reference/metricbeat/configure-cloud-id.md). - - ::::{note} - Make sure you replace the values for `cloud.id` and `cloud.auth` with your own information. - :::: - -6. Open Kibana and explore! - -Metricbeat creates a data view (formerly *index pattern*) with defined fields, searches, visualizations, and dashboards that you can start exploring in Kibana. Look for information related to system metrics, such as CPU usage, utilization rates for memory and disk, and details for processes. diff --git a/deploy-manage/deploy/cloud-enterprise/find-endpoint-url.md b/deploy-manage/deploy/cloud-enterprise/find-endpoint-url.md deleted file mode 100644 index 69ad7a3459..0000000000 --- a/deploy-manage/deploy/cloud-enterprise/find-endpoint-url.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -navigation_title: Connect to your deployment using endpoint URLs -applies_to: - deployment: - ece: all -mapped_pages: - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-connect.html ---- - -% note: this document is super outdated, the curl example doesn't use authentication and we add a note about Elasticsearch 5.0 or later to add user & password - -# Find your endpoint URL [ece-connect] - -To connect to your Elasticsearch cluster, you need to look up the the Endpoint URLs: - -1. [Log into the Cloud UI](log-into-cloud-ui.md), if you aren’t logged in already. -2. On the **Deployments** page, select one of your deployments. -3. Under **Endpoints**, the endpoint link for Elasticsearch is listed. If you already enabled Kibana, the endpoint where you can access Kibana is listed as well. Select the Elasticsearch endpoint to connect to the cluster in your browser. You should get the following standard message: - - ```json - { - "name" : "instance-0000000000", - "cluster_name" : "85943ce00a934471cb971009e73d2d39", - "cluster_uuid" : "0z2PsOX1TCGSk7PKgB9ajg", - "version" : { - "number" : "2.4.1", - "build_hash" : "c67dc32e24162035d18d6fe1e952c4cbcbe79d16", - "build_timestamp" : "2016-09-27T18:57:55Z", - "build_snapshot" : false, - "lucene_version" : "5.5.2" - }, - "tagline" : "You Know, for Search" - } - ``` - - If you are prompted for authentication credentials, you are trying to connect to a cluster that already has Shield enabled or that uses the X-Pack security features. Specify the credentials of a user, such as the default `elastic` user, to connect. - - -Currently, we support the following ways of connecting to an Elasticsearch cluster: - -RESTful API with JSON over HTTP and HTTPS -: Used by the `curl` command and most programming languages that aren’t Java. To interact with your cluster, use your Elasticsearch cluster endpoint information from the deployment overview page in the Cloud UI. Port 9200 is used for plain text, insecure HTTP connections, while port 9243 is used for HTTPS. Using HTTPS is generally recommended, as it is more secure. - - If this is your first time using Elasticsearch, you can try out some `curl` commands to become familiar with the basics. If you’re on an operating system like macOS or Linux, you probably already have the `curl` command installed. For example, to connect to your cluster from the command line over HTTPS with the `curl` command: - - ```sh - curl --cacert /path/to/elastic-ece-ca-cert.pem https://45e366dc3a4142e9a4d6bbe3c7eedee7.192.168.43.10.ip.es.io:9243 - { - "name" : "instance-0000000000", - "cluster_name" : "45e366dc3a4142e9a4d6bbe3c7eedee7", - "version" : { - "number" : "2.3.5", - "build_hash" : "90f439ff60a3c0f497f91663701e64ccd01edbb4", - "build_timestamp" : "2016-07-27T10:36:52Z", - "build_snapshot" : false, - "lucene_version" : "5.5.0" - }, - "tagline" : "You Know, for Search" - } - ``` - - To make this `curl` command work with your cluster, you need to replace the endpoint URL with your own. - - -::::{tip} -If you created a cluster on Elasticsearch 5.0 or later or if you already enabled the security features, you must include authentication details with the -u parameter. For example: `curl -u elastic:W0UN0Rh9WX8eKeN69grVk3bX https://85943ce00a934471cb971009e73d2d39.us-east-1.aws.found.io:9243`. You can check [Get existing ECE security certificates](../../security/secure-your-elastic-cloud-enterprise-installation/manage-security-certificates.md) for how to get the CA certificate (`elastic-ece-ca-cert.pem` in this example) and use it to connect to the Elasticsearch cluster. -:::: - -## Ingest methods - -There are several ways to connect to Elasticsearch, perform searches, insert data, and more. See the [ingesting data](https://www.elastic.co/guide/en/cloud-enterprise/current/ece-cloud-ingest-data.html) documentation. - diff --git a/deploy-manage/deploy/cloud-enterprise/keep-track-of-deployment-activity.md b/deploy-manage/deploy/cloud-enterprise/keep-track-of-deployment-activity.md index 22bb62257b..2f498d69d7 100644 --- a/deploy-manage/deploy/cloud-enterprise/keep-track-of-deployment-activity.md +++ b/deploy-manage/deploy/cloud-enterprise/keep-track-of-deployment-activity.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-activity-page.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md b/deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md index 414f7d31aa..15cca25c89 100644 --- a/deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md +++ b/deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-login.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/manage-integrations-server.md b/deploy-manage/deploy/cloud-enterprise/manage-integrations-server.md index d6ba014c3a..c93f9f90a1 100644 --- a/deploy-manage/deploy/cloud-enterprise/manage-integrations-server.md +++ b/deploy-manage/deploy/cloud-enterprise/manage-integrations-server.md @@ -1,21 +1,48 @@ --- +applies_to: + deployment: + ece: all mapped_urls: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-manage-integrations-server.html - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-integrations-server-api-example.html --- -# Manage your integrations server +# Manage your Integrations Server [ece-manage-integrations-server] -% What needs to be done: Lift-and-shift +For deployments that are version 8.0 and later, you have the option to add a combined [Application Performance Monitoring (APM) Server](/solutions/observability/apps/application-performance-monitoring-apm.md) and [Fleet Server](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/index.md) to your deployment. APM allows you to monitor software services and applications in real time, turning that data into documents stored in the Elasticsearch cluster. Fleet allows you to centrally manage Elastic Agents on many hosts. -% Use migrated content from existing pages that map to this page: +As part of provisioning, the APM Server and Fleet Server are already configured to work with Elasticsearch and Kibana. At the end of provisioning, you are shown the secret token to configure communication between the APM Server and the backend [APM Agents](https://www.elastic.co/guide/en/apm/agent/index.html). The APM Agents get deployed within your services and applications. -% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-manage-integrations-server.md -% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-integrations-server-api-example.md +From the deployment **Integrations Server** page you can also: -⚠️ **This page is a work in progress.** ⚠️ +* Get the URL to complete the APM agent configuration. +* Use the `elastic` credentials to go to the APM area of Kibana. Step by step instructions to configure a variety of agents are available right in Kibana. After that, you can use the pre-built, dedicated dashboards and the APM tab to visualize the data that is sent back from the APM Agents. +* Use the `elastic` credentials to go to the Fleet area of Kibana. Step by step instructions to download and install Elastic Agent on your hosts are available right in Kibana. After that, you can manage enrolled Elastic Agents on the **Agents** tab, and the data shipped back from those Elastic Agents on the **Data streams** tab. +* Access the Integrations Server logs and metrics. +* Stop and restart your Integrations Server. +* Upgrade your Integrations Server version if it is out of sync with your Elasticsearch cluster. +* 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 Elastic Cloud Enterprise 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. +:::: + +## Routing to Fleet Server [ece-integrations-server-fleet-routing] + +Because Fleet Server and APM Server live on the same instance, an additional part is added to the Fleet Server hostname to help distinguish between the traffic to each. If you have not configured support for deployment aliases, your certificate may not be configured to expect this extra part. + +Data is routed to APM using the same hostname `<>.<>`, but two new endpoints are introduced: + +* `<>.apm.<>` as an alternate endpoint for APM +* `<>.fleet.<>` is the *only* way of routing data to Fleet Server + +::::{note} +New certificates must be generated for both these endpoints. Check [Enable custom endpoint aliases](../../../deploy-manage/deploy/cloud-enterprise/enable-custom-endpoint-aliases.md) for more details. +:::: + +## Using the API to manage Integrations Server [ece_using_the_api_to_manage_integrations_server] + +To manage Integrations Server through the API you need to include an Integrations Server payload when creating or updating a deployment. Check [Enable Integrations Server through the API](../../../deploy-manage/deploy/cloud-enterprise/manage-integrations-server.md) for an example. + +Check [Switch from APM to Integrations Server payload](../../../deploy-manage/deploy/cloud-enterprise/switch-from-apm-to-integrations-server-payload.md) for an example of how to switch from APM & Fleet Server to Integrations Server. -The documentation team is working to combine content pulled from the following pages: -* [/raw-migrated-files/cloud/cloud-enterprise/ece-manage-integrations-server.md](/raw-migrated-files/cloud/cloud-enterprise/ece-manage-integrations-server.md) -* [/raw-migrated-files/cloud/cloud-enterprise/ece-integrations-server-api-example.md](/raw-migrated-files/cloud/cloud-enterprise/ece-integrations-server-api-example.md) \ No newline at end of file diff --git a/deploy-manage/deploy/cloud-enterprise/resize-deployment.md b/deploy-manage/deploy/cloud-enterprise/resize-deployment.md index 86b15deb15..c7002ba696 100644 --- a/deploy-manage/deploy/cloud-enterprise/resize-deployment.md +++ b/deploy-manage/deploy/cloud-enterprise/resize-deployment.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-resize-deployment.html --- @@ -8,10 +11,9 @@ mapped_pages: Elasticsearch scales to whatever capacity you need and with as many nodes as the available resources can support. If you don’t have enough available resources, [add some capacity first](../../maintenance/ece/scale-out-installation.md). ::::{tip} -You can also enable autoscaling on a deployment to have the available resources for components, such as data tiers and machine learning nodes, adjust automatically as the demands on the deployment change over time. Check [Deployment autoscaling](../../autoscaling.md) to learn more. +You can also enable autoscaling on a deployment to have the available resources for components, such as [data tiers](/manage-data/lifecycle/data-tiers.md) and [machine learning](/explore-analyze/machine-learning.md) nodes, adjust automatically as the demands on the deployment change over time. Check [Deployment autoscaling](/deploy-manage/autoscaling/autoscaling-in-ece-and-ech.md) to learn more. :::: - To resize a deployment: 1. [Log into the Cloud UI](log-into-cloud-ui.md). @@ -20,20 +22,19 @@ To resize a deployment: Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters. 3. From your deployment menu, go to the **Edit** page. -4. Change the deployment configuration: +4. Change the deployment configuration, keeping the following considerations in mind: Fault tolerance - : If the initial deployment you created uses only one availability zone, it is not fault tolerant. On a production system, enable [high availability](ece-ha.md) by changing your deployment to use at least two availability zones, three for mission-critical deployments. The number of instances comes from the number of zones and the type of template. Having more nodes or instances lets you scale out horizontally by adding more processing capacity to your deployment. + : If the initial deployment you created uses only one availability zone, it is not fault tolerant. On a production system, enable [high availability](ece-ha.md) by changing your deployment to use at least two availability zones, three for mission-critical deployments. The number of instances comes from the number of zones and the type of [template](./deployment-templates.md). Having more nodes or instances lets you scale out horizontally by adding more processing capacity to your deployment. ::::{warning} Deployments that use only one availability zone are not highly available and are at risk of data loss, if you do not [configure an external snapshot repository](../../tools/snapshot-and-restore/cloud-enterprise.md) to enable regular backups. To safeguard against data loss, you must use at least two data centers and configure an external repository for backups. :::: - RAM per instance : Node and instance capacity should be sufficient to sustain your search workload, even if you lose an availability zone. Currently, half of the memory is assigned to the JVM heap. For example, on an Elasticsearch cluster node with 32 GB RAM, 16 GB would be allotted to heap. Up to 64 GB RAM and 1 TB storage per node are supported. - A summary of your sections for each instance and the entire deployment are available for you to review before finalizing your changes. + Before finalizing your changes, you can review the **Architecture** summary, which shows the total number of instances per zone, with each circle color representing a different type of instance. 5. Select **Save changes**. diff --git a/deploy-manage/deploy/cloud-enterprise/resource-overrides.md b/deploy-manage/deploy/cloud-enterprise/resource-overrides.md index 58f293ba42..e25d36fad2 100644 --- a/deploy-manage/deploy/cloud-enterprise/resource-overrides.md +++ b/deploy-manage/deploy/cloud-enterprise/resource-overrides.md @@ -1,16 +1,31 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-resource-overrides.html --- # Resource overrides [ece-resource-overrides] -{{ecloud}} allocators allot {{es}} instance sizes based on RAM, where RAM is proportional to CPU and disk resources. As needed, you can temporarily override the allocated resources to stabilize the deployment. You should reset overrides as soon as possible, or make your the override permanent by [changing your configuration](working-with-deployments.md). +{{ecloud}} allocators assign resources to {{es}} instances based on RAM, where RAM is proportional to CPU and disk resources. As needed, you can temporarily override the allocated resources to stabilize the deployment. You should reset overrides as soon as possible, or make the override permanent by [changing your configuration](working-with-deployments.md). The RAM to CPU proportions can’t be overridden per instance. -You can override the RAM to disk storage capacity for an instance under **Override disk quota** from the instance’s drop-down menu. This can be helpful when troubleshooting [watermark errors](../../../troubleshoot/elasticsearch/fix-watermark-errors.md) that result in a red [cluster health](https://www.elastic.co/guide/en/elasticsearch/reference/current/_cluster_health.html) status, which blocks configuration changes. A **Reset system default** message appears while disk quota overrides are set. Overriding the disk storage capacity does not restart the {{es}} node. +## Override disk quota -Alternatively, you can override all resource allocations by selecting **Override instance size** from the instance’s drop-down menu. This overrides the alloted RAM, maintaining a proportional CPU and disk size. This can be helpful if the {{es}} cluster is overwhelmed by requests. You should [resize the deployment](resize-deployment.md) when the volume of requests stabilizes. Overriding the instance size restarts the {{es}} node. +You can override the RAM to disk storage capacity for an instance under **Override disk quota** from the instance’s drop-down menu. This can be helpful when troubleshooting [watermark errors](../../../troubleshoot/elasticsearch/fix-watermark-errors.md) that result in a red [cluster health](https://www.elastic.co/guide/en/elasticsearch/reference/current/_cluster_health.html) status, which blocks configuration changes. A **Reset system default** message appears while disk quota overrides are set. + +::::{note} +Overriding the disk storage capacity does not restart the {{es}} node. +:::: + +## Override RAM, CPU and disk + +Alternatively, you can override all resource allocations by selecting **Override instance size** from the instance’s drop-down menu. This overrides the alloted RAM, maintaining a proportional CPU and disk size. This can be helpful if the {{es}} cluster is overwhelmed by requests. You should [resize the deployment](resize-deployment.md) when the volume of requests stabilizes. + +::::{note} +Overriding the instance size restarts the {{es}} node. +:::: When an instance within a deployment has resource overrides, it displays a warning banner reading **Elastic added temporary capacity to stabilize the deployment**. [Configuration changes](working-with-deployments.md) can still be safely submitted. diff --git a/deploy-manage/deploy/cloud-enterprise/search-filter-deployments.md b/deploy-manage/deploy/cloud-enterprise/search-filter-deployments.md index 65dec8edf3..f9b6d6e09a 100644 --- a/deploy-manage/deploy/cloud-enterprise/search-filter-deployments.md +++ b/deploy-manage/deploy/cloud-enterprise/search-filter-deployments.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-find.html --- @@ -17,8 +20,7 @@ The **Deployments** page in the Cloud UI provides several ways to find deploymen :alt: Add a filter ::: - Looking for all deployments of a specific version, because you want to upgrade them? Easy. Or what about that deployments you noticed before lunch that seemed to be spending an awfully long time changing its configuration—​is it done? Just add a filter to find any ongoing configuration changes. - + Need to find all deployments running a specific version for an upgrade? Simply apply a filter. Or perhaps you noticed a deployment that was taking an unusually long time to apply configuration changes? Check its status by filtering for ongoing configuration updates. diff --git a/deploy-manage/deploy/cloud-enterprise/switch-from-apm-to-integrations-server-payload.md b/deploy-manage/deploy/cloud-enterprise/switch-from-apm-to-integrations-server-payload.md index a05cc41044..06b361e5d5 100644 --- a/deploy-manage/deploy/cloud-enterprise/switch-from-apm-to-integrations-server-payload.md +++ b/deploy-manage/deploy/cloud-enterprise/switch-from-apm-to-integrations-server-payload.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-integrations-server-apm-switch.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/tools-apis.md b/deploy-manage/deploy/cloud-enterprise/tools-apis.md index e0a2be2ee0..aabe99a0d2 100644 --- a/deploy-manage/deploy/cloud-enterprise/tools-apis.md +++ b/deploy-manage/deploy/cloud-enterprise/tools-apis.md @@ -1,3 +1,10 @@ +--- +applies_to: + deployment: + ece: all +mapped_pages: + - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-api-console.html +--- # Tools and APIs % What needs to be done: Write from scratch @@ -11,6 +18,30 @@ You can use these tools and APIs to interact with the following {{ece}} features * [{{ecloud}} Control (ecctl)](ecctl://reference/index.md): Wraps typical operations commonly needed by operators within a single command line tool. * [ECE scripts](cloud://reference/cloud-enterprise/scripts.md): Use the `elastic-cloud-enterprise.sh` script to install {{ece}} or modify your installation. * [ECE diagnostics tool](/troubleshoot/deployments/cloud-enterprise/run-ece-diagnostics-tool.md): Collect logs and metrics that you can send to Elastic Support for troubleshooting and investigation purposes. +* [Elasticsearch API console](#ece-api-console) + +**API** + +% ECE API links and information are still pending +* [Elastic Cloud Enterprise RESTful API](asciidocalypse://docs/cloud/docs/reference/cloud-enterprise/restful-api.md) + +## {{es}} API Console [ece-api-console] + +With the API console you can interact with a specific {{es}} deployment directly from the Cloud UI without having to authenticate again. This RESTful API access is limited to the specific cluster and works only for Elasticsearch API calls. + +::::{important} +API console is intended for admin purposes. Avoid running normal workload like indexing or search requests. +:::: + +You can find this console in Cloud UI when selecting a specific deployment to manage. From the {{es}} menu, select **API Console**. + +:::{note} +This API Console is different from the [Dev Tools Console](/explore-analyze/query-filter/tools/console.md) available in {{kib}}, from which you can call {{es}} and {{kib}} APIs. On the ECE API Console, you cannot run Kibana APIs. +::: + +To learn more about what kinds of {{es}} API calls you can make from the Cloud UI, check the [Elasticsearch API Reference](elasticsearch://reference/elasticsearch/rest-apis/index.md) documentation. + + diff --git a/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md b/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md index 41af26fb38..5c40541300 100644 --- a/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md +++ b/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md @@ -1,36 +1,94 @@ --- +applies_to: + deployment: + ece: all mapped_urls: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-stack-getting-started.html - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-administering-deployments.html - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-change-deployment.html - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-monitoring-deployments.html --- -# Working with deployments +% document scope: This doc focuses on everything that can be achieved from the deployment UI +% TBD: include a link to a doc to manage deployments through ECE API. Same for Deploy an orchestrator section (ECE API links are still pending because we still haven't published the reference docs) -% What needs to be done: Refine +# Manage deployments [ece-stack-getting-started] -% GitHub issue: https://github.com/elastic/docs-projects/issues/339 +{{ece}} allows you to manage one or more instances of the {{stack}} through **deployments**. -% Use migrated content from existing pages that map to this page: -% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-stack-getting-started.md -% Notes: 9 child and sub-child docs (some of them are about "adding data to Elasticsearch" which might fit better somewhere else. we need to analyze that. We are missing https://www.elastic.co/guide/en/cloud-enterprise/current/ece-administering-deployments.html.... on purpose? -% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-administering-deployments.md -% Notes: probably just a redirect -% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-change-deployment.md -% Notes: another redirect -% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-monitoring-deployments.md -% Notes: mostly redirect +A *deployment* helps you manage an {{es}} cluster and instances of other Elastic products, like {{kib}} or APM, in one place. Spin up, scale, upgrade, and delete your {{stack}} products without having to manage each one separately. In a deployment, everything works together. -⚠️ **This page is a work in progress.** ⚠️ +ECE provides a preset of *hardware profiles* 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. -The documentation team is working to combine content pulled from the following pages: +All of these profiles are based on [deployment templates](./deployment-templates.md), which are a reusable configuration of Elastic products that you can deploy. You can modify existing deployment templates, or create custom deployment templates, to suit your needs. -* [/raw-migrated-files/cloud/cloud-enterprise/ece-stack-getting-started.md](/raw-migrated-files/cloud/cloud-enterprise/ece-stack-getting-started.md) -* [/raw-migrated-files/cloud/cloud-enterprise/ece-administering-deployments.md](/raw-migrated-files/cloud/cloud-enterprise/ece-administering-deployments.md) -* [/raw-migrated-files/cloud/cloud-enterprise/ece-change-deployment.md](/raw-migrated-files/cloud/cloud-enterprise/ece-change-deployment.md) -* [/raw-migrated-files/cloud/cloud-enterprise/ece-monitoring-deployments.md](/raw-migrated-files/cloud/cloud-enterprise/ece-monitoring-deployments.md) +## Creating deployments -% from the post-install instructions -% * [Set up traffic filters](../../security/traffic-filtering.md) to restrict traffic to your deployment to only trusted IP addresses or VPCs. +Refer to [Create a deployment](./create-deployment.md) to launch and configure an Elastic Stack environment. + +## Administering deployments [ece-administering-deployments] + +Maintaining your existing deployments is important. Take a look at the things you can do to keep your deployments and the {{stack}} running smoothly. + +Deployments in ECE are managed from the **Deployment** view of the [Cloud UI](./log-into-cloud-ui.md). This section focuses on the different actions you can take from this view. + +### Configuration and features + +From the deployment main page, you can quickly access the following configuration areas: + +* Select **Edit** to change the deployment configuration, its components and data tiers. Refer to [](./customize-deployment.md) for more details. + +* Set a [Custom endpoint alias](./ece-regional-deployment-aliases.md) to create human-readable URLs for your {{stack}} applications, making them easier to share and use. + +* [Upgrade your deployment](../../upgrade/deployment-or-cluster/upgrade-on-ece.md) if a newer {{stack}} version is available. + +* Select **{{es}} > snapshots** to associate a [snapshots repository](../../tools/snapshot-and-restore/cloud-enterprise.md#ece-manage-repositories-clusters) with the deployment. + +* Select **Monitoring > Logs and metrics** to set up [Stack monitoring](../../monitor/stack-monitoring/ece-stack-monitoring.md) for your deployment, forwarding its logs and metrics to a dedicated monitoring deployment. + + ::::{note} + In addition to the monitoring of clusters that is described here, don’t forget that {{ece}} also provides [monitoring information for your entire installation](../../../deploy-manage/monitor/orchestrators/ece-platform-monitoring.md). + :::: + +### Security and access control + +From the **Deployment > Security** view, you can manage security settings, authentication, and access controls. Refer to [Secure your clusters](../../../deploy-manage/users-roles/cluster-or-deployment-auth.md) for more details on security options for your deployments. + +* [Reset the `elastic` user password](../../users-roles/cluster-or-deployment-auth/manage-elastic-user-cloud.md) +* [Set up traffic filters](../../security/traffic-filtering.md) to restrict traffic to your deployment +* Configure {{es}} keystore settings, also known as [secure settings](../../security/secure-settings.md) +* Configure trust relationships for [remote clusters](../../remote-clusters/ece-enable-ccs.md) + +### Endpoints, monitoring, and troubleshooting + +From the deployment view, you can directly access endpoints, platform logs and metrics, and troubleshoot issues using various built-in tools. + +* Select **Copy endpoint** links to obtain the different URLs to [](./connect-elasticsearch.md) and [](./access-kibana.md). + +* If your deployment includes an integrations server, open the **Integrations server** page to get direct access to APM and Fleet. Refer to [](./manage-integrations-server.md) for more information. + +* For {{es}}, {{kib}}, and Integrations Server components, use the **External links** to access each service's logs and metrics, including the associated proxy logs. These logs are part of [](../../../deploy-manage/monitor/orchestrators/ece-platform-monitoring.md), and are separate from user-configured stack monitoring. + +* Use the [{{es}} API console](./tools-apis.md#ece-api-console) to send API calls directly to {{es}}. + +* [Keep track of your deployment activity](./keep-track-of-deployment-activity.md) and get information about configuration changes results and failures. + +* Open the **Operations** page to generate and download diagnostics bundles for {{es}} and {{kib}}, and to access other [tools](./tools-apis.md). + +### Operational actions + +Use the **Actions** button at deployment or instance level to: + +* [Restart a deployment](../../../deploy-manage/maintenance/start-stop-services/restart-an-ece-deployment.md) that has become unresponsive, for example. +* [Terminate a deployment](../../../deploy-manage/uninstall/delete-a-cloud-deployment.md) to stop all running instances and delete all data in the deployment. +* [Restore a deployment](../../../deploy-manage/uninstall/delete-a-cloud-deployment.md#restore-a-deployment) that had been terminated. +* [Delete a deployment](../../../deploy-manage/uninstall/delete-a-cloud-deployment.md) if you no longer need it. +* [Override instance resources](./resource-overrides.md) when needed to stabilize your deployment. +* [Stop routing requests or pause deployment instances](../../../deploy-manage/maintenance/ece/deployments-maintenance.md) to perform corrective actions that might otherwise be difficult to complete. + +## Keeping your clusters healthy [ece-monitoring-deployments] + +{{ece}} monitors many aspects of your installation, but some issues require a human to resolve them. Use this section to learn how you can: + +* [Find clusters](/troubleshoot/deployments/cloud-enterprise/cloud-enterprise.md) that have issues. +* [Move affected instances off an allocator](../../../deploy-manage/maintenance/ece/move-nodes-instances-from-allocators.md), if the allocator fails. diff --git a/deploy-manage/toc.yml b/deploy-manage/toc.yml index 65f0dc2b1f..fc9b6c2c7f 100644 --- a/deploy-manage/toc.yml +++ b/deploy-manage/toc.yml @@ -150,8 +150,6 @@ toc: - file: deploy/cloud-enterprise/change-ece-api-url.md - file: deploy/cloud-enterprise/change-endpoint-urls.md - file: deploy/cloud-enterprise/enable-custom-endpoint-aliases.md - children: - - file: deploy/cloud-enterprise/ece-regional-deployment-aliases.md - file: deploy/cloud-enterprise/configure-allocator-affinity.md - file: deploy/cloud-enterprise/change-allocator-disconnect-timeout.md - file: deploy/cloud-enterprise/manage-elastic-stack-versions.md @@ -160,21 +158,29 @@ toc: children: - file: deploy/cloud-enterprise/deployment-templates.md - file: deploy/cloud-enterprise/create-deployment.md - - file: deploy/cloud-enterprise/edit-stack-settings.md - - file: deploy/cloud-enterprise/customize-deployment.md - - file: deploy/cloud-enterprise/resize-deployment.md + - file: deploy/cloud-enterprise/access-kibana.md + - file: deploy/cloud-enterprise/connect-elasticsearch.md + - file: deploy/cloud-enterprise/configure-deployment.md children: + - file: deploy/cloud-enterprise/customize-deployment.md + - file: deploy/cloud-enterprise/edit-stack-settings.md + children: + - file: deploy/cloud-enterprise/edit-stack-settings-elasticsearch.md + - file: deploy/cloud-enterprise/edit-stack-settings-kibana.md + - file: deploy/cloud-enterprise/edit-stack-settings-apm.md + - file: deploy/cloud-enterprise/edit-stack-settings-enterprise.md + - file: deploy/cloud-enterprise/resize-deployment.md + - file: deploy/cloud-enterprise/add-plugins.md + - file: deploy/cloud-enterprise/add-custom-bundles-plugins.md + - file: deploy/cloud-enterprise/ece-regional-deployment-aliases.md - file: deploy/cloud-enterprise/resource-overrides.md - - file: deploy/cloud-enterprise/add-plugins.md - - file: deploy/cloud-enterprise/add-custom-bundles-plugins.md + - file: deploy/cloud-enterprise/advanced-cluster-configuration.md + - file: deploy/cloud-enterprise/search-filter-deployments.md + - file: deploy/cloud-enterprise/keep-track-of-deployment-activity.md - file: deploy/cloud-enterprise/manage-integrations-server.md children: + - file: deploy/cloud-enterprise/ece-integrations-server-api-example.md - file: deploy/cloud-enterprise/switch-from-apm-to-integrations-server-payload.md - - file: deploy/cloud-enterprise/find-cloud-id.md - - file: deploy/cloud-enterprise/find-endpoint-url.md - - file: deploy/cloud-enterprise/advanced-cluster-configuration.md - - file: deploy/cloud-enterprise/search-filter-deployments.md - - file: deploy/cloud-enterprise/keep-track-of-deployment-activity.md - file: deploy/cloud-enterprise/tools-apis.md - file: deploy/cloud-on-k8s.md children: diff --git a/raw-migrated-files/cloud/cloud-enterprise/ece-access-kibana.md b/raw-migrated-files/cloud/cloud-enterprise/ece-access-kibana.md deleted file mode 100644 index 2197ef6a49..0000000000 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-access-kibana.md +++ /dev/null @@ -1,33 +0,0 @@ -# Access Kibana [ece-access-kibana] - -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 into the Cloud UI](../../../deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md). -2. On the **Deployments** page, select your deployment. - - Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters. - -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. - -::::{tip} -If your cluster didn’t include a Kibana instance initially, there might not be a Kibana endpoint URL shown, yet. To gain access, all you need to do is [enable Kibana first](../../../deploy-manage/maintenance.md). -:::: - - diff --git a/raw-migrated-files/cloud/cloud-enterprise/ece-add-custom-bundle-plugin.md b/raw-migrated-files/cloud/cloud-enterprise/ece-add-custom-bundle-plugin.md deleted file mode 100644 index 4d26f8dc8a..0000000000 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-add-custom-bundle-plugin.md +++ /dev/null @@ -1,408 +0,0 @@ -# Add custom bundles and plugins to your deployment [ece-add-custom-bundle-plugin] - -Follow these steps to upload custom bundles and plugins to your Elasticsearch clusters, so that it uses your custom bundles or plugins. - -* Update your Elasticsearch cluster in the [advanced configuration editor](../../../deploy-manage/deploy/cloud-enterprise/advanced-cluster-configuration.md): -* For bundles, modify the `resources.elasticsearch.plan.elasticsearch.user_bundles` JSON attribute. -* For plugins, modify the `resources.elasticsearch.plan.elasticsearch.user_plugins` JSON attribute. - -We’ve provided some examples, including [LDAP bundles](../../../solutions/search/full-text/search-with-synonyms.md#ece-add-custom-bundle-example-LDAP), [SAML bundles](../../../solutions/search/full-text/search-with-synonyms.md#ece-add-custom-bundle-example-SAML), [synonym bundles](../../../solutions/search/full-text/search-with-synonyms.md#ece-add-custom-bundle-example-synonyms), and adding a [JVM trustore](../../../solutions/search/full-text/search-with-synonyms.md#ece-add-custom-bundle-example-cacerts). - -::::{tip} -As part of the ECE [high availability](../../../deploy-manage/deploy/cloud-enterprise/ece-ha.md) strategy, it’s a good idea to make sure that any web servers hosting custom bundles or plugins required by ECE are available to all allocators, so that they can continue to be accessed in the event of a network partition or zone outage. An instance that requires custom bundles or plugins will be unable to start in the event that it can’t access the plugin web server. -:::: - - - -## Add custom plugins to your deployment [ece-add-custom-plugin] - -Custom plugins can include the official Elasticsearch plugins not provided with Elastic Cloud Enterprise, any of the community-sourced plugins, or plugins that you write yourself. - -1. [Log into the Cloud UI](../../../deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md). -2. From the **Deployments** page, select your deployment. - - Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters. - -3. In the left side navigation select **Edit** from your deployment menu, then go to the bottom of the page and select [**Advanced Edit**](../../../deploy-manage/deploy/cloud-enterprise/advanced-cluster-configuration.md). -4. Within the **Deployment configuration** JSON find the section: - - `resources` > `elasticsearch` > `plan` > `elasticsearch` - - If there is an existing `user_plugins` section, then add the new plugin there, otherwise add a `user_plugins` section. - - ```sh - { - ... - "resources": { - "elasticsearch": [ - ... - "plan": { - ... - "elasticsearch": { - ... - "user_bundles": [ - { - .... - } ] , - "user_plugins": [ - { - "url" : "", <1> - "name" : "plugin_name", - "elasticsearch_version" : "" <2> - }, - { - "url": "http://www.MYURL.com/my-custom-plugin.zip", - "name": "my-custom-plugin", - "elasticsearch_version": "7.17.1" - } - ] - } - ``` - - 1. The URL for the plugin must be always available. Make sure you host the plugin artifacts internally in a highly available environment. The URL must use the scheme `http` or `https` - 2. The version must match exactly your Elasticsearch version, such as `7.17.1`. Wildcards (*) are not allowed. - - - ::::{important} - If the plugin URL becomes unreachable (if the URL changes at remote end, or connectivity to the remote web server has issues) you might encounter boot loops. - :::: - - - ::::{important} - Don’t use the same URL to serve newer versions of the plugin. This may result in different nodes of the same cluster running different plugin versions. - :::: - - - ::::{important} - A plugin URL that uses an `https` endpoint with a certificate signed by an internal Certificate Authority (CA) is not supported. Either use a publicly trusted certificate, or fall back to the `http` scheme. - :::: - -5. Save your changes. -6. To verify that all nodes have the plugins installed, use one of these commands: `GET /_nodes/plugins?filter_path=nodes.*.plugins` or `GET _cat/plugins?v` - - -## Example: Custom LDAP bundle [ece-add-custom-bundle-example-LDAP] - -This example adds a custom LDAP bundle for deployment level role-based access control (RBAC). To set platform level RBAC, check [Configure RBAC](../../../deploy-manage/users-roles/cloud-enterprise-orchestrator/manage-users-roles.md). - -1. Prepare a custom bundle as a ZIP file that contains your keystore file with the private key and certificate inside of a `truststore` folder [in the same way that you would on Elastic Cloud](/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md). This bundle allows all Elasticsearch containers to access the same keystore file through your `ssl.truststore` settings. -2. In the [advanced configuration editor](../../../deploy-manage/deploy/cloud-enterprise/advanced-cluster-configuration.md), update your new Elasticsearch cluster with the custom bundle you have just created. Modify the `user_bundles` JSON attribute of **each** Elasticsearch instance type as shown in the following example: - - ```sh - { - ... - "resources": { - "elasticsearch": [ - ... - "plan": { - ... - "elasticsearch": { - ... - "user_bundles": [ - { - "name": "ldap-cert", - "url": "http://www.MYURL.com/ldapcert.zip", <1> - "elasticsearch_version": "*" - } - ] - } - ... - ``` - - 1. The URLs for the bundle ZIP files (`ldapcert.zip`) must be always available. Make sure you host the plugin artifacts internally in a highly available environment. - - - ::::{important} - If the bundle URL becomes unreachable (if the URL changes at remote end, or connectivity to the remote web server has issues) you might encounter boot loops. - :::: - - - ::::{important} - Don’t use the same URL to serve newer versions of the bundle. This may result in different nodes of the same cluster running different bundle versions. - :::: - -3. Custom bundles are unzipped in `/app/config/BUNDLE_DIRECTORY_STRUCTURE`, where `BUNDLE_DIRECTORY_STRUCTURE` is the directory structure within the bundle ZIP file itself. These file locations are needed in the next step. - - ```sh - $ tree . - . - └── truststore - └── keystore.ks - ``` - - In this example, the unzipped keystore file gets placed under `/app/config/truststore/keystore.ks`. - - - -## Example: Custom SAML bundle [ece-add-custom-bundle-example-SAML] - -This example adds a custom SAML bundle for deployment level role-based access control (RBAC). To set platform level RBAC, check [Configure RBAC](../../../deploy-manage/users-roles/cloud-enterprise-orchestrator/manage-users-roles.md). - -1. If your Identity Provider doesn’t publish its SAML metadata at an HTTP URL, or if your Elasticsearch cluster cannot reach that URL, you can upload the SAML metadata as a file. - - 1. Prepare a ZIP file with a [custom bundle](../../../solutions/search/full-text/search-with-synonyms.md) that contains your Identity Provider’s metadata (`metadata.xml`) and store it in the `saml` folder. - - This bundle allows all Elasticsearch containers to access the metadata file. - - 2. In the [advanced configuration editor](../../../deploy-manage/deploy/cloud-enterprise/advanced-cluster-configuration.md), update your Elasticsearch cluster configuration with the bundle you prepared in the previous step. Modify the `user_bundles` JSON attribute of **each** Elasticsearch instance type as shown in the following example: - - ```text - { - ... - "resources": { - "elasticsearch": [ - ... - "plan": { - ... - "elasticsearch": { - ... - "user_bundles": [ - { - "name": "saml-metadata", - "url": "http://www.MYURL.com/saml-metadata.zip", <1> - "elasticsearch_version": "*" - } - ] - } - ... - ``` - - 1. The URL for the bundle ZIP file must be always available. Make sure you host the plugin artifacts internally in a highly available environment.::::{important} - If the bundle URL becomes unreachable (if the URL changes at remote end, or connectivity to the remote web server has issues) you might encounter boot loops. - :::: - - - - - ::::{important} - Don’t use the same URL to serve newer versions of the bundle. This may result in different nodes of the same cluster running different bundle versions. - :::: - - - Custom bundles are unzipped in `/app/config/BUNDLE_DIRECTORY_STRUCTURE`, where `BUNDLE_DIRECTORY_STRUCTURE` is the directory structure within the ZIP file itself. These file locations are needed in the next step. - - In this example, the SAML metadata file is located in the path `/app/config/saml/metadata.xml`: - - ```sh - $ tree . - . - └── saml - └── metadata.xml - ``` - - 3. Adjust your `saml` realm configuration accordingly: - - ```sh - idp.metadata.path: /app/config/saml/metadata.xml <1> - ``` - - 1. The path to the SAML metadata file that was uploaded - - - -## Example: Custom JVM trust store bundle [ece-add-custom-bundle-example-cacerts] - -If you are using SSL certificates signed by non-public certificate authorities, Elasticsearch is not able to communicate with the services using those certificates unless you import a custom JVM trust store containing the certificates of your signing authority into your Elastic Cloud Enterprise installation. You’ll need the trust store to access snapshot repositories like Minio, for your Elastic Cloud Enterprise proxy, or to reindex from remote. - -To import a JVM trust store: - -1. Prepare the custom JVM trust store: - - 1. Pull the certificate from the service you want to make accessible: - - ```sh - openssl s_client -connect -showcerts <1> - ``` - - 1. The server address (name and port number) of the service that you want Elasticsearch to be able to access. This command prints the entire certificate chain to `stdout`. You can choose a certificate at any level to be added to the trust store. - - 2. Save it to a file with as a PEM extension. - 3. Locate your JRE’s default trust store, and copy it to the current directory: - - ```sh - cp cacerts <1> - ``` - - 1. Default JVM trust store is typically located in `$JAVA_HOME/jre/libs/security/cacerts` - - - ::::{tip} - Default trust store contains certificates of many well known root authorities that are trusted by default. If you only want to include a limited list of CAs to trust, skip this step, and simply import specific certificates you want to trust into an empty store as shown next - :::: - - 4. Use keytool command from your JRE to import certificate(s) into the keystore: - - ```sh - $JAVA_HOME/bin/keytool -keystore cacerts -storepass changeit -noprompt -importcert -file .pem -alias <1> - ``` - - 1. The file where you saved the certificate to import, and an alias you assign to it, that is descriptive of the origin of the certificate - - - ::::{important} - We recommend that you keep file name and password for the trust store as JVM defaults (`cacerts` and `changeit` respectively). If you need to use different values, you need to add extra configuration, as detailed later in this document, in addition to adding the bundle. - :::: - - - You can have multiple certificates to the trust store, repeating the same command. There is only one trust store per cluster currently supported. You cannot, for example, add multiple bundles with different trust stores to the same cluster, they will not get merged. Add all certificates to be trusted to the same trust store - -2. Create the bundle: - - ```sh - zip cacerts.zip cacerts <1> - ``` - - 1. The name of the zip archive is not significant - - - ::::{tip} - A bundle may contain other contents beyond the trust store if you prefer, but we recommend creating separate bundles for different purposes. - :::: - -3. In the [advanced configuration editor](../../../deploy-manage/deploy/cloud-enterprise/advanced-cluster-configuration.md), update your Elasticsearch cluster configuration with the bundle you prepared in the previous step. Modify the `user_bundles` JSON attribute of **each** Elasticsearch instance type as shown in the following example: - - ```sh - { - ... - "resources": { - "elasticsearch": [ - ... - "plan": { - ... - "elasticsearch": { - ... - "user_bundles": [ - { - "name": "custom-ca-certs", - "url": "http://www.MYURL.com/cacerts.zip", <1> - "elasticsearch_version": "*" <2> - } - ] - } - ... - ``` - - 1. The URL for the bundle ZIP file must be always available. Make sure you host the plugin artefacts internally in a highly available environment. - 2. Wildcards are allowed here, since the certificates are independent from the Elasticsearch version. - - - ::::{important} - If the bundle URL becomes unreachable (if the URL changes at remote end, or connectivity to the remote web server has issues) you might encounter boot loops. - :::: - - -::::{important} -Don’t use the same URL to serve newer versions of the bundle, i.e. when updating certificates. This may result in different nodes of the same cluster running different bundle versions. -:::: - - -1. If you prefer to use a different file name and/or password for the trust store, you also need to add an additional configuration section to the cluster metadata before adding the bundle. This configuration should be added to the `Elasticsearch cluster data` section of the page: - - ```sh - "jvm_trust_store": { - "name": "", - "password": "" - } - ``` - - -1. The name of the trust store must match the filename included into the archive -2. Password used to create the trust store::::{important} -Use only alphanumeric characters, dashes, and underscores in both file name and password. -:::: - - -You do not need to do this step if you are using default filename and password (`cacerts` and `changeit` respectively) in your bundle. - - - - -## Example: Custom GeoIP database bundle [ece-add-custom-bundle-example-geoip] - -1. Prepare a ZIP file with a [custom bundle](../../../solutions/search/full-text/search-with-synonyms.md) that contains a: [GeoLite2 database](https://dev.maxmind.com/geoip/geoip2/geolite2). The folder has to be named `ingest-geoip`, and the file name can be anything that is appended `-(City|Country|ASN)` with the `mmdb` file extension, and it must have a different name than the original name `GeoLite2-City.mmdb`. - - The file `my-geoip-file.zip` should look like this: - - ```sh - $ tree . - . - └── ingest-geoip - └── MyGeoLite2-City.mmdb - ``` - -2. Copy the ZIP file to a webserver that is reachable from any allocator in your environment. -3. In the [advanced configuration editor](../../../deploy-manage/deploy/cloud-enterprise/advanced-cluster-configuration.md), update your Elasticsearch cluster configuration with the bundle you prepared in the previous step. Modify the `user_bundles` JSON attribute of **each** Elasticsearch instance type as shown in the following example. - - ```sh - { - ... - "resources": { - "elasticsearch": [ - ... - "plan": { - ... - "elasticsearch": { - ... - "user_bundles": [ - { - "name": "custom-geoip-db", - "url": "http://www.MYURL.com/my-geoip-file.zip", - "elasticsearch_version": "*" - } - ] - } - ``` - -4. To use this bundle, you can refer it in the [GeoIP processor](elasticsearch://reference/ingestion-tools/enrich-processor/geoip-processor.md) of an ingest pipeline as `MyGeoLite2-City.mmdb` under `database_file` such as: - - ```sh - ... - { - "geoip": { - "field": ... - "database_file": "MyGeoLite2-City.mmdb", - ... - } - } - ... - ``` - - - -## Example: Custom synonyms bundle [ece-add-custom-bundle-example-synonyms] - -1. Prepare a ZIP file with a [custom bundle](../../../solutions/search/full-text/search-with-synonyms.md) that contains a dictionary of synonyms in a text file. - - The file `synonyms.zip` should look like this: - - ```sh - $ tree . - . - └── dictionaries - └── synonyms.txt - ``` - -2. Copy the ZIP file to a webserver that is reachable from any allocator in your environment. -3. In the [advanced configuration editor](../../../deploy-manage/deploy/cloud-enterprise/advanced-cluster-configuration.md), update your Elasticsearch cluster configuration with the bundle you prepared in the previous step. Modify the `user_bundles` JSON attribute of **each** Elasticsearch instance type as shown in the following example. - - ```sh - { - ... - "resources": { - "elasticsearch": [ - ... - "plan": { - ... - "elasticsearch": { - ... - "user_bundles": [ - { - "name": "custom-synonyms", - "url": "http://www.MYURL.com/synonyms.zip", - "elasticsearch_version": "*" - } - ] - } - ``` - - diff --git a/raw-migrated-files/cloud/cloud-enterprise/ece-administering-deployments.md b/raw-migrated-files/cloud/cloud-enterprise/ece-administering-deployments.md deleted file mode 100644 index a3a7d7f7a2..0000000000 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-administering-deployments.md +++ /dev/null @@ -1,16 +0,0 @@ -# Administering deployments [ece-administering-deployments] - -Care and feeding of your deployments is important. Take a look at the things you can do to keep your deployments and the Elastic Stack running smoothly: - -* [Change your deployment configuration](../../../deploy-manage/deploy/cloud-enterprise/working-with-deployments.md) to provide additional resources, for example. For many changes, your deployment can continue to handle search and indexing workloads without interruption. -* [Stop routing requests or pause nodes](../../../deploy-manage/maintenance/ece/deployments-maintenance.md) to perform corrective actions that might otherwise be difficult to complete. -* [Terminate a deployment](../../../deploy-manage/uninstall/delete-a-cloud-deployment.md) to stop all running instances and delete all data in the deployment. -* [Restart a deployment](../../../deploy-manage/maintenance/start-stop-services/restart-an-ece-deployment.md) that has become unresponsive, for example. -* [Restore a deployment](../../../deploy-manage/uninstall/delete-a-cloud-deployment.md) a deployment that had been terminated. -* [Delete a deployment](../../../deploy-manage/uninstall/delete-a-cloud-deployment.md) if you no longer need it. -* [Perform maintenance on the Kibana instance](../../../deploy-manage/maintenance.md) associated with the deployment. -* [Work with snapshots](../../../deploy-manage/tools/snapshot-and-restore.md) to recover from a failure or to recover from accidental deletion. -* [Keep your deployments healthy](../../../deploy-manage/deploy/cloud-enterprise/working-with-deployments.md) by monitoring key performance metrics. -* [Secure your clusters](../../../deploy-manage/users-roles/cluster-or-deployment-auth.md) to prevent unauthorized access from unwanted traffic or users and to preserve the integrity of your data with message authentication and SSL/TLS encryption. -* [Access the Elasticsearch API console](../../../explore-analyze/query-filter/tools/console.md) - Work with the Elasticsearch RESTful API directly from the Cloud UI. - diff --git a/raw-migrated-files/cloud/cloud-enterprise/ece-change-deployment.md b/raw-migrated-files/cloud/cloud-enterprise/ece-change-deployment.md deleted file mode 100644 index 4527b74e8a..0000000000 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-change-deployment.md +++ /dev/null @@ -1,26 +0,0 @@ -# Change your deployment configuration [ece-change-deployment] - -There are several reasons why you might want to change the configuration of a deployment: - -* To increase or decrease deployment capacity by changing the amount of reserved memory and storage. -* To enable [autoscaling](../../../deploy-manage/autoscaling.md) so that available resources for certain deployment components adjust automatically as the demands on them change. -* To enable high availability by adjusting the number of availability zones that your deployment runs in. -* To upgrade to new versions of Elasticsearch. You can upgrade from one major version to another, such as from 7.17 to 8.0, or from one minor version to another, such as 8.9.0 to 8.9.2. You can’t downgrade versions. -* To update Elasticsearch clusters and Kibana after an updated Elastic Stack pack for a particular version has been added to your Elastic Cloud Enterprise installation. -* To change what plugins are available on your deployment. - -For single availability zone deployments, there is downtime to portions of your cluster when changes are applied. For HA deployments and with the exception of major version upgrades, we can perform all these changes without interrupting your deployment. During the application of these changes, you can continue to search and index. - -Many changes can also be done in bulk: in one action, you can add more memory and storage, upgrade minor versions, adjust the number of plugins and adjust fault tolerance by changing the number of availability zones. Elastic Cloud Enterprise performs all of these changes with a grow-and-shrink operation, making an Elasticsearch cluster and other instances with the new configuration join the existing deployment. After re-joining, updated nodes recover their indexes and start handling requests. When all updated new nodes are ready, the old nodes that were replaced are removed. If you do a major version upgrade, you cannot change the cluster configuration at the same time. Perform these configuration changes separately. - -::::{tip} -When you scale up a deployment, existing data may be migrated to new nodes. For clusters containing large amounts of data, this migration can take some time, especially if your deployment is under a heavy workload. (Is your deployment under a heavy load? You might need to [stop routing requests](../../../deploy-manage/maintenance/ece/deployments-maintenance.md) first.) -:::: - - - - - - - - diff --git a/raw-migrated-files/cloud/cloud-enterprise/ece-create-deployment.md b/raw-migrated-files/cloud/cloud-enterprise/ece-create-deployment.md deleted file mode 100644 index 6c527bd549..0000000000 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-create-deployment.md +++ /dev/null @@ -1,51 +0,0 @@ -# Create a hosted deployment [ece-create-deployment] - -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 Elastic Cloud Enterprise 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 get up and running with your deployment quickly: - -1. From the Cloud UI, select **Create deployment**. - - :::{image} ../../../images/cloud-enterprise-ece-create-deployment.png - :alt: Create a deployment - ::: - - Once you are on the **Create deployment** page, you can edit the basic settings, or configure more advanced settings. - -2. Select **Create deployment**. It takes a few minutes for your deployment to be created. While waiting, you are prompted to save the `admin` credentials for your deployment which provides you with superuser access to Elasticsearch. Keep these credentials safe as they are shown only once. - - * **Default**. A template to get you started and for backwards compatibility with existing deployments. The default template is suitable for search and general all-purpose workloads that don’t require more specialized resources. - * **Cross-cluster Search**. A lightweight hub to manage remote connections for running Elasticsearch queries across multiple deployments and indices. - * [**Elastic Security**](../../../solutions/security.md). Provides an overview of the events and alerts from your environment. Elastic Security helps you defend your organization from threats before damage and loss occur. - * [**Elastic Observability**](../../../solutions/observability/get-started/what-is-elastic-observability.md). Enables you to monitor and apply analytics in real time to events happening across all your environments. You can analyze log events, monitor the performance metrics for the host or container that it ran in, trace the transaction, and check the overall service availability. - - -If these system templates are not suitable for your use case, you can [create your own deployment templates](../../../deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-create-templates.md). - -1. Choose your Elastic Stack version. -2. Optionally, use snapshots to back up your data or restore data from another deployment. - - Restoring a snapshot can help with major version upgrades by creating a separate, non-production deployment where you can test, for example. Or, make life easier for your developers by providing them with a development environment that is populated with real data. - -3. Select **Advanced settings**, to configure your deployment for autoscaling, storage, memory, and vCPU. Check [Customize your deployment](../../../deploy-manage/deploy/cloud-enterprise/customize-deployment.md) for more details. -4. Select **Create deployment**. It takes a few minutes before your deployment gets created. - - While waiting, you are prompted to save the admin credentials for your deployment which provides you with superuser access to Elasticsearch. Write down the password for the `elastic` user (or the `admin` user for version 2.x) and keep it somewhere safe. These credentials also help you [add data using Kibana](../../../manage-data/ingest.md). If you need to refresh these credentials, you can [reset the password](../../../deploy-manage/users-roles/cluster-or-deployment-auth/built-in-users.md). - -5. Once the deployment is ready, select **Continue** to open the deployment’s main page. From here, you can start ingesting data or simply [try a sample data](../../../explore-analyze/index.md#gs-get-data-into-kibana) set to get started. - - :::{image} ../../../images/cloud-enterprise-ece-deployment-mainpage.png - :alt: ECE Deployment main page - ::: - - -After a deployment is spun up, you can scale the size and add other features; however, the instance configuration and computing ratios cannot be changed. If you need to change an existing deployment to another template, we recommend [migrating your data](../../../manage-data/migrate.md). - - - - diff --git a/raw-migrated-files/cloud/cloud-enterprise/ece-delete-deployment.md b/raw-migrated-files/cloud/cloud-enterprise/ece-delete-deployment.md deleted file mode 100644 index 90f95224fd..0000000000 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-delete-deployment.md +++ /dev/null @@ -1,15 +0,0 @@ -# Delete a deployment [ece-delete-deployment] - -To delete a deployment: - -1. [Log into the Cloud UI](../../../deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md). -2. On the **Deployments** page, select your deployment. - - Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters. - -3. [Terminate the deployment](../../../deploy-manage/uninstall/delete-a-cloud-deployment.md). -4. Select **Delete deployment** and follow the steps to delete the deployment permanently. - -::::{warning} -Deleting a deployment cannot be undone. -:::: diff --git a/raw-migrated-files/cloud/cloud-enterprise/ece-find.md b/raw-migrated-files/cloud/cloud-enterprise/ece-find.md deleted file mode 100644 index ecbeac2a4c..0000000000 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-find.md +++ /dev/null @@ -1,20 +0,0 @@ -# Finding deployments, finding problems [ece-find] - -When you installed Elastic Cloud Enterprise and [logged into the Cloud UI](../../../deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md) for the first time, you were greeted by two deployments. We’ve also shown you how to [create your own first deployment](../../../deploy-manage/deploy/cloud-enterprise/create-deployment.md), but that still only makes a few deployments. What if you had hundreds of deployments to look after or maybe even a thousand? How would you find the ones that need your attention? - -The **Deployments** page in the Cloud UI provides several ways to find deployments that might need your attention, whether that’s deployments that have a problem or deployments that are at a specific version level or really almost anything you might want to find on a complex production system: - -* Check the visual health indicators of deployments -* Search for partial or whole deployment names or IDs in the search text box -* Add filters to the **Deployments** view to filter for specific conditions: - - :::{image} ../../../images/cloud-enterprise-deployment-filter.png - :alt: Add a filter - ::: - - Looking for all deployments of a specific version, because you want to upgrade them? Easy. Or what about that deployments you noticed before lunch that seemed to be spending an awfully long time changing its configuration—​is it done? Just add a filter to find any ongoing configuration changes. - - - - - diff --git a/raw-migrated-files/cloud/cloud-enterprise/ece-manage-integrations-server.md b/raw-migrated-files/cloud/cloud-enterprise/ece-manage-integrations-server.md deleted file mode 100644 index c1d5ff17b7..0000000000 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-manage-integrations-server.md +++ /dev/null @@ -1,44 +0,0 @@ -# Manage your Integrations Server [ece-manage-integrations-server] - -For deployments that are version 8.0 and later, you have the option to add a combined [Application Performance Monitoring (APM) Server](/solutions/observability/apps/application-performance-monitoring-apm.md) and [Fleet Server](/reference/ingestion-tools/fleet/index.md) to your deployment. APM allows you to monitor software services and applications in real time, turning that data into documents stored in the Elasticsearch cluster. Fleet allows you to centrally manage Elastic Agents on many hosts. - -As part of provisioning, the APM Server and Fleet Server are already configured to work with Elasticsearch and Kibana. At the end of provisioning, you are shown the secret token to configure communication between the APM Server and the backend [APM Agents](https://www.elastic.co/guide/en/apm/agent/index.html). The APM Agents get deployed within your services and applications. - -From the deployment **Integrations Server** page you can also: - -* Get the URL to complete the APM agent configuration. -* Use the `elastic` credentials to go to the APM area of Kibana. Step by step instructions to configure a variety of agents are available right in Kibana. After that, you can use the pre-built, dedicated dashboards and the APM tab to visualize the data that is sent back from the APM Agents. -* Use the `elastic` credentials to go to the Fleet area of Kibana. Step by step instructions to download and install Elastic Agent on your hosts are available right in Kibana. After that, you can manage enrolled Elastic Agents on the **Agents** tab, and the data shipped back from those Elastic Agents on the **Data streams** tab. -* Access the Integrations Server logs and metrics. -* Stop and restart your Integrations Server. -* Upgrade your Integrations Server version if it is out of sync with your Elasticsearch cluster. -* 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 Elastic Cloud Enterprise 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. -:::: - - - -## Routing to Fleet Server [ece-integrations-server-fleet-routing] - -Because Fleet Server and APM Server live on the same instance, an additional part is added to the Fleet Server hostname to help distinguish between the traffic to each. If you have not configured support for deployment aliases, your certificate may not be configured to expect this extra part. - -Data is routed to APM using the same hostname `<>.<>`, but two new endpoints are introduced: - -* `<>.apm.<>` as an alternate endpoint for APM -* `<>.fleet.<>` is the *only* way of routing data to Fleet Server - -::::{note} -New certificates must be generated for both these endpoints. Check [Enable custom endpoint aliases](../../../deploy-manage/deploy/cloud-enterprise/enable-custom-endpoint-aliases.md) for more details. -:::: - - - -## Using the API to manage Integrations Server [ece_using_the_api_to_manage_integrations_server] - -To manage Integrations Server through the API you need to include an Integrations Server payload when creating or updating a deployment. Check [Enable Integrations Server through the API](../../../deploy-manage/deploy/cloud-enterprise/manage-integrations-server.md) for an example. - -Check [Switch from APM to Integrations Server payload](../../../deploy-manage/deploy/cloud-enterprise/switch-from-apm-to-integrations-server-payload.md) for an example of how to switch from APM & Fleet Server to Integrations Server. - - diff --git a/raw-migrated-files/cloud/cloud-enterprise/ece-manage-kibana.md b/raw-migrated-files/cloud/cloud-enterprise/ece-manage-kibana.md deleted file mode 100644 index 8f111fc82b..0000000000 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-manage-kibana.md +++ /dev/null @@ -1,20 +0,0 @@ -# Manage your Kibana instance [ece-manage-kibana] - -Kibana is an open source analytics and visualization platform designed to work with Elasticsearch, that makes it easy to perform advanced data analysis and to visualize your data in a variety of charts, tables, and maps. Its simple, browser-based interface enables you to quickly create and share dynamic dashboards that display changes to Elasticsearch queries in real time. - -Most deployment templates include a Kibana instance, but if it wasn’t part of the initial deployment you can go to the **Kibana** page and **Enable** Kibana. - -The new Kibana instance takes a few moments to provision. After provisioning Kibana is complete, you can use the endpoint URL to access Kibana. - -::::{tip} -You can log into Kibana as the `elastic` superuser. The password was provided when you created your deployment or can be [reset](../../../deploy-manage/users-roles/cluster-or-deployment-auth/built-in-users.md). On AWS and not able to access Kibana? [Check if you need to update your endpoint URL first](../../../troubleshoot/deployments/cloud-enterprise/common-issues.md#ece-aws-private-ip). -:::: - - -From the deployment **Kibana** page you can also: - -* Terminate your Kibana instance, which stops it. The information is stored in your Elasticsearch cluster, so stopping and restarting should not risk your Kibana information. -* Restart it after stopping. -* Upgrade your Kibana instance version if it is out of sync with your Elasticsearch cluster. -* Delete to fully remove the instance, wipe it from the disk, and stop charges. - diff --git a/raw-migrated-files/cloud/cloud-enterprise/ece-monitoring-deployments.md b/raw-migrated-files/cloud/cloud-enterprise/ece-monitoring-deployments.md deleted file mode 100644 index dddc704f63..0000000000 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-monitoring-deployments.md +++ /dev/null @@ -1,13 +0,0 @@ -# Keep your clusters healthy [ece-monitoring-deployments] - -Elastic Cloud Enterprise monitors many aspects of your installation, but some issues require a human to resolve them. Use this section to learn how you can: - -* [Find clusters](/troubleshoot/deployments/elastic-cloud.md) that have issues. -* [Move affected nodes off an allocator](../../../deploy-manage/maintenance/ece/move-nodes-instances-from-allocators.md), if the allocator fails. -* [Enable deployment logging and monitoring](../../../deploy-manage/monitor/stack-monitoring/ece-stack-monitoring.md) to keep an eye on the performance of deployments and debug stack and solution issues. - -In addition to the monitoring of clusters that is described here, don’t forget that Elastic Cloud Enterprise also provides [monitoring information for your entire installation](../../../deploy-manage/monitor/orchestrators/ece-platform-monitoring.md). You can you also monitor the physical hosts machines on which Elastic Cloud Enterprise is installed. - - - - diff --git a/raw-migrated-files/cloud/cloud-enterprise/ece-stack-getting-started.md b/raw-migrated-files/cloud/cloud-enterprise/ece-stack-getting-started.md deleted file mode 100644 index cc5fbbfecb..0000000000 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-stack-getting-started.md +++ /dev/null @@ -1,56 +0,0 @@ -# Working with deployments [ece-stack-getting-started] - -::::{note} -Are you just discovering Elastic or are unfamiliar with the core concepts of the Elastic Stack? Would you like to be guided through the very first steps and understand how Elastic can help you? Try one of our [getting started guides](https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/getting-started-guides.html) first. -:::: - - - -## Introducing deployments [ece_introducing_deployments] - -**The Elastic Stack, managed through {{ecloud}} deployments.** - -Elastic Cloud Enterprise allows you to manage one or more instances of the Elastic Stack through **deployments**. - -A *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. - -**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. - -All of these profiles are based on *deployment templates*, which are a reusable configuration of Elastic products that you can deploy. With the flexibility of Elastic Cloud Enterprise, you can take it a step further by customizing a deployment template to your own needs. - -**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-enterprise-ec-stack-components.png -:alt: Elastic Stack components and solutions with Enterprise Search -::: - -:::{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 Elastic Cloud Enterprise? [ece_how_to_operate_elastic_cloud_enterprise] - -**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). -* [Create a deployment](../../../deploy-manage/deploy/cloud-enterprise/create-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](https://www.elastic.co/guide/en/cloud-enterprise/current/ece-cloud-ingest-data.html) - Ingest and index the data you want, from a variety of sources, and take action on it. - -**And then?** - -Now is the time for you to work with your data. The content of the Elastic Cloud Enterprise 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). diff --git a/raw-migrated-files/cloud/cloud-enterprise/editing-user-settings.md b/raw-migrated-files/cloud/cloud-enterprise/editing-user-settings.md deleted file mode 100644 index 90c505924f..0000000000 --- a/raw-migrated-files/cloud/cloud-enterprise/editing-user-settings.md +++ /dev/null @@ -1,13 +0,0 @@ -# Editing your user settings [editing-user-settings] - -From the Elastic Cloud Enterprise console you can customize Elasticsearch, Kibana, and other supported stack components 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: - -* [Dictate the behavior of Elasticsearch and its security features](../../../deploy-manage/deploy/cloud-enterprise/edit-stack-settings.md). -* [Manage Kibana’s settings](../../../deploy-manage/deploy/cloud-enterprise/edit-stack-settings.md). -* [Tune your APM Server](../../../deploy-manage/deploy/cloud-enterprise/edit-stack-settings.md). -* [Configure App Search](https://www.elastic.co/guide/en/cloud-enterprise/current/ece-manage-appsearch-settings.html). - - - - - diff --git a/raw-migrated-files/toc.yml b/raw-migrated-files/toc.yml index 40e99ee287..2da7b2f9d9 100644 --- a/raw-migrated-files/toc.yml +++ b/raw-migrated-files/toc.yml @@ -18,33 +18,16 @@ toc: - file: cloud/cloud-enterprise/index.md children: - file: cloud/cloud-enterprise/ece_re_running_the_ece_upgrade.md - - file: cloud/cloud-enterprise/ece-access-kibana.md - - file: cloud/cloud-enterprise/ece-add-custom-bundle-plugin.md - - file: cloud/cloud-enterprise/ece-add-user-settings.md - - file: cloud/cloud-enterprise/ece-administering-deployments.md - - file: cloud/cloud-enterprise/ece-change-deployment.md - - file: cloud/cloud-enterprise/ece-create-deployment.md - - file: cloud/cloud-enterprise/ece-delete-deployment.md - - file: cloud/cloud-enterprise/ece-find.md - - file: cloud/cloud-enterprise/ece-integrations-server-api-example.md - - file: cloud/cloud-enterprise/ece-manage-apm-settings.md - - file: cloud/cloud-enterprise/ece-manage-enterprise-search-settings.md - - file: cloud/cloud-enterprise/ece-manage-integrations-server.md - - file: cloud/cloud-enterprise/ece-manage-kibana-settings.md - - file: cloud/cloud-enterprise/ece-manage-kibana.md - - file: cloud/cloud-enterprise/ece-monitoring-deployments.md - file: cloud/cloud-enterprise/ece-password-reset-elastic.md - file: cloud/cloud-enterprise/ece-restore-across-clusters.md - file: cloud/cloud-enterprise/ece-restore-deployment.md - file: cloud/cloud-enterprise/ece-securing-clusters.md - file: cloud/cloud-enterprise/ece-securing-ece.md - file: cloud/cloud-enterprise/ece-snapshots.md - - file: cloud/cloud-enterprise/ece-stack-getting-started.md - file: cloud/cloud-enterprise/ece-terminate-deployment.md - file: cloud/cloud-enterprise/ece-troubleshooting.md - file: cloud/cloud-enterprise/ece-upgrade-deployment.md - file: cloud/cloud-enterprise/ece-upgrade.md - - file: cloud/cloud-enterprise/editing-user-settings.md - file: cloud/cloud-heroku/index.md children: - file: cloud/cloud-heroku/ech-about.md diff --git a/redirects.yml b/redirects.yml index 3e272bb8c7..0bd632d3ac 100644 --- a/redirects.yml +++ b/redirects.yml @@ -18,6 +18,7 @@ redirects: anchors: 'spaces-control-feature-visibility': 'deploy-manage/deploy/cloud-enterprise/deploy-large-installation-cloud.md': '!deploy-manage/deploy/cloud-enterprise/deploy-large-installation.md' + 'deploy-manage/deploy/cloud-enterprise/find-cloud-id.md': '!deploy-manage/deploy/cloud-enterprise/connect-elasticsearch.md' 'deploy-manage/deploy/cloud-on-k8s/k8s-kibana-http-configuration.md': '!deploy-manage/security/secure-http-communications.md' 'deploy-manage/deploy/self-managed/install-with-docker.md': '!deploy-manage/deploy/self-managed/install-kibana-with-docker.md' 'deploy-manage/deploy/self-managed/deploy-cluster.md': '!deploy-manage/deploy/self-managed/installing-elasticsearch.md'