From e30b052b62f52696811d6c477c376b88ef7f6d93 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Tue, 25 Feb 2025 14:18:18 +0100 Subject: [PATCH 01/29] install and configure ECE refined --- .../cloud-enterprise/air-gapped-install.md | 34 +++++++++------- .../alternative-install-ece-with-ansible.md | 3 ++ .../cloud-enterprise/assign-roles-to-hosts.md | 3 ++ ...-add-support-for-node-roles-autoscaling.md | 3 ++ .../change-allocator-disconnect-timeout.md | 3 ++ .../cloud-enterprise/change-ece-api-url.md | 3 ++ .../cloud-enterprise/change-endpoint-urls.md | 3 ++ .../configure-allocator-affinity.md | 3 ++ .../configure-deployment-templates.md | 3 ++ .../configure-host-rhel-cloud.md | 3 ++ .../configure-host-rhel-onprem.md | 3 ++ .../configure-host-suse-cloud.md | 3 ++ .../configure-host-suse-onprem.md | 3 ++ .../configure-host-ubuntu-cloud.md | 3 ++ .../configure-host-ubuntu-onprem.md | 3 ++ .../configure-operating-system-cloud.md | 3 ++ .../configure-operating-system-onprem.md | 3 ++ .../deploy/cloud-enterprise/configure.md | 33 ++++++++++----- .../default-system-deployment-versions.md | 3 ++ .../deploy-an-orchestrator.md | 6 +-- .../deploy-large-installation-cloud.md | 5 ++- .../deploy-large-installation-onprem.md | 3 ++ .../deploy-medium-installation-cloud.md | 5 ++- .../deploy-medium-installation-onprem.md | 3 ++ .../deploy-small-installation-cloud.md | 5 ++- .../deploy-small-installation-onprem.md | 3 ++ ...-ce-add-support-for-integrations-server.md | 3 ++ ...ce-configure-templates-index-management.md | 3 ++ ...figuring-ece-configure-system-templates.md | 3 ++ .../ece-configuring-ece-create-templates.md | 3 ++ ...ring-ece-instance-configurations-create.md | 3 ++ ...ing-ece-instance-configurations-default.md | 3 ++ ...guring-ece-instance-configurations-edit.md | 3 ++ .../ece-configuring-ece-tag-allocators.md | 3 ++ .../deploy/cloud-enterprise/ece-ha.md | 3 ++ .../cloud-enterprise/ece-hardware-prereq.md | 5 ++- .../ece-include-additional-kibana-plugin.md | 3 ++ .../ece-install-offline-images.md | 3 ++ .../ece-install-offline-no-registry.md | 3 ++ .../ece-install-offline-with-registry.md | 3 ++ .../deploy/cloud-enterprise/ece-jvm.md | 3 ++ .../cloud-enterprise/ece-load-balancers.md | 11 +++-- .../cloud-enterprise/ece-manage-capacity.md | 21 +++++----- .../cloud-enterprise/ece-networking-prereq.md | 3 ++ .../deploy/cloud-enterprise/ece-roles.md | 3 ++ .../cloud-enterprise/ece-software-prereq.md | 3 ++ .../deploy/cloud-enterprise/ece-sysconfig.md | 3 ++ .../cloud-enterprise/ece-users-permissions.md | 3 ++ .../cloud-enterprise/ece-wildcard-dns.md | 3 ++ .../enable-custom-endpoint-aliases.md | 3 ++ ...llation-of-ece-using-podman-hosts-cloud.md | 4 ++ .../identify-deployment-scenario.md | 3 ++ .../cloud-enterprise/install-ece-cloud.md | 8 ++-- .../install-ece-on-additional-hosts.md | 3 ++ .../install-ece-on-own-premises.md | 3 ++ .../install-ece-on-public-cloud.md | 31 +++++++++----- .../cloud-enterprise/install-ece-onprem.md | 3 ++ .../deploy/cloud-enterprise/install.md | 10 ++++- .../manage-elastic-stack-versions.md | 3 ++ ...-ece-on-podman-hosts-to-selinux-enforce.md | 3 ++ .../migrate-ece-to-podman-hosts.md | 3 ++ .../post-installation-steps.md | 40 +++++++++++++------ .../cloud-enterprise/prepare-environment.md | 4 ++ ...tatistics-collected-by-cloud-enterprise.md | 3 ++ .../system-deployments-configuration.md | 3 ++ .../working-with-deployments.md | 5 ++- deploy-manage/toc.yml | 2 +- .../cloud-enterprise/ece-install-offline.md | 23 ----------- raw-migrated-files/toc.yml | 1 - 69 files changed, 302 insertions(+), 101 deletions(-) delete mode 100644 raw-migrated-files/cloud/cloud-enterprise/ece-install-offline.md diff --git a/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md b/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md index 06fc1afe34..87c8bc38e9 100644 --- a/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md +++ b/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md @@ -1,26 +1,32 @@ --- +applies_to: + deployment: + ece: all mapped_urls: - - https://www.elastic.co/guide/en/elastic-stack/current/air-gapped-install.html - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-offline.html --- -# Air gapped install +# Air-gapped install [ece-install-offline] -% What needs to be done: Refine +Installing ECE on hosts without internet access is commonly referred to as an *offline* or *air-gapped installation*. ECE supports two air-gapped installation methods, depending on whether a private Docker registry is available. In both cases, you must download multiple Docker images and the installation script from Elastic, and load them onto your hosts or private registry. -% GitHub issue: https://github.com/elastic/docs-projects/issues/309 +::::{note} + The versioning of {{es}} and {{kib}} is synchronized and versions where the major, minor, and patch levels match can be used together. Differences in build versions indicated by a dash do not affect compatibility. +:::: -% Scope notes: In the issue +Before you start, you must: -% Use migrated content from existing pages that map to this page: +* Follow [](./prepare-environment.md) steps as you would for other installation methods, except that outgoing internet connections for downloading Docker images are not required. +* [Configure your operating system](./configure-operating-system-onprem.md). +* Be part of the `docker` group to run the installation script. You should not install Elastic Cloud Enterprise as the `root` user. +* Set up your [wildcard DNS record](./ece-wildcard-dns.md). +* Set up and run a local copy of the Elastic Package Repository, otherwise your deployments with APM server and Elastic agent won’t work. Refer to the [Running EPR in air-gapped environments](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/air-gapped.md#air-gapped-diy-epr) documentation. -% - [ ] ./raw-migrated-files/stack-docs/elastic-stack/air-gapped-install.md -% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-install-offline.md -% Notes: 3 child docs +When you are ready to install ECE, you can proceed: -⚠️ **This page is a work in progress.** ⚠️ +* [With your private Docker registry](./ece-install-offline-with-registry.md) +* [Without your private Docker registry](./ece-install-offline-no-registry.md) -The documentation team is working to combine content pulled from the following pages: - -* [/raw-migrated-files/stack-docs/elastic-stack/air-gapped-install.md](/raw-migrated-files/stack-docs/elastic-stack/air-gapped-install.md) -* [/raw-migrated-files/cloud/cloud-enterprise/ece-install-offline.md](/raw-migrated-files/cloud/cloud-enterprise/ece-install-offline.md) \ No newline at end of file +::::{note} +Deployment End-of-life (EOL) information relies on the connection to [https://www.elastic.co/support/eol.json](https://www.elastic.co/support/eol.json). If EOL information is updated, Elastic may require you to reconnect to [https://www.elastic.co/support/eol.json](https://www.elastic.co/support/eol.json) over the Internet to get this information reflected. +:::: diff --git a/deploy-manage/deploy/cloud-enterprise/alternative-install-ece-with-ansible.md b/deploy-manage/deploy/cloud-enterprise/alternative-install-ece-with-ansible.md index f8e95b1a2e..867c56d421 100644 --- a/deploy-manage/deploy/cloud-enterprise/alternative-install-ece-with-ansible.md +++ b/deploy-manage/deploy/cloud-enterprise/alternative-install-ece-with-ansible.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-ansible.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/assign-roles-to-hosts.md b/deploy-manage/deploy/cloud-enterprise/assign-roles-to-hosts.md index 2048ac20b2..dd4f7d51e1 100644 --- a/deploy-manage/deploy/cloud-enterprise/assign-roles-to-hosts.md +++ b/deploy-manage/deploy/cloud-enterprise/assign-roles-to-hosts.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-change-roles.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/ce-add-support-for-node-roles-autoscaling.md b/deploy-manage/deploy/cloud-enterprise/ce-add-support-for-node-roles-autoscaling.md index e6b3adca81..fed85dde0c 100644 --- a/deploy-manage/deploy/cloud-enterprise/ce-add-support-for-node-roles-autoscaling.md +++ b/deploy-manage/deploy/cloud-enterprise/ce-add-support-for-node-roles-autoscaling.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ce-add-support-for-node-roles-and-autoscaling.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/change-allocator-disconnect-timeout.md b/deploy-manage/deploy/cloud-enterprise/change-allocator-disconnect-timeout.md index 92b66c191f..47fb379d73 100644 --- a/deploy-manage/deploy/cloud-enterprise/change-allocator-disconnect-timeout.md +++ b/deploy-manage/deploy/cloud-enterprise/change-allocator-disconnect-timeout.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-change-allocator-disconnect-timeout.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/change-ece-api-url.md b/deploy-manage/deploy/cloud-enterprise/change-ece-api-url.md index 2d3be29af5..958d83b017 100644 --- a/deploy-manage/deploy/cloud-enterprise/change-ece-api-url.md +++ b/deploy-manage/deploy/cloud-enterprise/change-ece-api-url.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-config-api-base-url.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/change-endpoint-urls.md b/deploy-manage/deploy/cloud-enterprise/change-endpoint-urls.md index 6f7dc9b832..adc269ca01 100644 --- a/deploy-manage/deploy/cloud-enterprise/change-endpoint-urls.md +++ b/deploy-manage/deploy/cloud-enterprise/change-endpoint-urls.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-administering-endpoints.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/configure-allocator-affinity.md b/deploy-manage/deploy/cloud-enterprise/configure-allocator-affinity.md index 076970f656..d224c8a661 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-allocator-affinity.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-allocator-affinity.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configuring-allocator-affinity.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/configure-deployment-templates.md b/deploy-manage/deploy/cloud-enterprise/configure-deployment-templates.md index f93aee41a5..81ae3dddf2 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-deployment-templates.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-deployment-templates.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configuring-ece-templates.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/configure-host-rhel-cloud.md b/deploy-manage/deploy/cloud-enterprise/configure-host-rhel-cloud.md index bef34bece0..1c8bae7f45 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-host-rhel-cloud.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-host-rhel-cloud.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-hosts-rhel-centos-cloud.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/configure-host-rhel-onprem.md b/deploy-manage/deploy/cloud-enterprise/configure-host-rhel-onprem.md index 9272d2dc52..558e533a41 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-host-rhel-onprem.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-host-rhel-onprem.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-hosts-rhel-centos-onprem.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/configure-host-suse-cloud.md b/deploy-manage/deploy/cloud-enterprise/configure-host-suse-cloud.md index d397f7a1dc..b41613a5b4 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-host-suse-cloud.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-host-suse-cloud.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-hosts-sles12-cloud.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/configure-host-suse-onprem.md b/deploy-manage/deploy/cloud-enterprise/configure-host-suse-onprem.md index cd18a0c708..1c3d880093 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-host-suse-onprem.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-host-suse-onprem.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-hosts-sles12-onprem.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu-cloud.md b/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu-cloud.md index 86d667482a..87dd0bd484 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu-cloud.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu-cloud.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-hosts-ubuntu-cloud.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu-onprem.md b/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu-onprem.md index c0a23de7db..51e47c18da 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu-onprem.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu-onprem.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-hosts-ubuntu-onprem.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/configure-operating-system-cloud.md b/deploy-manage/deploy/cloud-enterprise/configure-operating-system-cloud.md index 17ae9b46c0..b05e7f920a 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-operating-system-cloud.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-operating-system-cloud.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-os-cloud.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/configure-operating-system-onprem.md b/deploy-manage/deploy/cloud-enterprise/configure-operating-system-onprem.md index 599d6e2257..fba0829c14 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-operating-system-onprem.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-operating-system-onprem.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-os-onprem.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/configure.md b/deploy-manage/deploy/cloud-enterprise/configure.md index 7a71714ea5..25b710572f 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure.md +++ b/deploy-manage/deploy/cloud-enterprise/configure.md @@ -9,30 +9,41 @@ mapped_pages: # Configure ECE [ece-configuring-ece] -⚠️ **This page is a work in progress.** ⚠️ +Now that you have {{ece}} up and running, take a look at some of the additional features that you can configure: -Now that you have Elastic Cloud Enterprise up and running, take a look at some of the additional features that you can configure: +## Common ECE tasks -* [System deployment configuration](system-deployments-configuration.md) - Best practices for ECE system deployments to ensure a highly available and resilient setup. +* [Assign Roles to Hosts](../../../deploy-manage/deploy/cloud-enterprise/assign-roles-to-hosts.md) - Make sure new hosts can be used for their intended purpose after you install ECE on them. +* [System deployments configuration](system-deployments-configuration.md) - Best practices for ECE system deployments to ensure a highly available and resilient setup. * [Configure deployment templates](configure-deployment-templates.md) - Make the most out of deployment templates by configuring ECE for your hardware and creating custom deployment templates. -* [Manage snapshot repositories](../../tools/snapshot-and-restore/cloud-enterprise.md) - To back up your Elasticsearch clusters automatically, you need to configure a snapshot repository. +* [Manage Elastic Stack versions](./manage-elastic-stack-versions.md) - Upload or remove Elastic Stack packs. +* [Change the ECE API URL](./change-ece-api-url.md) - Configure the HTTPS URL used to access the ECE API. +* [Change endpoint URLs](change-endpoint-urls.md) - Configure the URLs to access {{es}} and {{kib}} deployments to match your [domain name](./ece-wildcard-dns.md) and [proxy certificate](../../security/secure-your-elastic-cloud-enterprise-installation/manage-security-certificates.md). +* [Enable custom endpoint aliases](./enable-custom-endpoint-aliases.md) - This feature allows to use aliases in the endpoint URLs instead of cluster UUIDs. + +Other sections of the documentation describe important ECE features to consider: + +* [Configure ECE users and roles](../../users-roles/cloud-enterprise-orchestrator.md) - Manage authentication and authorization at ECE platform level. +* [Manage security certificates](../../security/secure-your-elastic-cloud-enterprise-installation/manage-security-certificates.md) - Configure Cloud UI and Proxy TLS/SSL certificates. * [Manage licenses](../../license/manage-your-license-in-ece.md) - Keep Elastic Cloud Enterprise current with a valid license. -* [Change endpoint URLs](change-endpoint-urls.md) - Set where Elasticsearch and Kibana can be accessed from. +* [Manage snapshot repositories](../../tools/snapshot-and-restore/cloud-enterprise.md) - To back up your Elasticsearch clusters automatically, you need to configure a snapshot repository. + +## Advanced configuration procedures + * [Configure allocator affinity](configure-allocator-affinity.md) - Determine how ECE distributes your Elastic Stack deployments across allocators. * [Change allocator disconnect timeout](change-allocator-disconnect-timeout.md) - Configure how long ECE waits before considering allocators to be disconnected. +* [Migrate ECE to Podman hosts](./migrate-ece-to-podman-hosts.md) - If you are running a Docker based installation and you need to migrate to Podman. * [Migrate ECE on Podman hosts to SELinux in enforcing mode](migrate-ece-on-podman-hosts-to-selinux-enforce.md) - Migrate ECE to SELinux in `enforcing` mode using Podman. -## Administering your installation [ece-administering-ece] +## Maintenance activities -Now that you have Elastic Cloud Enterprise up and running, take a look at the things you can do to keep your installation humming along, from adding more capacity to dealing with hosts that require maintenance or have failed. They are all presented in the [](../../maintenance.md) section. +Refer to [ECE maintenance](../../maintenance/ece.md) for important maintenance activities, including adding capacity, applying OS patches, and addressing host failures. * [Scale Out Your Installation](../../../deploy-manage/maintenance/ece/scale-out-installation.md) - Need to add more capacity? Here’s how. -* [Assign Roles to Hosts](../../../deploy-manage/deploy/cloud-enterprise/assign-roles-to-hosts.md) - Make sure new hosts can be used for their intended purpose after you install ECE on them. * [Enable Maintenance Mode](../../../deploy-manage/maintenance/ece/enable-maintenance-mode.md) - Perform administrative actions on allocators safely by putting them into maintenance mode first. * [Move Nodes From Allocators](../../../deploy-manage/maintenance/ece/move-nodes-instances-from-allocators.md) - Moves all Elasticsearch clusters and Kibana instances to another allocator, so that the allocator is no longer used for handling user requests. -* [Delete Hosts](../../../deploy-manage/maintenance/ece/delete-ece-hosts.md) - Remove a host from your ECE installation, either because it is no longer needed or because it is faulty. * [Perform Host Maintenance](../../../deploy-manage/maintenance/ece/perform-ece-hosts-maintenance.md) - Apply operating system patches and other maintenance to hosts safely without removing them from your ECE installation. -* [Manage Elastic Stack Versions](../../../deploy-manage/deploy/cloud-enterprise/manage-elastic-stack-versions.md) - View, add, or update versions of the Elastic Stack that are available on your ECE installation. -* [Upgrade Your Installation](../../../deploy-manage/upgrade/orchestrator/upgrade-cloud-enterprise.md) - A new version of Elastic Cloud Enterprise is available and you want to upgrade. Here’s how. +* [Delete Hosts](../../../deploy-manage/maintenance/ece/delete-ece-hosts.md) - Remove a host from your ECE installation, either because it is no longer needed or because it is faulty. +* [Upgrade Your Installation](../../../deploy-manage/upgrade/orchestrator/upgrade-cloud-enterprise.md) - A new version of Elastic Cloud Enterprise is available and you want to upgrade. Here’s how. diff --git a/deploy-manage/deploy/cloud-enterprise/default-system-deployment-versions.md b/deploy-manage/deploy/cloud-enterprise/default-system-deployment-versions.md index a2df2dd8fd..9ac6e41fdc 100644 --- a/deploy-manage/deploy/cloud-enterprise/default-system-deployment-versions.md +++ b/deploy-manage/deploy/cloud-enterprise/default-system-deployment-versions.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-system-deployment-versions.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/deploy-an-orchestrator.md b/deploy-manage/deploy/cloud-enterprise/deploy-an-orchestrator.md index a23a4873d6..8f3e0c0a9d 100644 --- a/deploy-manage/deploy/cloud-enterprise/deploy-an-orchestrator.md +++ b/deploy-manage/deploy/cloud-enterprise/deploy-an-orchestrator.md @@ -17,7 +17,7 @@ This section provides step-by-step guidance on: * [Prepare the environment](./prepare-environment.md): Follow the hardware, software, and networking prerequisites before the installation. -* [Install ECE](./install.md): Identify the deployment scenario that best fits your needs, choose an installation method, and complete the setup. +* [Install ECE orchestrator](./install.md): Identify the deployment scenario that best fits your needs, choose an installation method, and complete the setup. * [Install ECE on a public cloud](./install-ece-on-public-cloud.md) * [Install ECE on your own premises](./install-ece-on-own-premises.md) * [Alternative: install ECE with Ansible](./alternative-install-ece-with-ansible.md) @@ -36,8 +36,8 @@ This section provides step-by-step guidance on: After deploying the ECE platform, you may need to configure custom proxy certificates, manage snapshot repositories, or perform maintenance operations, among other tasks. Refer to the following sections for more details: -* [Secure your ECE installation](../../security/secure-your-elastic-cloud-enterprise-installation.md) -*[](/deploy-manage/security/secure-your-cluster-deployment.md) +* [Security considerations](../../security/secure-your-elastic-cloud-enterprise-installation.md) +* [Secure your deployments](/deploy-manage/security/secure-your-cluster-deployment.md) * [Users and roles](../../users-roles/cloud-enterprise-orchestrator.md) * [Manage snapshot repositories](../../tools/snapshot-and-restore.md) * [Manage licenses](../../license/manage-your-license-in-ece.md) diff --git a/deploy-manage/deploy/cloud-enterprise/deploy-large-installation-cloud.md b/deploy-manage/deploy/cloud-enterprise/deploy-large-installation-cloud.md index 20e7e75a62..5f6deb51d7 100644 --- a/deploy-manage/deploy/cloud-enterprise/deploy-large-installation-cloud.md +++ b/deploy-manage/deploy/cloud-enterprise/deploy-large-installation-cloud.md @@ -1,9 +1,12 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-large-cloud.html --- -# Deploy a large installation cloud [ece-install-large-cloud] +# Deploy a large installation [ece-install-large-cloud] This type of installation is recommended for deployments with significant overall search and indexing throughput. You need: diff --git a/deploy-manage/deploy/cloud-enterprise/deploy-large-installation-onprem.md b/deploy-manage/deploy/cloud-enterprise/deploy-large-installation-onprem.md index 4de56154ae..39ae070006 100644 --- a/deploy-manage/deploy/cloud-enterprise/deploy-large-installation-onprem.md +++ b/deploy-manage/deploy/cloud-enterprise/deploy-large-installation-onprem.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-large-onprem.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/deploy-medium-installation-cloud.md b/deploy-manage/deploy/cloud-enterprise/deploy-medium-installation-cloud.md index 990fd96f7c..93c4d6ea95 100644 --- a/deploy-manage/deploy/cloud-enterprise/deploy-medium-installation-cloud.md +++ b/deploy-manage/deploy/cloud-enterprise/deploy-medium-installation-cloud.md @@ -1,9 +1,12 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-medium-cloud.html --- -# Deploy a medium installation cloud [ece-install-medium-cloud] +# Deploy a medium installation [ece-install-medium-cloud] This type of installation is recommended for many production setups. You need: diff --git a/deploy-manage/deploy/cloud-enterprise/deploy-medium-installation-onprem.md b/deploy-manage/deploy/cloud-enterprise/deploy-medium-installation-onprem.md index 93997d08cd..0f5c107fb9 100644 --- a/deploy-manage/deploy/cloud-enterprise/deploy-medium-installation-onprem.md +++ b/deploy-manage/deploy/cloud-enterprise/deploy-medium-installation-onprem.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-medium-onprem.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/deploy-small-installation-cloud.md b/deploy-manage/deploy/cloud-enterprise/deploy-small-installation-cloud.md index 16541a1d47..108f9373f3 100644 --- a/deploy-manage/deploy/cloud-enterprise/deploy-small-installation-cloud.md +++ b/deploy-manage/deploy/cloud-enterprise/deploy-small-installation-cloud.md @@ -1,9 +1,12 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-small-cloud.html --- -# Deploy a small installation cloud [ece-install-small-cloud] +# Deploy a small installation [ece-install-small-cloud] The type of installation is recommended for development, test, and small-scale use cases. You need: diff --git a/deploy-manage/deploy/cloud-enterprise/deploy-small-installation-onprem.md b/deploy-manage/deploy/cloud-enterprise/deploy-small-installation-onprem.md index 2c511663a1..5fac118259 100644 --- a/deploy-manage/deploy/cloud-enterprise/deploy-small-installation-onprem.md +++ b/deploy-manage/deploy/cloud-enterprise/deploy-small-installation-onprem.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-small-onprem.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/ece-ce-add-support-for-integrations-server.md b/deploy-manage/deploy/cloud-enterprise/ece-ce-add-support-for-integrations-server.md index dbb9d75dcc..e22b8fef1d 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-ce-add-support-for-integrations-server.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-ce-add-support-for-integrations-server.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-ce-add-support-for-integrations-server.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/ece-configure-templates-index-management.md b/deploy-manage/deploy/cloud-enterprise/ece-configure-templates-index-management.md index bf00eb5bf9..66a3a8cd01 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-configure-templates-index-management.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-configure-templates-index-management.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-templates-index-management.html --- 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 b9dd286c4c..f7fc4736bf 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 @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configuring-ece-configure-system-templates.html --- 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 20939bb793..83d97ac30a 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 @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configuring-ece-create-templates.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-instance-configurations-create.md b/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-instance-configurations-create.md index 8b18432afc..80fab48f5b 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-instance-configurations-create.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-instance-configurations-create.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configuring-ece-instance-configurations-create.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-instance-configurations-default.md b/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-instance-configurations-default.md index 3576abd180..caba12ad81 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-instance-configurations-default.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-instance-configurations-default.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configuring-ece-instance-configurations-default.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-instance-configurations-edit.md b/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-instance-configurations-edit.md index 85fc9167f2..93be518574 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-instance-configurations-edit.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-instance-configurations-edit.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configuring-ece-instance-configurations-edit.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-tag-allocators.md b/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-tag-allocators.md index 0ce8fc9a63..880006e421 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-tag-allocators.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-tag-allocators.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configuring-ece-tag-allocators.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/ece-ha.md b/deploy-manage/deploy/cloud-enterprise/ece-ha.md index 2d57c6f76d..c4ca0d81d6 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-ha.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-ha.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-ha.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/ece-hardware-prereq.md b/deploy-manage/deploy/cloud-enterprise/ece-hardware-prereq.md index 6d5a1a6add..8a34c97de8 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-hardware-prereq.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-hardware-prereq.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-hardware-prereq.html --- @@ -48,7 +51,7 @@ The size of your ECE deployment has a bearing on the JVM heap sizes that you sho | Minimum to install | 10 GB | 10 GB | 15 GB | 10 GB | | Minimum recommended | 1:4 RAM-to-storage ratio1 | 1:4 RAM-to-storage ratio1 | 1:4 RAM-to-storage ratio1 | Enough storage to support the RAM-to-storage ratio2 | -1 Control-plane services usually require about 1:4 RAM-to-storage ratio, this may vary. +1 Control-plane management services usually require about 1:4 RAM-to-storage ratio, this may vary. 2 For example, if you use a host with 256 GB of RAM and the default ratio of 1:32, your host must provide 8192 GB of disk space. diff --git a/deploy-manage/deploy/cloud-enterprise/ece-include-additional-kibana-plugin.md b/deploy-manage/deploy/cloud-enterprise/ece-include-additional-kibana-plugin.md index c235968ccd..d2f8015916 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-include-additional-kibana-plugin.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-include-additional-kibana-plugin.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-include-additional-kibana-plugin.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/ece-install-offline-images.md b/deploy-manage/deploy/cloud-enterprise/ece-install-offline-images.md index e728f6908d..78127ed7d9 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-install-offline-images.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-install-offline-images.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-offline-images.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/ece-install-offline-no-registry.md b/deploy-manage/deploy/cloud-enterprise/ece-install-offline-no-registry.md index 5f0b2ded8e..7cc45717ed 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-install-offline-no-registry.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-install-offline-no-registry.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-offline-no-registry.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/ece-install-offline-with-registry.md b/deploy-manage/deploy/cloud-enterprise/ece-install-offline-with-registry.md index a2faa50ed7..dbcab8a1b4 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-install-offline-with-registry.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-install-offline-with-registry.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-offline-with-registry.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/ece-jvm.md b/deploy-manage/deploy/cloud-enterprise/ece-jvm.md index 6cc8797d36..27c3673666 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-jvm.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-jvm.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-jvm.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/ece-load-balancers.md b/deploy-manage/deploy/cloud-enterprise/ece-load-balancers.md index 220612d367..63340ca37a 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-load-balancers.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-load-balancers.md @@ -1,22 +1,25 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-load-balancers.html --- # Load balancers [ece-load-balancers] -Elastic Cloud Enterprise is designed to be used in conjunction with at least one load balancer. A load balancer is not included with Elastic Cloud Enterprise, so you need to provide one yourself and place it in front of the Elastic Cloud Enterprise proxies. +[{{ece}} architecture](./ece-architecture.md) is designed to be used in conjunction with at least one load balancer. A load balancer is not included with {{ece}}, so you need to provide one yourself and place it in front of the {{ece}} proxies. Use the following recommendations when configuring your load balancer: * **High availability**: The exact number of load balancers depends on the utilization rate for your clusters. In a highly available installation, use at least two load balancers for each availability zone in your installation. * **Inbound ports**: Load balancers require that inbound traffic is open on the ports used by Elasticsearch, Kibana, and the transport client. * **X-found-cluster**: ECE proxy uses the header `X-found-cluster` to know which cluster’s UUID (Universally Unique Identifier) the traffic needs to be routed to. If the load balancer rewrites a URL, make sure the HTTP header `X-Found-Cluster` gets added. For example: `X-found-cluster: d59109b8d542c5c4845679e597810796`. -* **X-Forwarded-For**: Configure load balancers to strip inbound `X-Forwarded-For` headers and to replace them with the client source IP as seen by the load balancer. This is required to prevent clients from spoofing their IP addresses. Elastic Cloud Enterprise uses `X-Forwarded-For` for logging client IP addresses and, if you have implemented IP filtering, for traffic management. +* **X-Forwarded-For**: Configure load balancers to strip inbound `X-Forwarded-For` headers and to replace them with the client source IP as seen by the load balancer. This is required to prevent clients from spoofing their IP addresses. {{ece}} uses `X-Forwarded-For` for logging client IP addresses and, if you have implemented IP filtering, for traffic management. * **HTTP**: Use *HTTP mode* for ports 9200/9243 (HTTP traffic to clusters) and also for ports 12400/12443 (adminconsole traffic). * **TCP**: Use *TCP mode* for ports 9300/9343 (transport client traffic to clusters) and the load balancer should enable the proxy protocol support. * **TCP**: Use *TCP mode* for port 9400 for TLS authenticated passthrough between clusters for cross-cluster search (CCS) and replication (CCR), if used. The load balancer should **not** enable the proxy protocol support. -* **TCP**: Use *HTTP mode* for port 9443 for API key authenticated traffic between clusters for cross-cluster search (CCS) and replication (CCR), if used. Make sure that all load balancers or proxies sending this traffic to deployments hosted on Elastic Cloud Enterprise are sending HTTP/1.1 traffic. +* **TCP**: Use *HTTP mode* for port 9443 for API key authenticated traffic between clusters for cross-cluster search (CCS) and replication (CCR), if used. Make sure that all load balancers or proxies sending this traffic to deployments hosted on {{ece}} are sending HTTP/1.1 traffic. * **Deployment traffic and Admin traffic**: Create separate load balancers for Deployment traffic (Elasticsearch and Kibana traffic) and Admin traffic (Cloud UI Console and Admin API). This separation allows you to migrate to a large installation topology without reconfiguring or creating an additional load balancer. * **Traffic across proxies**: Balance traffic evenly across all proxies. Proxies are constantly updated with the internal routing information on how to direct requests to clusters on allocators that are hosting their nodes across zones. Proxies prefer cluster nodes in their local zone and route requests primarily to nodes in their own zone. * **Network**: Use network that is fast enough from a latency and throughput perspective to be considered local for the Elasticsearch clustering requirement. There shouldn’t be a major advantage in "preferring local" from a load balancer perspective (rather than a proxy perspective), it might even lead to potential hot spotting on specific proxies, so it should be avoided. @@ -46,7 +49,7 @@ This returns a healthy response as: ## Proxy health check for ECE 2.1 and later [ece_proxy_health_check_for_ece_2_1_and_later] -For Elastic Cloud Enterprise 2.1 and later, the health check endpoint has changed. You can use `/_health` on proxy hosts with a result of either a 200 OK to indicate healthy or a 502 Bad Gateway response for unhealthy. A healthy response also means that internal routing tables in the proxy are valid and initialized, but not necessarily up-to-date. +For {{ece}} 2.1 and later, the health check endpoint has changed. You can use `/_health` on proxy hosts with a result of either a 200 OK to indicate healthy or a 502 Bad Gateway response for unhealthy. A healthy response also means that internal routing tables in the proxy are valid and initialized, but not necessarily up-to-date. ``` http://PROXY_ADDRESS:9200/_health diff --git a/deploy-manage/deploy/cloud-enterprise/ece-manage-capacity.md b/deploy-manage/deploy/cloud-enterprise/ece-manage-capacity.md index d7db12cfb1..5902c31c09 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-manage-capacity.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-manage-capacity.md @@ -1,11 +1,14 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-manage-capacity.html --- -# Manage your installation capacity [ece-manage-capacity] +# Manage your allocators capacity [ece-manage-capacity] -In ECE, every host is a runner. Depending on the size of your platform, runners can have [one or more roles](ece-roles.md): Coordinator, director, proxy, and allocator. While planning the capacity of your ECE installation, you have to properly size the capacity for all roles. However, the allocator role deserves particular attention, as it hosts the Elasticsearch, Kibana, and APM nodes, and the relevant services. +In {{ece}} (ECE), every host is a runner. Depending on the size of your platform, runners can have [one or more roles](ece-roles.md): Coordinator, director, proxy, and allocator. While planning the capacity of your ECE installation, you have to properly size the capacity for all roles. However, the allocator role deserves particular attention, as it hosts the Elasticsearch, Kibana, and APM nodes, and the relevant services. This section focuses on the allocator role, and explains how to plan its capacity in terms of memory, CPU, `processors` setting, and storage. @@ -69,18 +72,12 @@ Consider a 32GB deployment hosted on a 128GB allocator. If you use the default system service reservation, the CPU quota is 29%: -
-
-\$CPU quota = 32 / (128 * 0.85) = 29%\$ -
-
+* CPU quota = 32 / (128 * 0.85) = 29% + If you use 12GB Allocator system service reservation, the CPU quota is 28%: -
-
-\$CPU quota = 32 / (128 - 12) = 28%\$ -
-
+* CPU quota = 32 / (128 - 12) = 28% + Those percentages represent the upper limit of the % of the total CPU resources available in a given 100ms period. diff --git a/deploy-manage/deploy/cloud-enterprise/ece-networking-prereq.md b/deploy-manage/deploy/cloud-enterprise/ece-networking-prereq.md index 02d8024ac9..fa5ffd550a 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-networking-prereq.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-networking-prereq.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-networking-prereq.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/ece-roles.md b/deploy-manage/deploy/cloud-enterprise/ece-roles.md index 565387ceaa..241e35377f 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-roles.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-roles.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-roles.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/ece-software-prereq.md b/deploy-manage/deploy/cloud-enterprise/ece-software-prereq.md index 3ac08bad9f..84976f0c42 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-software-prereq.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-software-prereq.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-software-prereq.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/ece-sysconfig.md b/deploy-manage/deploy/cloud-enterprise/ece-sysconfig.md index 7815d902ae..0a038ef58d 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-sysconfig.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-sysconfig.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-sysconfig.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/ece-users-permissions.md b/deploy-manage/deploy/cloud-enterprise/ece-users-permissions.md index 8a0c7014c1..1720725b22 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-users-permissions.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-users-permissions.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-users-permissions.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/ece-wildcard-dns.md b/deploy-manage/deploy/cloud-enterprise/ece-wildcard-dns.md index 8cda2e9785..4755820873 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-wildcard-dns.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-wildcard-dns.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-wildcard-dns.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/enable-custom-endpoint-aliases.md b/deploy-manage/deploy/cloud-enterprise/enable-custom-endpoint-aliases.md index dbae739bd6..1fe7274782 100644 --- a/deploy-manage/deploy/cloud-enterprise/enable-custom-endpoint-aliases.md +++ b/deploy-manage/deploy/cloud-enterprise/enable-custom-endpoint-aliases.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configuring-deployment-aliases.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/fresh-installation-of-ece-using-podman-hosts-cloud.md b/deploy-manage/deploy/cloud-enterprise/fresh-installation-of-ece-using-podman-hosts-cloud.md index c41e865400..4bd3ea1534 100644 --- a/deploy-manage/deploy/cloud-enterprise/fresh-installation-of-ece-using-podman-hosts-cloud.md +++ b/deploy-manage/deploy/cloud-enterprise/fresh-installation-of-ece-using-podman-hosts-cloud.md @@ -1,6 +1,10 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-using-podman-cloud.html +navigation_title: Podman considerations --- # Fresh installation of ECE using Podman hosts cloud [ece-install-using-podman-cloud] diff --git a/deploy-manage/deploy/cloud-enterprise/identify-deployment-scenario.md b/deploy-manage/deploy/cloud-enterprise/identify-deployment-scenario.md index c25b3a8748..6a421ddb10 100644 --- a/deploy-manage/deploy/cloud-enterprise/identify-deployment-scenario.md +++ b/deploy-manage/deploy/cloud-enterprise/identify-deployment-scenario.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-deploy-scenario.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/install-ece-cloud.md b/deploy-manage/deploy/cloud-enterprise/install-ece-cloud.md index 501b8fa549..e67bdfa24b 100644 --- a/deploy-manage/deploy/cloud-enterprise/install-ece-cloud.md +++ b/deploy-manage/deploy/cloud-enterprise/install-ece-cloud.md @@ -1,9 +1,12 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-cloud.html --- -# Install ECE cloud [ece-install-cloud] +# Install ECE on a public cloud [ece-install-cloud] Choose the Elastic Cloud Enterprise deployment scenario that best fits your business needs: @@ -12,7 +15,6 @@ Choose the Elastic Cloud Enterprise deployment scenario that best fits your busi * [Deploy a large installation](deploy-large-installation-cloud.md): For deployments with significant overall search and indexing throughput. * [Deploy using Podman](fresh-installation-of-ece-using-podman-hosts-cloud.md): Fresh installation of ECE using Podman hosts. - - +For installations using Podman instead of Docker, refer to [](./fresh-installation-of-ece-using-podman-hosts-cloud.md) diff --git a/deploy-manage/deploy/cloud-enterprise/install-ece-on-additional-hosts.md b/deploy-manage/deploy/cloud-enterprise/install-ece-on-additional-hosts.md index 9d1506d83a..562f4a55c0 100644 --- a/deploy-manage/deploy/cloud-enterprise/install-ece-on-additional-hosts.md +++ b/deploy-manage/deploy/cloud-enterprise/install-ece-on-additional-hosts.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-installing-additional.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/install-ece-on-own-premises.md b/deploy-manage/deploy/cloud-enterprise/install-ece-on-own-premises.md index cf05d016b2..fcabc76764 100644 --- a/deploy-manage/deploy/cloud-enterprise/install-ece-on-own-premises.md +++ b/deploy-manage/deploy/cloud-enterprise/install-ece-on-own-premises.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-your-infra.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/install-ece-on-public-cloud.md b/deploy-manage/deploy/cloud-enterprise/install-ece-on-public-cloud.md index 36d0826217..6d217b74a2 100644 --- a/deploy-manage/deploy/cloud-enterprise/install-ece-on-public-cloud.md +++ b/deploy-manage/deploy/cloud-enterprise/install-ece-on-public-cloud.md @@ -1,27 +1,40 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-public.html --- # Install ECE on a Public Cloud [ece-install-public] -You can deploy ECE on any of the following cloud providers: +You can deploy {{ece}} (ECE) on any of the following cloud providers: * Amazon Web Services (AWS) * Google Cloud Platform (GCP) * Microsoft Azure -with one of the following operating systems: +To install ECE on a public cloud, follow these steps: -* [Ubuntu 20.04 LTS (Focal Fossa) and Ubuntu 22.04 LTS (Jammy Jellyfish)](configure-host-ubuntu-cloud.md) -* [Red Hat Enterprise Linux (RHEL) 8 and 9](configure-host-rhel-cloud.md) -* [Rocky Linux 8 and 9](configure-host-rhel-cloud.md) -* [SUSE Linux Enterprise Server (SLES) 12 SP5 and 15](configure-host-suse-cloud.md) +1. Configure your hosts by following the appropriate guide for your operating system: -::::{important} -Cloud providers default provide automatic operating system patching for their virtual machines. We strongly recommend disabling this feature to avoid potential data loss and installation failure. All patching should be done via [Perform host maintenance](../../maintenance/ece/perform-ece-hosts-maintenance.md). -:::: + * [Ubuntu 20.04 LTS (Focal Fossa) and Ubuntu 22.04 LTS (Jammy Jellyfish)](configure-host-ubuntu-cloud.md) + * [Red Hat Enterprise Linux (RHEL) 8 and 9](configure-host-rhel-cloud.md) + * [Rocky Linux 8 and 9](configure-host-rhel-cloud.md) + * [SUSE Linux Enterprise Server (SLES) 12 SP5 and 15](configure-host-suse-cloud.md) + + ::::{important} + Cloud providers default provide automatic operating system patching for their virtual machines. We strongly recommend disabling this feature to avoid potential data loss and installation failure. All patching should be done through [Perform host maintenance](../../maintenance/ece/perform-ece-hosts-maintenance.md) instructions. + :::: +2. Follow the instructions for the the ECE deployment scenario that best fits your business needs: + * [Deploy a small installation](deploy-small-installation-cloud.md): For development, test, and small-scale use cases. + * [Deploy a medium installation](deploy-medium-installation-cloud.md): For many production setups. + * [Deploy a large installation](deploy-large-installation-cloud.md): For deployments with significant overall search and indexing throughput. + * [Deploy using Podman](fresh-installation-of-ece-using-podman-hosts-cloud.md): Fresh installation of ECE using Podman hosts. +::::{note} +For installations using Podman instead of Docker, refer to [Podman considerations](./fresh-installation-of-ece-using-podman-hosts-cloud.md) +:::: diff --git a/deploy-manage/deploy/cloud-enterprise/install-ece-onprem.md b/deploy-manage/deploy/cloud-enterprise/install-ece-onprem.md index a7f52b8cf4..a98bf3c3d5 100644 --- a/deploy-manage/deploy/cloud-enterprise/install-ece-onprem.md +++ b/deploy-manage/deploy/cloud-enterprise/install-ece-onprem.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-onprem.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/install.md b/deploy-manage/deploy/cloud-enterprise/install.md index 63076e6766..52276df438 100644 --- a/deploy-manage/deploy/cloud-enterprise/install.md +++ b/deploy-manage/deploy/cloud-enterprise/install.md @@ -1,14 +1,20 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-installing.html +navigation_title: Install ECE --- -# Install [ece-installing] +# Install Elastic Cloud Enterprise [ece-installing] -Before you start, make sure you [identify your deployment scenario](identify-deployment-scenario.md) and [prepare your hosts](prepare-environment.md). +Before you start, make sure to [identify your deployment scenario](identify-deployment-scenario.md) and follow all the sections referenced in [prepare your hosts](prepare-environment.md). You can get ECE up and running using the official bash script on a [public cloud](install-ece-on-public-cloud.md) or on [your own premises](install-ece-on-own-premises.md). Alternatively, you can install ECE with the [Ansible](alternative-install-ece-with-ansible.md) playbook. The ECE Ansible playbook is a community project, supported by Elastic, aimed at installing ECE at scale. +To install ECE in an air-gapped environment, refer to [](./air-gapped-install.md). + Once you have installed ECE, check some final [post-installation steps](post-installation-steps.md) to get ready for production. ::::{tip} diff --git a/deploy-manage/deploy/cloud-enterprise/manage-elastic-stack-versions.md b/deploy-manage/deploy/cloud-enterprise/manage-elastic-stack-versions.md index 746ad592be..f6af860e7d 100644 --- a/deploy-manage/deploy/cloud-enterprise/manage-elastic-stack-versions.md +++ b/deploy-manage/deploy/cloud-enterprise/manage-elastic-stack-versions.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-manage-elastic-stack.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/migrate-ece-on-podman-hosts-to-selinux-enforce.md b/deploy-manage/deploy/cloud-enterprise/migrate-ece-on-podman-hosts-to-selinux-enforce.md index d1e5caf200..8f2045aebf 100644 --- a/deploy-manage/deploy/cloud-enterprise/migrate-ece-on-podman-hosts-to-selinux-enforce.md +++ b/deploy-manage/deploy/cloud-enterprise/migrate-ece-on-podman-hosts-to-selinux-enforce.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-migrate-to-selinux-in-enforcing-mode.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/migrate-ece-to-podman-hosts.md b/deploy-manage/deploy/cloud-enterprise/migrate-ece-to-podman-hosts.md index 8867cc8f58..3b8b8a3128 100644 --- a/deploy-manage/deploy/cloud-enterprise/migrate-ece-to-podman-hosts.md +++ b/deploy-manage/deploy/cloud-enterprise/migrate-ece-to-podman-hosts.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-migrate-to-podman.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/post-installation-steps.md b/deploy-manage/deploy/cloud-enterprise/post-installation-steps.md index ee7bafd326..ac8f31d011 100644 --- a/deploy-manage/deploy/cloud-enterprise/post-installation-steps.md +++ b/deploy-manage/deploy/cloud-enterprise/post-installation-steps.md @@ -1,26 +1,40 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-getting-started-post-installation.html --- # Post-installation steps [ece-getting-started-post-installation] -After your Elastic Cloud Enterprise installation is up, some additional steps might be required: +After your Elastic Cloud Enterprise installation is up, some additional steps might be required. For a complete list of configurable features in ECE, refer to [](./configure.md). + +* Add your own [load balancer](./ece-load-balancers.md). Load balancers are user supplied and we do not currently provide configuration steps for you. + +* In production systems, add your own [Cloud UI and Proxy certificates](../../security/secure-your-elastic-cloud-enterprise-installation/manage-security-certificates.md) to enable secure connections over HTTPS. The proxy certificate must be a wildcard certificate signed for the needed DNS records of your domain. + + ::::{note} + The default DNS resolution provided by Elastic is not intended for production use. Refer to [](./ece-wildcard-dns.md) for more information. + + If you intend to use [custom endpoint aliases](./enable-custom-endpoint-aliases.md) functionality, ensure you add the necessary Subject Alternative Name (SAN) entries to the proxy certificate. + :::: + +* Optionally, if you want the deployment endpoint links and Single-sign on to work with your domain name, configure it as the **deployment domain name** in the Platform → Settings section of the [Cloud UI](./log-into-cloud-ui.md). The domain name is used to generate the endpoint URLs and must align with your Proxy certificate and DNS record. + + ::::{tip} + For example, if your proxy certificate is signed for `*.elastic-cloud-enterprise.example.com` and you have a wildcard DNS register pointing `*.elastic-cloud-enterprise.example.com` to your load balancer, you should configure `elastic-cloud-enterprise.example.com` as the **deployment domain name** in Platform → Settings. Refer to [](./change-endpoint-urls.md) for more details. + :::: + +* If you received a license from Elastic, [manage the licenses](../../license/manage-your-license-in-ece.md) for your Elastic Cloud Enterprise installation. -* Add your own load balancer. Load balancers are user supplied and we do not currently provide configuration steps for you. -* [Add more capacity](../../maintenance/ece/scale-out-installation.md) to your Elastic Cloud Enterprise installation, [resize your deployment](resize-deployment.md), [upgrade to a newer Elasticsearch version](../../upgrade/deployment-or-cluster.md), and [add some plugins](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch-plugins/cloud-enterprise/ece-add-plugins.md). -* [Configure ECE system deployments](system-deployments-configuration.md) to ensure a highly available and resilient setup. -* [Configure ECE for deployment templates](configure-deployment-templates.md) to indicate what kind of hardware you have available for Elastic Stack deployments. -* [Install your security certificates](../../security/secure-your-elastic-cloud-enterprise-installation/manage-security-certificates.md) to enable TLS/SSL authentication for secure connections over HTTPS. -* [Add a snapshot repository](../../tools/snapshot-and-restore/cloud-enterprise.md) to enable regular backups of your Elasticsearch clusters. * [Add more platform users](../../users-roles/cloud-enterprise-orchestrator/manage-users-roles.md) with role-based access control. + +* [Add a snapshot repository](../../tools/snapshot-and-restore/cloud-enterprise.md) to enable regular backups of your Elasticsearch clusters. + * Consider enabling encryption-at-rest (EAR) on your hosts. -* [Set up traffic filters](../../security/traffic-filtering.md) to restrict traffic to your deployment to only trusted IP addresses or VPCs. -* Learn how to work around host maintenance or a host failure by [moving nodes off of an allocator](../../maintenance/ece/move-nodes-instances-from-allocators.md). -* If you received a license from Elastic, [manage the licenses](../../license/manage-your-license-in-ece.md) for your Elastic Cloud Enterprise installation. -::::{warning} -During installation, the system generates secrets that are placed into the `/mnt/data/elastic/bootstrap-state/bootstrap-secrets.json` secrets file, unless you passed in a different path with the --host-storage-path parameter. Keep the information in the `bootstrap-secrets.json` file secure by removing it from its default location and placing it into a secure storage location. -:::: +* To start creating {{es}} deployments, refer to [](./working-with-deployments.md). +* Learn about common maintenance activities—such as adding capacity, applying OS patches, and addressing host failures--at [](../../maintenance/ece.md). diff --git a/deploy-manage/deploy/cloud-enterprise/prepare-environment.md b/deploy-manage/deploy/cloud-enterprise/prepare-environment.md index 3f30d671b2..031df21a84 100644 --- a/deploy-manage/deploy/cloud-enterprise/prepare-environment.md +++ b/deploy-manage/deploy/cloud-enterprise/prepare-environment.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-prereqs.html --- @@ -17,6 +20,7 @@ To prepare your hosts for their ECE installation, the following prerequisites ** * [Hardware prerequisites](ece-hardware-prereq.md) * [Software prerequisites](ece-software-prereq.md) +* [System configuration prerequisites](ece-sysconfig.md) * [Networking prerequisites](ece-networking-prereq.md) * [Users and permissions prerequisites](ece-users-permissions.md) diff --git a/deploy-manage/deploy/cloud-enterprise/statistics-collected-by-cloud-enterprise.md b/deploy-manage/deploy/cloud-enterprise/statistics-collected-by-cloud-enterprise.md index a61fd6031f..a14f02ae68 100644 --- a/deploy-manage/deploy/cloud-enterprise/statistics-collected-by-cloud-enterprise.md +++ b/deploy-manage/deploy/cloud-enterprise/statistics-collected-by-cloud-enterprise.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-phone-home.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/system-deployments-configuration.md b/deploy-manage/deploy/cloud-enterprise/system-deployments-configuration.md index 6850273b4b..936e214e42 100644 --- a/deploy-manage/deploy/cloud-enterprise/system-deployments-configuration.md +++ b/deploy-manage/deploy/cloud-enterprise/system-deployments-configuration.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-system-clusters-configuration.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md b/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md index f4d1717623..41af26fb38 100644 --- a/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md +++ b/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md @@ -30,4 +30,7 @@ The documentation team is working to combine content pulled from the following p * [/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) \ No newline at end of file +* [/raw-migrated-files/cloud/cloud-enterprise/ece-monitoring-deployments.md](/raw-migrated-files/cloud/cloud-enterprise/ece-monitoring-deployments.md) + +% 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. diff --git a/deploy-manage/toc.yml b/deploy-manage/toc.yml index fb6a2bdac7..70175151d8 100644 --- a/deploy-manage/toc.yml +++ b/deploy-manage/toc.yml @@ -130,10 +130,10 @@ toc: - file: deploy/cloud-enterprise/ece-software-prereq.md - file: deploy/cloud-enterprise/ece-sysconfig.md - file: deploy/cloud-enterprise/ece-networking-prereq.md + - file: deploy/cloud-enterprise/ece-users-permissions.md - file: deploy/cloud-enterprise/ece-ha.md - file: deploy/cloud-enterprise/ece-roles.md - file: deploy/cloud-enterprise/ece-load-balancers.md - - file: deploy/cloud-enterprise/ece-users-permissions.md - file: deploy/cloud-enterprise/ece-jvm.md - file: deploy/cloud-enterprise/ece-wildcard-dns.md - file: deploy/cloud-enterprise/ece-manage-capacity.md diff --git a/raw-migrated-files/cloud/cloud-enterprise/ece-install-offline.md b/raw-migrated-files/cloud/cloud-enterprise/ece-install-offline.md deleted file mode 100644 index a8af0e872c..0000000000 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-install-offline.md +++ /dev/null @@ -1,23 +0,0 @@ -# Install ECE offline [ece-install-offline] - -Installing ECE on hosts without internet access is commonly referred to as an *offline* or *air-gapped installation*. Before you start, you must: - -* Download the Elasticsearch and Kibana images and installation script from Elastic and load them on your hosts, or push them to your private Docker registry. You need to download both the Elastic Stack pack and the Docker images for the same version. - - ``` - The versioning of Elasticsearch and Kibana is synchronized and versions where the major, minor, and patch levels match can be used together. Differences in build versions indicated by a dash do not affect compatibility. - ``` - -* Be part of the `docker` group to run the installation script. You should not install Elastic Cloud Enterprise as the `root` user. -* Set up your [wildcard DNS record](../../../deploy-manage/deploy/cloud-enterprise/ece-wildcard-dns.md). -* Set up and run a local copy of the Elastic Package Repository, otherwise your deployments with APM server and Elastic agent won’t work. Refer to the [Running EPR in airgapped environments](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/air-gapped.md#air-gapped-diy-epr) documentation. -* Deployment End-of-life (EOL) information relies on the connection to [https://www.elastic.co/support/eol.json](https://www.elastic.co/support/eol.json). If EOL information is updated, Elastic may require you to reconnect to [https://www.elastic.co/support/eol.json](https://www.elastic.co/support/eol.json) over the Internet to get this information reflected. - -When you are ready to install ECE, you can proceed: - -* [With your private Docker registry](../../../deploy-manage/deploy/cloud-enterprise/ece-install-offline-with-registry.md) -* [Without your private Docker registry](../../../deploy-manage/deploy/cloud-enterprise/ece-install-offline-no-registry.md) - - - - diff --git a/raw-migrated-files/toc.yml b/raw-migrated-files/toc.yml index bc2700e831..bf1bfff7d4 100644 --- a/raw-migrated-files/toc.yml +++ b/raw-migrated-files/toc.yml @@ -46,7 +46,6 @@ toc: - file: cloud/cloud-enterprise/ece-getting-started-search-use-cases-node-logs.md - file: cloud/cloud-enterprise/ece-getting-started-search-use-cases-python-logs.md - file: cloud/cloud-enterprise/ece-ingest-guides.md - - file: cloud/cloud-enterprise/ece-install-offline.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 From f2615a1c64104f1df871a170aa4b8ab31cfe5f2c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Tue, 25 Feb 2025 14:32:25 +0100 Subject: [PATCH 02/29] removed incorrect link to raw content --- deploy-manage/deploy/self-managed/air-gapped-install.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/deploy-manage/deploy/self-managed/air-gapped-install.md b/deploy-manage/deploy/self-managed/air-gapped-install.md index 37a2fb7930..e3f666f9aa 100644 --- a/deploy-manage/deploy/self-managed/air-gapped-install.md +++ b/deploy-manage/deploy/self-managed/air-gapped-install.md @@ -1,7 +1,6 @@ --- mapped_urls: - https://www.elastic.co/guide/en/elastic-stack/current/air-gapped-install.html - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-offline.html --- # Air gapped install @@ -83,4 +82,3 @@ $$$air-gapped-kibana-product-documentation$$$ **This page is a work in progress.** The documentation team is working to combine content pulled from the following pages: * [/raw-migrated-files/stack-docs/elastic-stack/air-gapped-install.md](/raw-migrated-files/stack-docs/elastic-stack/air-gapped-install.md) -* [/raw-migrated-files/cloud/cloud-enterprise/ece-install-offline.md](/raw-migrated-files/cloud/cloud-enterprise/ece-install-offline.md) \ No newline at end of file From e43bec761438082cdeb50def31688fbe53919425 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Wed, 26 Feb 2025 11:37:16 +0100 Subject: [PATCH 03/29] ECE install structure changed and duplicate content removed --- .../cloud-enterprise/air-gapped-install.md | 2 +- .../configure-host-rhel-onprem.md | 346 ----------------- ...t-rhel-cloud.md => configure-host-rhel.md} | 20 +- .../configure-host-suse-onprem.md | 347 ------------------ ...t-suse-cloud.md => configure-host-suse.md} | 25 +- .../configure-host-ubuntu-onprem.md | 312 ---------------- ...untu-cloud.md => configure-host-ubuntu.md} | 21 +- .../configure-operating-system-cloud.md | 20 - ...nprem.md => configure-operating-system.md} | 15 +- .../deploy-an-orchestrator.md | 9 +- .../deploy-large-installation-onprem.md | 96 ----- ...-cloud.md => deploy-large-installation.md} | 3 +- .../deploy-medium-installation-onprem.md | 78 ---- ...cloud.md => deploy-medium-installation.md} | 3 +- .../deploy-small-installation-onprem.md | 73 ---- ...-cloud.md => deploy-small-installation.md} | 5 +- .../deploy/cloud-enterprise/ece-jvm.md | 6 +- ...lation-of-ece-using-podman-hosts-onprem.md | 84 ----- ...installation-of-ece-using-podman-hosts.md} | 9 +- .../identify-deployment-scenario.md | 8 +- .../cloud-enterprise/install-ece-cloud.md | 20 - .../install-ece-on-own-premises.md | 31 -- .../install-ece-on-public-cloud.md | 40 -- .../cloud-enterprise/install-ece-onprem.md | 21 -- .../install-ece-procedures.md | 17 + .../deploy/cloud-enterprise/install.md | 49 ++- .../migrate-ece-to-podman-hosts.md | 2 +- deploy-manage/toc.yml | 35 +- .../minio-on-premise-repository.md | 2 +- .../troubleshooting-container-engines.md | 2 +- 30 files changed, 135 insertions(+), 1566 deletions(-) delete mode 100644 deploy-manage/deploy/cloud-enterprise/configure-host-rhel-onprem.md rename deploy-manage/deploy/cloud-enterprise/{configure-host-rhel-cloud.md => configure-host-rhel.md} (92%) delete mode 100644 deploy-manage/deploy/cloud-enterprise/configure-host-suse-onprem.md rename deploy-manage/deploy/cloud-enterprise/{configure-host-suse-cloud.md => configure-host-suse.md} (91%) delete mode 100644 deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu-onprem.md rename deploy-manage/deploy/cloud-enterprise/{configure-host-ubuntu-cloud.md => configure-host-ubuntu.md} (95%) delete mode 100644 deploy-manage/deploy/cloud-enterprise/configure-operating-system-cloud.md rename deploy-manage/deploy/cloud-enterprise/{configure-operating-system-onprem.md => configure-operating-system.md} (56%) delete mode 100644 deploy-manage/deploy/cloud-enterprise/deploy-large-installation-onprem.md rename deploy-manage/deploy/cloud-enterprise/{deploy-large-installation-cloud.md => deploy-large-installation.md} (97%) delete mode 100644 deploy-manage/deploy/cloud-enterprise/deploy-medium-installation-onprem.md rename deploy-manage/deploy/cloud-enterprise/{deploy-medium-installation-cloud.md => deploy-medium-installation.md} (97%) delete mode 100644 deploy-manage/deploy/cloud-enterprise/deploy-small-installation-onprem.md rename deploy-manage/deploy/cloud-enterprise/{deploy-small-installation-cloud.md => deploy-small-installation.md} (96%) delete mode 100644 deploy-manage/deploy/cloud-enterprise/fresh-installation-of-ece-using-podman-hosts-onprem.md rename deploy-manage/deploy/cloud-enterprise/{fresh-installation-of-ece-using-podman-hosts-cloud.md => fresh-installation-of-ece-using-podman-hosts.md} (83%) delete mode 100644 deploy-manage/deploy/cloud-enterprise/install-ece-cloud.md delete mode 100644 deploy-manage/deploy/cloud-enterprise/install-ece-on-own-premises.md delete mode 100644 deploy-manage/deploy/cloud-enterprise/install-ece-on-public-cloud.md delete mode 100644 deploy-manage/deploy/cloud-enterprise/install-ece-onprem.md create mode 100644 deploy-manage/deploy/cloud-enterprise/install-ece-procedures.md diff --git a/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md b/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md index 87c8bc38e9..b98df8c8db 100644 --- a/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md +++ b/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md @@ -17,7 +17,7 @@ Installing ECE on hosts without internet access is commonly referred to as an *o Before you start, you must: * Follow [](./prepare-environment.md) steps as you would for other installation methods, except that outgoing internet connections for downloading Docker images are not required. -* [Configure your operating system](./configure-operating-system-onprem.md). +* [Configure your operating system](./configure-operating-system.md). * Be part of the `docker` group to run the installation script. You should not install Elastic Cloud Enterprise as the `root` user. * Set up your [wildcard DNS record](./ece-wildcard-dns.md). * Set up and run a local copy of the Elastic Package Repository, otherwise your deployments with APM server and Elastic agent won’t work. Refer to the [Running EPR in air-gapped environments](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/air-gapped.md#air-gapped-diy-epr) documentation. diff --git a/deploy-manage/deploy/cloud-enterprise/configure-host-rhel-onprem.md b/deploy-manage/deploy/cloud-enterprise/configure-host-rhel-onprem.md deleted file mode 100644 index 558e533a41..0000000000 --- a/deploy-manage/deploy/cloud-enterprise/configure-host-rhel-onprem.md +++ /dev/null @@ -1,346 +0,0 @@ ---- -applies_to: - deployment: - ece: all -mapped_pages: - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-hosts-rhel-centos-onprem.html ---- - -# Configure host RHEL onprem [ece-configure-hosts-rhel-centos-onprem] - - -## Red Hat Enterprise Linux 8 (RHEL 8), 9 (RHEL 9), and Rocky Linux 8 and 9 [ece-setup-rhel8-podman-onprem] - -The following instructions show you how to prepare your hosts on Red Hat Enterprise Linux 8 (RHEL 8), 9 (RHEL 9), and Rocky Linux 8 and 9. - -* [Prerequisites](#ece-prerequisites-rhel8-onprem) -* [Configure the host](#ece-configure-hosts-rhel8-podman-onprem) - - -### Prerequisites [ece-prerequisites-rhel8-onprem] - -Create a RHEL 8 (the version must be >= 8.5, but <9), RHEL 9, Rocky Linux 8, or Rocky Linux 9 instance. - -* For RHEL 8, follow your internal guidelines to add a vanilla RHEL 8 instance to your environment. Note that the version must be >= 8.5, but <9. - -Verify that required traffic is allowed. - - -### Configure the host [ece-configure-hosts-rhel8-podman-onprem] - -1. Install the OS packages `lvm2`, `iptables`, `sysstat`, and `net-tools` by executing: - - ```sh - sudo dnf install lvm2 iptables sysstat net-tools <1> - ``` - - 1. The ECE diagnostic script requires `net-tools`.
- - - ::::{note} - For RHEL 9 and Rocky Linux 9, also install the `containernetworking-plugins` package using:
- - ```sh - sudo dnf -y install containernetworking-plugins - ``` - - :::: - -2. Remove Docker and previously installed podman packages (if previously installed). - - ```sh - sudo dnf remove docker docker-ce podman podman-remote containerd.io - ``` - -3. As a sudoers user, edit the `/etc/selinux/config` file: - - 1. If you are not using SELinux, set it to permissive mode: - - ```text - SELINUX=permissive - ``` - - 2. If you are using SELinux, set it to enforcing mode: - - ::::{note} - Avoid customizing the host Docker path `/mnt/data/docker` when using SELinux. Otherwise the ECE installer script needs to be adjusted. - :::: - - - ```text - SELINUX=enforcing - ``` - -4. Install podman: - - * For RHEL 8 and Rocky Linux, install version `4.*`. - - ```sh - sudo dnf install podman-4.* podman-remote-4.* - ``` - - * For RHEL 9, install the latest available version `4.*` using dnf. - - ```sh - sudo dnf install podman-4.* podman-remote-4.* - ``` - -5. [This step is for RHEL 9 and Rocky Linux 9 only] Switch the network stack from Netavark to CNI: - - 1. If the */etc/containers/containers.conf* file does not exist, copy the */usr/share/containers/containers.conf* file to the */etc/containers/* directory (for example, using `cp /usr/share/containers/containers.conf /etc/containers/`). - 2. Open the */etc/containers/containers.conf* file. Navigate to the **network** section and make sure that the **network_backend** setting is set to `cni`. - 3. Reboot the system (`reboot`). - 4. Check that the network stack has changed to `cni`:
- - ```sh - cat /etc/containers/containers.conf - [...] - [network] - network_backend="cni" - [...] - ``` - -6. If podman requires a proxy in your infrastructure setup, modify the `/usr/share/containers/containers.conf` file and add the `HTTP_PROXY` and `HTTPS_PROXY` environment variables in the [engine] section. Please note that multiple env variables in that configuration file exists — use the one in the [engine] section. - - Example: - - ```text - [engine] - env = ["HTTP_PROXY=http://{proxy-ip}:{proxy-port}", "HTTPS_PROXY=http://{proxy-ip}:{proxy-port}"] - ``` - -7. Reload systemd configuration - - ```sh - sudo systemctl daemon-reload - ``` - -8. Create OS groups, if they do not exist yet - - Reference: [Users and permissions](ece-users-permissions.md) - - ```sh - sudo groupadd elastic - sudo groupadd podman - ``` - -9. Add user `elastic` to the `podman` group - - Reference: [Users and permissions](ece-users-permissions.md) - - ```sh - sudo useradd -g "elastic" -G "podman" elastic - ``` - -10. As a sudoers user, add the following line to /etc/sudoers.d/99-ece-users - - Reference: [Users and permissions](ece-users-permissions.md) - - ```text - elastic ALL=(ALL) NOPASSWD:ALL - ``` - -11. Add the required options to the kernel boot arguments - - ```sh - sudo /sbin/grubby --update-kernel=ALL --args='cgroup_enable=memory cgroup.memory=nokmem swapaccount=1' - ``` - -12. Create the directory - - ```sh - sudo mkdir -p /etc/systemd/system/podman.socket.d - ``` - -13. As a sudoers user, create the file `/etc/systemd/system/podman.socket.d/podman.conf` with the following content. Set the correct ownership and permission. - - ::::{important} - Both `ListenStream=` and `ListenStream=/var/run/docker.sock` parameters are required! - :::: - - - File content: - - ```text - [Socket] - ListenStream= - ListenStream=/var/run/docker.sock - SocketMode=770 - SocketUser=elastic - SocketGroup=podman - ``` - - File ownership and permission: - - ```sh - sudo chown root:root /etc/systemd/system/podman.socket.d/podman.conf - sudo chmod 0644 /etc/systemd/system/podman.socket.d/podman.conf - ``` - -14. As a sudoers user, create the (text) file `/usr/bin/docker` with the following content. Verify that the regular double quotes in the text file are used (ASCII code Hex 22) - - ```text - #!/bin/bash - podman-remote --url unix:///var/run/docker.sock "$@" - ``` - -15. Set the file permissions on `/usr/bin/docker` - - ```sh - sudo chmod 0755 /usr/bin/docker - ``` - -16. As a sudoers user, add the following two lines to section `[storage]` in the file `/etc/containers/storage.conf`. Verify that those parameters are only defined once. Either remove or comment out potentially existing parameters. - - ::::{note} - Avoid customizing the host Docker path `/mnt/data/docker` when using SELinux. Otherwise the ECE installer script needs to be adjusted. - :::: - - - ```text - runroot = "/mnt/data/docker/runroot/" - graphroot = "/mnt/data/docker" - ``` - -17. Enable podman so that itself and running containers start automatically after a reboot - - ```sh - sudo systemctl enable podman.service - sudo systemctl enable podman-restart.service - ``` - -18. Enable the `overlay` kernel module (check [Use the OverlayFS storage driver](https://docs.docker.com/storage/storagedriver/overlayfs-driver/)) that the Podman `overlay` storage driver uses (check [Working with the Container Storage library and tools in Red Hat Enterprise Linux](https://www.redhat.com/en/blog/working-container-storage-library-and-tools-red-hat-enterprise-linux#:~:text=Storage%20Configuration)). - - In the Docker world there are two overlay drivers, overlay and overlay2. Today most users use the overlay2 driver, so we just use that one, and called it overlay. Refer also to [Use the OverlayFS storage driver](https://docs.docker.com/storage/storagedriver/overlayfs-driver/). - - ```sh - echo "overlay" | sudo tee -a /etc/modules-load.d/overlay.conf - ``` - -19. Format the additional data partition - - ```sh - sudo mkfs.xfs /dev/nvme1n1 - ``` - -20. Create the `/mnt/data/` directory used as a mount point - - ```sh - sudo install -o elastic -g elastic -d -m 700 /mnt/data - ``` - -21. As a sudoers user, modify the entry for the XFS volume in the `/etc/fstab` file to add `pquota,prjquota`. The default filesystem path used by Elastic Cloud Enterprise is `/mnt/data`. - - ::::{note} - Replace `/dev/nvme1n1` in the following example with the corresponding device on your host, and add this example configuration as a single line to `/etc/fstab`. - :::: - - - ```text - /dev/nvme1n1 /mnt/data xfs defaults,nofail,x-systemd.automount,prjquota,pquota 0 2 - ``` - -22. Restart the local-fs target - - ```sh - sudo systemctl daemon-reload - sudo systemctl restart local-fs.target - ``` - -23. Set the permissions on the newly mounted device - - ```sh - ls /mnt/data - sudo chown elastic:elastic /mnt/data - ``` - -24. Create the `/mnt/data/docker` directory for the Docker service storage - - ::::{note} - Avoid customizing the host Docker path `/mnt/data/docker` when using SELinux. Otherwise the ECE installer script needs to be adjusted. - :::: - - - ```sh - sudo install -o elastic -g elastic -d -m 700 /mnt/data/docker - ``` - -25. If you want to use FirewallD, please ensure you meet the [networking prerequisites](ece-networking-prereq.md). Otherwise, you can disable it with: - - ```sh - sudo systemctl disable firewalld - ``` - - ::::{note} - If FirewallD does not exist on your VM, you can skip this step. - :::: - -26. Configure kernel parameters - - ```sh - cat <" - } - } - } - ``` - -30. Restart the podman service by running this command: - - ```sh - sudo systemctl daemon-reload - sudo systemctl restart podman - ``` - -31. Reboot the RHEL host - - ```sh - sudo reboot - ``` diff --git a/deploy-manage/deploy/cloud-enterprise/configure-host-rhel-cloud.md b/deploy-manage/deploy/cloud-enterprise/configure-host-rhel.md similarity index 92% rename from deploy-manage/deploy/cloud-enterprise/configure-host-rhel-cloud.md rename to deploy-manage/deploy/cloud-enterprise/configure-host-rhel.md index 1c8bae7f45..9e650bbffd 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-host-rhel-cloud.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-host-rhel.md @@ -4,31 +4,29 @@ applies_to: ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-hosts-rhel-centos-cloud.html + - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-hosts-rhel-centos-onprem.html --- -# Configure host RHEL cloud [ece-configure-hosts-rhel-centos-cloud] +# Configure host RHEL cloud [ece-configure-hosts-rhel-centos] -## Red Hat Enterprise Linux 8 (RHEL 8), 9 (RHEL 9), and Rocky Linux 8 and 9 [ece-setup-rhel8-podman-cloud] +## Red Hat Enterprise Linux 8 (RHEL 8), 9 (RHEL 9), and Rocky Linux 8 and 9 [ece-setup-rhel8-podman] The following instructions show you how to prepare your hosts on Red Hat Enterprise Linux 8 (RHEL 8), 9 (RHEL 9), and Rocky Linux 8 and 9. -* [Prerequisites](#ece-prerequisites-rhel8-cloud) -* [Configure the host](#ece-configure-hosts-rhel8-podman-cloud) +* [Prerequisites](#ece-prerequisites-rhel8) +* [Configure the host](#ece-configure-hosts-rhel8-podman) -### Prerequisites [ece-prerequisites-rhel8-cloud] +### Prerequisites [ece-prerequisites-rhel8] -Create a RHEL 8 (the version must be >= 8.5, but <9), RHEL 9, Rocky Linux 8, or Rocky Linux 9 VM. +Follow your internal guidelines to create a RHEL 8 (the version must be >= 8.5), RHEL 9, Rocky Linux 8, or Rocky Linux 9 server or VM in your environment. -* For RHEL 8, follow your internal guidelines to add a vanilla RHEL 8 VM to your environment. Note that the version must be >= 8.5, but <9. - -Verify that required traffic is allowed. Check the [Networking prerequisites](ece-networking-prereq.md) and [Google Cloud Platform (GCP)](/deploy-manage/deploy/cloud-enterprise/prepare-environment.md) guidelines for a list of ports that need to be open. The technical configuration highly depends on the underlying infrastructure. +Verify that required traffic is allowed. Check the [Networking prerequisites](ece-networking-prereq.md) for a list of ports that need to be open. The technical configuration depends on the underlying infrastructure. **Example:** For AWS, allowing traffic between hosts is implemented using security groups. - -### Configure the host [ece-configure-hosts-rhel8-podman-cloud] +### Configure the host [ece-configure-hosts-rhel8-podman] 1. Install the OS packages `lvm2`, `iptables`, `sysstat`, and `net-tools` by executing: diff --git a/deploy-manage/deploy/cloud-enterprise/configure-host-suse-onprem.md b/deploy-manage/deploy/cloud-enterprise/configure-host-suse-onprem.md deleted file mode 100644 index 1c3d880093..0000000000 --- a/deploy-manage/deploy/cloud-enterprise/configure-host-suse-onprem.md +++ /dev/null @@ -1,347 +0,0 @@ ---- -applies_to: - deployment: - ece: all -mapped_pages: - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-hosts-sles12-onprem.html ---- - -# Configure host SUSE onprem [ece-configure-hosts-sles12-onprem] - -The following instructions show you how to prepare your hosts on SLES 12 SP5 or 15. - -* [Install Docker](#ece-install-docker-sles12-onprem) -* [Set up XFS on SLES](#ece-xfs-setup-sles12-onprem) -* [Update the configurations settings](#ece-update-config-sles-onprem) -* [Configure the Docker daemon options](#ece-configure-docker-daemon-sles12-onprem) - -If you want to install Elastic Cloud Enterprise on your own hosts, the steps for preparing your hosts can take a bit of time. There are two ways you can approach this: - -* **Think like a minimalist**: [Install the correct version of Docker](#ece-install-docker-sles12-onprem) on hosts that meet the [prerequisites](prepare-environment.md) for Elastic Cloud Enterprise, then skip ahead and [install Elastic Cloud Enterprise](install.md). Be aware that some checks during the installation can fail with this approach, which will mean doing further host preparation work before retrying the installation. -* **Cover your bases**: If you want to make absolutely sure that your installation of Elastic Cloud Enterprise can succeed on hosts that meet the [prerequisites](prepare-environment.md), or if any of the checks during the installation failed previously, run through the full preparation steps in this section and then and [install Elastic Cloud Enterprise](install.md). You’ll do a bit more work now, but life will be simpler later on. - -Regardless of which approach you take, the steps in this section need to be performed on every host that you want to use with Elastic Cloud Enterprise. - - -## Install Docker [ece-install-docker-sles12-onprem] - -::::{important} -Make sure to use a combination of Linux distribution and Docker version that is supported, following our official [Support matrix](https://www.elastic.co/support/matrix#elastic-cloud-enterprise). Using unsupported combinations can cause multiple issues with you ECE environment, such as failures to create system deployments, to upgrade workload deployments, proxy timeouts, and more. -:::: - - -1. Remove Docker and previously installed podman packages (if previously installed). - - ```sh - sudo zypper remove -y docker docker-ce podman podman-remote - ``` - -2. Update packages to the latest available versions - - ```sh - sudo zypper refresh - sudo zypper update -y - ``` - -3. Install Docker and other required packages: - - * For SLES 12: - - ```sh - sudo zypper install -y docker=24.0.7_ce-98.109.3 - ``` - - * For SLES 15: - - ```sh - sudo zypper install -y curl device-mapper lvm2 net-tools docker=24.0.7_ce-150000.198.2 net-tools - ``` - -4. Disable nscd, as it interferes with Elastic’s services: - - ```sh - sudo systemctl stop nscd - sudo systemctl disable nscd - ``` - - - -## Set up OS groups and user [ece_set_up_os_groups_and_user_2] - -1. If they don’t already exist, create the following OS groups: - - ```sh - sudo groupadd elastic - sudo groupadd docker - ``` - -2. Add the user to these groups: - - ```sh - sudo usermod -aG elastic,docker $USER - ``` - - - -## Set up XFS on SLES [ece-xfs-setup-sles12-onprem] - -XFS is required to support disk space quotas for Elasticsearch data directories. Some Linux distributions such as RHEL and Rocky Linux already provide XFS as the default file system. On SLES 12 and 15, you need to set up an XFS file system and have quotas enabled. - -Disk space quotas set a limit on the amount of disk space an Elasticsearch cluster node can use. Currently, quotas are calculated by a static ratio of 1:32, which means that for every 1 GB of RAM a cluster is given, a cluster node is allowed to consume 32 GB of disk space. - -::::{note} -Using LVM, `mdadm`, or a combination of the two for block device management is possible, but the configuration is not covered here, nor is it provided as part of supporting Elastic Cloud Enterprise. -:::: - - -::::{important} -You must use XFS and have quotas enabled on all allocators, otherwise disk usage won’t display correctly. -:::: - - -**Example:** Set up XFS on a single, pre-partitioned block device named `/dev/xvdg1`. Replace `/dev/xvdg1` in the following example with the corresponding device on your host. - -1. Format the partition: - - ```sh - sudo mkfs.xfs /dev/xvdg1 - ``` - -2. Create the `/mnt/data/` directory as a mount point: - - ```sh - sudo install -o $USER -g elastic -d -m 700 /mnt/data - ``` - -3. Add an entry to the `/etc/fstab` file for the new XFS volume. The default filesystem path used by Elastic Cloud Enterprise is `/mnt/data`. - - ```sh - /dev/xvdg1 /mnt/data xfs defaults,pquota,prjquota,x-systemd.automount 0 0 - ``` - -4. Regenerate the mount files: - - ```sh - sudo mount -a - ``` - - - -## Update the configurations settings [ece-update-config-sles-onprem] - -1. Stop the Docker service: - - ```sh - sudo systemctl stop docker - ``` - -2. Enable cgroup accounting for memory and swap space. - - 1. In the `/etc/default/grub` file, ensure that the `GRUB_CMDLINE_LINUX=` variable includes these values: - - ```sh - cgroup_enable=memory swapaccount=1 cgroup.memory=nokmem - ``` - - 2. Update your Grub configuration: - - ```sh - sudo update-bootloader - ``` - -3. Configure kernel parameters - - ```sh - cat <" - } - } - } - ``` - -6. If you did not create the mount point earlier (if you did not set up XFS), create the `/mnt/data/` directory as a mount point: - - ```sh - sudo install -o $USER -g elastic -d -m 700 /mnt/data - ``` - -7. If you [set up a new device with XFS](#ece-xfs-setup-sles12-onprem) earlier: - - 1. Mount the block device (change the device name if you use a different device than `/dev/xvdg1`): - - ```sh - sudo mount /dev/xvdg1 - ``` - - 2. Set the permissions on the newly mounted device: - - ```sh - sudo chown $USER:elastic /mnt/data - ``` - -8. Create the `/mnt/data/docker` directory for the Docker service storage: - - ```sh - sudo install -o $USER -g elastic -d -m 700 /mnt/data/docker - ``` - - - -## Configure the Docker daemon [ece-configure-docker-daemon-sles12-onprem] - -1. Edit `/etc/docker/daemon.json`, and make sure that the following configuration values are present:
- - ```json - { - "storage-driver": "overlay2", - "bip":"172.17.42.1/16", - "icc": false, - "log-driver": "json-file", - "log-opts": { - "max-size": "500m", - "max-file": "10" - }, - "data-root": "/mnt/data/docker" - } - ``` - -2. The user installing {{ece}} must have a User ID (UID) and Group ID (GID) of 1000 or higher. Make sure that the GID matches the ID of the `elastic`` group created earlier (likely to be 1000). You can set this using the following command: - - ```sh - sudo usermod -g $USER - ``` - -3. Apply the updated Docker daemon configuration: - - Reload the Docker daemon configuration: - - ```sh - sudo systemctl daemon-reload - ``` - - Restart the Docker service: - - ```sh - sudo systemctl restart docker - ``` - - Enable Docker to start on boot: - - ```sh - sudo systemctl enable docker - ``` - -4. Recommended: Tune your network settings. - - Create a `70-cloudenterprise.conf` file in the `/etc/sysctl.d/` file path that includes these network settings: - - ```sh - cat << SETTINGS | sudo tee /etc/sysctl.d/70-cloudenterprise.conf - net.ipv4.tcp_max_syn_backlog=65536 - net.core.somaxconn=32768 - net.core.netdev_max_backlog=32768 - net.ipv4.tcp_keepalive_time=1800 - net.netfilter.nf_conntrack_tcp_timeout_established=7200 - net.netfilter.nf_conntrack_max=262140 - SETTINGS - ``` - - 1. Ensure settings in /etc/sysctl.d/*.conf are applied on boot - - ```sh - SCRIPT_LOCATION="/var/lib/cloud/scripts/per-boot/00-load-sysctl-settings" - sudo sh -c "cat << EOF > ${SCRIPT_LOCATION} - #!/bin/bash - - set -x - - lsmod | grep ip_conntrack || modprobe ip_conntrack - - sysctl --system - EOF - " - sudo chmod +x ${SCRIPT_LOCATION} - ``` - -5. Reboot your system to ensure that all configuration changes take effect: - - ```sh - sudo reboot - ``` - -6. If the Docker daemon is not already running, start it: - - ```sh - sudo systemctl start docker - ``` - -7. After rebooting, verify that your Docker settings persist as expected: - - ```sh - sudo docker info | grep Root - ``` - - If the command returns `Docker Root Dir: /mnt/data/docker`, then your changes were applied successfully and persist as expected. - - If the command returns `Docker Root Dir: /var/lib/docker`, then you need to troubleshoot the previous configuration steps until the Docker settings are applied successfully before continuing with the installation process. For more information, check [Custom Docker daemon options](https://docs.docker.com/engine/admin/systemd/#/custom-docker-daemon-options) in the Docker documentation. - -8. Repeat these steps on other hosts that you want to use with Elastic Cloud Enterprise or follow the steps in the next section to start installing Elastic Cloud Enterprise. diff --git a/deploy-manage/deploy/cloud-enterprise/configure-host-suse-cloud.md b/deploy-manage/deploy/cloud-enterprise/configure-host-suse.md similarity index 91% rename from deploy-manage/deploy/cloud-enterprise/configure-host-suse-cloud.md rename to deploy-manage/deploy/cloud-enterprise/configure-host-suse.md index b41613a5b4..07301aaa06 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-host-suse-cloud.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-host-suse.md @@ -4,26 +4,27 @@ applies_to: ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-hosts-sles12-cloud.html + - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-hosts-sles12-onprem.html --- -# Configure host SUSE cloud [ece-configure-hosts-sles12-cloud] +# Configure host SUSE cloud [ece-configure-hosts-sles12] The following instructions show you how to prepare your hosts on SLES 12 SP5 or 15. -* [Install Docker](#ece-install-docker-sles12-cloud) -* [Set up XFS on SLES](#ece-xfs-setup-sles12-cloud) -* [Update the configurations settings](#ece-update-config-sles-cloud) -* [Configure the Docker daemon options](#ece-configure-docker-daemon-sles12-cloud) +* [Install Docker](#ece-install-docker-sles12) +* [Set up XFS on SLES](#ece-xfs-setup-sles12) +* [Update the configurations settings](#ece-update-config-sles) +* [Configure the Docker daemon options](#ece-configure-docker-daemon-sles12) If you want to install Elastic Cloud Enterprise on your own hosts, the steps for preparing your hosts can take a bit of time. There are two ways you can approach this: -* **Think like a minimalist**: [Install the correct version of Docker](#ece-install-docker-sles12-cloud) on hosts that meet the [prerequisites](prepare-environment.md) for Elastic Cloud Enterprise, then skip ahead and [install Elastic Cloud Enterprise](install.md). Be aware that some checks during the installation can fail with this approach, which will mean doing further host preparation work before retrying the installation. -* **Cover your bases**: If you want to make absolutely sure that your installation of Elastic Cloud Enterprise can succeed on hosts that meet the [prerequisites](prepare-environment.md), or if any of the checks during the installation failed previously, run through the full preparation steps in this section and then and [install Elastic Cloud Enterprise](install.md). You’ll do a bit more work now, but life will be simpler later on. +* **Think like a minimalist**: [Install the correct version of Docker](#ece-install-docker-sles12) on hosts that meet the [prerequisites](prepare-environment.md) for Elastic Cloud Enterprise, then skip ahead and [install Elastic Cloud Enterprise](install.md#install-ece). Be aware that some checks during the installation can fail with this approach, which will mean doing further host preparation work before retrying the installation. +* **Cover your bases**: If you want to make absolutely sure that your installation of Elastic Cloud Enterprise can succeed on hosts that meet the [prerequisites](prepare-environment.md), or if any of the checks during the installation failed previously, run through the full preparation steps in this section and then and [install Elastic Cloud Enterprise](install.md#install-ece). You’ll do a bit more work now, but life will be simpler later on. Regardless of which approach you take, the steps in this section need to be performed on every host that you want to use with Elastic Cloud Enterprise. -## Install Docker [ece-install-docker-sles12-cloud] +## Install Docker [ece-install-docker-sles12] ::::{important} Make sure to use a combination of Linux distribution and Docker version that is supported, following our official [Support matrix](https://www.elastic.co/support/matrix#elastic-cloud-enterprise). Using unsupported combinations can cause multiple issues with you ECE environment, such as failures to create system deployments, to upgrade workload deployments, proxy timeouts, and more. @@ -83,7 +84,7 @@ Make sure to use a combination of Linux distribution and Docker version that is -## Set up XFS on SLES [ece-xfs-setup-sles12-cloud] +## Set up XFS on SLES [ece-xfs-setup-sles12] XFS is required to support disk space quotas for Elasticsearch data directories. Some Linux distributions such as RHEL and Rocky Linux already provide XFS as the default file system. On SLES 12 and 15, you need to set up an XFS file system and have quotas enabled. @@ -127,7 +128,7 @@ You must use XFS and have quotas enabled on all allocators, otherwise disk usage -## Update the configurations settings [ece-update-config-sles-cloud] +## Update the configurations settings [ece-update-config-sles] 1. Stop the Docker service: @@ -224,7 +225,7 @@ You must use XFS and have quotas enabled on all allocators, otherwise disk usage sudo install -o $USER -g elastic -d -m 700 /mnt/data ``` -7. If you [set up a new device with XFS](#ece-xfs-setup-sles12-cloud) earlier: +7. If you [set up a new device with XFS](#ece-xfs-setup-sles12) earlier: 1. Mount the block device (change the device name if you use a different device than `/dev/xvdg1`): @@ -246,7 +247,7 @@ You must use XFS and have quotas enabled on all allocators, otherwise disk usage -## Configure the Docker daemon [ece-configure-docker-daemon-sles12-cloud] +## Configure the Docker daemon [ece-configure-docker-daemon-sles12] 1. Edit `/etc/docker/daemon.json`, and make sure that the following configuration values are present:
diff --git a/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu-onprem.md b/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu-onprem.md deleted file mode 100644 index 51e47c18da..0000000000 --- a/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu-onprem.md +++ /dev/null @@ -1,312 +0,0 @@ ---- -applies_to: - deployment: - ece: all -mapped_pages: - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-hosts-ubuntu-onprem.html ---- - -# Configure host Ubuntu onprem [ece-configure-hosts-ubuntu-onprem] - -The following instructions show you how to prepare your hosts on 20.04 LTS (Focal Fossa) and Ubuntu 22.04 LTS (Jammy Jellyfish). - -* [Install Docker 24.0](#ece-install-docker-ubuntu-onprem) -* [Set up XFS quotas](#ece-xfs-setup-ubuntu-onprem) -* [Update the configurations settings](#ece-update-config-ubuntu-onprem) -* [Configure the Docker daemon options](#ece-configure-docker-daemon-ubuntu-onprem) - - -## Install Docker [ece-install-docker-ubuntu-onprem] - -Install Docker LTS version 24.0 for Ubuntu 20.04 or 22.04. - -::::{important} -Make sure to use a combination of Linux distribution and Docker version that is supported, following our official [Support matrix](https://www.elastic.co/support/matrix#elastic-cloud-enterprise). Using unsupported combinations can cause multiple issues with you ECE environment, such as failures to create system deployments, to upgrade workload deployments, proxy timeouts, and more. -:::: - - -::::{note} -Docker 25 and higher are not compatible with ECE 3.7. -:::: - - -1. Install the Docker repository dependencies: - - ```sh - sudo apt-get install ca-certificates curl gnupg lsb-release - ``` - -2. Add Docker’s official GPG key: - - ```sh - sudo mkdir -m 0755 -p /etc/apt/keyrings - curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg - ``` - -3. Add the stable Docker repository: - - ```sh - echo \ - "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \ - $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null - ``` - -4. Install the correct version of the `docker-ce` package, for Ubuntu 20.04 LTS (Focal Fossa) or Ubuntu 22.04 LTS (Jammy Jellyfish): - - ```sh - sudo apt install -y docker-ce=5:24.0.* docker-ce-cli=5:24.0.* containerd.io - ``` - - - -## Set up XFS quotas [ece-xfs-setup-ubuntu-onprem] - -XFS is required to support disk space quotas for Elasticsearch data directories. Some Linux distributions such as RHEL and Rocky Linux already provide XFS as the default file system. On Ubuntu, you need to set up an XFS file system and have quotas enabled. - -Disk space quotas set a limit on the amount of disk space an Elasticsearch cluster node can use. Currently, quotas are calculated by a static ratio of 1:32, which means that for every 1 GB of RAM a cluster is given, a cluster node is allowed to consume 32 GB of disk space. - -::::{note} -Using LVM, `mdadm`, or a combination of the two for block device management is possible, but the configuration is not covered here, and it is not supported by Elastic Cloud Enterprise. -:::: - - -::::{important} -You must use XFS and have quotas enabled on all allocators, otherwise disk usage won’t display correctly. -:::: - - -**Example:** Set up XFS on a single, pre-partitioned block device named `/dev/xvdg1`. - -1. Format the partition: - - ```sh - sudo mkfs.xfs /dev/xvdg1 - ``` - -2. Create the `/mnt/data/` directory as a mount point: - - ```sh - sudo install -o $USER -g $USER -d -m 700 /mnt/data - ``` - -3. Add an entry to the `/etc/fstab` file for the new XFS volume. The default filesystem path used by Elastic Cloud Enterprise is `/mnt/data`. - - ```sh - /dev/xvdg1 /mnt/data xfs defaults,nofail,x-systemd.automount,prjquota,pquota 0 2 - ``` - -4. Regenerate the mount files: - - ```sh - sudo systemctl daemon-reload - sudo systemctl restart local-fs.target - ``` - - - -## Update the configurations settings [ece-update-config-ubuntu-onprem] - -1. Stop the Docker service: - - ```sh - sudo systemctl stop docker - ``` - -2. Enable cgroup accounting for memory and swap space. - - 1. In the `/etc/default/grub` file, ensure that the `GRUB_CMDLINE_LINUX=` variable includes these values: - - ```sh - cgroup_enable=memory swapaccount=1 cgroup.memory=nokmem - ``` - - 2. Update your Grub configuration: - - ```sh - sudo update-grub - ``` - -3. Configure kernel parameters - - ```sh - cat <" - } - } - } - ``` - -6. If you did not create the mount point earlier (if you did not set up XFS), create the `/mnt/data/` directory as a mount point: - - ```sh - sudo install -o $USER -g $USER -d -m 700 /mnt/data - ``` - -7. If you [set up a new device with XFS](#ece-xfs-setup-ubuntu-onprem) earlier: - - 1. Mount the block device (change the device name if you use a different device than `/dev/xvdg1`): - - ```sh - sudo mount /dev/xvdg1 /mnt/data - ``` - - 2. Set the permissions on the newly mounted device: - - ```sh - sudo chown $USER:$USER /mnt/data - ``` - -8. Create the `/mnt/data/docker` directory for the Docker service storage: - - ```sh - sudo install -o $USER -g $USER -d -m 700 /mnt/data/docker - ``` - - - -## Configure the Docker daemon options [ece-configure-docker-daemon-ubuntu-onprem] - -::::{tip} -Docker creates a bridge IP address that can conflict with IP addresses on your internal network. To avoid an IP address conflict, change the `--bip=172.17.42.1/16` parameter in our examples to something that you know will work. If there is no conflict, you can omit the `--bip` parameter. The `--bip` parameter is internal to the host and can be set to the same IP for each host in the cluster. More information on Docker daemon options can be found in the [dockerd command line reference](https://docs.docker.com/engine/reference/commandline/dockerd/). -:::: - - -::::{tip} -You can specify `--log-opt max-size` and `--log-opt max-file` to define the Docker daemon containers log rotation. -:::: - - -1. Update `/etc/systemd/system/docker.service.d/docker.conf`. If the file path and file do not exist, create them first. - - ```sh - [Unit] - Description=Docker Service - After=multi-user.target - - [Service] - Environment="DOCKER_OPTS=-H unix:///run/docker.sock --data-root /mnt/data/docker --storage-driver=overlay2 --bip=172.17.42.1/16 --raw-logs --log-opt max-size=500m --log-opt max-file=10 --icc=false" - ExecStart= - ExecStart=/usr/bin/dockerd $DOCKER_OPTS - ``` - -2. Apply the updated Docker daemon configuration: - - Reload the Docker daemon configuration: - - ```sh - sudo systemctl daemon-reload - ``` - - Restart the Docker service: - - ```sh - sudo systemctl restart docker - ``` - - Enable Docker to start on boot: - - ```sh - sudo systemctl enable docker - ``` - -3. Enable your user to communicate with the Docker subsystem by adding it to the `docker` group: - - ```sh - sudo usermod -aG docker $USER - ``` - -4. Recommended: Tune your network settings. - - Create a `70-cloudenterprise.conf` file in the `/etc/sysctl.d/` file path that includes these network settings: - - ```sh - cat << SETTINGS | sudo tee /etc/sysctl.d/70-cloudenterprise.conf - net.ipv4.tcp_max_syn_backlog=65536 - net.core.somaxconn=32768 - net.core.netdev_max_backlog=32768 - SETTINGS - ``` - -5. Pin the Docker version to ensure that the package does not get upgraded: - - ```sh - echo "docker-ce hold" | sudo dpkg --set-selections - echo "docker-ce-cli hold" | sudo dpkg --set-selections - echo "containerd.io hold" | sudo dpkg --set-selections - ``` - -6. Reboot your system to ensure that all configuration changes take effect: - - ```sh - sudo reboot - ``` - -7. After rebooting, verify that your Docker settings persist as expected: - - ```sh - sudo docker info | grep Root - ``` - - If the command returns `Docker Root Dir: /mnt/data/docker`, then your changes were applied successfully and persist as expected. - - If the command returns `Docker Root Dir: /var/lib/docker`, then you need to troubleshoot the previous configuration steps until the Docker settings are applied successfully before continuing with the installation process. For more information, check [Custom Docker daemon options](https://docs.docker.com/engine/admin/systemd/#/custom-docker-daemon-options) in the Docker documentation. - -8. Repeat these steps on other hosts that you want to use with Elastic Cloud Enterprise or follow the steps in the next section to start installing Elastic Cloud Enterprise. diff --git a/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu-cloud.md b/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu.md similarity index 95% rename from deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu-cloud.md rename to deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu.md index 87dd0bd484..c7765a1d28 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu-cloud.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu.md @@ -4,19 +4,20 @@ applies_to: ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-hosts-ubuntu-cloud.html + - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-hosts-ubuntu-onprem.html --- -# Configure host Ubuntu cloud [ece-configure-hosts-ubuntu-cloud] +# Configure host Ubuntu cloud [ece-configure-hosts-ubuntu] The following instructions show you how to prepare your hosts on 20.04 LTS (Focal Fossa) and Ubuntu 22.04 LTS (Jammy Jellyfish). -* [Install Docker 24.0](#ece-install-docker-ubuntu-cloud) -* [Set up XFS quotas](#ece-xfs-setup-ubuntu-cloud) -* [Update the configurations settings](#ece-update-config-ubuntu-cloud) -* [Configure the Docker daemon options](#ece-configure-docker-daemon-ubuntu-cloud) +* [Install Docker 24.0](#ece-install-docker-ubuntu) +* [Set up XFS quotas](#ece-xfs-setup-ubuntu) +* [Update the configurations settings](#ece-update-config-ubuntu) +* [Configure the Docker daemon options](#ece-configure-docker-daemon-ubuntu) -## Install Docker [ece-install-docker-ubuntu-cloud] +## Install Docker [ece-install-docker-ubuntu] Install Docker LTS version 24.0 for Ubuntu 20.04 or 22.04. @@ -59,7 +60,7 @@ Docker 25 and higher are not compatible with ECE 3.7. -## Set up XFS quotas [ece-xfs-setup-ubuntu-cloud] +## Set up XFS quotas [ece-xfs-setup-ubuntu] XFS is required to support disk space quotas for Elasticsearch data directories. Some Linux distributions such as RHEL and Rocky Linux already provide XFS as the default file system. On Ubuntu, you need to set up an XFS file system and have quotas enabled. @@ -104,7 +105,7 @@ You must use XFS and have quotas enabled on all allocators, otherwise disk usage -## Update the configurations settings [ece-update-config-ubuntu-cloud] +## Update the configurations settings [ece-update-config-ubuntu] 1. Stop the Docker service: @@ -200,7 +201,7 @@ You must use XFS and have quotas enabled on all allocators, otherwise disk usage sudo install -o $USER -g $USER -d -m 700 /mnt/data ``` -7. If you [set up a new device with XFS](#ece-xfs-setup-ubuntu-cloud) earlier: +7. If you [set up a new device with XFS](#ece-xfs-setup-ubuntu) earlier: 1. Mount the block device (change the device name if you use a different device than `/dev/xvdg1`): @@ -222,7 +223,7 @@ You must use XFS and have quotas enabled on all allocators, otherwise disk usage -## Configure the Docker daemon options [ece-configure-docker-daemon-ubuntu-cloud] +## Configure the Docker daemon options [ece-configure-docker-daemon-ubuntu] ::::{tip} Docker creates a bridge IP address that can conflict with IP addresses on your internal network. To avoid an IP address conflict, change the `--bip=172.17.42.1/16` parameter in our examples to something that you know will work. If there is no conflict, you can omit the `--bip` parameter. The `--bip` parameter is internal to the host and can be set to the same IP for each host in the cluster. More information on Docker daemon options can be found in the [dockerd command line reference](https://docs.docker.com/engine/reference/commandline/dockerd/). diff --git a/deploy-manage/deploy/cloud-enterprise/configure-operating-system-cloud.md b/deploy-manage/deploy/cloud-enterprise/configure-operating-system-cloud.md deleted file mode 100644 index b05e7f920a..0000000000 --- a/deploy-manage/deploy/cloud-enterprise/configure-operating-system-cloud.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -applies_to: - deployment: - ece: all -mapped_pages: - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-os-cloud.html ---- - -# Configure your operating system cloud [ece-configure-os-cloud] - -Before installing Elastic Cloud Enterprise, you have to prepare your hosts with one of the following Linux distributions: - -* [Ubuntu 20.04 LTS (Focal Fossa) and Ubuntu 22.04 LTS (Jammy Jellyfish)](configure-host-ubuntu-cloud.md) -* [Red Hat Enterprise Linux (RHEL) 8 and 9](configure-host-rhel-cloud.md) -* [Rocky Linux 8 and 9](configure-host-rhel-cloud.md) -* [SUSE Linux Enterprise Server (SLES) 12 SP5 and 15](configure-host-suse-cloud.md) - - - - diff --git a/deploy-manage/deploy/cloud-enterprise/configure-operating-system-onprem.md b/deploy-manage/deploy/cloud-enterprise/configure-operating-system.md similarity index 56% rename from deploy-manage/deploy/cloud-enterprise/configure-operating-system-onprem.md rename to deploy-manage/deploy/cloud-enterprise/configure-operating-system.md index fba0829c14..d145e29603 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-operating-system-onprem.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-operating-system.md @@ -3,18 +3,15 @@ applies_to: deployment: ece: all mapped_pages: + - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-os-cloud.html - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-os-onprem.html --- -# Configure your operating system onprem [ece-configure-os-onprem] +# Configure your operating system cloud [ece-configure-os] Before installing Elastic Cloud Enterprise, you have to prepare your hosts with one of the following Linux distributions: -* [Ubuntu 20.04 LTS (Focal Fossa) and Ubuntu 22.04 LTS (Jammy Jellyfish)](configure-host-ubuntu-onprem.md) -* [Red Hat Enterprise Linux (RHEL) 8 and 9](configure-host-rhel-onprem.md) -* [Rocky Linux 8 and 9](configure-host-rhel-onprem.md) -* [SUSE Linux Enterprise Server (SLES) 12 SP5 and 15](configure-host-suse-onprem.md) - - - - +* [Ubuntu 20.04 LTS (Focal Fossa) and Ubuntu 22.04 LTS (Jammy Jellyfish)](configure-host-ubuntu.md) +* [Red Hat Enterprise Linux (RHEL) 8 and 9](configure-host-rhel.md) +* [Rocky Linux 8 and 9](configure-host-rhel.md) +* [SUSE Linux Enterprise Server (SLES) 12 SP5 and 15](configure-host-suse.md) diff --git a/deploy-manage/deploy/cloud-enterprise/deploy-an-orchestrator.md b/deploy-manage/deploy/cloud-enterprise/deploy-an-orchestrator.md index 8f3e0c0a9d..9400091a5a 100644 --- a/deploy-manage/deploy/cloud-enterprise/deploy-an-orchestrator.md +++ b/deploy-manage/deploy/cloud-enterprise/deploy-an-orchestrator.md @@ -17,15 +17,20 @@ This section provides step-by-step guidance on: * [Prepare the environment](./prepare-environment.md): Follow the hardware, software, and networking prerequisites before the installation. +% Add here post-installation steps, configure OS, choose type of installation. + * [Install ECE orchestrator](./install.md): Identify the deployment scenario that best fits your needs, choose an installation method, and complete the setup. - * [Install ECE on a public cloud](./install-ece-on-public-cloud.md) - * [Install ECE on your own premises](./install-ece-on-own-premises.md) + * [](./configure-operating-system.md) + * [Install ECE on a public cloud](./install.md) + * [Install ECE on your own premises](./install.md) * [Alternative: install ECE with Ansible](./alternative-install-ece-with-ansible.md) * [Air-gapped installations](./air-gapped-install.md): Review the different options for air-gapped environments. * [With your private Docker registry](./ece-install-offline-with-registry.md) * [Without any Docker registry](./ece-install-offline-no-registry.md) +* [Post-installation tasks](./post-installation-steps.md) + * [Configure ECE](./configure.md): Explore the most common tasks to configure your ECE platform. * [System deployments configuration](./system-deployments-configuration.md) * [Configure deployment templates](./deployment-templates.md) diff --git a/deploy-manage/deploy/cloud-enterprise/deploy-large-installation-onprem.md b/deploy-manage/deploy/cloud-enterprise/deploy-large-installation-onprem.md deleted file mode 100644 index 39ae070006..0000000000 --- a/deploy-manage/deploy/cloud-enterprise/deploy-large-installation-onprem.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -applies_to: - deployment: - ece: all -mapped_pages: - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-large-onprem.html ---- - -# Deploy a large installation onprem [ece-install-large-onprem] - -This type of installation is recommended for deployments with significant overall search and indexing throughput. You need: - -* 3 hosts with at least 64 GB RAM each for directors and coordinators (ECE management services) -* 3 hosts for allocators, each with one of the following RAM configurations: - - * 1 x 256 GB RAM - * 2 x 128 GB RAM - * 4 x 64 GB RAM - -* 3 hosts with 16 GB RAM each for proxies -* 3 availability zones - -:::{image} ../../../images/cloud-enterprise-ece-pb-9.png -:alt: A large installation with nine to twelve hosts across three availability zones -::: - - -## Before you start [ece_before_you_start_6] - -Note that the large-sized Elastic Cloud Enterprise installation separates the allocator and proxy roles from the director and coordinator roles (ECE management services). - -**Check the recommended JVM Heap sizes** - -| Service | JVM Heap Size (Xms and Xmx) | -| --- | --- | -| `runner` | 1 GB | -| `allocator` | 4 GB | -| `zookeeper` | 24 GB | -| `director` | 1 GB | -| `constructor` | 4 GB | -| `admin-console` | 24 GB | - -::::{warning} -For production environments, you must define the memory settings for each role, except for the `proxy` role, as starting from ECE 2.4 the JVM proxy was replaced with a Golang-based proxy. If you don’t set any memory setting, the default values are used, which are inadequate for production environments and can lead to performance or stability issues. -:::: - - - -## Installation steps [ece_installation_steps_6] - -1. Install Elastic Cloud Enterprise on the first host to start a new installation with your first availability zone. This first host holds all roles to help bootstrap the rest of the installation, but you will remove some of its roles in a later step. - - ```sh - bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --availability-zone MY_ZONE-1 --memory-settings '{"runner":{"xms":"1G","xmx":"1G"},"allocator":{"xms":"4G","xmx":"4G"},"zookeeper":{"xms":"24G","xmx":"24G"},"director":{"xms":"1G","xmx":"1G"},"constructor":{"xms":"4G","xmx":"4G"},"admin-console":{"xms":"24G","xmx":"24G"}}' - ``` - - After the installation completes, copy down the coordinator host IP address, user credentials, and roles token information. Keep this information safe. - -2. Generate a new roles token that persists for one hour on the first host, so that other hosts can join your installation with the right role permissions in subsequent steps (referred to as `MY_TOKEN`). The new token needs to enable the director, coordinator, and proxy roles. - - ```sh - curl -k -H 'Content-Type: application/json' -u admin:PASSWORD https://localhost:12443/api/v1/platform/configuration/security/enrollment-tokens -d '{ "persistent": false, "roles": ["director", "coordinator", "proxy"] }' - ``` - -3. Install Elastic Cloud Enterprise on a second and third host, placing them into a second and a third availability zone, and assign them the `director` and `coordinator` roles. Do not assign the `allocator` or the `proxy` role, as these hosts should not handle or route any user requests. Make sure you include the coordinator host IP information from step 1 and the new roles token from step 2. - - ```sh - bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'MY_TOKEN' --roles "director,coordinator" --availability-zone MY_ZONE-2 --memory-settings '{"runner":{"xms":"1G","xmx":"1G"},"zookeeper":{"xms":"24G","xmx":"24G"},"director":{"xms":"1G","xmx":"1G"},"constructor":{"xms":"4G","xmx":"4G"},"admin-console":{"xms":"24G","xmx":"24G"}}' - ``` - - ```sh - bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'MY_TOKEN' --roles "director,coordinator" --availability-zone MY_ZONE-3 --memory-settings '{"runner":{"xms":"1G","xmx":"1G"},"zookeeper":{"xms":"24G","xmx":"24G"},"director":{"xms":"1G","xmx":"1G"},"constructor":{"xms":"4G","xmx":"4G"},"admin-console":{"xms":"24G","xmx":"24G"}}' - ``` - -4. To handle the Elasticsearch and Kibana workload, install Elastic Cloud Enterprise on three or more hosts, distributing them evenly across the existing three availability zones, or on however many hosts you think you need initially, and assign them the `allocator` role. Make sure you include the coordinator host IP information and allocator roles token from step 1. - - ```sh - bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'ALLOCATOR_TOKEN' --roles "allocator" --availability-zone MY_ZONE-1 --memory-settings '{"runner":{"xms":"1G","xmx":"1G"},"allocator":{"xms":"4G","xmx":"4G"}}' - - bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'ALLOCATOR_TOKEN' --roles "allocator" --availability-zone MY_ZONE-2 --memory-settings '{"runner":{"xms":"1G","xmx":"1G"},"allocator":{"xms":"4G","xmx":"4G"}}' - - bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'ALLOCATOR_TOKEN' --roles "allocator" --availability-zone MY_ZONE-3 --memory-settings '{"runner":{"xms":"1G","xmx":"1G"},"allocator":{"xms":"4G","xmx":"4G"}}' - ``` - -5. To handle the routing of user requests to Elasticsearch, install Elastic Cloud Enterprise on a three additional hosts, distributing them evenly across the existing three availability zones, and assign them the `proxy` role. Do not assign any other roles, as these hosts should only route user requests. Make sure you include the coordinator host IP information from step 1 and the new roles token from step 2. - - ```sh - bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'MY_TOKEN' --roles "proxy" --availability-zone MY_ZONE-1 --memory-settings - '{"runner":{"xms":"1G","xmx":"1G"}}' - - bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'MY_TOKEN' --roles "proxy" --availability-zone MY_ZONE-2 --memory-settings - '{"runner":{"xms":"1G","xmx":"1G"}}' - - bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'MY_TOKEN' --roles "proxy" --availability-zone MY_ZONE-3 --memory-settings - '{"runner":{"xms":"1G","xmx":"1G"}}' - ``` diff --git a/deploy-manage/deploy/cloud-enterprise/deploy-large-installation-cloud.md b/deploy-manage/deploy/cloud-enterprise/deploy-large-installation.md similarity index 97% rename from deploy-manage/deploy/cloud-enterprise/deploy-large-installation-cloud.md rename to deploy-manage/deploy/cloud-enterprise/deploy-large-installation.md index 5f6deb51d7..d17e9f927b 100644 --- a/deploy-manage/deploy/cloud-enterprise/deploy-large-installation-cloud.md +++ b/deploy-manage/deploy/cloud-enterprise/deploy-large-installation.md @@ -4,9 +4,10 @@ applies_to: ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-large-cloud.html + - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-large-onprem.html --- -# Deploy a large installation [ece-install-large-cloud] +# Deploy a large installation [ece-install-large] This type of installation is recommended for deployments with significant overall search and indexing throughput. You need: diff --git a/deploy-manage/deploy/cloud-enterprise/deploy-medium-installation-onprem.md b/deploy-manage/deploy/cloud-enterprise/deploy-medium-installation-onprem.md deleted file mode 100644 index 0f5c107fb9..0000000000 --- a/deploy-manage/deploy/cloud-enterprise/deploy-medium-installation-onprem.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -applies_to: - deployment: - ece: all -mapped_pages: - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-medium-onprem.html ---- - -# Deploy a medium installation onprem [ece-install-medium-onprem] - -This type of installation is recommended for many production setups. You need: - -* 3 hosts with at least 32 GB RAM each for directors and coordinators (ECE management services), and proxies -* 3 hosts with 256 GB RAM each for allocators -* 3 availability zones - -:::{image} ../../../images/cloud-enterprise-ece-pb-6.png -:alt: A medium installation with nine to twelve hosts across three availability zones -::: - - -## Before you start [ece_before_you_start_5] - -* Monitor the load on proxies and make sure the volume of user requests routed by the proxies does not affect the resources available to the ECE management services. -* Note that the medium-sized Elastic Cloud Enterprise installation separates the allocator from the director and coordinator roles (ECE management services) and the proxy roles. - -**Check the recommended JVM Heap sizes** - -| Service | JVM Heap Size (Xms and Xmx) | -| --- | --- | -| `runner` | 1 GB | -| `allocator` | 4 GB | -| `zookeeper` | 8 GB | -| `director` | 1 GB | -| `constructor` | 4 GB | -| `admin-console` | 8 GB | - -::::{warning} -For production environments, you must define the memory settings for each role, except for the `proxy` role, as starting from ECE 2.4 the JVM proxy was replaced with a Golang-based proxy. If you don’t set any memory setting, the default values are used, which are inadequate for production environments and can lead to performance or stability issues. -:::: - - - -## Installation steps [ece_installation_steps_5] - -1. Install Elastic Cloud Enterprise on the first host to start a new installation with your first availability zone. This first host holds all roles to help bootstrap the rest of the installation, but you will remove some of its roles in a later step. - - ```sh - bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --availability-zone MY_ZONE-1 --memory-settings '{"runner":{"xms":"1G","xmx":"1G"},"allocator":{"xms":"4G","xmx":"4G"},"zookeeper":{"xms":"8G","xmx":"8G"},"director":{"xms":"1G","xmx":"1G"},"constructor":{"xms":"4G","xmx":"4G"},"admin-console":{"xms":"8G","xmx":"8G"}}' - ``` - - After the installation completes, copy down the coordinator host IP address, user credentials, and roles token information. Keep this information safe. - -2. Generate a new roles token that persists for one hour on the first host, so that other hosts can join your installation with the right role permissions in the next step (referred to as `MY_TOKEN`). The new token needs to enable the director, coordinator and proxy roles. - - ```sh - curl -k -H 'Content-Type: application/json' -u admin:PASSWORD https://localhost:12443/api/v1/platform/configuration/security/enrollment-tokens -d '{ "persistent": false, "roles": ["director", "coordinator", "proxy"] }' - ``` - -3. Install Elastic Cloud Enterprise on a second and third host, placing them into a second and a third availability zone, and assign them the `director`, `coordinator`, and `proxy` roles. Do not assign the `allocator` role, as these hosts should not handle any user requests. Make sure you include the coordinator host IP information from step 1 and the new roles token from step 2. - - ```sh - bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'MY_TOKEN' --roles "director,coordinator,proxy" --availability-zone MY_ZONE-2 --memory-settings '{"runner":{"xms":"1G","xmx":"1G"},"zookeeper":{"xms":"8G","xmx":"8G"},"director":{"xms":"1G","xmx":"1G"},"constructor":{"xms":"4G","xmx":"4G"},"admin-console":{"xms":"8G","xmx":"8G"}}' - ``` - - ```sh - bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'MY_TOKEN' --roles "director,coordinator,proxy" --availability-zone MY_ZONE-3 --memory-settings '{"runner":{"xms":"1G","xmx":"1G"},"zookeeper":{"xms":"8G","xmx":"8G"},"director":{"xms":"1G","xmx":"1G"},"constructor":{"xms":"4G","xmx":"4G"},"admin-console":{"xms":"8G","xmx":"8G"}}' - ``` - -4. To handle the Elasticsearch and Kibana workload, install Elastic Cloud Enterprise on a fourth, fifth, and sixth host, distributing them evenly across the existing three availability zones and assign them the `allocator` role. Make sure you include the coordinator host IP information and allocator roles token from step 1. - - ```sh - bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'ALLOCATOR_TOKEN' --roles "allocator" --availability-zone MY_ZONE-1 --memory-settings '{"runner":{"xms":"1G","xmx":"1G"},"allocator":{"xms":"4G","xmx":"4G"}}' - - bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'ALLOCATOR_TOKEN' --roles "allocator" --availability-zone MY_ZONE-2 --memory-settings '{"runner":{"xms":"1G","xmx":"1G"},"allocator":{"xms":"4G","xmx":"4G"}}' - - bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'ALLOCATOR_TOKEN' --roles "allocator" --availability-zone MY_ZONE-3 --memory-settings '{"runner":{"xms":"1G","xmx":"1G"},"allocator":{"xms":"4G","xmx":"4G"}}' - ``` diff --git a/deploy-manage/deploy/cloud-enterprise/deploy-medium-installation-cloud.md b/deploy-manage/deploy/cloud-enterprise/deploy-medium-installation.md similarity index 97% rename from deploy-manage/deploy/cloud-enterprise/deploy-medium-installation-cloud.md rename to deploy-manage/deploy/cloud-enterprise/deploy-medium-installation.md index 93c4d6ea95..50933a8854 100644 --- a/deploy-manage/deploy/cloud-enterprise/deploy-medium-installation-cloud.md +++ b/deploy-manage/deploy/cloud-enterprise/deploy-medium-installation.md @@ -4,9 +4,10 @@ applies_to: ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-medium-cloud.html + - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-medium-onprem.html --- -# Deploy a medium installation [ece-install-medium-cloud] +# Deploy a medium installation [ece-install-medium] This type of installation is recommended for many production setups. You need: diff --git a/deploy-manage/deploy/cloud-enterprise/deploy-small-installation-onprem.md b/deploy-manage/deploy/cloud-enterprise/deploy-small-installation-onprem.md deleted file mode 100644 index 5fac118259..0000000000 --- a/deploy-manage/deploy/cloud-enterprise/deploy-small-installation-onprem.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -applies_to: - deployment: - ece: all -mapped_pages: - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-small-onprem.html ---- - -# Deploy a small installation onprem [ece-install-small-onprem] - -The type of installation is recommended for development, test, and small-scale use cases. You need: - -* 3 hosts with 128 GB RAM -* 3 availability zones - -:::{image} ../../../images/cloud-enterprise-ece-pb-3.png -:alt: A small baseline installation with three hosts across three availability zones -::: - - -## Before you start [ece_before_you_start_4] - -* This type of installation is **not recommended for high-traffic workloads**. -* You must not use **spinning disks** with small ECE installations, as these are not supported when you run allocators and ECE management services on the same server. -* Note that the small-size ECE installation keeps the directors and coordinators roles (ECE management services) on the same hosts as your allocators and proxies. - -**Check the recommended JVM Heap sizes** - -| Service | JVM Heap Size (Xms and Xmx) | -| --- | --- | -| `runner` | 1 GB | -| `allocator` | 4 GB | -| `zookeeper` | 4 GB | -| `director` | 1 GB | -| `constructor` | 4 GB | -| `admin-console` | 4 GB | - -::::{warning} -For production environments, you must define the memory settings for each role, except for the `proxy` role, as starting from ECE 2.4 the JVM proxy was replaced with a Golang-based proxy. If you don’t set any memory setting, the default values are used, which are inadequate for production environments and can lead to performance or stability issues. -:::: - - - -## Installation steps [ece_installation_steps_4] - -1. Install Elastic Cloud Enterprise on the first host to start a new installation with your first availability zone. This first host holds all roles to help bootstrap the rest of the installation. - - ```sh - bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --availability-zone MY_ZONE-1 --memory-settings '{"runner":{"xms":"1G","xmx":"1G"},"allocator":{"xms":"4G","xmx":"4G"},"zookeeper":{"xms":"4G","xmx":"4G"},"director":{"xms":"1G","xmx":"1G"},"constructor":{"xms":"4G","xmx":"4G"},"admin-console":{"xms":"4G","xmx":"4G"}}' - ``` - - After the installation completes, copy down the coordinator host IP address, user credentials, and roles token information. Keep this information safe. - -2. Generate a new roles token that persists for one hour on the first host, so that other hosts can join your installation with the right role permissions in the next step (referred to as `MY_TOKEN`). The new token needs to enable all host roles, which none of the tokens automatically generated by the installation on the first host provide. - - ```sh - curl -k -H 'Content-Type: application/json' -u admin:PASSWORD https://localhost:12443/api/v1/platform/configuration/security/enrollment-tokens -d '{ "persistent": false, "roles": ["director", "coordinator", "proxy", "allocator"] }' - ``` - -3. Install Elastic Cloud Enterprise on a second and third host, placing them into a second and a third availability zone, and assign them the same roles and memory settings as the first host. Make sure you include the coordinator host IP information from step 1 and the new roles token from step 2. - - ```sh - bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'MY_TOKEN' --roles "director,coordinator,proxy,allocator" --availability-zone MY_ZONE-2 --memory-settings '{"runner":{"xms":"1G","xmx":"1G"},"allocator":{"xms":"4G","xmx":"4G"},"zookeeper":{"xms":"4G","xmx":"4G"},"director":{"xms":"1G","xmx":"1G"},"constructor":{"xms":"4G","xmx":"4G"},"admin-console":{"xms":"4G","xmx":"4G"}}' - ``` - - ```sh - bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'MY_TOKEN' --roles "director,coordinator,proxy,allocator" --availability-zone MY_ZONE-3 --memory-settings '{"runner":{"xms":"1G","xmx":"1G"},"allocator":{"xms":"4G","xmx":"4G"},"zookeeper":{"xms":"4G","xmx":"4G"},"director":{"xms":"1G","xmx":"1G"},"constructor":{"xms":"4G","xmx":"4G"},"admin-console":{"xms":"4G","xmx":"4G"}}' - ``` - -4. [Change the deployment configuration for the `admin-console-elasticsearch`, `logging-and-metrics`, and `security` clusters](working-with-deployments.md) to use three availability zones and resize the nodes to use at least 4 GB of RAM. This change makes sure that the clusters used by the administration console are highly available and provisioned sufficiently. -5. [Log into the Cloud UI](log-into-cloud-ui.md) to provision your deployment. - -If necessary, you can scale and deploy a [medium installation](deploy-medium-installation-cloud.md). diff --git a/deploy-manage/deploy/cloud-enterprise/deploy-small-installation-cloud.md b/deploy-manage/deploy/cloud-enterprise/deploy-small-installation.md similarity index 96% rename from deploy-manage/deploy/cloud-enterprise/deploy-small-installation-cloud.md rename to deploy-manage/deploy/cloud-enterprise/deploy-small-installation.md index 108f9373f3..28c6db330c 100644 --- a/deploy-manage/deploy/cloud-enterprise/deploy-small-installation-cloud.md +++ b/deploy-manage/deploy/cloud-enterprise/deploy-small-installation.md @@ -4,9 +4,10 @@ applies_to: ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-small-cloud.html + - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-small-onprem.html --- -# Deploy a small installation [ece-install-small-cloud] +# Deploy a small installation [ece-install-small] The type of installation is recommended for development, test, and small-scale use cases. You need: @@ -70,4 +71,4 @@ For production environments, you must define the memory settings for each role, 4. [Change the deployment configuration for the `admin-console-elasticsearch`, `logging-and-metrics`, and `security` clusters](working-with-deployments.md) to use three availability zones and resize the nodes to use at least 4 GB of RAM. This change makes sure that the clusters used by the administration console are highly available and provisioned sufficiently. 5. [Log into the Cloud UI](log-into-cloud-ui.md) to provision your deployment. -If necessary, you can scale and deploy a [medium installation](deploy-medium-installation-cloud.md). +If necessary, you can scale and deploy a [medium installation](deploy-medium-installation.md). diff --git a/deploy-manage/deploy/cloud-enterprise/ece-jvm.md b/deploy-manage/deploy/cloud-enterprise/ece-jvm.md index 27c3673666..bd9dff5652 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-jvm.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-jvm.md @@ -15,9 +15,9 @@ ECE uses default JVM heap sizes for services that work for testing. Make sure to When you install ECE specify the recommended JVM heap sizes with `--memory-settings JVM_SETTINGS` parameter, based on the use cases as described below: -* [Deploy a small installation](deploy-small-installation-onprem.md): For development, test, and small-scale use cases. -* [Deploy a medium installation](deploy-medium-installation-onprem.md): For many production setups. -* [Deploy a large installation](deploy-large-installation-onprem.md): For deployments with significant overall search and indexing throughput. +* [Deploy a small installation](deploy-small-installation.md): For development, test, and small-scale use cases. +* [Deploy a medium installation](deploy-medium-installation.md): For many production setups. +* [Deploy a large installation](deploy-large-installation.md): For deployments with significant overall search and indexing throughput. Other JVM heap sizes can be left at their defaults. diff --git a/deploy-manage/deploy/cloud-enterprise/fresh-installation-of-ece-using-podman-hosts-onprem.md b/deploy-manage/deploy/cloud-enterprise/fresh-installation-of-ece-using-podman-hosts-onprem.md deleted file mode 100644 index 290c64fa8a..0000000000 --- a/deploy-manage/deploy/cloud-enterprise/fresh-installation-of-ece-using-podman-hosts-onprem.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -mapped_pages: - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-using-podman-onprem.html ---- - -# Fresh installation of ECE using Podman hosts onprem [ece-install-using-podman-onprem] - -This section provides guidelines and recommendations to install ECE using a Podman-based environment. The recommended approach consists of two (2) high-level steps. - -**Step 1**: Install ECE. - -**Step 2**: Add additional Podman hosts - -::::{note} -When copy-pasting commands, verify that characters like quotes (“) are encoded correctly in the console where you copy the command to. -:::: - - -::::{note} -Steps that run commands starting with `sudo` can be run as any sudoers user. Otherwise, the corresponding user is mentioned as part of the step description. -:::: - - -::::{note} -Avoid customizing the host Docker path `/mnt/data/docker` when using SELinux. Otherwise the ECE installer script needs to be adjusted. -:::: - - -1. Install ECE - - Use the ECE installer script together with the `--podman` flag. - - Refer to the official [Install ECE online](install-ece-onprem.md) documentation to adapt the command line parameters to your environment. - - [JVM heap sizes](ece-jvm.md) describes recommended JVM options. - - ::::{important} - Important while running `./elastic-cloud-enterprise.sh` - - * Execute the installer script as user `elastic`. - * Ensure to use an installer script that supports podman. - * Make sure you use `--podman`. - * Use `--cloud-enterprise-version VERSION_NAME` to specify the correct version. - * If you are using SELinux, make sure you also use `--selinux`. - - :::: - -2. Add additional Podman hosts - - Refer to the official [Install Elastic Cloud Enterprise on an additional host](install-ece-on-additional-hosts.md) and [Install ECE online](install-ece-onprem.md) documentation to adapt the command line parameters to your environment including fetching the role token. - - [JVM heap sizes](ece-jvm.md) describes recommended JVM options. - - ::::{important} - Important while running `./elastic-cloud-enterprise.sh` - - * Execute the installer script as user `elastic`. - * Ensure to use an installer script that supports podman. - * Make sure you use `--podman`. - * If you are using SELinux, make sure you also use `--selinux`. - * To fetch a role token following the [Generate Roles Tokens](generate-roles-tokens.md) guidelines, you need to send a JSON token to the admin console. Double check the correct format of the roles. Roles are a list of individual strings in quotes, **NOT a single string**. - - **Example** - - ```json - { "persistent": true, "roles": [ "allocator","coordinator","director","proxy" ] } - ``` - - * The ECE version of the additional host must be the same as the version used in step 2. Use `--cloud-enterprise-version VERSION_NAME` to specify the correct version. - * Make sure to apply the roles to the additional host. The value for the `--roles` flag is a single string. - - **Example** - - ```sh - --roles "allocator,coordinator,director,proxy" - ``` - - - :::: - - - To add a new allocator, use `--roles "allocator"`. To add a new coordinator, director, proxy, and allocator, use `--roles "allocator,coordinator,director,proxy"` - - diff --git a/deploy-manage/deploy/cloud-enterprise/fresh-installation-of-ece-using-podman-hosts-cloud.md b/deploy-manage/deploy/cloud-enterprise/fresh-installation-of-ece-using-podman-hosts.md similarity index 83% rename from deploy-manage/deploy/cloud-enterprise/fresh-installation-of-ece-using-podman-hosts-cloud.md rename to deploy-manage/deploy/cloud-enterprise/fresh-installation-of-ece-using-podman-hosts.md index 4bd3ea1534..4954a7a130 100644 --- a/deploy-manage/deploy/cloud-enterprise/fresh-installation-of-ece-using-podman-hosts-cloud.md +++ b/deploy-manage/deploy/cloud-enterprise/fresh-installation-of-ece-using-podman-hosts.md @@ -4,10 +4,11 @@ applies_to: ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-using-podman-cloud.html -navigation_title: Podman considerations + - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-using-podman-onprem.html +navigation_title: Deploy using Podman --- -# Fresh installation of ECE using Podman hosts cloud [ece-install-using-podman-cloud] +# Fresh installation of ECE using Podman hosts [ece-install-using-podman] This section provides guidelines and recommendations to install ECE using a Podman-based environment. The recommended approach consists of two (2) high-level steps. @@ -34,7 +35,7 @@ Avoid customizing the host Docker path `/mnt/data/docker` when using SELinux. Ot Use the ECE installer script together with the `--podman` flag. - Refer to the official [Install ECE online](install-ece-onprem.md) documentation to adapt the command line parameters to your environment. + Refer to the official [ECE installation](./install-ece-procedures.md) documentation to adapt the command line parameters to your environment. [JVM heap sizes](ece-jvm.md) describes recommended JVM options. @@ -51,7 +52,7 @@ Avoid customizing the host Docker path `/mnt/data/docker` when using SELinux. Ot 2. Add additional Podman hosts - Refer to the official [Install Elastic Cloud Enterprise on an additional host](install-ece-on-additional-hosts.md) and [Install ECE online](install-ece-onprem.md) documentation to adapt the command line parameters to your environment including fetching the role token. + Refer to the official [Install Elastic Cloud Enterprise on an additional host](install-ece-on-additional-hosts.md) and [ECE installation](./install-ece-procedures.md) documentation to adapt the command line parameters to your environment including fetching the role token. [JVM heap sizes](ece-jvm.md) describes recommended JVM options. diff --git a/deploy-manage/deploy/cloud-enterprise/identify-deployment-scenario.md b/deploy-manage/deploy/cloud-enterprise/identify-deployment-scenario.md index 6a421ddb10..45de3ec9ef 100644 --- a/deploy-manage/deploy/cloud-enterprise/identify-deployment-scenario.md +++ b/deploy-manage/deploy/cloud-enterprise/identify-deployment-scenario.md @@ -26,8 +26,7 @@ The type of deployment is recommended for development, test, and small-scale use * Avoid ECE installations with **spinning disks** as these are not supported when you run allocators and control plane on the same server. * Note that the small-size ECE installation keeps the directors and coordinators roles (ECE management services) on the same hosts as your allocators and proxies. -You can proceed with this scenario and install ECE with [Ansible](alternative-install-ece-with-ansible.md), on a [public cloud](install-ece-on-public-cloud.md), or on [your own premises](install-ece-on-own-premises.md). - +You can proceed with this scenario and [install ECE](./install.md). ## Medium deployment [ece_medium_deployment] @@ -50,8 +49,7 @@ This type of deployment is recommended for many production setups. You need: * Monitor the load on proxies and make sure the volume of user requests routed by the proxies does not affect the resources available to the ECE management services. * Note that the large-sized Elastic Cloud Enterprise installation separates the allocator and proxy roles from the director and coordinator roles (ECE management services). -You can proceed with this scenario and install ECE with [Ansible](alternative-install-ece-with-ansible.md), on a [public cloud](install-ece-on-public-cloud.md), or on [your own premises](install-ece-on-own-premises.md). - +You can proceed with this scenario and [install ECE](./install.md). ## Large deployment [ece_large_deployment] @@ -73,4 +71,4 @@ This type of deployment is recommended for deployments with significant overall Note that the large-sized Elastic Cloud Enterprise installation separates the allocator and proxy roles from the director and coordinator roles (ECE management services). -You can proceed with this scenario and install ECE with [Ansible](alternative-install-ece-with-ansible.md), on a [public cloud](install-ece-on-public-cloud.md), or on [your own premises](install-ece-on-own-premises.md). +You can proceed with this scenario and [install ECE](./install.md). \ No newline at end of file diff --git a/deploy-manage/deploy/cloud-enterprise/install-ece-cloud.md b/deploy-manage/deploy/cloud-enterprise/install-ece-cloud.md deleted file mode 100644 index e67bdfa24b..0000000000 --- a/deploy-manage/deploy/cloud-enterprise/install-ece-cloud.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -applies_to: - deployment: - ece: all -mapped_pages: - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-cloud.html ---- - -# Install ECE on a public cloud [ece-install-cloud] - -Choose the Elastic Cloud Enterprise deployment scenario that best fits your business needs: - -* [Deploy a small installation](deploy-small-installation-cloud.md): For development, test, and small-scale use cases. -* [Deploy a medium installation](deploy-medium-installation-cloud.md): For many production setups. -* [Deploy a large installation](deploy-large-installation-cloud.md): For deployments with significant overall search and indexing throughput. -* [Deploy using Podman](fresh-installation-of-ece-using-podman-hosts-cloud.md): Fresh installation of ECE using Podman hosts. - -For installations using Podman instead of Docker, refer to [](./fresh-installation-of-ece-using-podman-hosts-cloud.md) - - diff --git a/deploy-manage/deploy/cloud-enterprise/install-ece-on-own-premises.md b/deploy-manage/deploy/cloud-enterprise/install-ece-on-own-premises.md deleted file mode 100644 index fcabc76764..0000000000 --- a/deploy-manage/deploy/cloud-enterprise/install-ece-on-own-premises.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -applies_to: - deployment: - ece: all -mapped_pages: - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-your-infra.html ---- - -# Install ECE on your own premises [ece-install-your-infra] - -Before you start, make sure that your existing infrastructure meets the [requirements](prepare-environment.md). - -ECE supports a [wide range of OS versions](https://www.elastic.co/support/matrix). Here are some OS-specific instructions for preparing your hosts; other versions will be similar: - -* [Ubuntu 20.04 LTS (Focal Fossa) and 22.04 LTS (Jammy Jellyfish)](configure-host-ubuntu-onprem.md) -* [Red Hat Enterprise Linux (RHEL) 8 and 9, and Rocky Linux 8 and 9](configure-host-rhel-onprem.md) -* [SUSE Linux Enterprise Server (SLES) 12 SP5 and 15](configure-host-suse-onprem.md) - -After your hosts are prepared, choose your preferred installation type: - -* [Install ECE online](install-ece-onprem.md) -* [Install ECE offline](air-gapped-install.md) - -::::{note} -In these pages we frequently refer to [Docker](https://www.docker.com/), as its currently the most common container engine, but these instructions are generally valid for [Podman](https://podman.io/) as well, with `podman` replacing `docker` in commands as appropriate. -:::: - - - - - diff --git a/deploy-manage/deploy/cloud-enterprise/install-ece-on-public-cloud.md b/deploy-manage/deploy/cloud-enterprise/install-ece-on-public-cloud.md deleted file mode 100644 index 6d217b74a2..0000000000 --- a/deploy-manage/deploy/cloud-enterprise/install-ece-on-public-cloud.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -applies_to: - deployment: - ece: all -mapped_pages: - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-public.html ---- - -# Install ECE on a Public Cloud [ece-install-public] - -You can deploy {{ece}} (ECE) on any of the following cloud providers: - -* Amazon Web Services (AWS) -* Google Cloud Platform (GCP) -* Microsoft Azure - -To install ECE on a public cloud, follow these steps: - -1. Configure your hosts by following the appropriate guide for your operating system: - - * [Ubuntu 20.04 LTS (Focal Fossa) and Ubuntu 22.04 LTS (Jammy Jellyfish)](configure-host-ubuntu-cloud.md) - * [Red Hat Enterprise Linux (RHEL) 8 and 9](configure-host-rhel-cloud.md) - * [Rocky Linux 8 and 9](configure-host-rhel-cloud.md) - * [SUSE Linux Enterprise Server (SLES) 12 SP5 and 15](configure-host-suse-cloud.md) - - ::::{important} - Cloud providers default provide automatic operating system patching for their virtual machines. We strongly recommend disabling this feature to avoid potential data loss and installation failure. All patching should be done through [Perform host maintenance](../../maintenance/ece/perform-ece-hosts-maintenance.md) instructions. - :::: - -2. Follow the instructions for the the ECE deployment scenario that best fits your business needs: - - * [Deploy a small installation](deploy-small-installation-cloud.md): For development, test, and small-scale use cases. - * [Deploy a medium installation](deploy-medium-installation-cloud.md): For many production setups. - * [Deploy a large installation](deploy-large-installation-cloud.md): For deployments with significant overall search and indexing throughput. - * [Deploy using Podman](fresh-installation-of-ece-using-podman-hosts-cloud.md): Fresh installation of ECE using Podman hosts. - -::::{note} -For installations using Podman instead of Docker, refer to [Podman considerations](./fresh-installation-of-ece-using-podman-hosts-cloud.md) -:::: - diff --git a/deploy-manage/deploy/cloud-enterprise/install-ece-onprem.md b/deploy-manage/deploy/cloud-enterprise/install-ece-onprem.md deleted file mode 100644 index a98bf3c3d5..0000000000 --- a/deploy-manage/deploy/cloud-enterprise/install-ece-onprem.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -applies_to: - deployment: - ece: all -mapped_pages: - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-onprem.html ---- - -# Install ECE onprem [ece-install-onprem] - -Choose the Elastic Cloud Enterprise deployment scenario that best fits your business needs: - -* [Deploy a small installation](deploy-small-installation-onprem.md): For development, test, and small-scale use cases. -* [Deploy a medium installation](deploy-medium-installation-onprem.md): For many production setups. -* [Deploy a large installation](deploy-large-installation-onprem.md): For deployments with significant overall search and indexing throughput. -* [Deploy using Podman](fresh-installation-of-ece-using-podman-hosts-onprem.md): Fresh installation of ECE using Podman hosts. - - - - - diff --git a/deploy-manage/deploy/cloud-enterprise/install-ece-procedures.md b/deploy-manage/deploy/cloud-enterprise/install-ece-procedures.md new file mode 100644 index 0000000000..20b554d3e3 --- /dev/null +++ b/deploy-manage/deploy/cloud-enterprise/install-ece-procedures.md @@ -0,0 +1,17 @@ +--- +navigation_title: Installation procedures +applies_to: + deployment: + ece: all +--- + +# ECE installation procedures + +Choose the Elastic Cloud Enterprise deployment scenario that best fits your business needs: + +* [Deploy a small installation](deploy-small-installation.md): For development, test, and small-scale use cases. +* [Deploy a medium installation](deploy-medium-installation.md): For many production setups. +* [Deploy a large installation](deploy-large-installation.md): For deployments with significant overall search and indexing throughput. +* [Deploy using Podman](fresh-installation-of-ece-using-podman-hosts.md): Fresh installation of ECE using Podman hosts. + +For installations using Podman instead of Docker, refer to [](./fresh-installation-of-ece-using-podman-hosts.md) diff --git a/deploy-manage/deploy/cloud-enterprise/install.md b/deploy-manage/deploy/cloud-enterprise/install.md index 52276df438..185305672a 100644 --- a/deploy-manage/deploy/cloud-enterprise/install.md +++ b/deploy-manage/deploy/cloud-enterprise/install.md @@ -4,26 +4,57 @@ applies_to: ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-installing.html + - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-public.html + - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-your-infra.html navigation_title: Install ECE --- # Install Elastic Cloud Enterprise [ece-installing] -Before you start, make sure to [identify your deployment scenario](identify-deployment-scenario.md) and follow all the sections referenced in [prepare your hosts](prepare-environment.md). +You can deploy ECE on public or private clouds, virtual machines, or on-premises. In particular, for public cloud deployments, you can choose from the following providers: -You can get ECE up and running using the official bash script on a [public cloud](install-ece-on-public-cloud.md) or on [your own premises](install-ece-on-own-premises.md). Alternatively, you can install ECE with the [Ansible](alternative-install-ece-with-ansible.md) playbook. The ECE Ansible playbook is a community project, supported by Elastic, aimed at installing ECE at scale. +* Amazon Web Services (AWS) +* Google Cloud Platform (GCP) +* Microsoft Azure -To install ECE in an air-gapped environment, refer to [](./air-gapped-install.md). +::::{note} +In these pages we frequently refer to [Docker](https://www.docker.com/), as its currently the most common container engine, but these instructions are generally valid for [Podman](https://podman.io/) as well, with `podman` replacing `docker` in commands as appropriate. +:::: -Once you have installed ECE, check some final [post-installation steps](post-installation-steps.md) to get ready for production. +## Prerequisites -::::{tip} -This outline pertains to troubleshooting on the container engine level. The following outline is structured according to [Docker](https://www.docker.com/) as the most common engine but is also valid for [Podman](https://podman.io/), replacing out commands as needed. -:::: +Before you start, make sure to [identify your deployment scenario](identify-deployment-scenario.md) and follow all the referenced sections in [prepare your hosts](prepare-environment.md). Make sure that your selected infrastructure meets the requirements. +## Configure your ECE hosts [ece-configure-hosts] -::::{note} -In these pages we frequently refer to [Docker](https://www.docker.com/), as its currently the most common container engine, but these instructions are generally valid for [Podman](https://podman.io/) as well, with `podman` replacing `docker` in commands as appropriate. +After completing the prerequisites, proceed to configure your ECE hosts. This includes installing Docker or Podman, setting up XFS quotas, preparing mount points, and other required configurations. + +ECE supports a [wide range of OS versions](https://www.elastic.co/support/matrix#elastic-cloud-enterprise). Below are some OS-specific instructions for preparing your hosts, though other versions follow a similar process. Choose the appropriate guide for your operating system and follow the instructions: + +* [Ubuntu 20.04 LTS (Focal Fossa) and Ubuntu 22.04 LTS (Jammy Jellyfish)](configure-host-ubuntu.md) +* [Red Hat Enterprise Linux (RHEL) 8 and 9](configure-host-rhel.md) +* [Rocky Linux 8 and 9](configure-host-rhel.md) +* [SUSE Linux Enterprise Server (SLES) 12 SP5 and 15](configure-host-suse.md) + +::::{important} +Cloud providers default provide automatic operating system patching for their virtual machines. We strongly recommend disabling this feature to avoid potential data loss and installation failure. All patching should be done through [Perform host maintenance](../../maintenance/ece/perform-ece-hosts-maintenance.md) instructions. :::: +## Install ECE [install-ece] + +To install ECE with the official bash script, follow the instructions for the [deployment scenario](./identify-deployment-scenario.md) that best fits your business needs: + + * [Deploy a small installation](deploy-small-installation.md): For development, test, and small-scale use cases. + * [Deploy a medium installation](deploy-medium-installation.md): For many production setups. + * [Deploy a large installation](deploy-large-installation.md): For deployments with significant overall search and indexing throughput. + * [Deploy using Podman](./fresh-installation-of-ece-using-podman-hosts.md): Fresh installation of ECE using Podman hosts. + +Alternatively, you can install ECE with the [Ansible](alternative-install-ece-with-ansible.md) playbook. The ECE Ansible playbook is a community project, supported by Elastic, aimed at installing ECE at scale. + +To install ECE in an air-gapped environment, refer to [](./air-gapped-install.md). + +## Post-installation steps + +Once you have installed ECE, check some final [post-installation steps](post-installation-steps.md) to get ready for production. + diff --git a/deploy-manage/deploy/cloud-enterprise/migrate-ece-to-podman-hosts.md b/deploy-manage/deploy/cloud-enterprise/migrate-ece-to-podman-hosts.md index 3b8b8a3128..dc0ff2f520 100644 --- a/deploy-manage/deploy/cloud-enterprise/migrate-ece-to-podman-hosts.md +++ b/deploy-manage/deploy/cloud-enterprise/migrate-ece-to-podman-hosts.md @@ -388,7 +388,7 @@ Otherwise, when the file content changes, the corresponding user is mentioned as 1. Use the ECE installer script together with the `--podman` flag to add the additional host as a podman-based host. - Refer to the official [Install Elastic Cloud Enterprise on an additional host](install-ece-on-additional-hosts.md) and [Install ECE online](install-ece-onprem.md) documentation to adapt the command line parameters to your environment including fetching the role token. + Refer to the official [Install Elastic Cloud Enterprise on an additional host](install-ece-on-additional-hosts.md) and [Install ECE online](./install.md) documentation to adapt the command line parameters to your environment including fetching the role token. [JVM heap sizes](ece-jvm.md) describes recommended JVM options. diff --git a/deploy-manage/toc.yml b/deploy-manage/toc.yml index 70175151d8..d6b105851a 100644 --- a/deploy-manage/toc.yml +++ b/deploy-manage/toc.yml @@ -140,38 +140,23 @@ toc: - file: deploy/cloud-enterprise/install.md children: - file: deploy/cloud-enterprise/identify-deployment-scenario.md - - file: deploy/cloud-enterprise/install-ece-on-public-cloud.md + - file: deploy/cloud-enterprise/configure-operating-system.md children: - - file: deploy/cloud-enterprise/configure-operating-system-cloud.md - children: - - file: deploy/cloud-enterprise/configure-host-ubuntu-cloud.md - - file: deploy/cloud-enterprise/configure-host-rhel-cloud.md - - file: deploy/cloud-enterprise/configure-host-suse-cloud.md - - file: deploy/cloud-enterprise/install-ece-cloud.md - children: - - file: deploy/cloud-enterprise/deploy-small-installation-cloud.md - - file: deploy/cloud-enterprise/deploy-medium-installation-cloud.md - - file: deploy/cloud-enterprise/deploy-large-installation-cloud.md - - file: deploy/cloud-enterprise/fresh-installation-of-ece-using-podman-hosts-cloud.md - - file: deploy/cloud-enterprise/install-ece-on-own-premises.md + - file: deploy/cloud-enterprise/configure-host-ubuntu.md + - file: deploy/cloud-enterprise/configure-host-rhel.md + - file: deploy/cloud-enterprise/configure-host-suse.md + - file: deploy/cloud-enterprise/install-ece-procedures.md children: - - file: deploy/cloud-enterprise/configure-operating-system-onprem.md - children: - - file: deploy/cloud-enterprise/configure-host-ubuntu-onprem.md - - file: deploy/cloud-enterprise/configure-host-rhel-onprem.md - - file: deploy/cloud-enterprise/configure-host-suse-onprem.md - - file: deploy/cloud-enterprise/install-ece-onprem.md - children: - - file: deploy/cloud-enterprise/deploy-small-installation-onprem.md - - file: deploy/cloud-enterprise/deploy-medium-installation-onprem.md - - file: deploy/cloud-enterprise/deploy-large-installation-onprem.md - - file: deploy/cloud-enterprise/fresh-installation-of-ece-using-podman-hosts-onprem.md + - file: deploy/cloud-enterprise/deploy-small-installation.md + - file: deploy/cloud-enterprise/deploy-medium-installation.md + - file: deploy/cloud-enterprise/deploy-large-installation.md + - file: deploy/cloud-enterprise/fresh-installation-of-ece-using-podman-hosts.md + - file: deploy/cloud-enterprise/migrate-ece-to-podman-hosts.md - file: deploy/cloud-enterprise/alternative-install-ece-with-ansible.md - file: deploy/cloud-enterprise/log-into-cloud-ui.md - file: deploy/cloud-enterprise/install-ece-on-additional-hosts.md children: - file: deploy/cloud-enterprise/generate-roles-tokens.md - - file: deploy/cloud-enterprise/migrate-ece-to-podman-hosts.md - file: deploy/cloud-enterprise/post-installation-steps.md - file: deploy/cloud-enterprise/statistics-collected-by-cloud-enterprise.md - file: deploy/cloud-enterprise/air-gapped-install.md diff --git a/deploy-manage/tools/snapshot-and-restore/minio-on-premise-repository.md b/deploy-manage/tools/snapshot-and-restore/minio-on-premise-repository.md index 07d523bc20..6b52f1c4af 100644 --- a/deploy-manage/tools/snapshot-and-restore/minio-on-premise-repository.md +++ b/deploy-manage/tools/snapshot-and-restore/minio-on-premise-repository.md @@ -22,7 +22,7 @@ Installing Minio for production requires a high-availability configuration where As mentioned in the Minio documentation, you will need to have 4-16 Minio drive mounts. There is no hard limit on the number of Minio nodes. It might be convenient to place the Minio node containers on your ECE hosts to ensure you have a suitable level of availability, but those can not be located on the same hosts as ECE proxies since they both listen on the same port. -The following illustration is a sample architecture for a [large ECE installation](../../deploy/cloud-enterprise/deploy-large-installation-onprem.md). Note that there is at least one MinIO container in *each* availability zone. +The following illustration is a sample architecture for a [large ECE installation](../../deploy/cloud-enterprise/deploy-large-installation.md). Note that there is at least one MinIO container in *each* availability zone. There are a number of different ways of orchestrating the Minio deployment (Docker Compose, Kubernetes, and so on). We suggest you use the method most familiar to you. diff --git a/troubleshoot/deployments/cloud-enterprise/troubleshooting-container-engines.md b/troubleshoot/deployments/cloud-enterprise/troubleshooting-container-engines.md index ba1b83ddb0..59b54f85a2 100644 --- a/troubleshoot/deployments/cloud-enterprise/troubleshooting-container-engines.md +++ b/troubleshoot/deployments/cloud-enterprise/troubleshooting-container-engines.md @@ -16,7 +16,7 @@ Do not restart the Docker daemon unless directly prescribed by Elastic Support u ## Use supported configuration [ece-troubleshooting-containers-supported] -Make sure to use a combination of [Linux operating systems](../../../deploy-manage/deploy/cloud-enterprise/configure-operating-system-cloud.md) and container engine version that is supported, following our official [Support matrix](https://www.elastic.co/support/matrix#elastic-cloud-enterprise). Using unsupported combinations can cause a plethora of either intermediate or potentially permanent issues with you {{ece}} environment, such as failures to create [system deployments](../../../deploy-manage/deploy/cloud-enterprise/system-deployments-configuration.md), to upgrade workload deployments, proxy timeouts, data loss, and more. +Make sure to use a combination of [Linux operating systems](../../../deploy-manage/deploy/cloud-enterprise/configure-operating-system.md) and container engine version that is supported, following our official [Support matrix](https://www.elastic.co/support/matrix#elastic-cloud-enterprise). Using unsupported combinations can cause a plethora of either intermediate or potentially permanent issues with you {{ece}} environment, such as failures to create [system deployments](../../../deploy-manage/deploy/cloud-enterprise/system-deployments-configuration.md), to upgrade workload deployments, proxy timeouts, data loss, and more. ## Troubleshoot unhealthy containers [ece-troubleshooting-containers-unhealthy] From f1ed120b66a0e3aa85b8c6c28ffa85cef030cc21 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Wed, 26 Feb 2025 14:59:40 +0100 Subject: [PATCH 04/29] sections moved in toc --- .../alternative-install-ece-with-ansible.md | 1 + .../deploy/cloud-enterprise/configure-operating-system.md | 2 +- .../deploy/cloud-enterprise/deploy-an-orchestrator.md | 7 ++----- deploy-manage/deploy/cloud-enterprise/install.md | 5 +++++ .../deploy/cloud-enterprise/post-installation-steps.md | 2 +- deploy-manage/toc.yml | 4 ++-- 6 files changed, 12 insertions(+), 9 deletions(-) diff --git a/deploy-manage/deploy/cloud-enterprise/alternative-install-ece-with-ansible.md b/deploy-manage/deploy/cloud-enterprise/alternative-install-ece-with-ansible.md index 867c56d421..adb2887f43 100644 --- a/deploy-manage/deploy/cloud-enterprise/alternative-install-ece-with-ansible.md +++ b/deploy-manage/deploy/cloud-enterprise/alternative-install-ece-with-ansible.md @@ -4,6 +4,7 @@ applies_to: ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-ansible.html +navigation_title: Ansible playbook --- # Alternative: Install ECE with Ansible [ece-configure-ansible] diff --git a/deploy-manage/deploy/cloud-enterprise/configure-operating-system.md b/deploy-manage/deploy/cloud-enterprise/configure-operating-system.md index d145e29603..6cf39a8f64 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-operating-system.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-operating-system.md @@ -7,7 +7,7 @@ mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-os-onprem.html --- -# Configure your operating system cloud [ece-configure-os] +# Configure your operating system [ece-configure-os] Before installing Elastic Cloud Enterprise, you have to prepare your hosts with one of the following Linux distributions: diff --git a/deploy-manage/deploy/cloud-enterprise/deploy-an-orchestrator.md b/deploy-manage/deploy/cloud-enterprise/deploy-an-orchestrator.md index 9400091a5a..a9a70ba715 100644 --- a/deploy-manage/deploy/cloud-enterprise/deploy-an-orchestrator.md +++ b/deploy-manage/deploy/cloud-enterprise/deploy-an-orchestrator.md @@ -17,19 +17,16 @@ This section provides step-by-step guidance on: * [Prepare the environment](./prepare-environment.md): Follow the hardware, software, and networking prerequisites before the installation. -% Add here post-installation steps, configure OS, choose type of installation. - * [Install ECE orchestrator](./install.md): Identify the deployment scenario that best fits your needs, choose an installation method, and complete the setup. * [](./configure-operating-system.md) - * [Install ECE on a public cloud](./install.md) - * [Install ECE on your own premises](./install.md) + * [](./install-ece-procedures.md) * [Alternative: install ECE with Ansible](./alternative-install-ece-with-ansible.md) * [Air-gapped installations](./air-gapped-install.md): Review the different options for air-gapped environments. * [With your private Docker registry](./ece-install-offline-with-registry.md) * [Without any Docker registry](./ece-install-offline-no-registry.md) -* [Post-installation tasks](./post-installation-steps.md) +* [](./post-installation-steps.md): Get ready for production by adding SSL certificates, configuring domain names, and completing other essential tasks. * [Configure ECE](./configure.md): Explore the most common tasks to configure your ECE platform. * [System deployments configuration](./system-deployments-configuration.md) diff --git a/deploy-manage/deploy/cloud-enterprise/install.md b/deploy-manage/deploy/cloud-enterprise/install.md index 185305672a..c590110d61 100644 --- a/deploy-manage/deploy/cloud-enterprise/install.md +++ b/deploy-manage/deploy/cloud-enterprise/install.md @@ -17,10 +17,15 @@ You can deploy ECE on public or private clouds, virtual machines, or on-premises * Google Cloud Platform (GCP) * Microsoft Azure +::::{tip} +If you already have an ECE platform up and running, and you want to add hosts to your installation, refer to [](./install-ece-on-additional-hosts.md). +:::: + ::::{note} In these pages we frequently refer to [Docker](https://www.docker.com/), as its currently the most common container engine, but these instructions are generally valid for [Podman](https://podman.io/) as well, with `podman` replacing `docker` in commands as appropriate. :::: + ## Prerequisites Before you start, make sure to [identify your deployment scenario](identify-deployment-scenario.md) and follow all the referenced sections in [prepare your hosts](prepare-environment.md). Make sure that your selected infrastructure meets the requirements. diff --git a/deploy-manage/deploy/cloud-enterprise/post-installation-steps.md b/deploy-manage/deploy/cloud-enterprise/post-installation-steps.md index ac8f31d011..da379f5c87 100644 --- a/deploy-manage/deploy/cloud-enterprise/post-installation-steps.md +++ b/deploy-manage/deploy/cloud-enterprise/post-installation-steps.md @@ -20,7 +20,7 @@ After your Elastic Cloud Enterprise installation is up, some additional steps mi If you intend to use [custom endpoint aliases](./enable-custom-endpoint-aliases.md) functionality, ensure you add the necessary Subject Alternative Name (SAN) entries to the proxy certificate. :::: -* Optionally, if you want the deployment endpoint links and Single-sign on to work with your domain name, configure it as the **deployment domain name** in the Platform → Settings section of the [Cloud UI](./log-into-cloud-ui.md). The domain name is used to generate the endpoint URLs and must align with your Proxy certificate and DNS record. +* Optionally, if you want the deployment endpoint links and Single-sign on to work with your domain name, configure it as the **deployment domain name** in the Platform → Settings section of the [Cloud UI](./log-into-cloud-ui.md). The domain name is used to generate the endpoint URLs and must align with your proxy certificate and DNS record. ::::{tip} For example, if your proxy certificate is signed for `*.elastic-cloud-enterprise.example.com` and you have a wildcard DNS register pointing `*.elastic-cloud-enterprise.example.com` to your load balancer, you should configure `elastic-cloud-enterprise.example.com` as the **deployment domain name** in Platform → Settings. Refer to [](./change-endpoint-urls.md) for more details. diff --git a/deploy-manage/toc.yml b/deploy-manage/toc.yml index d6b105851a..2e9cad4f27 100644 --- a/deploy-manage/toc.yml +++ b/deploy-manage/toc.yml @@ -152,12 +152,12 @@ toc: - file: deploy/cloud-enterprise/deploy-large-installation.md - file: deploy/cloud-enterprise/fresh-installation-of-ece-using-podman-hosts.md - file: deploy/cloud-enterprise/migrate-ece-to-podman-hosts.md - - file: deploy/cloud-enterprise/alternative-install-ece-with-ansible.md - file: deploy/cloud-enterprise/log-into-cloud-ui.md + - file: deploy/cloud-enterprise/post-installation-steps.md - file: deploy/cloud-enterprise/install-ece-on-additional-hosts.md children: - file: deploy/cloud-enterprise/generate-roles-tokens.md - - file: deploy/cloud-enterprise/post-installation-steps.md + - file: deploy/cloud-enterprise/alternative-install-ece-with-ansible.md - file: deploy/cloud-enterprise/statistics-collected-by-cloud-enterprise.md - file: deploy/cloud-enterprise/air-gapped-install.md children: From 3bc8a637ecefb447bf9365840a62c5fcb9fe3bc7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Wed, 26 Feb 2025 15:40:34 +0100 Subject: [PATCH 05/29] redirect added to fix asciidoc link after file name changes --- redirects.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/redirects.yml b/redirects.yml index f53ec18cb6..4db48b8b85 100644 --- a/redirects.yml +++ b/redirects.yml @@ -5,4 +5,5 @@ redirects: anchors: 'anonymous-authentication': 'basic-authentication': - 'http-authentication': \ No newline at end of file + 'http-authentication': + 'deploy-manage/deploy/cloud-enterprise/deploy-large-installation-cloud.md': '!deploy-manage/deploy/cloud-enterprise/deploy-large-installation.md' \ No newline at end of file From 5adfc43e6c4bfc540b59fe220e738784cc596192 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Wed, 26 Feb 2025 15:49:44 +0100 Subject: [PATCH 06/29] fixed another broken link --- troubleshoot/deployments/cloud-enterprise/common-issues.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/troubleshoot/deployments/cloud-enterprise/common-issues.md b/troubleshoot/deployments/cloud-enterprise/common-issues.md index 25c97e570c..b8e11e6457 100644 --- a/troubleshoot/deployments/cloud-enterprise/common-issues.md +++ b/troubleshoot/deployments/cloud-enterprise/common-issues.md @@ -10,7 +10,7 @@ This set of common symptoms and resolutions can help you to diagnose unexpected ## Emergency token not spinning up the coordinator role [ece_emergency_token_not_spinning_up_the_coordinator_role] -**Symptom:** You have no access to API and UI because all coordinators are lost. More than half of the director hosts are available. If you have 5 directors, 3 directors must be available. If you lost more than half of the directors, contact the support. If all directors are lost, [re-install ECE](../../../deploy-manage/deploy/cloud-enterprise/install-ece-cloud.md). +**Symptom:** You have no access to API and UI because all coordinators are lost. More than half of the director hosts are available. If you have 5 directors, 3 directors must be available. If you lost more than half of the directors, contact the support. If all directors are lost, [re-install ECE](../../../deploy-manage/deploy/cloud-enterprise/install.md). **Resolution:** Use the emergency token provided during the installation of the genesis ECE nodes. You must explicitly specify the roles with the parameter `--roles`, for example `"coordinator,director,proxy"`. Otherwise, the host does not run any role. From ec08e036a6d5552987d0002c45699f05048cc67e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Mon, 3 Mar 2025 08:49:52 +0100 Subject: [PATCH 07/29] Update deploy-manage/deploy/cloud-enterprise/install.md Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com> --- deploy-manage/deploy/cloud-enterprise/install.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/deploy-manage/deploy/cloud-enterprise/install.md b/deploy-manage/deploy/cloud-enterprise/install.md index c590110d61..576ca6da53 100644 --- a/deploy-manage/deploy/cloud-enterprise/install.md +++ b/deploy-manage/deploy/cloud-enterprise/install.md @@ -11,7 +11,9 @@ navigation_title: Install ECE # Install Elastic Cloud Enterprise [ece-installing] -You can deploy ECE on public or private clouds, virtual machines, or on-premises. In particular, for public cloud deployments, you can choose from the following providers: +You can deploy ECE on public or private clouds, virtual machines, or on-premises. + +For public cloud deployments, you can choose from the following providers: * Amazon Web Services (AWS) * Google Cloud Platform (GCP) From 23804d6b18129e4bcdd857756806df7755beb010 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Mon, 3 Mar 2025 08:50:25 +0100 Subject: [PATCH 08/29] Update deploy-manage/deploy/cloud-enterprise/install.md Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com> --- deploy-manage/deploy/cloud-enterprise/install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deploy-manage/deploy/cloud-enterprise/install.md b/deploy-manage/deploy/cloud-enterprise/install.md index 576ca6da53..87f094002c 100644 --- a/deploy-manage/deploy/cloud-enterprise/install.md +++ b/deploy-manage/deploy/cloud-enterprise/install.md @@ -30,7 +30,7 @@ In these pages we frequently refer to [Docker](https://www.docker.com/), as its ## Prerequisites -Before you start, make sure to [identify your deployment scenario](identify-deployment-scenario.md) and follow all the referenced sections in [prepare your hosts](prepare-environment.md). Make sure that your selected infrastructure meets the requirements. +Before you start, make sure to [identify your deployment scenario](identify-deployment-scenario.md) and follow all the referenced sections in [](prepare-environment.md). Make sure that your selected infrastructure meets the requirements. ## Configure your ECE hosts [ece-configure-hosts] From f82063bdac3084038ee68a8731b991a123caef73 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Mon, 3 Mar 2025 08:50:59 +0100 Subject: [PATCH 09/29] Update deploy-manage/deploy/cloud-enterprise/air-gapped-install.md Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com> --- deploy-manage/deploy/cloud-enterprise/air-gapped-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md b/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md index b98df8c8db..0d8fbc0c9d 100644 --- a/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md +++ b/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md @@ -28,5 +28,5 @@ When you are ready to install ECE, you can proceed: * [Without your private Docker registry](./ece-install-offline-no-registry.md) ::::{note} -Deployment End-of-life (EOL) information relies on the connection to [https://www.elastic.co/support/eol.json](https://www.elastic.co/support/eol.json). If EOL information is updated, Elastic may require you to reconnect to [https://www.elastic.co/support/eol.json](https://www.elastic.co/support/eol.json) over the Internet to get this information reflected. +Deployment End-of-life (EOL) information relies on the connection to [https://www.elastic.co/support/eol.json](https://www.elastic.co/support/eol.json). If EOL information is updated, Elastic may require you to reconnect to [https://www.elastic.co/support/eol.json](https://www.elastic.co/support/eol.json) over the internet to get this information reflected. :::: From 10514f5f6064e77372c2485c864cdcdc8f7c48bd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Mon, 3 Mar 2025 08:51:53 +0100 Subject: [PATCH 10/29] Update deploy-manage/deploy/cloud-enterprise/air-gapped-install.md Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com> --- deploy-manage/deploy/cloud-enterprise/air-gapped-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md b/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md index 0d8fbc0c9d..fdfb746b90 100644 --- a/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md +++ b/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md @@ -8,7 +8,7 @@ mapped_urls: # Air-gapped install [ece-install-offline] -Installing ECE on hosts without internet access is commonly referred to as an *offline* or *air-gapped installation*. ECE supports two air-gapped installation methods, depending on whether a private Docker registry is available. In both cases, you must download multiple Docker images and the installation script from Elastic, and load them onto your hosts or private registry. +Installing ECE on hosts without internet access is commonly referred to as an *offline* or *air-gapped* installation. ECE supports two air-gapped installation methods, depending on whether a private Docker registry is available. In both cases, you must download multiple Docker images and the installation script from Elastic, and load them onto your hosts or private registry. ::::{note} The versioning of {{es}} and {{kib}} is synchronized and versions where the major, minor, and patch levels match can be used together. Differences in build versions indicated by a dash do not affect compatibility. From b0b0f9bb37210445807178fe81e6e737c9d82f0f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Mon, 3 Mar 2025 08:52:08 +0100 Subject: [PATCH 11/29] Update deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu.md Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com> --- deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu.md | 1 + 1 file changed, 1 insertion(+) diff --git a/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu.md b/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu.md index c7765a1d28..373c977228 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu.md @@ -5,6 +5,7 @@ applies_to: mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-hosts-ubuntu-cloud.html - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-hosts-ubuntu-onprem.html +navigation_title: Ubuntu --- # Configure host Ubuntu cloud [ece-configure-hosts-ubuntu] From 0374ee84649f5f66d050d47d9d6c4645674b2131 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Mon, 3 Mar 2025 08:53:12 +0100 Subject: [PATCH 12/29] Update deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu.md Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com> --- deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu.md b/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu.md index 373c977228..fd98d15e69 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu.md @@ -8,7 +8,7 @@ mapped_pages: navigation_title: Ubuntu --- -# Configure host Ubuntu cloud [ece-configure-hosts-ubuntu] +# Configure an Ubuntu host [ece-configure-hosts-ubuntu] The following instructions show you how to prepare your hosts on 20.04 LTS (Focal Fossa) and Ubuntu 22.04 LTS (Jammy Jellyfish). From 2025200d6bea3eb7f3eefe4abf4ef2184ff4f2a2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Mon, 3 Mar 2025 08:53:48 +0100 Subject: [PATCH 13/29] Update deploy-manage/deploy/cloud-enterprise/configure-host-rhel.md Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com> --- deploy-manage/deploy/cloud-enterprise/configure-host-rhel.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deploy-manage/deploy/cloud-enterprise/configure-host-rhel.md b/deploy-manage/deploy/cloud-enterprise/configure-host-rhel.md index 9e650bbffd..2d14a7d46c 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-host-rhel.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-host-rhel.md @@ -7,7 +7,7 @@ mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-hosts-rhel-centos-onprem.html --- -# Configure host RHEL cloud [ece-configure-hosts-rhel-centos] +# Configure a RHEL host [ece-configure-hosts-rhel-centos] ## Red Hat Enterprise Linux 8 (RHEL 8), 9 (RHEL 9), and Rocky Linux 8 and 9 [ece-setup-rhel8-podman] From 93b0fd6b6d6c4416465fbb9848db5f9d0c3f5f10 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Mon, 3 Mar 2025 09:05:41 +0100 Subject: [PATCH 14/29] Apply suggestions from code review Awesome suggestions by Shaina :) Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com> --- deploy-manage/deploy/cloud-enterprise/air-gapped-install.md | 2 +- .../deploy/cloud-enterprise/configure-host-rhel.md | 6 +++--- .../deploy/cloud-enterprise/configure-host-suse.md | 3 ++- deploy-manage/deploy/cloud-enterprise/configure.md | 2 +- .../deploy/cloud-enterprise/install-ece-procedures.md | 2 +- deploy-manage/deploy/cloud-enterprise/install.md | 2 +- .../deploy/cloud-enterprise/post-installation-steps.md | 6 +++++- 7 files changed, 14 insertions(+), 9 deletions(-) diff --git a/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md b/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md index fdfb746b90..050e23f27a 100644 --- a/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md +++ b/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md @@ -25,7 +25,7 @@ Before you start, you must: When you are ready to install ECE, you can proceed: * [With your private Docker registry](./ece-install-offline-with-registry.md) -* [Without your private Docker registry](./ece-install-offline-no-registry.md) +* [Without a private Docker registry](./ece-install-offline-no-registry.md) ::::{note} Deployment End-of-life (EOL) information relies on the connection to [https://www.elastic.co/support/eol.json](https://www.elastic.co/support/eol.json). If EOL information is updated, Elastic may require you to reconnect to [https://www.elastic.co/support/eol.json](https://www.elastic.co/support/eol.json) over the internet to get this information reflected. diff --git a/deploy-manage/deploy/cloud-enterprise/configure-host-rhel.md b/deploy-manage/deploy/cloud-enterprise/configure-host-rhel.md index 2d14a7d46c..4bdcd7a1ba 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-host-rhel.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-host-rhel.md @@ -5,12 +5,12 @@ applies_to: mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-hosts-rhel-centos-cloud.html - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-hosts-rhel-centos-onprem.html +navigation_title: RHEL --- # Configure a RHEL host [ece-configure-hosts-rhel-centos] -## Red Hat Enterprise Linux 8 (RHEL 8), 9 (RHEL 9), and Rocky Linux 8 and 9 [ece-setup-rhel8-podman] The following instructions show you how to prepare your hosts on Red Hat Enterprise Linux 8 (RHEL 8), 9 (RHEL 9), and Rocky Linux 8 and 9. @@ -18,7 +18,7 @@ The following instructions show you how to prepare your hosts on Red Hat Enterpr * [Configure the host](#ece-configure-hosts-rhel8-podman) -### Prerequisites [ece-prerequisites-rhel8] +## Prerequisites [ece-prerequisites-rhel8] Follow your internal guidelines to create a RHEL 8 (the version must be >= 8.5), RHEL 9, Rocky Linux 8, or Rocky Linux 9 server or VM in your environment. @@ -26,7 +26,7 @@ Verify that required traffic is allowed. Check the [Networking prerequisites](ec **Example:** For AWS, allowing traffic between hosts is implemented using security groups. -### Configure the host [ece-configure-hosts-rhel8-podman] +## Configure the host [ece-configure-hosts-rhel8-podman] 1. Install the OS packages `lvm2`, `iptables`, `sysstat`, and `net-tools` by executing: diff --git a/deploy-manage/deploy/cloud-enterprise/configure-host-suse.md b/deploy-manage/deploy/cloud-enterprise/configure-host-suse.md index 07301aaa06..e4c7db05f7 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-host-suse.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-host-suse.md @@ -5,9 +5,10 @@ applies_to: mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-hosts-sles12-cloud.html - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-hosts-sles12-onprem.html +navigation_title: SUSE --- -# Configure host SUSE cloud [ece-configure-hosts-sles12] +# Configure a SUSE host [ece-configure-hosts-sles12] The following instructions show you how to prepare your hosts on SLES 12 SP5 or 15. diff --git a/deploy-manage/deploy/cloud-enterprise/configure.md b/deploy-manage/deploy/cloud-enterprise/configure.md index 25b710572f..e318c3573d 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure.md +++ b/deploy-manage/deploy/cloud-enterprise/configure.md @@ -13,7 +13,7 @@ Now that you have {{ece}} up and running, take a look at some of the additional ## Common ECE tasks -* [Assign Roles to Hosts](../../../deploy-manage/deploy/cloud-enterprise/assign-roles-to-hosts.md) - Make sure new hosts can be used for their intended purpose after you install ECE on them. +* [Assign roles to hosts](../../../deploy-manage/deploy/cloud-enterprise/assign-roles-to-hosts.md) - Make sure new hosts can be used for their intended purpose after you install ECE on them. * [System deployments configuration](system-deployments-configuration.md) - Best practices for ECE system deployments to ensure a highly available and resilient setup. * [Configure deployment templates](configure-deployment-templates.md) - Make the most out of deployment templates by configuring ECE for your hardware and creating custom deployment templates. * [Manage Elastic Stack versions](./manage-elastic-stack-versions.md) - Upload or remove Elastic Stack packs. diff --git a/deploy-manage/deploy/cloud-enterprise/install-ece-procedures.md b/deploy-manage/deploy/cloud-enterprise/install-ece-procedures.md index 20b554d3e3..e2b8957e4c 100644 --- a/deploy-manage/deploy/cloud-enterprise/install-ece-procedures.md +++ b/deploy-manage/deploy/cloud-enterprise/install-ece-procedures.md @@ -7,7 +7,7 @@ applies_to: # ECE installation procedures -Choose the Elastic Cloud Enterprise deployment scenario that best fits your business needs: +Choose the guide for the Elastic Cloud Enterprise [deployment scenario](/deploy-manage/deploy/cloud-enterprise/identify-deployment-scenario.md) that best fits your business needs: * [Deploy a small installation](deploy-small-installation.md): For development, test, and small-scale use cases. * [Deploy a medium installation](deploy-medium-installation.md): For many production setups. diff --git a/deploy-manage/deploy/cloud-enterprise/install.md b/deploy-manage/deploy/cloud-enterprise/install.md index 87f094002c..762b3014ea 100644 --- a/deploy-manage/deploy/cloud-enterprise/install.md +++ b/deploy-manage/deploy/cloud-enterprise/install.md @@ -44,7 +44,7 @@ ECE supports a [wide range of OS versions](https://www.elastic.co/support/matrix * [SUSE Linux Enterprise Server (SLES) 12 SP5 and 15](configure-host-suse.md) ::::{important} -Cloud providers default provide automatic operating system patching for their virtual machines. We strongly recommend disabling this feature to avoid potential data loss and installation failure. All patching should be done through [Perform host maintenance](../../maintenance/ece/perform-ece-hosts-maintenance.md) instructions. +Cloud providers default provide automatic operating system patching for their virtual machines. We strongly recommend disabling this feature to avoid potential data loss and installation failure. All patching should be done using the [Perform host maintenance](../../maintenance/ece/perform-ece-hosts-maintenance.md) instructions. :::: ## Install ECE [install-ece] diff --git a/deploy-manage/deploy/cloud-enterprise/post-installation-steps.md b/deploy-manage/deploy/cloud-enterprise/post-installation-steps.md index da379f5c87..73f238fb0d 100644 --- a/deploy-manage/deploy/cloud-enterprise/post-installation-steps.md +++ b/deploy-manage/deploy/cloud-enterprise/post-installation-steps.md @@ -20,7 +20,7 @@ After your Elastic Cloud Enterprise installation is up, some additional steps mi If you intend to use [custom endpoint aliases](./enable-custom-endpoint-aliases.md) functionality, ensure you add the necessary Subject Alternative Name (SAN) entries to the proxy certificate. :::: -* Optionally, if you want the deployment endpoint links and Single-sign on to work with your domain name, configure it as the **deployment domain name** in the Platform → Settings section of the [Cloud UI](./log-into-cloud-ui.md). The domain name is used to generate the endpoint URLs and must align with your proxy certificate and DNS record. +* Optionally, if you want the deployment endpoint links and Single-sign on to work with your domain name, configure it as the **deployment domain name** in the **Platform** > **Settings** section of the [Cloud UI](./log-into-cloud-ui.md). The domain name is used to generate the endpoint URLs and must align with your proxy certificate and DNS record. ::::{tip} For example, if your proxy certificate is signed for `*.elastic-cloud-enterprise.example.com` and you have a wildcard DNS register pointing `*.elastic-cloud-enterprise.example.com` to your load balancer, you should configure `elastic-cloud-enterprise.example.com` as the **deployment domain name** in Platform → Settings. Refer to [](./change-endpoint-urls.md) for more details. @@ -33,6 +33,10 @@ After your Elastic Cloud Enterprise installation is up, some additional steps mi * [Add a snapshot repository](../../tools/snapshot-and-restore/cloud-enterprise.md) to enable regular backups of your Elasticsearch clusters. * Consider enabling encryption-at-rest (EAR) on your hosts. + + :::{{tip}} + Encryption-at-rest is not implemented out of the box in {{{ece}}. [Learn more](/deploy-manage/security/secure-your-elastic-cloud-enterprise-installation.md#ece_encryption). + ::: * To start creating {{es}} deployments, refer to [](./working-with-deployments.md). From 8b39a14f251de05e791430e57f1fb6edf65f5fdc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Wed, 5 Mar 2025 12:41:08 +0100 Subject: [PATCH 15/29] working with shaina's suggestions --- .../deploy/cloud-enterprise/ece-ha.md | 23 ++++++++----------- .../cloud-enterprise/prepare-environment.md | 5 ++-- 2 files changed, 11 insertions(+), 17 deletions(-) diff --git a/deploy-manage/deploy/cloud-enterprise/ece-ha.md b/deploy-manage/deploy/cloud-enterprise/ece-ha.md index c4ca0d81d6..3d87a911a5 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-ha.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-ha.md @@ -8,16 +8,17 @@ mapped_pages: # High availability [ece-ha] +Ensuring high availability in {{ece}} (ECE) requires careful planning and implementation across multiple areas, including availability zones, master nodes, replica shards, snapshot backups, and Zookeeper nodes. This section outlines key considerations and best practices to prevent downtime and data loss at both the ECE platform level and within orchestrated deployments. ## Availability zones [ece-ece-ha-1-az] -Fault tolerance for Elastic Cloud Enterprise is based around the concept of *availability zones*. +Fault tolerance for ECE is based around the concept of *availability zones*. -An availability zone contains resources available to an Elastic Cloud Enterprise installation that are isolated from other availability zones to safeguard against potential failure. +An availability zone contains resources available to an ECE installation that are isolated from other availability zones to safeguard against potential failure. -Planning for a fault-tolerant installation with multiple availability zones means avoiding any single point of failure that could bring down Elastic Cloud Enterprise. +Planning for a fault-tolerant installation with multiple availability zones means avoiding any single point of failure that could bring down ECE. -The main difference between Elastic Cloud Enterprise installations that include two or three availability zones is that three availability zones enable Elastic Cloud Enterprise to create clusters with a *tiebreaker*. If you have only two availability zones in total in your installation, no tiebreaker is created. +The main difference between ECE installations that include two or three availability zones is that three availability zones enable ECE to create clusters with a *tiebreaker*. If you have only two availability zones in total in your installation, no tiebreaker is created. We recommend that for each deployment you use at least two availability zones for production and three for mission-critical systems. Using more than three availability zones for a deployment is not required nor supported. Availability zones are intended for high availability, not scalability. @@ -25,18 +26,16 @@ We recommend that for each deployment you use at least two availability zones fo {{es}} clusters that are set up to use only one availability zone are not [highly available](/deploy-manage/production-guidance/availability-and-resilience.md) and are at risk of data loss. To safeguard against data loss, you must use at least two {{ece}} availability zones. :::: - ::::{warning} Increasing the number of zones should not be used to add more resources. The concept of zones is meant for High Availability (2 zones) and Fault Tolerance (3 zones), but neither will work if the cluster relies on the resources from those zones to be operational. The recommendation is to scale up the resources within a single zone until the cluster can take the full load (add some buffer to be prepared for a peak of requests), then scale out by adding additional zones depending on your requirements: 2 zones for High Availability, 3 zones for Fault Tolerance. :::: - ## Master nodes [ece-ece-ha-2-master-nodes] -$$$ece-ha-tiebreaker$$$Tiebreakers are used in distributed clusters to avoid cases of [split brain](https://en.wikipedia.org/wiki/Split-brain_(computing)), where an {{es}} cluster splits into multiple, autonomous parts that continue to handle requests independently of each other, at the risk of affecting cluster consistency and data loss. A split-brain scenario is avoided by making sure that a minimum number of [master-eligible nodes](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/configuration-reference/node-settings.md#master-node) must be present in order for any part of the cluster to elect a master node and accept user requests. To prevent multiple parts of a cluster from being eligible, there must be a [quorum-based majority](/deploy-manage/distributed-architecture/discovery-cluster-formation/modules-discovery-quorums.md) of `(n/2)+1` nodes, where `n` is the number of master-eligible nodes in the cluster. The minimum number of master nodes to reach quorum in a two-node cluster is the same as for a three-node cluster: two nodes must be available. +Tiebreakers are used in distributed clusters to avoid cases of [split brain](https://en.wikipedia.org/wiki/Split-brain_(computing)), where an {{es}} cluster splits into multiple, autonomous parts that continue to handle requests independently of each other, at the risk of affecting cluster consistency and data loss. A split-brain scenario is avoided by making sure that a minimum number of [master-eligible nodes](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/configuration-reference/node-settings.md#master-node) must be present in order for any part of the cluster to elect a master node and accept user requests. To prevent multiple parts of a cluster from being eligible, there must be a [quorum-based majority](/deploy-manage/distributed-architecture/discovery-cluster-formation/modules-discovery-quorums.md) of `(n/2)+1` nodes, where `n` is the number of master-eligible nodes in the cluster. The minimum number of master nodes to reach quorum in a two-node cluster is the same as for a three-node cluster: two nodes must be available. -When you create a cluster with nodes in two availability zones when a third zone is available, Elastic Cloud Enterprise can create a tiebreaker in the third availability zone to help establish quorum in case of loss of an availability zone. The extra tiebreaker node that helps to provide quorum does not have to be a full-fledged and expensive node, as it does not hold data. For example: By tagging allocators hosts in Elastic Cloud Enterprise, can you create a cluster with eight nodes each in zones `ece-1a` and `ece-1b`, for a total of 16 nodes, and one tiebreaker node in zone `ece-1c`. This cluster can lose any of the three availability zones whilst maintaining quorum, which means that the cluster can continue to process user requests, provided that there is sufficient capacity available when an availability zone goes down. +When you create a cluster with nodes in two availability zones when a third zone is available, ECE can create a tiebreaker in the third availability zone to help establish quorum in case of loss of an availability zone. The extra tiebreaker node that helps to provide quorum does not have to be a full-fledged and expensive node, as it does not hold data. For example: By tagging allocators hosts in ECE, can you create a cluster with eight nodes each in zones `ece-1a` and `ece-1b`, for a total of 16 nodes, and one tiebreaker node in zone `ece-1c`. This cluster can lose any of the three availability zones whilst maintaining quorum, which means that the cluster can continue to process user requests, provided that there is sufficient capacity available when an availability zone goes down. By default, each node in an {{es}} cluster is a master-eligible node and a data node. In larger clusters, such as production clusters, it’s a good practice to split the roles, so that master nodes are not handling search or indexing work. When you create a cluster, you can specify to use dedicated [master-eligible nodes](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/configuration-reference/node-settings.md#master-node), one per availability zone. @@ -44,8 +43,6 @@ By default, each node in an {{es}} cluster is a master-eligible node and a data Clusters that only have two or fewer master-eligible node are not [highly available](/deploy-manage/production-guidance/availability-and-resilience.md) and are at risk of data loss. You must have [at least three master-eligible nodes](/deploy-manage/distributed-architecture/discovery-cluster-formation/modules-discovery-quorums.md). :::: - - ## Replica shards [ece-ece-ha-3-replica-shards] With multiple {{es}} nodes in multiple availability zones you have the recommended hardware, the next thing to consider is having the recommended index replication. Each index, with the exception of searchable snapshot indexes, should have one or more replicas. Use the index settings API to find any indices with no replica: @@ -58,18 +55,16 @@ GET _all/_settings/index.number_of_replicas Indices with no replica, except for [searchable snapshot indices](/deploy-manage/tools/snapshot-and-restore/searchable-snapshots.md), are not highly available. You should use replicas to mitigate against possible data loss. :::: - - ## Snapshot backups [ece-ece-ha-4-snapshot] You should configure and use [{{es}} snapshots](/deploy-manage/tools/snapshot-and-restore.md). Snapshots provide a way to backup and restore your {{es}} indices. They can be used to copy indices for testing, to recover from failures or accidental deletions, or to migrate data to other deployments. We recommend configuring an [{{ece}}-level repository](../../tools/snapshot-and-restore/cloud-enterprise.md) to apply across all deployments. See [Work with snapshots](../../tools/snapshot-and-restore.md) for more guidance. - ## Furthermore considerations [ece-ece-ha-5-other] * Make sure you have three Zookeepers - by default, on the Director host - for your ECE installation. Similar to three Elasticsearch master nodes can form a quorum, three Zookeepers can forum the quorum for high availability purposes. Backing up Zookeeper data directory is also recommended, read [this doc](../../../troubleshoot/deployments/cloud-enterprise/rebuilding-broken-zookeeper-quorum.md) for more guidance. + * Make sure that if you’re using a [private Docker registry server](ece-install-offline-with-registry.md) or are using any [custom bundles and plugins](../../../solutions/search/full-text/search-with-synonyms.md) hosted on a web server, that these are available to all ECE allocators, so that they can continue to be accessed in the event of a network partition or zone outage. + * Don’t delete containers unless guided by Elastic Support or there’s public documentation explicitly describing this as required action. Otherwise, it can cause issues and you may lose access or functionality of your {{ece}} platform. See [Troubleshooting container engines](../../../troubleshoot/deployments/cloud-enterprise/troubleshooting-container-engines.md) for more information. If in doubt, please [contact support for help](../../../troubleshoot/deployments/cloud-enterprise/ask-for-help.md). - diff --git a/deploy-manage/deploy/cloud-enterprise/prepare-environment.md b/deploy-manage/deploy/cloud-enterprise/prepare-environment.md index 031df21a84..45c8845c71 100644 --- a/deploy-manage/deploy/cloud-enterprise/prepare-environment.md +++ b/deploy-manage/deploy/cloud-enterprise/prepare-environment.md @@ -8,6 +8,7 @@ mapped_pages: # Prepare your environment [ece-prereqs] +In this section you'll find all the prerequisites and environment preparations required to properly plan and install {{ece}} (ECE). ## Requirements [ece-prepare-requirements] @@ -15,7 +16,6 @@ mapped_pages: These prerequisites are critical to establish a supported ECE configuration. Using unsupported combinations can cause a number of either intermediate or potentially permanent issues with your ECE environment, such as failures to create [system deployments](system-deployments-configuration.md), failures to upgrade workload deployments, proxy timeouts, data loss, and more. If upgrading ECE, read [upgrade your installation](../../upgrade/orchestrator/upgrade-cloud-enterprise.md) for guidance. :::: - To prepare your hosts for their ECE installation, the following prerequisites **must** be met: * [Hardware prerequisites](ece-hardware-prereq.md) @@ -24,10 +24,9 @@ To prepare your hosts for their ECE installation, the following prerequisites ** * [Networking prerequisites](ece-networking-prereq.md) * [Users and permissions prerequisites](ece-users-permissions.md) - ## Best practices and recommendations [ece-prepare-recommendations] -To prepare your hosts for ECE installation, the following best practices are recommended and should be considered: +Follow these best practices to properly prepare your ECE installation: * [High availability](ece-ha.md) - For production and mission-critical systems, high availability **must** be considered * [Separation of roles](ece-roles.md) - To group components on ECE and prevent conflicting workloads, consider role separation From bec10bb7986d8a01d023ce4cdc13533bf4e7ccff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Wed, 5 Mar 2025 21:05:12 +0100 Subject: [PATCH 16/29] applying Shaina's guidance and suggestions --- .../cloud-enterprise/air-gapped-install.md | 7 ++-- ...-add-support-for-node-roles-autoscaling.md | 8 ++-- .../cloud-enterprise/change-endpoint-urls.md | 7 +--- .../cloud-enterprise/configure-host-suse.md | 42 +++++++++---------- .../deploy/cloud-enterprise/configure.md | 15 +++---- .../deploy-large-installation.md | 24 +++++++---- .../deploy-medium-installation.md | 19 +++++++-- .../deploy-small-installation.md | 11 +++-- ...-ce-add-support-for-integrations-server.md | 2 +- ...ce-configure-templates-index-management.md | 3 +- ...figuring-ece-configure-system-templates.md | 11 ++--- .../ece-configuring-ece-create-templates.md | 1 + ...ring-ece-instance-configurations-create.md | 2 +- ...guring-ece-instance-configurations-edit.md | 12 +++--- .../deploy/cloud-enterprise/ece-ha.md | 6 ++- .../ece-include-additional-kibana-plugin.md | 1 + .../ece-install-offline-images.md | 2 +- .../ece-install-offline-no-registry.md | 9 +++- .../ece-install-offline-with-registry.md | 18 +++++--- .../deploy/cloud-enterprise/ece-jvm.md | 1 - ...-installation-of-ece-using-podman-hosts.md | 20 ++------- .../install-ece-procedures.md | 5 ++- .../deploy/cloud-enterprise/install.md | 7 ++-- ...-ece-on-podman-hosts-to-selinux-enforce.md | 6 ++- .../migrate-ece-to-podman-hosts.md | 17 ++------ .../post-installation-steps.md | 13 ++++-- .../cloud-enterprise/prepare-environment.md | 6 ++- .../system-deployments-configuration.md | 15 ++----- deploy-manage/toc.yml | 2 +- 29 files changed, 155 insertions(+), 137 deletions(-) diff --git a/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md b/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md index 050e23f27a..da252cc9d7 100644 --- a/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md +++ b/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md @@ -16,10 +16,9 @@ Installing ECE on hosts without internet access is commonly referred to as an *o Before you start, you must: -* Follow [](./prepare-environment.md) steps as you would for other installation methods, except that outgoing internet connections for downloading Docker images are not required. -* [Configure your operating system](./configure-operating-system.md). +* Follow the same prerequisites described in [](./install.md#ece-install-prerequisites). This includes [](./identify-deployment-scenario.md) and [](./prepare-environment.md) steps. +* [Configure your operating system](./configure-operating-system.md) in all ECE hosts. * Be part of the `docker` group to run the installation script. You should not install Elastic Cloud Enterprise as the `root` user. -* Set up your [wildcard DNS record](./ece-wildcard-dns.md). * Set up and run a local copy of the Elastic Package Repository, otherwise your deployments with APM server and Elastic agent won’t work. Refer to the [Running EPR in air-gapped environments](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/air-gapped.md#air-gapped-diy-epr) documentation. When you are ready to install ECE, you can proceed: @@ -27,6 +26,8 @@ When you are ready to install ECE, you can proceed: * [With your private Docker registry](./ece-install-offline-with-registry.md) * [Without a private Docker registry](./ece-install-offline-no-registry.md) +After installing ECE in your hosts, you can continue with [](./post-installation-steps.md). + ::::{note} Deployment End-of-life (EOL) information relies on the connection to [https://www.elastic.co/support/eol.json](https://www.elastic.co/support/eol.json). If EOL information is updated, Elastic may require you to reconnect to [https://www.elastic.co/support/eol.json](https://www.elastic.co/support/eol.json) over the internet to get this information reflected. :::: diff --git a/deploy-manage/deploy/cloud-enterprise/ce-add-support-for-node-roles-autoscaling.md b/deploy-manage/deploy/cloud-enterprise/ce-add-support-for-node-roles-autoscaling.md index 6f7d5ad33f..8199d35107 100644 --- a/deploy-manage/deploy/cloud-enterprise/ce-add-support-for-node-roles-autoscaling.md +++ b/deploy-manage/deploy/cloud-enterprise/ce-add-support-for-node-roles-autoscaling.md @@ -1,4 +1,5 @@ --- +navigation_title: Data tiers and autoscaling support applies_to: deployment: ece: all @@ -8,10 +9,11 @@ mapped_pages: # Updating custom templates to support node_roles and autoscaling [ce-add-support-for-node-roles-and-autoscaling] -Custom deployment templates should be updated in order to take advantage of new Elastic Cloud Enterprise features, such as [Data tiers](../../../manage-data/lifecycle/data-tiers.md) (that is, the new cold and frozen data tiers) and [Deployment autoscaling](../../autoscaling.md). By updating these templates we also ensure forward compatibility with future Elastic Cloud Enterprise versions that will require certain fields such as `node_roles` and `id` to be present in the deployment configuration. - -System owned deployment templates have already been updated to support both data tiers with `node_roles` and autoscaling. However, the custom templates that you created need to be manually updated by following the steps in this guide. +Templates created in older versions of ECE should be updated in order to take advantage of new Elastic Cloud Enterprise features, such as [Data tiers](../../../manage-data/lifecycle/data-tiers.md), and [Deployment autoscaling](../../autoscaling.md). By updating these templates we also ensure forward compatibility with future Elastic Cloud Enterprise versions that will require certain fields such as `node_roles` and `id` to be present in the deployment configuration. +::::{note} +System owned deployment templates are automatically updated during the ECE upgrade process to support both data tiers with `node_roles` and autoscaling. However, custom templates that you created must be manually updated by following the steps in this guide. +:::: ## Adding support for node_roles [ece_adding_support_for_node_roles] diff --git a/deploy-manage/deploy/cloud-enterprise/change-endpoint-urls.md b/deploy-manage/deploy/cloud-enterprise/change-endpoint-urls.md index adc269ca01..034a7637ce 100644 --- a/deploy-manage/deploy/cloud-enterprise/change-endpoint-urls.md +++ b/deploy-manage/deploy/cloud-enterprise/change-endpoint-urls.md @@ -12,15 +12,11 @@ For applications without SSL or HTTPS protocol support, you can use a local endp 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: -::::{admonition} -```text +```sh http://CLUSTER_ID.LOCAL_HOST_IP.ip.es.io:9200 https://CLUSTER_ID.LOCAL_HOST_IP.ip.es.io:9243 ``` -:::: - - For example: ```sh @@ -32,7 +28,6 @@ https://2882c82e54d4361.us-west-5.aws.found.io:9243 To find your endpoints, select a deployment review the information on the **Elasticsearch** and **Kibana** pages. :::: - To change endpoints in the Cloud UI: 1. [Log into the Cloud UI](log-into-cloud-ui.md). diff --git a/deploy-manage/deploy/cloud-enterprise/configure-host-suse.md b/deploy-manage/deploy/cloud-enterprise/configure-host-suse.md index e4c7db05f7..5fd99dd82b 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-host-suse.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-host-suse.md @@ -17,12 +17,12 @@ The following instructions show you how to prepare your hosts on SLES 12 SP5 or * [Update the configurations settings](#ece-update-config-sles) * [Configure the Docker daemon options](#ece-configure-docker-daemon-sles12) -If you want to install Elastic Cloud Enterprise on your own hosts, the steps for preparing your hosts can take a bit of time. There are two ways you can approach this: +If you want to install {{ece}} (ECE) on your own hosts, the steps for preparing your hosts can take a bit of time. There are two ways you can approach this: -* **Think like a minimalist**: [Install the correct version of Docker](#ece-install-docker-sles12) on hosts that meet the [prerequisites](prepare-environment.md) for Elastic Cloud Enterprise, then skip ahead and [install Elastic Cloud Enterprise](install.md#install-ece). Be aware that some checks during the installation can fail with this approach, which will mean doing further host preparation work before retrying the installation. -* **Cover your bases**: If you want to make absolutely sure that your installation of Elastic Cloud Enterprise can succeed on hosts that meet the [prerequisites](prepare-environment.md), or if any of the checks during the installation failed previously, run through the full preparation steps in this section and then and [install Elastic Cloud Enterprise](install.md#install-ece). You’ll do a bit more work now, but life will be simpler later on. +* **Think like a minimalist**: [Install the correct version of Docker](#ece-install-docker-sles12) on hosts that meet the [prerequisites](prepare-environment.md) for ECE, then skip ahead and [install ECE](install.md#install-ece). Be aware that some checks during the installation can fail with this approach, which will mean doing further host preparation work before retrying the installation. +* **Cover your bases**: If you want to make absolutely sure that your installation of {{ece}} can succeed on hosts that meet the [prerequisites](prepare-environment.md), or if any of the checks during the installation failed previously, run through the full preparation steps in this section and then and [install ECE](install.md#install-ece). You’ll do a bit more work now, but life will be simpler later on. -Regardless of which approach you take, the steps in this section need to be performed on every host that you want to use with Elastic Cloud Enterprise. +Regardless of which approach you take, the steps in this section need to be performed on every host that you want to use with ECE. ## Install Docker [ece-install-docker-sles12] @@ -92,7 +92,7 @@ XFS is required to support disk space quotas for Elasticsearch data directories. Disk space quotas set a limit on the amount of disk space an Elasticsearch cluster node can use. Currently, quotas are calculated by a static ratio of 1:32, which means that for every 1 GB of RAM a cluster is given, a cluster node is allowed to consume 32 GB of disk space. ::::{note} -Using LVM, `mdadm`, or a combination of the two for block device management is possible, but the configuration is not covered here, nor is it provided as part of supporting Elastic Cloud Enterprise. +Using LVM, `mdadm`, or a combination of the two for block device management is possible, but the configuration is not covered here, nor is it provided as part of supporting ECE. :::: @@ -115,7 +115,7 @@ You must use XFS and have quotas enabled on all allocators, otherwise disk usage sudo install -o $USER -g elastic -d -m 700 /mnt/data ``` -3. Add an entry to the `/etc/fstab` file for the new XFS volume. The default filesystem path used by Elastic Cloud Enterprise is `/mnt/data`. +3. Add an entry to the `/etc/fstab` file for the new XFS volume. The default filesystem path used by ECE is `/mnt/data`. ```sh /dev/xvdg1 /mnt/data xfs defaults,pquota,prjquota,x-systemd.automount 0 0 @@ -181,7 +181,7 @@ You must use XFS and have quotas enabled on all allocators, otherwise disk usage 4. Adjust the system limits. - Add the following configuration values to the `/etc/security/limits.conf` file. These values are derived from our experience with the Elastic Cloud hosted offering and should be used for Elastic Cloud Enterprise as well. + Add the following configuration values to the `/etc/security/limits.conf` file. These values are derived from our experience with the Elastic Cloud hosted offering and should be used for ECE as well. ::::{tip} If you are using a user name other than `elastic`, adjust the configuration values accordingly. @@ -266,7 +266,7 @@ You must use XFS and have quotas enabled on all allocators, otherwise disk usage } ``` -2. The user installing {{ece}} must have a User ID (UID) and Group ID (GID) of 1000 or higher. Make sure that the GID matches the ID of the `elastic`` group created earlier (likely to be 1000). You can set this using the following command: +2. The user installing ECE must have a User ID (UID) and Group ID (GID) of 1000 or higher. Make sure that the GID matches the ID of the `elastic`` group created earlier (likely to be 1000). You can set this using the following command: ```sh sudo usermod -g $USER @@ -274,23 +274,23 @@ You must use XFS and have quotas enabled on all allocators, otherwise disk usage 3. Apply the updated Docker daemon configuration: - Reload the Docker daemon configuration: + * Reload the Docker daemon configuration: - ```sh - sudo systemctl daemon-reload - ``` + ```sh + sudo systemctl daemon-reload + ``` - Restart the Docker service: + * Restart the Docker service: - ```sh - sudo systemctl restart docker - ``` + ```sh + sudo systemctl restart docker + ``` - Enable Docker to start on boot: + * Enable Docker to start on boot: - ```sh - sudo systemctl enable docker - ``` + ```sh + sudo systemctl enable docker + ``` 4. Recommended: Tune your network settings. @@ -346,4 +346,4 @@ You must use XFS and have quotas enabled on all allocators, otherwise disk usage If the command returns `Docker Root Dir: /var/lib/docker`, then you need to troubleshoot the previous configuration steps until the Docker settings are applied successfully before continuing with the installation process. For more information, check [Custom Docker daemon options](https://docs.docker.com/engine/admin/systemd/#/custom-docker-daemon-options) in the Docker documentation. -8. Repeat these steps on other hosts that you want to use with Elastic Cloud Enterprise or follow the steps in the next section to start installing Elastic Cloud Enterprise. +8. Repeat these steps on other hosts that you want to use with ECE or follow the steps in the next section to start installing {{ece}}. diff --git a/deploy-manage/deploy/cloud-enterprise/configure.md b/deploy-manage/deploy/cloud-enterprise/configure.md index e318c3573d..cc569297ad 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure.md +++ b/deploy-manage/deploy/cloud-enterprise/configure.md @@ -15,7 +15,7 @@ Now that you have {{ece}} up and running, take a look at some of the additional * [Assign roles to hosts](../../../deploy-manage/deploy/cloud-enterprise/assign-roles-to-hosts.md) - Make sure new hosts can be used for their intended purpose after you install ECE on them. * [System deployments configuration](system-deployments-configuration.md) - Best practices for ECE system deployments to ensure a highly available and resilient setup. -* [Configure deployment templates](configure-deployment-templates.md) - Make the most out of deployment templates by configuring ECE for your hardware and creating custom deployment templates. +* [Configure deployment templates](configure-deployment-templates.md) – Define the resources, topology, hardware, and configurations that will be applied to your deployments. * [Manage Elastic Stack versions](./manage-elastic-stack-versions.md) - Upload or remove Elastic Stack packs. * [Change the ECE API URL](./change-ece-api-url.md) - Configure the HTTPS URL used to access the ECE API. * [Change endpoint URLs](change-endpoint-urls.md) - Configure the URLs to access {{es}} and {{kib}} deployments to match your [domain name](./ece-wildcard-dns.md) and [proxy certificate](../../security/secure-your-elastic-cloud-enterprise-installation/manage-security-certificates.md). @@ -39,11 +39,8 @@ Other sections of the documentation describe important ECE features to consider: Refer to [ECE maintenance](../../maintenance/ece.md) for important maintenance activities, including adding capacity, applying OS patches, and addressing host failures. -* [Scale Out Your Installation](../../../deploy-manage/maintenance/ece/scale-out-installation.md) - Need to add more capacity? Here’s how. -* [Enable Maintenance Mode](../../../deploy-manage/maintenance/ece/enable-maintenance-mode.md) - Perform administrative actions on allocators safely by putting them into maintenance mode first. -* [Move Nodes From Allocators](../../../deploy-manage/maintenance/ece/move-nodes-instances-from-allocators.md) - Moves all Elasticsearch clusters and Kibana instances to another allocator, so that the allocator is no longer used for handling user requests. -* [Perform Host Maintenance](../../../deploy-manage/maintenance/ece/perform-ece-hosts-maintenance.md) - Apply operating system patches and other maintenance to hosts safely without removing them from your ECE installation. -* [Delete Hosts](../../../deploy-manage/maintenance/ece/delete-ece-hosts.md) - Remove a host from your ECE installation, either because it is no longer needed or because it is faulty. - -* [Upgrade Your Installation](../../../deploy-manage/upgrade/orchestrator/upgrade-cloud-enterprise.md) - A new version of Elastic Cloud Enterprise is available and you want to upgrade. Here’s how. - +* [Scale out your installation](../../../deploy-manage/maintenance/ece/scale-out-installation.md) - Need to add more capacity? Here’s how. +* [Enable maintenance mode](../../../deploy-manage/maintenance/ece/enable-maintenance-mode.md) - Perform administrative actions on allocators safely by putting them into maintenance mode first. +* [Move nodes from allocators](../../../deploy-manage/maintenance/ece/move-nodes-instances-from-allocators.md) - Moves all Elasticsearch clusters and Kibana instances to another allocator, so that the allocator is no longer used for handling user requests. +* [Perform host maintenance](../../../deploy-manage/maintenance/ece/perform-ece-hosts-maintenance.md) - Apply operating system patches and other maintenance to hosts safely without removing them from your ECE installation. +* [Delete hosts](../../../deploy-manage/maintenance/ece/delete-ece-hosts.md) - Remove a host from your ECE installation, either because it is no longer needed or because it is faulty. diff --git a/deploy-manage/deploy/cloud-enterprise/deploy-large-installation.md b/deploy-manage/deploy/cloud-enterprise/deploy-large-installation.md index d17e9f927b..fe2e56c516 100644 --- a/deploy-manage/deploy/cloud-enterprise/deploy-large-installation.md +++ b/deploy-manage/deploy/cloud-enterprise/deploy-large-installation.md @@ -25,8 +25,7 @@ This type of installation is recommended for deployments with significant overal :alt: A large installation with nine to twelve hosts across three availability zones ::: - -## Before you start [ece_before_you_start_3] +## Important considerations [ece_before_you_start_3] Note that the large-sized Elastic Cloud Enterprise installation separates the allocator and proxy roles from the director and coordinator roles (ECE management services). @@ -45,7 +44,9 @@ Note that the large-sized Elastic Cloud Enterprise installation separates the al For production environments, you must define the memory settings for each role, except for the `proxy` role, as starting from ECE 2.4 the JVM proxy was replaced with a Golang-based proxy. If you don’t set any memory setting, the default values are used, which are inadequate for production environments and can lead to performance or stability issues. :::: +## Before you start +Make sure you have completed all prerequisites and environment preparations described in the [Installation overview](./install.md), and that the hosts are configured according to [](./configure-operating-system.md). ## Installation steps [ece_installation_steps_3] @@ -86,12 +87,19 @@ For production environments, you must define the memory settings for each role, 5. To handle the routing of user requests to Elasticsearch, install Elastic Cloud Enterprise on a three additional hosts, distributing them evenly across the existing three availability zones, and assign them the `proxy` role. Do not assign any other roles, as these hosts should only route user requests. Make sure you include the coordinator host IP information from step 1 and the new roles token from step 2. ```sh - bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'MY_TOKEN' --roles "proxy" --availability-zone MY_ZONE-1 --memory-settings - '{"runner":{"xms":"1G","xmx":"1G"}}' + bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'MY_TOKEN' --roles "proxy" --availability-zone MY_ZONE-1 --memory-settings '{"runner":{"xms":"1G","xmx":"1G"}}' + ``` - bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'MY_TOKEN' --roles "proxy" --availability-zone MY_ZONE-2 --memory-settings - '{"runner":{"xms":"1G","xmx":"1G"}}' + ```sh + bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'MY_TOKEN' --roles "proxy" --availability-zone MY_ZONE-2 --memory-settings '{"runner":{"xms":"1G","xmx":"1G"}}' + ``` - bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'MY_TOKEN' --roles "proxy" --availability-zone MY_ZONE-3 --memory-settings - '{"runner":{"xms":"1G","xmx":"1G"}}' + ```sh + bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'MY_TOKEN' --roles "proxy" --availability-zone MY_ZONE-3 --memory-settings '{"runner":{"xms":"1G","xmx":"1G"}}' ``` + +6. [Change the deployment configuration](working-with-deployments.md) for the `admin-console-elasticsearch`, `logging-and-metrics`, and `security` clusters to use three availability zones and resize the nodes to use at least 4 GB of RAM. This change makes sure that the clusters used by the administration console are highly available and provisioned sufficiently. + +7. [Log into the Cloud UI](log-into-cloud-ui.md) to provision your deployment. + +Once the installation is complete, you can continue with [](./post-installation-steps.md). \ No newline at end of file diff --git a/deploy-manage/deploy/cloud-enterprise/deploy-medium-installation.md b/deploy-manage/deploy/cloud-enterprise/deploy-medium-installation.md index 50933a8854..5e5d630d11 100644 --- a/deploy-manage/deploy/cloud-enterprise/deploy-medium-installation.md +++ b/deploy-manage/deploy/cloud-enterprise/deploy-medium-installation.md @@ -19,8 +19,7 @@ This type of installation is recommended for many production setups. You need: :alt: A medium installation with nine to twelve hosts across three availability zones ::: - -## Before you start [ece_before_you_start_2] +## Important considerations [ece_before_you_start_2] * Monitor the load on proxies and make sure the volume of user requests routed by the proxies does not affect the resources available to the ECE management services. * Note that the medium-sized Elastic Cloud Enterprise installation separates the allocator from the director and coordinator roles (ECE management services) and the proxy roles. @@ -40,7 +39,9 @@ This type of installation is recommended for many production setups. You need: For production environments, you must define the memory settings for each role, except for the `proxy` role, as starting from ECE 2.4 the JVM proxy was replaced with a Golang-based proxy. If you don’t set any memory setting, the default values are used, which are inadequate for production environments and can lead to performance or stability issues. :::: +## Before you start +Make sure you have completed all prerequisites and environment preparations described in the [Installation overview](./install.md), and that the hosts are configured according to [](./configure-operating-system.md). ## Installation steps [ece_installation_steps_2] @@ -68,12 +69,22 @@ For production environments, you must define the memory settings for each role, bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'MY_TOKEN' --roles "director,coordinator,proxy" --availability-zone MY_ZONE-3 --memory-settings '{"runner":{"xms":"1G","xmx":"1G"},"zookeeper":{"xms":"8G","xmx":"8G"},"director":{"xms":"1G","xmx":"1G"},"constructor":{"xms":"4G","xmx":"4G"},"admin-console":{"xms":"8G","xmx":"8G"}}' ``` -4. To handle the Elasticsearch and Kibana workload, install Elastic Cloud Enterprise on a fourth, fifth, and sixth host, distributing them evenly across the existing three availability zones and assign them the `allocator` role. Make sure you include the coordinator host IP information and allocator roles token from step 1. +4. To handle the Elasticsearch and Kibana workloads, install Elastic Cloud Enterprise on a fourth, fifth, and sixth host, distributing them evenly across the existing three availability zones and assign them the `allocator` role. Make sure you include the coordinator host IP information and allocator roles token from step 1. ```sh bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'ALLOCATOR_TOKEN' --roles "allocator" --availability-zone MY_ZONE-1 --memory-settings '{"runner":{"xms":"1G","xmx":"1G"},"allocator":{"xms":"4G","xmx":"4G"}}' + ``` + ```sh bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'ALLOCATOR_TOKEN' --roles "allocator" --availability-zone MY_ZONE-2 --memory-settings '{"runner":{"xms":"1G","xmx":"1G"},"allocator":{"xms":"4G","xmx":"4G"}}' - + ``` + + ```sh bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'ALLOCATOR_TOKEN' --roles "allocator" --availability-zone MY_ZONE-3 --memory-settings '{"runner":{"xms":"1G","xmx":"1G"},"allocator":{"xms":"4G","xmx":"4G"}}' ``` + +5. [Change the deployment configuration](working-with-deployments.md) for the `admin-console-elasticsearch`, `logging-and-metrics`, and `security` clusters to use three availability zones and resize the nodes to use at least 4 GB of RAM. This change makes sure that the clusters used by the administration console are highly available and provisioned sufficiently. + +6. [Log into the Cloud UI](log-into-cloud-ui.md) to provision your deployment. + +Once the installation is complete, you can continue with [](./post-installation-steps.md). \ No newline at end of file diff --git a/deploy-manage/deploy/cloud-enterprise/deploy-small-installation.md b/deploy-manage/deploy/cloud-enterprise/deploy-small-installation.md index 28c6db330c..9196d92453 100644 --- a/deploy-manage/deploy/cloud-enterprise/deploy-small-installation.md +++ b/deploy-manage/deploy/cloud-enterprise/deploy-small-installation.md @@ -18,8 +18,7 @@ The type of installation is recommended for development, test, and small-scale u :alt: A small baseline installation with three hosts across three availability zones ::: - -## Before you start [ece_before_you_start] +## Important considerations [ece_before_you_start] * This type of installation is **not recommended for high-traffic workloads**. * You must not use **spinning disks** with small ECE installations, as these are not supported when you run allocators and ECE management services on the same server. @@ -40,6 +39,9 @@ The type of installation is recommended for development, test, and small-scale u For production environments, you must define the memory settings for each role, except for the `proxy` role, as starting from ECE 2.4 the JVM proxy was replaced with a Golang-based proxy. If you don’t set any memory setting, the default values are used, which are inadequate for production environments and can lead to performance or stability issues. :::: +## Before you start + +Make sure you have completed all prerequisites and environment preparations described in the [Installation overview](./install.md), and that the hosts are configured according to [](./configure-operating-system.md). ## Installation steps [ece_installation_steps] @@ -68,7 +70,10 @@ For production environments, you must define the memory settings for each role, bash <(curl -fsSL https://download.elastic.co/cloud/elastic-cloud-enterprise.sh) install --coordinator-host HOST_IP --roles-token 'MY_TOKEN' --roles "director,coordinator,proxy,allocator" --availability-zone MY_ZONE-3 --memory-settings '{"runner":{"xms":"1G","xmx":"1G"},"allocator":{"xms":"4G","xmx":"4G"},"zookeeper":{"xms":"4G","xmx":"4G"},"director":{"xms":"1G","xmx":"1G"},"constructor":{"xms":"4G","xmx":"4G"},"admin-console":{"xms":"4G","xmx":"4G"}}' ``` -4. [Change the deployment configuration for the `admin-console-elasticsearch`, `logging-and-metrics`, and `security` clusters](working-with-deployments.md) to use three availability zones and resize the nodes to use at least 4 GB of RAM. This change makes sure that the clusters used by the administration console are highly available and provisioned sufficiently. +4. [Change the deployment configuration](working-with-deployments.md) for the `admin-console-elasticsearch`, `logging-and-metrics`, and `security` clusters to use three availability zones and resize the nodes to use at least 4 GB of RAM. This change makes sure that the clusters used by the administration console are highly available and provisioned sufficiently. + 5. [Log into the Cloud UI](log-into-cloud-ui.md) to provision your deployment. If necessary, you can scale and deploy a [medium installation](deploy-medium-installation.md). + +Once the installation is complete, you can continue with [](./post-installation-steps.md). \ No newline at end of file diff --git a/deploy-manage/deploy/cloud-enterprise/ece-ce-add-support-for-integrations-server.md b/deploy-manage/deploy/cloud-enterprise/ece-ce-add-support-for-integrations-server.md index e22b8fef1d..0375fb3e2b 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-ce-add-support-for-integrations-server.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-ce-add-support-for-integrations-server.md @@ -1,4 +1,5 @@ --- +navigation_title: Integrations server support applies_to: deployment: ece: all @@ -45,7 +46,6 @@ To manually update your custom deployment templates to support Integrations Serv ] ``` - Send a `PUT` request with the updated template in the payload to replace the original template with the new one. Remember that: * The following request is just an example; other resources in the request payload should remain unchanged (they have been truncated in the example). diff --git a/deploy-manage/deploy/cloud-enterprise/ece-configure-templates-index-management.md b/deploy-manage/deploy/cloud-enterprise/ece-configure-templates-index-management.md index 0dc5b7cf03..a9495cbc14 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-configure-templates-index-management.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-configure-templates-index-management.md @@ -1,4 +1,5 @@ --- +navigation_title: Configure index management applies_to: deployment: ece: all @@ -6,7 +7,7 @@ mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configure-templates-index-management.html --- -# Configure index management for templates [ece-configure-templates-index-management] +# Configure index management for deployment templates [ece-configure-templates-index-management] If you create a deployment template that includes more than one data configuration, you must also specify how Elastic Cloud Enterprise should manage indices for your users when they create their deployments. For time-series use cases such as logging, metrics, and APM, providing a template that enables index management ensures that data is being stored in the most cost-effective way possible as it ages. 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 f7fc4736bf..4d93ffff94 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 @@ -1,4 +1,5 @@ --- +navigation_title: Configure default templates applies_to: deployment: ece: all @@ -6,14 +7,15 @@ mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configuring-ece-configure-system-templates.html --- -# Configure system deployment templates [ece-configuring-ece-configure-system-templates] +# Configure default system deployment templates [ece-configuring-ece-configure-system-templates] -While you can create new deployment templates for some use cases, if the system templates generally suit your needs but just require minor changes, you may choose to configure or modify the system templates. +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. -Note that you cannot edit system templates through the UI; they may only be configured through the API. - +::::{note} +You cannot edit system templates through the UI; they can only be configured through the API. +:::: ## Configure system deployment templates through the RESTful API [ece_configure_system_deployment_templates_through_the_restful_api] @@ -21,7 +23,6 @@ Note that you cannot edit system templates through the UI; they may only be conf The API user must have the `Platform admin` role in order to configure system templates. :::: - 1. Obtain the existing system deployment template you wish to modify. Note the `id` of the system deployment template as you will include this value in the API call to edit the template. ```sh 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 83d97ac30a..7c60a6059f 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 @@ -1,4 +1,5 @@ --- +navigation_title: Create templates applies_to: deployment: ece: all diff --git a/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-instance-configurations-create.md b/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-instance-configurations-create.md index 80fab48f5b..b5401110aa 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-instance-configurations-create.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-instance-configurations-create.md @@ -8,7 +8,7 @@ mapped_pages: # Create instance configurations [ece-configuring-ece-instance-configurations-create] -If you plan to [create your own templates](ece-configuring-ece-create-templates.md) and the default instance configurations that ship with ECE don’t quite suit your purpose, it’s generally easier and safer to create your own custom instance configurations first. Instance configurations match components of the Elastic Stack to allocators and tailor how memory and storage resources get sized relative to each other, and what sizes are available. +If you plan to [create your own templates](ece-configuring-ece-create-templates.md) and the [default instance configurations](./ece-configuring-ece-instance-configurations-default.md) that ship with ECE don’t quite suit your purpose, it’s generally easier and safer to create your own custom instance configurations first. Instance configurations match components of the Elastic Stack to allocators and tailor how memory and storage resources get sized relative to each other, and what sizes are available. ## Before you begin [ece_before_you_begin_2] diff --git a/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-instance-configurations-edit.md b/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-instance-configurations-edit.md index 93be518574..c12d2ff333 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-instance-configurations-edit.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-instance-configurations-edit.md @@ -19,23 +19,21 @@ You might need to edit instance configurations under the following circumstances If you edit instance configurations, so that they match fewer allocators, instances of the Elastic Stack that were previously matched to those allocators might be relocated. Keep this in mind when making queries more restrictive. :::: - - ## Steps [ece_steps] 1. [Log into the Cloud UI](log-into-cloud-ui.md). 2. From the **Platform** menu, select **Templates**. -3. Select the **Instance configurations** tab to check the default instance configurations that ship with ECE. +3. Select the **Instance configurations** tab to check the [default instance configurations](./ece-configuring-ece-instance-configurations-default.md) that ship with ECE. 4. Choose one of the instance configurations and select **Edit instance configuration**. For example: Select to edit the `data.default` default instance configuration, so that you can specify where Elasticsearch data nodes for incoming data should be deployed. In a hot-warm architecture, this will determine where your hot data gets sent to. 5. In the **Input** section, construct a query that filters on specific allocator tags. - The following steps assume that no query exists, as is the case when you edit the default instance configurations for the first time after installing ECE version 2.0 or later. You can also edit an existing query by modifying the inner and outer clauses. + The following steps assume that no query exists, as is the case when you edit the [default instance configurations](./ece-configuring-ece-instance-configurations-default.md) for the first time after installing ECE version 2.0 or later. You can also edit an existing query by modifying the inner and outer clauses. ::::{tip} - An *outer clause* ANDs or ORs your main filtering criteria. You use outer clauses to find the allocators that you tagged earlier. An *inner clause* modifies an outer clause and let’s you refine your filtering criteria further. If you are unsure how the process works, try searching on some of the allocator tags that you added and check how the query results change. If you are editing the `data.default` default instance configuration, you want your query to return all allocators on which Elasticsearch data nodes for incoming data can be placed. + An *outer clause* ANDs or ORs your main filtering criteria. You use outer clauses to find the allocators that you tagged earlier. An *inner clause* modifies an outer clause and let’s you refine your filtering criteria further. If you are unsure how the process works, try searching on some of the allocator tags that you added and check how the query results change. If you are editing the `data.default` instance configuration, you want your query to return all allocators on which Elasticsearch data nodes for incoming data can be placed. :::: @@ -50,11 +48,11 @@ If you edit instance configurations, so that they match fewer allocators, instan 3. Check the list of allocators that get matched by your query: - * If you are satisfied that your query matches all the allocators where the component(s) of the Elastic Stack can be deployed, move on to the next step. For the `data.default` default instance configuration, this means all the allocators where Elasticsearch data nodes for incoming data should be deployed, for example. + * If you are satisfied that your query matches all the allocators where the component(s) of the Elastic Stack can be deployed, move on to the next step. For the `data.default` instance configuration, this means all the allocators where Elasticsearch data nodes for incoming data should be deployed, for example. * If you need to refine your query further, continue to adjust your outer or inner clauses. If you are unsure what to do, keep your initial query simple. You can always refine the query later on by re-editing the instance configuration. 6. Select **Save changes**. -7. If you are configuring the default instance configurations for the hot-warm template: Repeat steps 4 through 6 for the `data.highstorage`, `master`, `coordinating`, `kibana`, and `ml` instance configurations. +7. If you are configuring the [default instance configurations](./ece-configuring-ece-instance-configurations-default.md) for the hot-warm template: Repeat steps 4 through 6 for the `data.highstorage`, `master`, `coordinating`, `kibana`, and `ml` instance configurations. For example: For the `data.highstorage` instance configuration, your query should filter for allocators that use spindle-based storage. If you are using our [sample tags](ece-configuring-ece-tag-allocators.md#allocator-sample-tags), you could filter on either `SSD: false` or `highstorage: true`, depending on which tag you decided to use. For the `master` and `kibana` configurations, some multi-purpose hardware might work well. The `ml` instance configuration can benefit from hardware that provides higher CPU (`highCPU: true` in our sample tags). diff --git a/deploy-manage/deploy/cloud-enterprise/ece-ha.md b/deploy-manage/deploy/cloud-enterprise/ece-ha.md index 3d87a911a5..8db8390d24 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-ha.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-ha.md @@ -8,7 +8,9 @@ mapped_pages: # High availability [ece-ha] -Ensuring high availability in {{ece}} (ECE) requires careful planning and implementation across multiple areas, including availability zones, master nodes, replica shards, snapshot backups, and Zookeeper nodes. This section outlines key considerations and best practices to prevent downtime and data loss at both the ECE platform level and within orchestrated deployments. +Ensuring high availability in {{ece}} (ECE) requires careful planning and implementation across multiple areas, including availability zones, master nodes, replica shards, snapshot backups, and Zookeeper nodes. + +This section describes key considerations and best practices to prevent downtime and data loss at both the ECE platform level and within orchestrated deployments. ## Availability zones [ece-ece-ha-1-az] @@ -55,6 +57,8 @@ GET _all/_settings/index.number_of_replicas Indices with no replica, except for [searchable snapshot indices](/deploy-manage/tools/snapshot-and-restore/searchable-snapshots.md), are not highly available. You should use replicas to mitigate against possible data loss. :::: +Refer to [](../../reference-architectures.md) for information about {{es}} architectures. + ## Snapshot backups [ece-ece-ha-4-snapshot] You should configure and use [{{es}} snapshots](/deploy-manage/tools/snapshot-and-restore.md). Snapshots provide a way to backup and restore your {{es}} indices. They can be used to copy indices for testing, to recover from failures or accidental deletions, or to migrate data to other deployments. We recommend configuring an [{{ece}}-level repository](../../tools/snapshot-and-restore/cloud-enterprise.md) to apply across all deployments. See [Work with snapshots](../../tools/snapshot-and-restore.md) for more guidance. diff --git a/deploy-manage/deploy/cloud-enterprise/ece-include-additional-kibana-plugin.md b/deploy-manage/deploy/cloud-enterprise/ece-include-additional-kibana-plugin.md index d2f8015916..97964752d0 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-include-additional-kibana-plugin.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-include-additional-kibana-plugin.md @@ -1,4 +1,5 @@ --- +navigation_title: Include additional Kibana plugins applies_to: deployment: ece: all diff --git a/deploy-manage/deploy/cloud-enterprise/ece-install-offline-images.md b/deploy-manage/deploy/cloud-enterprise/ece-install-offline-images.md index 78127ed7d9..f9019483ed 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-install-offline-images.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-install-offline-images.md @@ -61,7 +61,7 @@ Enterprise Search is not available in versions 9.0+. ## All available Elastic Stack packs and Docker images [ece-full-download-list] -::::{dropdown} **Expand to view the full list** +::::{dropdown} Expand to view the full list | Required downloads | Minimum required ECE version | | --- | --- | | [Elasticsearch, Kibana, APM, and Enterprise Search stack pack: 8.17.1](https://download.elastic.co/cloud-enterprise/versions/8.17.1.zip) | ECE 3.0.0
(+ docker 20.10.10+ required for 8.16+) | diff --git a/deploy-manage/deploy/cloud-enterprise/ece-install-offline-no-registry.md b/deploy-manage/deploy/cloud-enterprise/ece-install-offline-no-registry.md index 7cc45717ed..7d426c18e7 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-install-offline-no-registry.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-install-offline-no-registry.md @@ -1,4 +1,5 @@ --- +navigation_title: Without a private Docker registry applies_to: deployment: ece: all @@ -6,7 +7,7 @@ mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-offline-no-registry.html --- -# Without a private Docker registry [ece-install-offline-no-registry] +# Air-gapped install without a private Docker registry [ece-install-offline-no-registry] To perform an offline installation without a private Docker registry, you have to download the available Docker Images on each host. @@ -68,6 +69,10 @@ To perform an offline installation without a private Docker registry, you have t 7. Copy the installation script to each host where you plan to install Elastic Cloud Enterprise or make it available on your network. 8. Invoke the installation script on each host: + ::::{note} + The installation commands for this method are the same as in a standard installation. Refer to [](./install-ece-procedures.md) for details on the installation steps and the parameters required by the installation script, which vary based on your installation size. + :::: + 1. On the first host: ```sh @@ -82,4 +87,4 @@ To perform an offline installation without a private Docker registry, you have t --roles-token 'TOKEN' ``` - + Once the installation is complete, refer to [](./log-into-cloud-ui.md) to access Cloud UI. \ No newline at end of file diff --git a/deploy-manage/deploy/cloud-enterprise/ece-install-offline-with-registry.md b/deploy-manage/deploy/cloud-enterprise/ece-install-offline-with-registry.md index dbcab8a1b4..a28dd31665 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-install-offline-with-registry.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-install-offline-with-registry.md @@ -1,4 +1,5 @@ --- +navigation_title: With your private Docker registry applies_to: deployment: ece: all @@ -6,7 +7,7 @@ mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-offline-with-registry.html --- -# With your private Docker registry [ece-install-offline-with-registry] +# Air-gapped install with a private Docker registry [ece-install-offline-with-registry] Installing ECE on multiple hosts with your own registry server is simpler, because you do not have to load the Docker images on each host. @@ -39,7 +40,7 @@ Installing ECE on multiple hosts with your own registry server is simpler, becau Enterprise Search is not available in versions 9.0+. ::: -3. Tag the Docker images with your private registry, where `REGISTRY` is `my.private.repo:5000`, for example: +3. Tag the Docker images with your private registry URL by replacing `REGISTRY` with your actual registry address, for example `my.private.repo:5000`: ```sh docker tag docker.elastic.co/cloud-enterprise/elastic-cloud-enterprise:3.8.1 REGISTRY/cloud-enterprise/elastic-cloud-enterprise:3.8.1 @@ -53,7 +54,7 @@ Installing ECE on multiple hosts with your own registry server is simpler, becau docker tag docker.elastic.co/cloud-release/enterprise-search-cloud:8.17.1 REGISTRY/cloud-release/enterprise-search-cloud:8.17.1 ``` -4. Push the Docker images to your private Docker registry, where `REGISTRY` is `my.private.repo:5000`, for example: +4. Push the Docker images to your private Docker registry, using the same tags from the previous step. Replace `REGISTRY` with your actual registry URL, for example `my.private.repo:5000`: ```sh docker push REGISTRY/cloud-enterprise/elastic-cloud-enterprise:3.8.1 @@ -73,8 +74,13 @@ Installing ECE on multiple hosts with your own registry server is simpler, becau curl -L -O https://download.elastic.co/cloud/elastic-cloud-enterprise.sh ``` -6. Copy the installation script to each host where you plan to install Elastic Cloud Enterprise. (Alternatively, you can place the installation script in a secure network location where your other hosts can access it.) -7. Invoke the installation script on each host with the `--docker-registry REGISTRY` parameter, where `REGISTRY` is `my.private.repo:5000`, for example: +6. Copy the installation script to each host where you plan to install Elastic Cloud Enterprise or make it available on your network. + +7. Invoke the installation script on each host with the `--docker-registry REGISTRY` parameter, replacing `REGISTRY` with your actual registry URL (for example `my.private.repo:5000`): + + ::::{note} + Refer to [](./install-ece-procedures.md) for more details on the parameters to pass to the installation script depending on the size of your installation. + :::: 1. On the first host: @@ -92,4 +98,4 @@ Installing ECE on multiple hosts with your own registry server is simpler, becau --docker-registry REGISTRY ``` - + Once the installation is complete, refer to [](./log-into-cloud-ui.md) to access Cloud UI. \ No newline at end of file diff --git a/deploy-manage/deploy/cloud-enterprise/ece-jvm.md b/deploy-manage/deploy/cloud-enterprise/ece-jvm.md index bd9dff5652..64ed541a13 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-jvm.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-jvm.md @@ -12,7 +12,6 @@ mapped_pages: ECE uses default JVM heap sizes for services that work for testing. Make sure to configure the JVM heap size that fits your use case. Not following the recommended settings may cause issues later on as volume of data and usage increases. :::: - When you install ECE specify the recommended JVM heap sizes with `--memory-settings JVM_SETTINGS` parameter, based on the use cases as described below: * [Deploy a small installation](deploy-small-installation.md): For development, test, and small-scale use cases. diff --git a/deploy-manage/deploy/cloud-enterprise/fresh-installation-of-ece-using-podman-hosts.md b/deploy-manage/deploy/cloud-enterprise/fresh-installation-of-ece-using-podman-hosts.md index 4954a7a130..4a5770dcf5 100644 --- a/deploy-manage/deploy/cloud-enterprise/fresh-installation-of-ece-using-podman-hosts.md +++ b/deploy-manage/deploy/cloud-enterprise/fresh-installation-of-ece-using-podman-hosts.md @@ -16,21 +16,12 @@ This section provides guidelines and recommendations to install ECE using a Podm **Step 2**: Add additional Podman hosts -::::{note} -When copy-pasting commands, verify that characters like quotes (“) are encoded correctly in the console where you copy the command to. +::::{note} +* When copy-pasting commands, verify that characters like quotes (“) are encoded correctly in the console where you copy the command to. +* Steps that run commands starting with `sudo` can be run as any sudoers user. Otherwise, the corresponding user is mentioned as part of the step description. +* Avoid customizing the host Docker path `/mnt/data/docker` when using SELinux. Otherwise the ECE installer script needs to be adjusted. :::: - -::::{note} -Steps that run commands starting with `sudo` can be run as any sudoers user. Otherwise, the corresponding user is mentioned as part of the step description. -:::: - - -::::{note} -Avoid customizing the host Docker path `/mnt/data/docker` when using SELinux. Otherwise the ECE installer script needs to be adjusted. -:::: - - 1. Install ECE Use the ECE installer script together with the `--podman` flag. @@ -47,7 +38,6 @@ Avoid customizing the host Docker path `/mnt/data/docker` when using SELinux. Ot * Make sure you use `--podman`. * Use `--cloud-enterprise-version VERSION_NAME` to specify the correct version. * If you are using SELinux, make sure you also use `--selinux`. - :::: 2. Add additional Podman hosts @@ -79,8 +69,6 @@ Avoid customizing the host Docker path `/mnt/data/docker` when using SELinux. Ot ```sh --roles "allocator,coordinator,director,proxy" ``` - - :::: diff --git a/deploy-manage/deploy/cloud-enterprise/install-ece-procedures.md b/deploy-manage/deploy/cloud-enterprise/install-ece-procedures.md index e2b8957e4c..d1b7833df0 100644 --- a/deploy-manage/deploy/cloud-enterprise/install-ece-procedures.md +++ b/deploy-manage/deploy/cloud-enterprise/install-ece-procedures.md @@ -12,6 +12,7 @@ Choose the guide for the Elastic Cloud Enterprise [deployment scenario](/deploy- * [Deploy a small installation](deploy-small-installation.md): For development, test, and small-scale use cases. * [Deploy a medium installation](deploy-medium-installation.md): For many production setups. * [Deploy a large installation](deploy-large-installation.md): For deployments with significant overall search and indexing throughput. -* [Deploy using Podman](fresh-installation-of-ece-using-podman-hosts.md): Fresh installation of ECE using Podman hosts. -For installations using Podman instead of Docker, refer to [](./fresh-installation-of-ece-using-podman-hosts.md) +For installations using Podman instead of Docker, refer to [](./fresh-installation-of-ece-using-podman-hosts.md). + +If you need to migrate an existing installation based on Docker to Podman, follow [](./migrate-ece-to-podman-hosts.md). \ No newline at end of file diff --git a/deploy-manage/deploy/cloud-enterprise/install.md b/deploy-manage/deploy/cloud-enterprise/install.md index 762b3014ea..4ebc1e30cd 100644 --- a/deploy-manage/deploy/cloud-enterprise/install.md +++ b/deploy-manage/deploy/cloud-enterprise/install.md @@ -11,7 +11,9 @@ navigation_title: Install ECE # Install Elastic Cloud Enterprise [ece-installing] -You can deploy ECE on public or private clouds, virtual machines, or on-premises. +You can deploy {{ece}} (ECE) on public or private clouds, virtual machines, or on-premises. + +In ECE, a host refers to any server, VM, or cloud instance where the ECE software is installed. An ECE platform consists of multiple hosts working together to orchestrate Elastic Stack applications. For public cloud deployments, you can choose from the following providers: @@ -27,8 +29,7 @@ If you already have an ECE platform up and running, and you want to add hosts to In these pages we frequently refer to [Docker](https://www.docker.com/), as its currently the most common container engine, but these instructions are generally valid for [Podman](https://podman.io/) as well, with `podman` replacing `docker` in commands as appropriate. :::: - -## Prerequisites +## Prerequisites [ece-install-prerequisites] Before you start, make sure to [identify your deployment scenario](identify-deployment-scenario.md) and follow all the referenced sections in [](prepare-environment.md). Make sure that your selected infrastructure meets the requirements. diff --git a/deploy-manage/deploy/cloud-enterprise/migrate-ece-on-podman-hosts-to-selinux-enforce.md b/deploy-manage/deploy/cloud-enterprise/migrate-ece-on-podman-hosts-to-selinux-enforce.md index 8f2045aebf..f56009f9e4 100644 --- a/deploy-manage/deploy/cloud-enterprise/migrate-ece-on-podman-hosts-to-selinux-enforce.md +++ b/deploy-manage/deploy/cloud-enterprise/migrate-ece-on-podman-hosts-to-selinux-enforce.md @@ -8,7 +8,11 @@ mapped_pages: # Migrate ECE on Podman hosts to SELinux enforce [ece-migrate-to-selinux-in-enforcing-mode] -This section provides guidelines and recommendations for migrating an existing platform on a Podman-based environment to use SELinux in `enforcing` mode. The recommended approach consists of four (4) high-level steps. Steps 2-4 need to be repeated for each host in your environment. +This section provides guidelines and recommendations for migrating an existing platform on a Podman-based environment to use SELinux in `enforcing` mode. + +[SELinux](https://www.redhat.com/en/topics/linux/what-is-selinux) (Security-Enhanced Linux) is a security module that enforces mandatory access controls, helping to protect systems from unauthorized access and privilege escalation. Running in enforcing mode ensures that security policies are strictly applied, which can improve security and compliance in hardened environments. + +The migration process consists of four high-level steps. Steps 2-4 need to be repeated for each host in your environment. **Step 1** Migrate existing ECE installation to version >=3.7.2 diff --git a/deploy-manage/deploy/cloud-enterprise/migrate-ece-to-podman-hosts.md b/deploy-manage/deploy/cloud-enterprise/migrate-ece-to-podman-hosts.md index dc0ff2f520..ec1c201fbb 100644 --- a/deploy-manage/deploy/cloud-enterprise/migrate-ece-to-podman-hosts.md +++ b/deploy-manage/deploy/cloud-enterprise/migrate-ece-to-podman-hosts.md @@ -26,22 +26,11 @@ Using Docker or Podman as container runtime is a configuration local to the host ::: ::::{note} -When copy-pasting commands, verify that characters like quotes (“) are encoded correctly in the console where you copy the command to. +* When copy-pasting commands, verify that characters like quotes (“) are encoded correctly in the console where you copy the command to. +* Steps that run commands starting with `sudo` can be run as any sudoers user. Otherwise, the corresponding user is mentioned as part of the step description. +* Avoid customizing the host Docker path `/mnt/data/docker` when using SELinux. Otherwise the ECE installer script needs to be adjusted. :::: - -::::{note} -Steps that run commands starting with `sudo` can be run as any sudoers user. -:::: - - -::::{note} -Avoid customizing the host Docker path `/mnt/data/docker` when using SELinux. Otherwise the ECE installer script needs to be adjusted. -:::: - - -Otherwise, when the file content changes, the corresponding user is mentioned as part of the step description. - 1. Make sure you are running a healthy x-node ECE environment ready to be upgraded. All nodes use the Docker container runtime. 2. Upgrade to ECE 3.3.0+ following the [Upgrade your installation](../../upgrade/orchestrator/upgrade-cloud-enterprise.md) guideline. Skip this step if your existing ECE installation already runs ECE >= 3.3.0. 3. Follow your internal guidelines to add an additional vanilla RHEL (Note that the version must be >= 8.5, but <9), or Rocky Linux 8 or 9 VM to your environment. diff --git a/deploy-manage/deploy/cloud-enterprise/post-installation-steps.md b/deploy-manage/deploy/cloud-enterprise/post-installation-steps.md index 73f238fb0d..2580c1d895 100644 --- a/deploy-manage/deploy/cloud-enterprise/post-installation-steps.md +++ b/deploy-manage/deploy/cloud-enterprise/post-installation-steps.md @@ -10,6 +10,10 @@ mapped_pages: After your Elastic Cloud Enterprise installation is up, some additional steps might be required. For a complete list of configurable features in ECE, refer to [](./configure.md). +::::{tip} +To start creating {{es}} deployments directly, refer to [](./working-with-deployments.md). +:::: + * Add your own [load balancer](./ece-load-balancers.md). Load balancers are user supplied and we do not currently provide configuration steps for you. * In production systems, add your own [Cloud UI and Proxy certificates](../../security/secure-your-elastic-cloud-enterprise-installation/manage-security-certificates.md) to enable secure connections over HTTPS. The proxy certificate must be a wildcard certificate signed for the needed DNS records of your domain. @@ -34,11 +38,12 @@ After your Elastic Cloud Enterprise installation is up, some additional steps mi * Consider enabling encryption-at-rest (EAR) on your hosts. - :::{{tip}} - Encryption-at-rest is not implemented out of the box in {{{ece}}. [Learn more](/deploy-manage/security/secure-your-elastic-cloud-enterprise-installation.md#ece_encryption). + :::{{note}} + Encryption-at-rest is not implemented out of the box in {{ece}}. [Learn more](/deploy-manage/security/secure-your-elastic-cloud-enterprise-installation.md#ece_encryption). ::: -* To start creating {{es}} deployments, refer to [](./working-with-deployments.md). - * Learn about common maintenance activities—such as adding capacity, applying OS patches, and addressing host failures--at [](../../maintenance/ece.md). +::::{warning} +During installation, the system generates secrets that are placed into the `/mnt/data/elastic/bootstrap-state/bootstrap-secrets.json` secrets file, unless you passed in a different path with the --host-storage-path parameter. Keep the information in the `bootstrap-secrets.json` file secure by removing it from its default location and placing it into a secure storage location. +:::: diff --git a/deploy-manage/deploy/cloud-enterprise/prepare-environment.md b/deploy-manage/deploy/cloud-enterprise/prepare-environment.md index 45c8845c71..594a2730d3 100644 --- a/deploy-manage/deploy/cloud-enterprise/prepare-environment.md +++ b/deploy-manage/deploy/cloud-enterprise/prepare-environment.md @@ -12,12 +12,14 @@ In this section you'll find all the prerequisites and environment preparations r ## Requirements [ece-prepare-requirements] +In {{ece}}, an ECE host is the server, virtual machine, or cloud instance where the ECE software is installed. An ECE installation consists of a cluster of multiple hosts, forming the platform where Elastic Stack applications are orchestrated. + +To prepare your hosts for installation, the following prerequisites **must** be met: + ::::{important} These prerequisites are critical to establish a supported ECE configuration. Using unsupported combinations can cause a number of either intermediate or potentially permanent issues with your ECE environment, such as failures to create [system deployments](system-deployments-configuration.md), failures to upgrade workload deployments, proxy timeouts, data loss, and more. If upgrading ECE, read [upgrade your installation](../../upgrade/orchestrator/upgrade-cloud-enterprise.md) for guidance. :::: -To prepare your hosts for their ECE installation, the following prerequisites **must** be met: - * [Hardware prerequisites](ece-hardware-prereq.md) * [Software prerequisites](ece-software-prereq.md) * [System configuration prerequisites](ece-sysconfig.md) diff --git a/deploy-manage/deploy/cloud-enterprise/system-deployments-configuration.md b/deploy-manage/deploy/cloud-enterprise/system-deployments-configuration.md index 936e214e42..f0a89b3206 100644 --- a/deploy-manage/deploy/cloud-enterprise/system-deployments-configuration.md +++ b/deploy-manage/deploy/cloud-enterprise/system-deployments-configuration.md @@ -24,7 +24,7 @@ Admin console - `admin-console-elasticsearch` : Stores the state of your deployments, plans, and other operational data. If this cluster is not available, there will be several unexpected behaviors in the Cloud UI, such as stale or wrong status indicators for deployments, allocators, hosts, and more. Logging and metrics - `logging-and-metrics` -: As part of an ECE environment, a Beats sidecar with Filebeat and Metricbeat is installed on each ECE host. The logs and metrics collected by those beats are indexed in the `logging-and-metrics` cluster. This includes ECE service logs, such as proxy logs, director logs, and more. It also includes hosted deployments logs, security cluster audit logs, and metrics, such as CPU and disk usage. Data is collected from all hosts. This information is critical in order to be able to monitor ECE and troubleshoot issues. You can also use this data to configure watches to alert you in case of an issue, or machine learning jobs that can provide alerts based on anomalies or forecasting. +: As part of an ECE environment, a Beats sidecar with Filebeat and Metricbeat is installed on each ECE host. The logs and metrics collected by those beats are indexed in the `logging-and-metrics` cluster. This includes ECE service logs, such as proxy logs, director logs, and more. It also includes hosted deployments logs, security cluster audit logs, and metrics, such as CPU and disk usage. Data is collected from all hosts. This information is critical in order to be able to monitor ECE and troubleshoot issues. You can also use this data to configure watches to alert you in case of an issue, or machine learning jobs that can provide alerts based on anomalies or forecasting. Security - `security` : When you enable the user management feature, you trigger the creation of a third system deployment named `security`. This cluster stores all security-related configurations, such as native users and the related native realm, integration with SAML or LDAP as external authentication providers and their role mapping, and the realm ordering. The health of this cluster is critical to provide access to the ECE Cloud UI and REST API. To learn more, check [Configure role-based access control](../../users-roles/cloud-enterprise-orchestrator/manage-users-roles.md). Beginning with Elastic Cloud Enterprise 2.5.0 the `security` cluster is created automatically for you. It is recommended to use the [dedicated API](https://www.elastic.co/docs/api/doc/cloud-enterprise/operation/operation-update-security-deployment) to manage the cluster. @@ -42,9 +42,7 @@ For the `logging-and-metrics` cluster, you might want to also make sure that you For the `security` cluster, the number of zones must be set to 3 for high availability, otherwise you may encounter errors when trying to upgrade ECE versions. :::: - - -### Backup and restore [ece_backup_and_restore] +## Backup and restore [ece_backup_and_restore] ECE lets you manage snapshot repositories, so that you can back up and restore your clusters. This mechanism allows you to centrally manage your snapshot repositories, assigning them to deployments, and restoring snapshots to an existing or new deployment. Since the `admin-console-elasticsearch` and `security` clusters have a key role in making sure your ECE installation is operational, it’s important that you configure a snapshot repository after you complete your ECE installation and enable snapshots for both the `admin-console-elasticsearch` and `security` clusters, so that you can easily restore them if needed. @@ -52,8 +50,7 @@ As mentioned earlier, the `logging-and-metrics` cluster stores important informa To configure snapshot repositories, check [Add snapshot repository configurations](../../tools/snapshot-and-restore/cloud-enterprise.md). - -### Sizing [ece_sizing] +## Sizing [ece_sizing] Both the `admin-console-elasticsearch` and `security` clusters require relatively small amounts of RAM and almost no disk space, so increasing their size to 4 GB or 8 GB RAM per data node should be sufficient. @@ -65,8 +62,7 @@ When sizing your `logging-and-metrics` cluster, consider: * the number of ECE hosts, deployments, and log types you want to enable, such as slow logs or audit logs. * the desired retention period for the data. As with any other time-series data, you must properly manage your indices and delete old indices based on that retention period. - -### Access to system deployments [ece_access_to_system_deployments] +## Access to system deployments [ece_access_to_system_deployments] In the case of the `admin-console-elasticsearch` and `security` system deployments, the team managing ECE and assigned to the platform admin role should have permission to change each system deployment configuration and also to access each cluster itself. @@ -76,11 +72,8 @@ The `logging-and-metrics` cluster is different since, as an ECE admin, you likel The `logging-and-metrics` cluster is only intended for troubleshooting ECE deployment issues. If your use case involves modifying or normalizing logs from {{es}} or {{kib}}, use a separate [dedicated monitoring deployment](../../monitor/stack-monitoring/ece-stack-monitoring.md) instead. :::: - You can’t use ECE’s single sign-on (SSO) to access system deployments. ::::{note} Enabling integration with external authentication provider requires that you set the `system_owned` flag to `false` in order to change the elasticsearch.yaml configuration. Remember to set the flag back to `true` after you are done. :::: - - diff --git a/deploy-manage/toc.yml b/deploy-manage/toc.yml index f205506b60..9bae5ca7ec 100644 --- a/deploy-manage/toc.yml +++ b/deploy-manage/toc.yml @@ -168,7 +168,6 @@ toc: - file: deploy/cloud-enterprise/ce-add-support-for-node-roles-autoscaling.md - file: deploy/cloud-enterprise/ece-ce-add-support-for-integrations-server.md - file: deploy/cloud-enterprise/ece-configuring-ece-instance-configurations-default.md - - file: deploy/cloud-enterprise/ece-include-additional-kibana-plugin.md - 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 @@ -177,6 +176,7 @@ toc: - 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 + - file: deploy/cloud-enterprise/ece-include-additional-kibana-plugin.md - file: deploy/cloud-enterprise/migrate-ece-on-podman-hosts-to-selinux-enforce.md - file: deploy/cloud-enterprise/working-with-deployments.md children: From 29bb745cd553e05a352c773532a8ecfa54f6eb27 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Thu, 6 Mar 2025 12:21:03 +0100 Subject: [PATCH 17/29] create deployment doc completed --- .../cloud-enterprise/create-deployment.md | 97 ++++++++++++++++--- .../working-with-deployments.md | 18 ++++ .../cloud-enterprise/ece-access-kibana.md | 33 ------- .../cloud-enterprise/ece-create-deployment.md | 51 ---------- .../cloud-enterprise/ece-manage-kibana.md | 20 ---- 5 files changed, 103 insertions(+), 116 deletions(-) delete mode 100644 raw-migrated-files/cloud/cloud-enterprise/ece-access-kibana.md delete mode 100644 raw-migrated-files/cloud/cloud-enterprise/ece-create-deployment.md delete mode 100644 raw-migrated-files/cloud/cloud-enterprise/ece-manage-kibana.md diff --git a/deploy-manage/deploy/cloud-enterprise/create-deployment.md b/deploy-manage/deploy/cloud-enterprise/create-deployment.md index 5c2b4ee197..91b5d1e82f 100644 --- a/deploy-manage/deploy/cloud-enterprise/create-deployment.md +++ b/deploy-manage/deploy/cloud-enterprise/create-deployment.md @@ -7,22 +7,95 @@ mapped_urls: # 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, including autoscaling, snapshot settings, and security configurations. -% Scope notes: create then access. and then link to add data +In this section, you'll learn how to: -% Use migrated content from existing pages that map to this page: +* [Create a deployment](#ece-create-deployment) +* [Access Kibana](#ece-access-kibana) -% - [ ] ./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 +## Create a deployment [ece-create-deployment] -⚠️ **This page is a work in progress.** ⚠️ +To create a deployment in ECE: -The documentation team is working to combine content pulled from the following pages: +1. From the Cloud UI, select **Create 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 + :::{image} ../../../images/cloud-enterprise-ece-create-deployment.png + :alt: Create a deployment + ::: + + On the **Create deployment** page, you can edit the basic settings or adjust advanced configurations. **Advanced settings** allow you to modify deployment parameters defined by the selected template, such as autoscaling, storage, memory, data tiers, and additional {{stack}} components. + +2. Set a name for your deployment. + +3. Select a deployment template. + +::::{tip} +* Refer to [](./deployment-templates.md) for more information about deployment templates, including descriptions of the default system templates. +* 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, 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**, to configure your deployment for [autoscaling](../../autoscaling/ece-autoscaling.md), storage, memory, and data tiers. Check [Customize your deployment](../../../deploy-manage/deploy/cloud-enterprise/customize-deployment.md) for more details. + +7. 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 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). + +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). + +## 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-deployment.md) and 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 **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. + + ::::{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. + +## Next steps + + Once you have created your deployment, consider the following activities: + +* Connect your applications to your {{es}} cluster to start sending data. +* [Add data](../../../manage-data/ingest.md) +* Configure [users and roles](../../users-roles.md) +* TBD +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. + +Check all other actions from [](./working-with-deployments.md). diff --git a/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md b/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md index 41af26fb38..381e99a145 100644 --- a/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md +++ b/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md @@ -34,3 +34,21 @@ The documentation team is working to combine content pulled from the following p % 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. + + +TBD: where to put this: + +## Other actions + +From the deployment page you can also: + +* Access to different feature sections like +* + +**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-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-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-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. - From 0c0a07246a9a701b89c575119dd1f7b7048eefb9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Thu, 6 Mar 2025 12:41:42 +0100 Subject: [PATCH 18/29] access kibana moved to doc and toc updates --- .../deploy/cloud-enterprise/access-kibana.md | 39 +++++++++++++++ .../cloud-enterprise/configure-deployment.md | 6 +++ .../cloud-enterprise/create-deployment.md | 47 ++----------------- .../working-with-deployments.md | 2 +- deploy-manage/toc.yml | 23 +++++---- raw-migrated-files/toc.yml | 3 -- 6 files changed, 63 insertions(+), 57 deletions(-) create mode 100644 deploy-manage/deploy/cloud-enterprise/access-kibana.md create mode 100644 deploy-manage/deploy/cloud-enterprise/configure-deployment.md 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..c1d7f0d7e5 --- /dev/null +++ b/deploy-manage/deploy/cloud-enterprise/access-kibana.md @@ -0,0 +1,39 @@ +--- +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-deployment.md) and 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 **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. + + ::::{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. + 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..2e9d8d232e --- /dev/null +++ b/deploy-manage/deploy/cloud-enterprise/configure-deployment.md @@ -0,0 +1,6 @@ +--- +mapped_pages: + - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-change-deployment.html +--- + +# Configure deployment diff --git a/deploy-manage/deploy/cloud-enterprise/create-deployment.md b/deploy-manage/deploy/cloud-enterprise/create-deployment.md index 91b5d1e82f..209373c4ec 100644 --- a/deploy-manage/deploy/cloud-enterprise/create-deployment.md +++ b/deploy-manage/deploy/cloud-enterprise/create-deployment.md @@ -1,8 +1,6 @@ --- 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 @@ -11,13 +9,6 @@ An ECE deployment is a fully managed Elastic Stack environment running on {{ece} 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, including autoscaling, snapshot settings, and security configurations. -In this section, you'll learn how to: - -* [Create a deployment](#ece-create-deployment) -* [Access Kibana](#ece-access-kibana) - -## Create a deployment [ece-create-deployment] - To create a deployment in ECE: 1. From the Cloud UI, select **Create deployment**. @@ -55,42 +46,12 @@ To create a deployment in ECE: 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). -## 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-deployment.md) and 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 **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. - - ::::{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. - ## Next steps - Once you have created your deployment, consider the following activities: +Once you have created your deployment, consider the following activities: +(TBD) + +* [Access {{kib}}](./access-kibana.md) * Connect your applications to your {{es}} cluster to start sending data. * [Add data](../../../manage-data/ingest.md) diff --git a/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md b/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md index 381e99a145..579b7efd7d 100644 --- a/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md +++ b/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md @@ -6,7 +6,7 @@ mapped_urls: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-monitoring-deployments.html --- -# Working with deployments +# Manage deployments % What needs to be done: Refine diff --git a/deploy-manage/toc.yml b/deploy-manage/toc.yml index 809b55934c..5c10bf982f 100644 --- a/deploy-manage/toc.yml +++ b/deploy-manage/toc.yml @@ -182,19 +182,22 @@ 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/configure-deployment.md children: - - 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/manage-integrations-server.md - children: - - file: deploy/cloud-enterprise/switch-from-apm-to-integrations-server-payload.md + - file: deploy/cloud-enterprise/customize-deployment.md + - file: deploy/cloud-enterprise/edit-stack-settings.md + - file: deploy/cloud-enterprise/resize-deployment.md + children: + - 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/manage-integrations-server.md + children: + - 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 diff --git a/raw-migrated-files/toc.yml b/raw-migrated-files/toc.yml index 963189d266..8d36a62a17 100644 --- a/raw-migrated-files/toc.yml +++ b/raw-migrated-files/toc.yml @@ -23,7 +23,6 @@ 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 @@ -31,7 +30,6 @@ toc: - file: cloud/cloud-enterprise/ece-autoscaling.md - file: cloud/cloud-enterprise/ece-change-deployment.md - file: cloud/cloud-enterprise/ece-configuring-keystore.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-getting-started-node-js.md @@ -46,7 +44,6 @@ toc: - 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-restful-api-examples-configuring-keystore.md From 6883214f825f99f80ca36f216dbfb2a132558ab6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Fri, 7 Mar 2025 10:21:27 +0100 Subject: [PATCH 19/29] change endpoint urls improved --- .../cloud-enterprise/change-endpoint-urls.md | 23 ++++++------------- .../cloud-enterprise/ece-wildcard-dns.md | 1 - 2 files changed, 7 insertions(+), 17 deletions(-) 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/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. From 2f59b98e26b4fabc7fdd435d1aa3a4e65e03671e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Fri, 7 Mar 2025 11:46:18 +0100 Subject: [PATCH 20/29] cloud id and endpoint docs merged --- deploy-manage/deploy/cloud-enterprise.md | 2 +- .../cloud-enterprise/connect-elasticsearch.md | 104 ++++++++++++++++++ .../deploy/cloud-enterprise/find-cloud-id.md | 68 ------------ .../cloud-enterprise/find-endpoint-url.md | 72 ------------ deploy-manage/toc.yml | 3 +- 5 files changed, 106 insertions(+), 143 deletions(-) create mode 100644 deploy-manage/deploy/cloud-enterprise/connect-elasticsearch.md delete mode 100644 deploy-manage/deploy/cloud-enterprise/find-cloud-id.md delete mode 100644 deploy-manage/deploy/cloud-enterprise/find-endpoint-url.md diff --git a/deploy-manage/deploy/cloud-enterprise.md b/deploy-manage/deploy/cloud-enterprise.md index 41258c4f41..f8bd462834 100644 --- a/deploy-manage/deploy/cloud-enterprise.md +++ b/deploy-manage/deploy/cloud-enterprise.md @@ -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/connect-elasticsearch.md b/deploy-manage/deploy/cloud-enterprise/connect-elasticsearch.md new file mode 100644 index 0000000000..252453107f --- /dev/null +++ b/deploy-manage/deploy/cloud-enterprise/connect-elasticsearch.md @@ -0,0 +1,104 @@ +--- +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. + +{{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, open the endpoint in your browser or 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}}. It works by assigning a unique ID to your hosted {{es}} cluster on {{ece}}. All deployments automatically get a Cloud ID. + +You include your Cloud ID along with your 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. + +::::{note} +For information about beats or logstash refer to xxxx +:::: + +### 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. +:::: + +### 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/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/toc.yml b/deploy-manage/toc.yml index 5c10bf982f..db31ab5a43 100644 --- a/deploy-manage/toc.yml +++ b/deploy-manage/toc.yml @@ -183,6 +183,7 @@ toc: - file: deploy/cloud-enterprise/deployment-templates.md - file: deploy/cloud-enterprise/create-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 @@ -196,8 +197,6 @@ toc: - file: deploy/cloud-enterprise/manage-integrations-server.md children: - 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/search-filter-deployments.md - file: deploy/cloud-enterprise/keep-track-of-deployment-activity.md - file: deploy/cloud-enterprise/tools-apis.md From 4741f3b64f487bca36185509bfd12a4a23e9e423 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Fri, 7 Mar 2025 18:36:42 +0100 Subject: [PATCH 21/29] edit user settings content refined --- .../configure-deployment-templates.md | 2 +- .../cloud-enterprise/connect-elasticsearch.md | 77 +++++++++++-------- .../cloud-enterprise/create-deployment.md | 16 ++-- .../cloud-enterprise/customize-deployment.md | 3 + .../cloud-enterprise/deployment-templates.md | 6 +- .../edit-stack-settings-apm.md | 10 +++ .../edit-stack-settings-elasticsearch.md | 26 ++++--- .../edit-stack-settings-enterprise.md | 12 +++ .../edit-stack-settings-kibana.md | 14 +++- .../cloud-enterprise/edit-stack-settings.md | 48 ++++-------- .../working-with-deployments.md | 3 + deploy-manage/toc.yml | 8 +- .../cloud-enterprise/editing-user-settings.md | 13 ---- 13 files changed, 129 insertions(+), 109 deletions(-) rename raw-migrated-files/cloud/cloud-enterprise/ece-manage-apm-settings.md => deploy-manage/deploy/cloud-enterprise/edit-stack-settings-apm.md (96%) rename raw-migrated-files/cloud/cloud-enterprise/ece-add-user-settings.md => deploy-manage/deploy/cloud-enterprise/edit-stack-settings-elasticsearch.md (55%) rename raw-migrated-files/cloud/cloud-enterprise/ece-manage-enterprise-search-settings.md => deploy-manage/deploy/cloud-enterprise/edit-stack-settings-enterprise.md (88%) rename raw-migrated-files/cloud/cloud-enterprise/ece-manage-kibana-settings.md => deploy-manage/deploy/cloud-enterprise/edit-stack-settings-kibana.md (85%) delete mode 100644 raw-migrated-files/cloud/cloud-enterprise/editing-user-settings.md 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/connect-elasticsearch.md b/deploy-manage/deploy/cloud-enterprise/connect-elasticsearch.md index 252453107f..3dfab87987 100644 --- a/deploy-manage/deploy/cloud-enterprise/connect-elasticsearch.md +++ b/deploy-manage/deploy/cloud-enterprise/connect-elasticsearch.md @@ -24,46 +24,55 @@ To connect to your {{es}} cluster, copy the **{{es}} endpoint** from the deploym 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, open the endpoint in your browser or 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). +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} -When connecting to {{es}}, you can use one of the following ports: -* Port 9243 – Secure HTTPS (**recommended**). -* Port 9200 – Plaintext HTTP (**not recommended**). +Connections through Cloud IDs are only supported in Beats and Logstash. :::: -## 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}}. It works by assigning a unique ID to your hosted {{es}} cluster on {{ece}}. All deployments automatically get a Cloud ID. +Cloud IDs are available in every deployment page, as showed below: -You include your Cloud ID along with your 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 +::: -::::{note} -For information about beats or logstash refer to xxxx -:::: +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] @@ -81,7 +90,7 @@ To use the Cloud ID, you need: ### 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. +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. diff --git a/deploy-manage/deploy/cloud-enterprise/create-deployment.md b/deploy-manage/deploy/cloud-enterprise/create-deployment.md index 209373c4ec..79b795dbf2 100644 --- a/deploy-manage/deploy/cloud-enterprise/create-deployment.md +++ b/deploy-manage/deploy/cloud-enterprise/create-deployment.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_urls: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-create-deployment.html --- @@ -48,15 +51,8 @@ After a deployment is spun up, you can scale the size and add other features; ho ## Next steps -Once you have created your deployment, consider the following activities: -(TBD) +After creating your deployment, you may want to: * [Access {{kib}}](./access-kibana.md) - -* Connect your applications to your {{es}} cluster to start sending data. -* [Add data](../../../manage-data/ingest.md) -* Configure [users and roles](../../users-roles.md) -* TBD -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. - -Check all other actions from [](./working-with-deployments.md). +* [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) \ No newline at end of file diff --git a/deploy-manage/deploy/cloud-enterprise/customize-deployment.md b/deploy-manage/deploy/cloud-enterprise/customize-deployment.md index db8c411bdc..31180fe8e4 100644 --- a/deploy-manage/deploy/cloud-enterprise/customize-deployment.md +++ b/deploy-manage/deploy/cloud-enterprise/customize-deployment.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-customize-deployment.html --- diff --git a/deploy-manage/deploy/cloud-enterprise/deployment-templates.md b/deploy-manage/deploy/cloud-enterprise/deployment-templates.md index 917f5309f1..6d5ff11bea 100644 --- a/deploy-manage/deploy/cloud-enterprise/deployment-templates.md +++ b/deploy-manage/deploy/cloud-enterprise/deployment-templates.md @@ -14,9 +14,9 @@ The components of the Elastic Stack that we support as part of a deployment are * Kibana 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. +Elastic Cloud Enterprise 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 Elastic Stack. -The deployment templates available are: +The system deployment templates available by default are: * **Default template** @@ -42,8 +42,6 @@ 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. 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 96% 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 3e62e7fcc6..2f504a315f 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: @@ -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 55% 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..2d66cf3351 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, check [{{es}} settings](asciidocalypse://pending-link-lisa) on ECE reference documentation. :::: +To add user settings for {{es}} follow the instructions provided in [](./edit-stack-settings.md) -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 88% 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..4bc6b9657a 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} @@ -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 2ac1b3c62c..b35660d525 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](asciidocalypse://docs/kibana/docs/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..a319129d78 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 your deployments' {{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/working-with-deployments.md b/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md index 579b7efd7d..37da5873b2 100644 --- a/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md +++ b/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md @@ -1,4 +1,7 @@ --- +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 diff --git a/deploy-manage/toc.yml b/deploy-manage/toc.yml index db31ab5a43..3cfe558046 100644 --- a/deploy-manage/toc.yml +++ b/deploy-manage/toc.yml @@ -188,9 +188,13 @@ toc: children: - file: deploy/cloud-enterprise/customize-deployment.md - file: deploy/cloud-enterprise/edit-stack-settings.md - - file: deploy/cloud-enterprise/resize-deployment.md children: - - file: deploy/cloud-enterprise/resource-overrides.md + - 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/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 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). - - - - - From 3ffe66a13e0ee07c604c67de7d7467b2857b91fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Sun, 9 Mar 2025 23:24:02 +0100 Subject: [PATCH 22/29] work in progress with deployments --- .../add-custom-bundles-plugins.md | 193 +++++++----------- .../deploy/cloud-enterprise/add-plugins.md | 1 + .../advanced-cluster-configuration.md | 3 + .../cloud-enterprise/configure-deployment.md | 65 +++++- .../cloud-enterprise/connect-elasticsearch.md | 3 +- .../cloud-enterprise/create-deployment.md | 52 +++-- .../cloud-enterprise/customize-deployment.md | 53 ++++- .../ece-regional-deployment-aliases.md | 8 +- .../cloud-enterprise/resize-deployment.md | 3 + .../cloud-enterprise/resource-overrides.md | 5 +- .../working-with-deployments.md | 65 +++++- deploy-manage/toc.yml | 5 +- .../ece-administering-deployments.md | 2 + .../cloud-enterprise/ece-change-deployment.md | 2 + .../ece-monitoring-deployments.md | 2 + .../ece-stack-getting-started.md | 2 + 16 files changed, 307 insertions(+), 157 deletions(-) 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 74e917dddb..207b3f9f43 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,25 +76,9 @@ 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` @@ -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). -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. - :::: - - - 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. + "user_bundles": [ + { + "name": "saml-metadata", + "url": "http://www.MYURL.com/saml-metadata.zip", <1> + "elasticsearch_version": "*" + } + ] + } + ... + ``` - In this example, the SAML metadata file is located in the path `/app/config/saml/metadata.xml`: + 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. + +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::::{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. - - - + 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`. +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 632fc4395e..0cc873d73d 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: 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/configure-deployment.md b/deploy-manage/deploy/cloud-enterprise/configure-deployment.md index 2e9d8d232e..5031e5b343 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-deployment.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-deployment.md @@ -1,6 +1,69 @@ --- +navigation_title: Configure +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-change-deployment.html --- -# Configure deployment +# Configure your deployment [ece-change-deployment] + +In this section you will learn the different ways and possibilities to change your deployment configuration. 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 add, remove, or update {{es}} or {{kib}} configuration settings. +* 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. + + +You can perform the following configuration changes to your deployments: + +* [](./customize-deployment.md): Learn how to change your deployment architecture, configure resources, autoscaling, data tiers, and other {{stack}} components, from the Edit UI. +* [](./edit-stack-settings.md): Add, remove, or update {{es}} or {{kib}} YML configuration settings. +* [](./resize-deployment.md): Scale +* [](./add-plugins.md): Enable or disable plugins from the list of available plugins. +* [](./add-custom-bundles-plugins.md): Add custom plugins or configuration files to your {{es}} instances. +* [](./resource-overrides.md): In certain use cases, extend the cluster capacity temporary. +* [](./advanced-cluster-configuration.md): ... +* + +From the deployment menu you can also access to the configuration of the following features: + +* Logs and metrics (Stack monitoring). +* Snapshots +* Secure settings + +## Configuration use cases + +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 add, remove, or update {{es}} or {{kib}} configuration settings. +* 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. + +## Applying changes + +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.) +:::: + +TBD - EDU + +This section describes how to configure and customize your deployments and the different features available for your deployments, such as: + +* Stack settings: +* Plugins and extensions: +* Custom bundles and plugins +* diff --git a/deploy-manage/deploy/cloud-enterprise/connect-elasticsearch.md b/deploy-manage/deploy/cloud-enterprise/connect-elasticsearch.md index 3dfab87987..7eab5f9016 100644 --- a/deploy-manage/deploy/cloud-enterprise/connect-elasticsearch.md +++ b/deploy-manage/deploy/cloud-enterprise/connect-elasticsearch.md @@ -12,7 +12,8 @@ mapped_pages: 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. -{{ece}} clusters running on ECE only support connections over **HTTP/HTTPS** through the RESTful API. Direct connections to the transport port are not supported. +% 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). diff --git a/deploy-manage/deploy/cloud-enterprise/create-deployment.md b/deploy-manage/deploy/cloud-enterprise/create-deployment.md index 79b795dbf2..a07da63e2e 100644 --- a/deploy-manage/deploy/cloud-enterprise/create-deployment.md +++ b/deploy-manage/deploy/cloud-enterprise/create-deployment.md @@ -8,7 +8,7 @@ mapped_urls: # Create a deployment -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. +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. 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, including autoscaling, snapshot settings, and security configurations. @@ -16,34 +16,36 @@ To create a deployment in ECE: 1. From the Cloud UI, select **Create deployment**. + You can quickly create a deployment by setting the basic parameters shown in the UI. If you need more control, select **Advanced settings** to customize the deployment parameters, including autoscaling, storage, memory, data tiers, and additional Elastic Stack components. Refer to [](./customize-deployment.md) for more information. + :::{image} ../../../images/cloud-enterprise-ece-create-deployment.png :alt: Create a deployment ::: - On the **Create deployment** page, you can edit the basic settings or adjust advanced configurations. **Advanced settings** allow you to modify deployment parameters defined by the selected template, such as autoscaling, storage, memory, data tiers, and additional {{stack}} components. - 2. Set a name for your deployment. 3. Select a deployment template. -::::{tip} -* Refer to [](./deployment-templates.md) for more information about deployment templates, including descriptions of the default system templates. -* 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). -:::: + ::::{tip} + * 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, 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). +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. -:::: + ::::{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**, to configure your deployment for [autoscaling](../../autoscaling/ece-autoscaling.md), storage, memory, and data tiers. Check [Customize your deployment](../../../deploy-manage/deploy/cloud-enterprise/customize-deployment.md) for more details. +6. Select **Advanced settings** if you want to configure [autoscaling](../../autoscaling/ece-autoscaling.md), adjust storage, memory, or customize data tiers. 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 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 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). + ::::{tip} + While 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. @@ -51,8 +53,26 @@ After a deployment is spun up, you can scale the size and add other features; ho ## Next steps -After creating your deployment, you may want to: +% TBD, we have to refine a bit this section + +That’s it! Now that you are up and running, you may want to: -* [Access {{kib}}](./access-kibana.md) +* [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) \ No newline at end of file +* Learn how to configure and [manage your deployment](./working-with-deployments.md) + +% From Shaina in Cloud, TBD. + +## Preparing a deployment for production [ec-prepare-production] + +To make sure you’re all set for production, consider the following actions: + +* [Plan for your expected workloads](/deploy-manage/production-guidance/pl) and consider how many availability zones you’ll need. +* [Create a deployment](/deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.md) on the region you need and with a hardware profile that matches your use case. +* [Change your configuration](/deploy-manage/deploy/elastic-cloud/ec-customize-deployment-components.md) by turning on autoscaling, adding high availability, or adjusting components of the Elastic Stack. +* [Add extensions and plugins](/deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md) to use Elastic supported extensions or add your own custom dictionaries and scripts. +* [Edit settings and defaults](/deploy-manage/deploy/elastic-cloud/edit-stack-settings.md) to fine tune the performance of specific features. +* [Manage your deployment](/deploy-manage/deploy/elastic-cloud/manage-deployments.md) as a whole to restart, upgrade, stop routing, or delete. +* [Set up monitoring](/deploy-manage/monitor/stack-monitoring/elastic-cloud-stack-monitoring.md) to learn how to configure your deployments for observability, which includes metric and log collection, troubleshooting views, and cluster alerts to automate performance monitoring. + + diff --git a/deploy-manage/deploy/cloud-enterprise/customize-deployment.md b/deploy-manage/deploy/cloud-enterprise/customize-deployment.md index 31180fe8e4..3c885817f6 100644 --- a/deploy-manage/deploy/cloud-enterprise/customize-deployment.md +++ b/deploy-manage/deploy/cloud-enterprise/customize-deployment.md @@ -1,4 +1,5 @@ --- +navigation_title: Customize deployment components applies_to: deployment: ece: all @@ -6,14 +7,33 @@ mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-customize-deployment.html --- +% Background and scope note: this document is about the Deployment -> Edit page, how ECE applies changes, and links to other configurable features + # Customize your deployment [ece-customize-deployment] -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. +% TBD, refine this intro after checking the UI +In ECE, you can customize your deployment at any time by selecting **Edit** from the deployment page. This allows you to modify the deployment architecture, adjust configuration settings, availability zones, resources, and enable or disable data tiers. + +::::{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. -On the **Advanced settings** page, you can change the following settings: + 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. + +## Editing deployment + +In the deployment edit page, you can change the following settings: * 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. + +* 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 or cold tier nodes if you have time series data that is accessed less-frequently and rarely needs to be updated. * From the **Size per zone** drop-down menu, select what best fits your requirements. @@ -21,7 +41,9 @@ 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 @@ -29,12 +51,29 @@ On the **Advanced settings** page, you can change the following settings: * Adjust the number of **Availability zones** to increase fault tolerance for the deployment. -* Open **Edit user settings** to change the YML configuration file to further customize how you run {{es}}. +* Select **Edit user settings** to add configuration settings to the YML file of any component and further customize its behavior. -For more information, refer to [Editing your user settings](edit-stack-settings.md). + For more information, refer to [](edit-stack-settings.md). * 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. -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}}. +## Applying changes + +When clicking on **Save changes** in the Edit deployment page + +% TBD, explain a bit the different type of plans + +* Select the method to apply changes + * Rolling inline + * Grow and shrink + +## Other configuration changes + +The following configuration settings are not available within the Edit deployment page: + +* Logs and Metrics (monitoring) +* Secure settings (keystore settings) +* Snapshots + 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 e0e152b0c4..bf57a5e7f9 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: @@ -46,7 +49,6 @@ You can get the application-specific custom endpoint alias by selecting **Copy e :::: - ### With the REST Client [ece-rest-regional-deployment-alias] * As part of the host name: diff --git a/deploy-manage/deploy/cloud-enterprise/resize-deployment.md b/deploy-manage/deploy/cloud-enterprise/resize-deployment.md index 86b15deb15..99eea780e5 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 --- diff --git a/deploy-manage/deploy/cloud-enterprise/resource-overrides.md b/deploy-manage/deploy/cloud-enterprise/resource-overrides.md index 58f293ba42..05a37f9c93 100644 --- a/deploy-manage/deploy/cloud-enterprise/resource-overrides.md +++ b/deploy-manage/deploy/cloud-enterprise/resource-overrides.md @@ -1,11 +1,14 @@ --- +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 {{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 the override permanent by [changing your configuration](working-with-deployments.md). The RAM to CPU proportions can’t be overridden per instance. diff --git a/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md b/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md index 37da5873b2..8751aa7c95 100644 --- a/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md +++ b/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md @@ -5,11 +5,10 @@ applies_to: 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 --- -# Manage deployments +# Manage deployments [ece-stack-getting-started] % What needs to be done: Refine @@ -39,9 +38,51 @@ The documentation team is working to combine content pulled from the following p % * [Set up traffic filters](../../security/traffic-filtering.md) to restrict traffic to your deployment to only trusted IP addresses or VPCs. -TBD: where to put this: +## Introducing deployments [ece_introducing_deployments] -## Other actions +**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. + +## 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. + + +## 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. + +TBD: EDU where to put this: +### Other actions From the deployment page you can also: @@ -55,3 +96,19 @@ From the deployment page you can also: * 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. + +TBD - Link to monitoring and troubleshooting perhaps + +## 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/deploy-manage/toc.yml b/deploy-manage/toc.yml index 3cfe558046..57627d61fa 100644 --- a/deploy-manage/toc.yml +++ b/deploy-manage/toc.yml @@ -171,8 +171,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 @@ -194,9 +192,10 @@ toc: - 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/resource-overrides.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/advanced-cluster-configuration.md - file: deploy/cloud-enterprise/manage-integrations-server.md children: diff --git a/raw-migrated-files/cloud/cloud-enterprise/ece-administering-deployments.md b/raw-migrated-files/cloud/cloud-enterprise/ece-administering-deployments.md index a3a7d7f7a2..712e9a4129 100644 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-administering-deployments.md +++ b/raw-migrated-files/cloud/cloud-enterprise/ece-administering-deployments.md @@ -1,3 +1,5 @@ +% processed + # 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: diff --git a/raw-migrated-files/cloud/cloud-enterprise/ece-change-deployment.md b/raw-migrated-files/cloud/cloud-enterprise/ece-change-deployment.md index 4527b74e8a..07c71e6d90 100644 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-change-deployment.md +++ b/raw-migrated-files/cloud/cloud-enterprise/ece-change-deployment.md @@ -1,3 +1,5 @@ +% processed + # Change your deployment configuration [ece-change-deployment] There are several reasons why you might want to change the configuration of a deployment: diff --git a/raw-migrated-files/cloud/cloud-enterprise/ece-monitoring-deployments.md b/raw-migrated-files/cloud/cloud-enterprise/ece-monitoring-deployments.md index dddc704f63..fc1865090a 100644 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-monitoring-deployments.md +++ b/raw-migrated-files/cloud/cloud-enterprise/ece-monitoring-deployments.md @@ -1,3 +1,5 @@ +% processed + # 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: 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 index cc5fbbfecb..a2280ae4c0 100644 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-stack-getting-started.md +++ b/raw-migrated-files/cloud/cloud-enterprise/ece-stack-getting-started.md @@ -1,3 +1,5 @@ +% processed + # Working with deployments [ece-stack-getting-started] ::::{note} From cb9a8d27f39db7c7c0185c079cf2e92d13327f74 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Mon, 10 Mar 2025 22:38:57 +0100 Subject: [PATCH 23/29] ece manage deployments complete section refined --- deploy-manage/deploy/cloud-enterprise.md | 2 +- .../deploy/cloud-enterprise/access-kibana.md | 2 +- .../cloud-enterprise/configure-deployment.md | 73 ++-- .../cloud-enterprise/create-deployment.md | 22 +- .../cloud-enterprise/customize-deployment.md | 57 +-- .../ece-integrations-server-api-example.md | 10 +- .../cloud-enterprise/edit-stack-settings.md | 2 +- .../manage-integrations-server.md | 47 +- .../cloud-enterprise/resize-deployment.md | 1 - ...from-apm-to-integrations-server-payload.md | 3 + .../deploy/cloud-enterprise/tools-apis.md | 34 +- .../working-with-deployments.md | 117 +++-- deploy-manage/toc.yml | 7 +- .../ece-add-custom-bundle-plugin.md | 408 ------------------ .../ece-administering-deployments.md | 18 - .../cloud/cloud-enterprise/ece-api-console.md | 33 -- .../cloud-enterprise/ece-change-deployment.md | 28 -- .../cloud/cloud-enterprise/ece-find.md | 20 - .../ece-manage-integrations-server.md | 44 -- .../ece-monitoring-deployments.md | 15 - .../ece-stack-getting-started.md | 58 --- raw-migrated-files/toc.yml | 14 - 22 files changed, 195 insertions(+), 820 deletions(-) rename {raw-migrated-files/cloud => deploy-manage/deploy}/cloud-enterprise/ece-integrations-server-api-example.md (96%) delete mode 100644 raw-migrated-files/cloud/cloud-enterprise/ece-add-custom-bundle-plugin.md delete mode 100644 raw-migrated-files/cloud/cloud-enterprise/ece-administering-deployments.md delete mode 100644 raw-migrated-files/cloud/cloud-enterprise/ece-api-console.md delete mode 100644 raw-migrated-files/cloud/cloud-enterprise/ece-change-deployment.md delete mode 100644 raw-migrated-files/cloud/cloud-enterprise/ece-find.md delete mode 100644 raw-migrated-files/cloud/cloud-enterprise/ece-manage-integrations-server.md delete mode 100644 raw-migrated-files/cloud/cloud-enterprise/ece-monitoring-deployments.md delete mode 100644 raw-migrated-files/cloud/cloud-enterprise/ece-stack-getting-started.md diff --git a/deploy-manage/deploy/cloud-enterprise.md b/deploy-manage/deploy/cloud-enterprise.md index f8bd462834..c1c03de565 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: diff --git a/deploy-manage/deploy/cloud-enterprise/access-kibana.md b/deploy-manage/deploy/cloud-enterprise/access-kibana.md index c1d7f0d7e5..4f77e683ca 100644 --- a/deploy-manage/deploy/cloud-enterprise/access-kibana.md +++ b/deploy-manage/deploy/cloud-enterprise/access-kibana.md @@ -19,7 +19,7 @@ To access Kibana: 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. +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. diff --git a/deploy-manage/deploy/cloud-enterprise/configure-deployment.md b/deploy-manage/deploy/cloud-enterprise/configure-deployment.md index 5031e5b343..059436f6bc 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-deployment.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-deployment.md @@ -7,63 +7,38 @@ mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-change-deployment.html --- -# Configure your deployment [ece-change-deployment] - -In this section you will learn the different ways and possibilities to change your deployment configuration. 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 add, remove, or update {{es}} or {{kib}} configuration settings. -* 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. - - -You can perform the following configuration changes to your deployments: - -* [](./customize-deployment.md): Learn how to change your deployment architecture, configure resources, autoscaling, data tiers, and other {{stack}} components, from the Edit UI. -* [](./edit-stack-settings.md): Add, remove, or update {{es}} or {{kib}} YML configuration settings. -* [](./resize-deployment.md): Scale -* [](./add-plugins.md): Enable or disable plugins from the list of available plugins. -* [](./add-custom-bundles-plugins.md): Add custom plugins or configuration files to your {{es}} instances. -* [](./resource-overrides.md): In certain use cases, extend the cluster capacity temporary. -* [](./advanced-cluster-configuration.md): ... -* +% document scope: introduction to deployment configuration use cases -From the deployment menu you can also access to the configuration of the following features: - -* Logs and metrics (Stack monitoring). -* Snapshots -* Secure settings - -## Configuration use cases - -There are several reasons why you might want to change the configuration of a deployment: +# Configure your deployment [ece-change-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 add, remove, or update {{es}} or {{kib}} configuration settings. -* 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. +You might want to change the configuration of your deployment to: -## Applying changes +* Add features, such as machine learning or APM (application performance monitoring). +* Increase or decrease capacity by changing the amount of reserved memory and storage for different parts of your deployment. +* Enable [autoscaling](../../../deploy-manage/autoscaling.md) so that the available resources for deployment components, such as data tiers and machine learning nodes, adjust automatically as the demands on them change over time. +* Enable [high availability](./ece-ha.md), also known as fault tolerance, by adjusting the number of availability zones that parts of your deployment run on. +* Upgrade to new versions of {{es}}. You can upgrade from one major version to another, such as from 6.8.23 to 7.17.27, or from one minor version to another, such as 6.1 to 6.2. You can’t downgrade versions. +* Change what plugins or custom bundles are available on your {{es}} cluster. +* Change {{es}}, {{kib}}, or other stack application YML configuration settings. 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. +When updating an existing deployment, you can make multiple changes in a single configuration update. For example, you increase memory and storage, upgrade minor versions, adjust the number of plugins, and adjust fault tolerance by changing the number of availability zones—all in one action. -::::{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.) +::::{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. :::: -TBD - EDU +## Preparing a deployment for production [ece-prepare-production] + +To make sure you’re all set for production, consider the following actions: -This section describes how to configure and customize your deployments and the different features available for your deployments, such as: +* [](./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): Considerations when scaling deployments. +* [](./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. -* Stack settings: -* Plugins and extensions: -* Custom bundles and plugins -* +Refer to [](./working-with-deployments.md) for additional actions and configurable features for your deployments, such as snapshots, secure settings, and monitoring. diff --git a/deploy-manage/deploy/cloud-enterprise/create-deployment.md b/deploy-manage/deploy/cloud-enterprise/create-deployment.md index a07da63e2e..288b1478f1 100644 --- a/deploy-manage/deploy/cloud-enterprise/create-deployment.md +++ b/deploy-manage/deploy/cloud-enterprise/create-deployment.md @@ -14,7 +14,7 @@ Each deployment is based on a [deployment template](./deployment-templates.md), To create a deployment in ECE: -1. From the Cloud UI, select **Create deployment**. +1. From the Cloud UI **Deployments** view, select **Create deployment**. You can quickly create a deployment by setting the basic parameters shown in the UI. If you need more control, select **Advanced settings** to customize the deployment parameters, including autoscaling, storage, memory, data tiers, and additional Elastic Stack components. Refer to [](./customize-deployment.md) for more information. @@ -31,7 +31,7 @@ To create a deployment in ECE: * 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, refer to [](./manage-elastic-stack-versions.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). @@ -53,26 +53,8 @@ After a deployment is spun up, you can scale the size and add other features; ho ## Next steps -% TBD, we have to refine a bit this section - 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) - -% From Shaina in Cloud, TBD. - -## Preparing a deployment for production [ec-prepare-production] - -To make sure you’re all set for production, consider the following actions: - -* [Plan for your expected workloads](/deploy-manage/production-guidance/pl) and consider how many availability zones you’ll need. -* [Create a deployment](/deploy-manage/deploy/elastic-cloud/create-an-elastic-cloud-hosted-deployment.md) on the region you need and with a hardware profile that matches your use case. -* [Change your configuration](/deploy-manage/deploy/elastic-cloud/ec-customize-deployment-components.md) by turning on autoscaling, adding high availability, or adjusting components of the Elastic Stack. -* [Add extensions and plugins](/deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md) to use Elastic supported extensions or add your own custom dictionaries and scripts. -* [Edit settings and defaults](/deploy-manage/deploy/elastic-cloud/edit-stack-settings.md) to fine tune the performance of specific features. -* [Manage your deployment](/deploy-manage/deploy/elastic-cloud/manage-deployments.md) as a whole to restart, upgrade, stop routing, or delete. -* [Set up monitoring](/deploy-manage/monitor/stack-monitoring/elastic-cloud-stack-monitoring.md) to learn how to configure your deployments for observability, which includes metric and log collection, troubleshooting views, and cluster alerts to automate performance monitoring. - - diff --git a/deploy-manage/deploy/cloud-enterprise/customize-deployment.md b/deploy-manage/deploy/cloud-enterprise/customize-deployment.md index 3c885817f6..5af4b69796 100644 --- a/deploy-manage/deploy/cloud-enterprise/customize-deployment.md +++ b/deploy-manage/deploy/cloud-enterprise/customize-deployment.md @@ -7,12 +7,11 @@ mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-customize-deployment.html --- -% Background and scope note: this document is about the Deployment -> Edit page, how ECE applies changes, and links to other configurable features +% document scope: this document focuses on the Deployment -> Edit page, how ECE applies changes, and links to other configurable features -# Customize your deployment [ece-customize-deployment] +# Customize your deployment components [ece-customize-deployment] -% TBD, refine this intro after checking the UI -In ECE, you can customize your deployment at any time by selecting **Edit** from the deployment page. This allows you to modify the deployment architecture, adjust configuration settings, availability zones, resources, and enable or disable data tiers. +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). ::::{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. @@ -27,13 +26,23 @@ To customize your deployment: 3. From your deployment menu, go to the **Edit** page. -## Editing deployment +4. Let the user interface guide you through the cluster configuration for your cluster. Refer to [](#ece-edit-deployment) for more details. -In the deployment edit page, you can change the following settings: + ::::{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](../../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 or cold tier nodes if you have time series data that is accessed less-frequently and rarely needs to be updated. +* 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. @@ -49,31 +58,27 @@ In the deployment edit page, you can change the following settings: :alt: Number of nodes per deployment size ::: - * Adjust the number of **Availability zones** to increase fault tolerance for the deployment. - -* Select **Edit user settings** to add configuration settings to the YML file of any component and further customize its behavior. - - For more information, refer to [](edit-stack-settings.md). +* Adjust the number of **Availability zones** for each component to enhance [fault tolerance](./ece-ha.md) in your deployment. -* 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. +* Enable additional components, such as [Machine Learning](../../../explore-analyze/machine-learning.md) nodes or an [Integrations server](./manage-integrations-server.md). -## Applying changes +* 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). -When clicking on **Save changes** in the Edit deployment page +* Select the **Advanced edit** link at the bottom of the page to access the [](./advanced-cluster-configuration.md) view. -% TBD, explain a bit the different type of plans + ::::{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. + :::: -* Select the method to apply changes - * Rolling inline - * Grow and shrink +## Configuration strategies [configuration-strategies] -## Other configuration changes +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. -The following configuration settings are not available within the Edit deployment page: +* Autodetect strategy (**recommended**): Let ECE will determine the strategy depending on the type changes to apply. +* Rolling change per node: One node at a time. This strategy performs inline, rolling configuration changes that mutate existing containers. Recommended for most configuration changes. +* Grow and shrink: The orchestrator creates nodes with the new configuration, then migrates data from the old ones, and eventually delete the original nodes. This strategy is automatically selected when adding or removing master-eligibie nodes. +* Rolling grow and shrink: Similar to grow and shrink, but creating one node at a time. This strategy can take a lot longer than grow and shrink. -* Logs and Metrics (monitoring) -* Secure settings (keystore settings) -* Snapshots +The `Extended maintenance` option 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. +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}} and {{kib}}. 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/edit-stack-settings.md b/deploy-manage/deploy/cloud-enterprise/edit-stack-settings.md index a319129d78..a2294115bf 100644 --- a/deploy-manage/deploy/cloud-enterprise/edit-stack-settings.md +++ b/deploy-manage/deploy/cloud-enterprise/edit-stack-settings.md @@ -15,7 +15,7 @@ To customize the settings of your deployments' {{stack}} components: 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}. +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. 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 99eea780e5..a6753146ce 100644 --- a/deploy-manage/deploy/cloud-enterprise/resize-deployment.md +++ b/deploy-manage/deploy/cloud-enterprise/resize-deployment.md @@ -14,7 +14,6 @@ Elasticsearch scales to whatever capacity you need and with as many nodes as the 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. :::: - To resize a deployment: 1. [Log into the Cloud UI](log-into-cloud-ui.md). 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 e427c5852d..6be361d037 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 @@ -6,12 +13,37 @@ ⚠️ **This page is a work in progress.** ⚠️ +**TOOLS** + You can use these tools and APIs to interact with the following {{ece}} features: * [{{ecloud}} Control (ecctl)](asciidocalypse://docs/ecctl/docs/reference/index.md): Wraps typical operations commonly needed by operators within a single command line tool. * [ECE scripts](asciidocalypse://docs/cloud/docs/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 Reference](https://www.elastic.co/guide/en/elasticsearch/reference/current). + + - \ No newline at end of file diff --git a/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md b/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md index 8751aa7c95..d3490874df 100644 --- a/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md +++ b/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md @@ -8,107 +8,88 @@ mapped_urls: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-monitoring-deployments.html --- -# Manage deployments [ece-stack-getting-started] - -% What needs to be done: Refine - -% GitHub issue: https://github.com/elastic/docs-projects/issues/339 - -% Use migrated content from existing pages that map to this page: +% 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) -% - [ ] ./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 - -⚠️ **This page is a work in progress.** ⚠️ +# Manage deployments [ece-stack-getting-started] -The documentation team is working to combine content pulled from the following pages: +{{ece}} allows you to manage one or more instances of the {{stack}} through **deployments**. -* [/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) +## Introducing 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. +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 Elastic Stack products without having to manage each one separately. In a deployment, everything works together. +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. -## Introducing deployments [ece_introducing_deployments] +All of these profiles are based on [deployment templates](./deployment-templates.md), 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. -**The Elastic Stack, managed through {{ecloud}} deployments.** +## Creating deployments -Elastic Cloud Enterprise allows you to manage one or more instances of the Elastic Stack through **deployments**. +Refer to [Create a deployment](./create-deployment.md) to launch and configure an Elastic Stack environment. -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. +## Administering deployments [ece-administering-deployments] -**Hardware profiles to optimize deployments for your usage.** +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. -You can optimize the configuration and performance of a deployment by selecting a **hardware profile** that matches your usage. +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. -*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. +### Configuration and features -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. +From the deployment main page you can quickly access the following configuration areas: -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. +* Select **Edit** to change the deployment configuration, its components and data tiers. Refer to [](./customize-deployment.md) for more details. -## How to operate Elastic Cloud Enterprise? [ece_how_to_operate_elastic_cloud_enterprise] +* 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. -**Where to start?** +* [Upgrade your deployment](../../upgrade/deployment-or-cluster/upgrade-on-ece.md) if a newer {{stack}} version is available. -* 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. +* 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. -## Administering deployments [ece-administering-deployments] + ::::{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). + :::: -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: +### Security and access control -* [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. +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. -TBD: EDU where to put this: -### Other actions +* [Reset elastic 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) -From the deployment page you can also: +### Endpoints, monitoring, and troubleshooting -* Access to different feature sections like -* +From the deployment view, you can directly access endpoints, platform logs and metrics, and troubleshoot issues using various built-in tools. -**Kibana** page you can also: +* Select **Copy endpoint** links to obtain the different URLs to [](./connect-elasticsearch.md) and [](./access-kibana.md). -* 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. +* 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. -TBD - Link to monitoring and troubleshooting perhaps +* Use the [{{es}} API console](./tools-apis.md#ece-api-console) to send API calls directly to {{es}}. -## Keep your clusters healthy [ece-monitoring-deployments] +* [Keep track of your deployment activity](./keep-track-of-deployment-activity.md) and get information about configuration changes results and failures. -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: +* Open the **Operations** page to generate and download diagnostics bundles for {{es}} and {{kib}}, and to access other [tools](./tools-apis.md). -* [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. +### Operational actions -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. +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. \ No newline at end of file diff --git a/deploy-manage/toc.yml b/deploy-manage/toc.yml index 57627d61fa..765dd9270b 100644 --- a/deploy-manage/toc.yml +++ b/deploy-manage/toc.yml @@ -197,11 +197,12 @@ toc: - file: deploy/cloud-enterprise/ece-regional-deployment-aliases.md - file: deploy/cloud-enterprise/resource-overrides.md - file: deploy/cloud-enterprise/advanced-cluster-configuration.md - - file: deploy/cloud-enterprise/manage-integrations-server.md - children: - - file: deploy/cloud-enterprise/switch-from-apm-to-integrations-server-payload.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/tools-apis.md - file: deploy/cloud-on-k8s.md children: 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 460d85a66f..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](asciidocalypse://docs/elasticsearch/docs/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 712e9a4129..0000000000 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-administering-deployments.md +++ /dev/null @@ -1,18 +0,0 @@ -% processed - -# 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-api-console.md b/raw-migrated-files/cloud/cloud-enterprise/ece-api-console.md deleted file mode 100644 index c0d20fa1c5..0000000000 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-api-console.md +++ /dev/null @@ -1,33 +0,0 @@ -# Access the Elasticsearch API console [ece-api-console] - -Interact with a specific Elasticsearch cluster 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. - -::::{note} -API console is intended for admin purposes. Avoid running normal workload like indexing or search request. -:::: - - -You are unable to make Elastic Cloud Enterprise platform changes from the Elasticsearch API. If you want to work with the platform, check the [Elastic Cloud Enterprise RESTful API](asciidocalypse://docs/cloud/docs/reference/cloud-enterprise/restful-api.md). - -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. From the Elasticsearch menu, go to the **API Console** page. -4. Make a selection from the operation drop-down list and complete the path. - - For example, select `GET`, then use the `_cluster/health?pretty=true` path for cluster status and other pertinent details. - -5. If needed, add the body information. - - ::::{tip} - To display the body area, select PUT, POST, or DELETE from the drop-down list. - :::: - -6. Select **Submit**. - -The results of the API operation are displayed, along with the time it took to complete the operation. - -To learn more about what kinds of Elasticsearch API calls you can make from the Cloud UI, check the [Elasticsearch Reference](https://www.elastic.co/guide/en/elasticsearch/reference/current). - 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 07c71e6d90..0000000000 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-change-deployment.md +++ /dev/null @@ -1,28 +0,0 @@ -% processed - -# 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-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 dcb7819e3d..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](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. - -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-monitoring-deployments.md b/raw-migrated-files/cloud/cloud-enterprise/ece-monitoring-deployments.md deleted file mode 100644 index fc1865090a..0000000000 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-monitoring-deployments.md +++ /dev/null @@ -1,15 +0,0 @@ -% processed - -# 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 a2280ae4c0..0000000000 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-stack-getting-started.md +++ /dev/null @@ -1,58 +0,0 @@ -% processed - -# 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/toc.yml b/raw-migrated-files/toc.yml index 8d36a62a17..621afb55c2 100644 --- a/raw-migrated-files/toc.yml +++ b/raw-migrated-files/toc.yml @@ -23,15 +23,9 @@ toc: - file: cloud/cloud-enterprise/index.md children: - file: cloud/cloud-enterprise/ece_re_running_the_ece_upgrade.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-api-console.md - file: cloud/cloud-enterprise/ece-autoscaling.md - - file: cloud/cloud-enterprise/ece-change-deployment.md - file: cloud/cloud-enterprise/ece-configuring-keystore.md - file: cloud/cloud-enterprise/ece-delete-deployment.md - - file: cloud/cloud-enterprise/ece-find.md - file: cloud/cloud-enterprise/ece-getting-started-node-js.md - file: cloud/cloud-enterprise/ece-getting-started-python.md - file: cloud/cloud-enterprise/ece-getting-started-search-use-cases-beats-logstash.md @@ -39,12 +33,6 @@ toc: - file: cloud/cloud-enterprise/ece-getting-started-search-use-cases-node-logs.md - file: cloud/cloud-enterprise/ece-getting-started-search-use-cases-python-logs.md - file: cloud/cloud-enterprise/ece-ingest-guides.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-monitoring-deployments.md - file: cloud/cloud-enterprise/ece-password-reset-elastic.md - file: cloud/cloud-enterprise/ece-restful-api-examples-configuring-keystore.md - file: cloud/cloud-enterprise/ece-restore-across-clusters.md @@ -52,7 +40,6 @@ toc: - 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-traffic-filtering-deployment-configuration.md - file: cloud/cloud-enterprise/ece-traffic-filtering-ip.md @@ -60,7 +47,6 @@ toc: - 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 From dda35c81310179e53c6f7dcb46470160a319f785 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Mon, 10 Mar 2025 23:05:43 +0100 Subject: [PATCH 24/29] redirect updated to fix broken link --- redirects.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/redirects.yml b/redirects.yml index 9f65b82505..cb2cce1aab 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' ## explore-analyze 'explore-analyze/machine-learning/nlp/ml-nlp-auto-scale.md': '!deploy-manage/autoscaling/trained-model-autoscaling.md' From b2853409eb068c2414aae1b2a1c87e71a2565c65 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Mon, 10 Mar 2025 23:24:35 +0100 Subject: [PATCH 25/29] added pending applies_to tags --- deploy-manage/deploy/cloud-enterprise/access-kibana.md | 3 +++ deploy-manage/deploy/cloud-enterprise/deployment-templates.md | 3 +++ .../cloud-enterprise/keep-track-of-deployment-activity.md | 3 +++ deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md | 3 +++ .../deploy/cloud-enterprise/search-filter-deployments.md | 3 +++ 5 files changed, 15 insertions(+) diff --git a/deploy-manage/deploy/cloud-enterprise/access-kibana.md b/deploy-manage/deploy/cloud-enterprise/access-kibana.md index 4f77e683ca..52c19442a7 100644 --- a/deploy-manage/deploy/cloud-enterprise/access-kibana.md +++ b/deploy-manage/deploy/cloud-enterprise/access-kibana.md @@ -1,4 +1,7 @@ --- +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 diff --git a/deploy-manage/deploy/cloud-enterprise/deployment-templates.md b/deploy-manage/deploy/cloud-enterprise/deployment-templates.md index 6d5ff11bea..bf6b79a828 100644 --- a/deploy-manage/deploy/cloud-enterprise/deployment-templates.md +++ b/deploy-manage/deploy/cloud-enterprise/deployment-templates.md @@ -1,4 +1,7 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-deployment-templates.html --- 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/search-filter-deployments.md b/deploy-manage/deploy/cloud-enterprise/search-filter-deployments.md index 65dec8edf3..664c0afee9 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 --- From d0ba7ff02c1fff0c4bd71fade4a4db993e89323c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Tue, 11 Mar 2025 11:11:20 +0100 Subject: [PATCH 26/29] autoscaling links updated --- deploy-manage/deploy/cloud-enterprise/configure-deployment.md | 2 +- deploy-manage/deploy/cloud-enterprise/create-deployment.md | 4 ++-- deploy-manage/deploy/cloud-enterprise/customize-deployment.md | 2 +- .../ece-configuring-ece-configure-system-templates.md | 2 +- .../cloud-enterprise/ece-configuring-ece-create-templates.md | 2 +- deploy-manage/deploy/cloud-enterprise/resize-deployment.md | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/deploy-manage/deploy/cloud-enterprise/configure-deployment.md b/deploy-manage/deploy/cloud-enterprise/configure-deployment.md index 059436f6bc..7c023e89ab 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-deployment.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-deployment.md @@ -15,7 +15,7 @@ You might want to change the configuration of your deployment to: * Add features, such as machine learning or APM (application performance monitoring). * Increase or decrease capacity by changing the amount of reserved memory and storage for different parts of your deployment. -* Enable [autoscaling](../../../deploy-manage/autoscaling.md) so that the available resources for deployment components, such as data tiers and machine learning nodes, adjust automatically as the demands on them change over time. +* Enable [autoscaling](/deploy-manage/autoscaling/autoscaling-in-ece-and-ech.md) so that the available resources for deployment components, such as data tiers and machine learning nodes, adjust automatically as the demands on them change over time. * Enable [high availability](./ece-ha.md), also known as fault tolerance, by adjusting the number of availability zones that parts of your deployment run on. * Upgrade to new versions of {{es}}. You can upgrade from one major version to another, such as from 6.8.23 to 7.17.27, or from one minor version to another, such as 6.1 to 6.2. You can’t downgrade versions. * Change what plugins or custom bundles are available on your {{es}} cluster. diff --git a/deploy-manage/deploy/cloud-enterprise/create-deployment.md b/deploy-manage/deploy/cloud-enterprise/create-deployment.md index 288b1478f1..cd94912fcc 100644 --- a/deploy-manage/deploy/cloud-enterprise/create-deployment.md +++ b/deploy-manage/deploy/cloud-enterprise/create-deployment.md @@ -10,7 +10,7 @@ mapped_urls: 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. -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, including autoscaling, snapshot settings, and security configurations. +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. To create a deployment in ECE: @@ -39,7 +39,7 @@ To create a deployment in ECE: 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](../../autoscaling/ece-autoscaling.md), adjust storage, memory, or customize data tiers. Refer to [Customize your deployment](../../../deploy-manage/deploy/cloud-enterprise/customize-deployment.md) for more details on the available options. +6. Select **Advanced settings** if you want to configure [autoscaling](/deploy-manage/autoscaling/autoscaling-in-ece-and-ech.md), adjust storage, memory, or customize data tiers. 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. diff --git a/deploy-manage/deploy/cloud-enterprise/customize-deployment.md b/deploy-manage/deploy/cloud-enterprise/customize-deployment.md index 5af4b69796..cd4021401c 100644 --- a/deploy-manage/deploy/cloud-enterprise/customize-deployment.md +++ b/deploy-manage/deploy/cloud-enterprise/customize-deployment.md @@ -40,7 +40,7 @@ Review the changes to your configuration on the **Activity** page, with a tab fo In the deployment edit page, you can configure the following settings and features: -* Enable [autoscaling](../../autoscaling.md) so that the available resources adjust automatically as demands on the deployment change. +* 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. 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/deploy-manage/deploy/cloud-enterprise/resize-deployment.md b/deploy-manage/deploy/cloud-enterprise/resize-deployment.md index a6753146ce..f3f53ee39b 100644 --- a/deploy-manage/deploy/cloud-enterprise/resize-deployment.md +++ b/deploy-manage/deploy/cloud-enterprise/resize-deployment.md @@ -11,7 +11,7 @@ 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 and machine learning 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: From 7888fbed09bf0f2ac04bed3ca0f5cb2c2bffe365 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Tue, 11 Mar 2025 22:02:08 +0100 Subject: [PATCH 27/29] Apply suggestions from code review Applying Shaina's suggestions Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com> --- .../deploy/cloud-enterprise/access-kibana.md | 4 ++-- .../cloud-enterprise/configure-deployment.md | 4 ++-- .../cloud-enterprise/connect-elasticsearch.md | 4 ++-- .../cloud-enterprise/create-deployment.md | 4 +--- .../cloud-enterprise/customize-deployment.md | 12 ++++++------ .../edit-stack-settings-elasticsearch.md | 2 +- .../cloud-enterprise/edit-stack-settings.md | 10 +++++----- .../cloud-enterprise/resource-overrides.md | 2 +- .../working-with-deployments.md | 17 ++++++++--------- 9 files changed, 28 insertions(+), 31 deletions(-) diff --git a/deploy-manage/deploy/cloud-enterprise/access-kibana.md b/deploy-manage/deploy/cloud-enterprise/access-kibana.md index 52c19442a7..b0ee89cec9 100644 --- a/deploy-manage/deploy/cloud-enterprise/access-kibana.md +++ b/deploy-manage/deploy/cloud-enterprise/access-kibana.md @@ -12,7 +12,7 @@ mapped_pages: 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-deployment.md) and add {{kib}}. +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: @@ -31,7 +31,7 @@ To access Kibana: 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 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. ::::{tip} diff --git a/deploy-manage/deploy/cloud-enterprise/configure-deployment.md b/deploy-manage/deploy/cloud-enterprise/configure-deployment.md index 7c023e89ab..e90d9ab7bb 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-deployment.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-deployment.md @@ -17,11 +17,11 @@ You might want to change the configuration of your deployment to: * Increase or decrease capacity by changing the amount of reserved memory and storage for different parts of your deployment. * Enable [autoscaling](/deploy-manage/autoscaling/autoscaling-in-ece-and-ech.md) so that the available resources for deployment components, such as data tiers and machine learning nodes, adjust automatically as the demands on them change over time. * Enable [high availability](./ece-ha.md), also known as fault tolerance, by adjusting the number of availability zones that parts of your deployment run on. -* Upgrade to new versions of {{es}}. You can upgrade from one major version to another, such as from 6.8.23 to 7.17.27, or from one minor version to another, such as 6.1 to 6.2. You can’t downgrade versions. +* Upgrade to new versions of {{es}}. You can upgrade from one major version to another, such as from 8.17 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 or custom bundles are available on your {{es}} cluster. * Change {{es}}, {{kib}}, or other stack application YML configuration settings. -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. +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. When updating an existing deployment, you can make multiple changes in a single configuration update. For example, you increase memory and storage, upgrade minor versions, adjust the number of plugins, and adjust fault tolerance by changing the number of availability zones—all in one action. diff --git a/deploy-manage/deploy/cloud-enterprise/connect-elasticsearch.md b/deploy-manage/deploy/cloud-enterprise/connect-elasticsearch.md index 7eab5f9016..c84dfb9c6f 100644 --- a/deploy-manage/deploy/cloud-enterprise/connect-elasticsearch.md +++ b/deploy-manage/deploy/cloud-enterprise/connect-elasticsearch.md @@ -17,7 +17,7 @@ This section explains how to connect client applications to an {{es}} deployment 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] +## 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). @@ -89,7 +89,7 @@ To use the Cloud ID, you need: 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. :::: -### Configure Beats with your Cloud ID [ece-cloud-id-beats] +### 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. diff --git a/deploy-manage/deploy/cloud-enterprise/create-deployment.md b/deploy-manage/deploy/cloud-enterprise/create-deployment.md index cd94912fcc..9b3e47e2f9 100644 --- a/deploy-manage/deploy/cloud-enterprise/create-deployment.md +++ b/deploy-manage/deploy/cloud-enterprise/create-deployment.md @@ -43,9 +43,7 @@ To create a deployment in ECE: 7. Select **Create deployment**. It takes a few minutes before your deployment gets created. - ::::{tip} - While 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. - :::: + 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. diff --git a/deploy-manage/deploy/cloud-enterprise/customize-deployment.md b/deploy-manage/deploy/cloud-enterprise/customize-deployment.md index cd4021401c..2e05415dc1 100644 --- a/deploy-manage/deploy/cloud-enterprise/customize-deployment.md +++ b/deploy-manage/deploy/cloud-enterprise/customize-deployment.md @@ -32,7 +32,7 @@ To customize your deployment: 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. +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}}. @@ -72,12 +72,12 @@ In the deployment edit page, you can configure the following settings and featur ## 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. +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 will determine the strategy depending on the type changes to apply. -* Rolling change per node: One node at a time. This strategy performs inline, rolling configuration changes that mutate existing containers. Recommended for most configuration changes. -* Grow and shrink: The orchestrator creates nodes with the new configuration, then migrates data from the old ones, and eventually delete the original nodes. This strategy is automatically selected when adding or removing master-eligibie nodes. -* Rolling grow and shrink: Similar to grow and shrink, but creating one node at a time. This strategy can take a lot longer than grow and shrink. +* **Autodetect strategy** (recommended): Let ECE determine the strategy depending on the type changes to apply. +* **Rolling change per node**: One node at a time. This strategy performs inline, rolling configuration changes that mutate existing containers. Recommended for most configuration changes. +* **Grow and shrink**: The orchestrator creates nodes with the new configuration, then migrates data from the old ones, and eventually delete the original nodes. This strategy is automatically selected when adding or removing master-eligibie nodes. +* **Rolling grow and shrink**: Similar to grow and shrink, but creating one node at a time. This strategy can take a lot longer than grow and shrink. The `Extended maintenance` option 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. diff --git a/deploy-manage/deploy/cloud-enterprise/edit-stack-settings-elasticsearch.md b/deploy-manage/deploy/cloud-enterprise/edit-stack-settings-elasticsearch.md index 2d66cf3351..c3b4fd3cfa 100644 --- a/deploy-manage/deploy/cloud-enterprise/edit-stack-settings-elasticsearch.md +++ b/deploy-manage/deploy/cloud-enterprise/edit-stack-settings-elasticsearch.md @@ -12,7 +12,7 @@ mapped_urls: 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. ::::{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, check [{{es}} settings](asciidocalypse://pending-link-lisa) on ECE reference documentation. +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 add user settings for {{es}} follow the instructions provided in [](./edit-stack-settings.md) diff --git a/deploy-manage/deploy/cloud-enterprise/edit-stack-settings.md b/deploy-manage/deploy/cloud-enterprise/edit-stack-settings.md index a2294115bf..fc845604a4 100644 --- a/deploy-manage/deploy/cloud-enterprise/edit-stack-settings.md +++ b/deploy-manage/deploy/cloud-enterprise/edit-stack-settings.md @@ -11,7 +11,7 @@ mapped_urls: 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. -To customize the settings of your deployments' {{stack}} components: +To customize the settings of a deployment's {{stack}} components: 1. Open your deployment page in the ECE [Cloud UI](./log-into-cloud-ui.md). 2. In the left navigation menu, select **Edit**. @@ -21,7 +21,7 @@ To customize the settings of your deployments' {{stack}} components: The following sections provide extra details and examples for different components: -* [](./edit-stack-settings-elasticsearch.md). -* [](./edit-stack-settings-kibana.md). -* [](./edit-stack-settings-apm.md). -* [](./edit-stack-settings-enterprise.md). +* [](./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/resource-overrides.md b/deploy-manage/deploy/cloud-enterprise/resource-overrides.md index 05a37f9c93..28f80ebded 100644 --- a/deploy-manage/deploy/cloud-enterprise/resource-overrides.md +++ b/deploy-manage/deploy/cloud-enterprise/resource-overrides.md @@ -8,7 +8,7 @@ mapped_pages: # Resource overrides [ece-resource-overrides] -{{ecloud}} allocators assign {{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 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. diff --git a/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md b/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md index d3490874df..2a1bb7586c 100644 --- a/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md +++ b/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md @@ -15,13 +15,12 @@ mapped_urls: {{ece}} allows you to manage one or more instances of the {{stack}} through **deployments**. -## Introducing deployments -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 Elastic Stack products without having to manage each one separately. In a deployment, everything works together. +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. 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. -All of these profiles are based on [deployment templates](./deployment-templates.md), 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. +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. ## Creating deployments @@ -29,13 +28,13 @@ Refer to [Create a deployment](./create-deployment.md) to launch and configure a ## 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. +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. +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: +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. @@ -55,10 +54,10 @@ From the deployment main page you can quickly access the following configuration 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 elastic password](../../users-roles/cluster-or-deployment-auth/manage-elastic-user-cloud.md) +* [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) +* 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 2d764eba416c3a26481c00943aeca2e0741aa34c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Fri, 14 Mar 2025 11:07:59 +0100 Subject: [PATCH 28/29] working on shaina's suggestions --- .../deploy/cloud-enterprise/access-kibana.md | 10 ++-- .../add-custom-bundles-plugins.md | 20 ++++---- .../deploy/cloud-enterprise/add-plugins.md | 6 ++- .../cloud-enterprise/configure-deployment.md | 46 ++++++++++--------- .../cloud-enterprise/create-deployment.md | 10 ++-- .../cloud-enterprise/customize-deployment.md | 16 +++++-- .../cloud-enterprise/deployment-templates.md | 23 +++++----- .../ece-regional-deployment-aliases.md | 2 +- .../edit-stack-settings-elasticsearch.md | 2 +- .../edit-stack-settings-enterprise.md | 2 +- .../cloud-enterprise/resize-deployment.md | 9 ++-- .../cloud-enterprise/resource-overrides.md | 16 ++++++- .../search-filter-deployments.md | 3 +- .../deploy/cloud-enterprise/tools-apis.md | 2 +- .../working-with-deployments.md | 2 +- raw-migrated-files/toc.yml | 1 - 16 files changed, 94 insertions(+), 76 deletions(-) diff --git a/deploy-manage/deploy/cloud-enterprise/access-kibana.md b/deploy-manage/deploy/cloud-enterprise/access-kibana.md index b0ee89cec9..0cf330bb65 100644 --- a/deploy-manage/deploy/cloud-enterprise/access-kibana.md +++ b/deploy-manage/deploy/cloud-enterprise/access-kibana.md @@ -28,15 +28,15 @@ To access Kibana: 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: +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 your Cloud account credentials and then you’ll be redirected to Kibana. + * 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. + * Log in with [any users you created in Kibana already](/deploy-manage/users-roles/cluster-or-deployment-auth/user-roles.md). - ::::{tip} + ::::{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. +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 d5af1754f4..36df3185c6 100644 --- a/deploy-manage/deploy/cloud-enterprise/add-custom-bundles-plugins.md +++ b/deploy-manage/deploy/cloud-enterprise/add-custom-bundles-plugins.md @@ -85,7 +85,7 @@ Custom plugins can include the official Elasticsearch plugins not provided with ## 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: @@ -126,7 +126,7 @@ This example adds a custom LDAP bundle for deployment level role-based access co ## 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). 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. @@ -159,16 +159,16 @@ In this example, we assume the Identity Provider does not publish its SAML metad 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. -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. + 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`: + In this example, the SAML metadata file is located in the path `/app/config/saml/metadata.xml`: -```sh -$ tree . -. -└── saml - └── metadata.xml -``` + ```sh + $ tree . + . + └── saml + └── metadata.xml + ``` 3. Adjust your `saml` realm configuration accordingly through [](./edit-stack-settings.md): diff --git a/deploy-manage/deploy/cloud-enterprise/add-plugins.md b/deploy-manage/deploy/cloud-enterprise/add-plugins.md index 6506ab4a21..773003eb9d 100644 --- a/deploy-manage/deploy/cloud-enterprise/add-plugins.md +++ b/deploy-manage/deploy/cloud-enterprise/add-plugins.md @@ -9,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 @@ -22,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/configure-deployment.md b/deploy-manage/deploy/cloud-enterprise/configure-deployment.md index e90d9ab7bb..e750a577b3 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-deployment.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-deployment.md @@ -11,34 +11,36 @@ mapped_pages: # Configure your deployment [ece-change-deployment] -You might want to change the configuration of your deployment to: - -* Add features, such as machine learning or APM (application performance monitoring). -* Increase or decrease capacity by changing the amount of reserved memory and storage for different parts of your deployment. -* Enable [autoscaling](/deploy-manage/autoscaling/autoscaling-in-ece-and-ech.md) so that the available resources for deployment components, such as data tiers and machine learning nodes, adjust automatically as the demands on them change over time. -* Enable [high availability](./ece-ha.md), also known as fault tolerance, by adjusting the number of availability zones that parts of your deployment run on. -* Upgrade to new versions of {{es}}. You can upgrade from one major version to another, such as from 8.17 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 or custom bundles are available on your {{es}} cluster. -* Change {{es}}, {{kib}}, or other stack application YML configuration settings. - -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. - -When updating an existing deployment, you can make multiple changes in a single configuration update. For example, you increase memory and storage, upgrade minor versions, adjust the number of plugins, and adjust fault tolerance by changing the number of availability zones—all in one action. - -::::{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. -:::: - -## Preparing a deployment for production [ece-prepare-production] - -To make sure you’re all set for production, consider the following actions: +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): Considerations when scaling deployments. +* [](./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/create-deployment.md b/deploy-manage/deploy/cloud-enterprise/create-deployment.md index 9b3e47e2f9..5f0c64e486 100644 --- a/deploy-manage/deploy/cloud-enterprise/create-deployment.md +++ b/deploy-manage/deploy/cloud-enterprise/create-deployment.md @@ -16,7 +16,7 @@ To create a deployment in ECE: 1. From the Cloud UI **Deployments** view, select **Create deployment**. - You can quickly create a deployment by setting the basic parameters shown in the UI. If you need more control, select **Advanced settings** to customize the deployment parameters, including autoscaling, storage, memory, data tiers, and additional Elastic Stack components. Refer to [](./customize-deployment.md) for more information. + 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. :::{image} ../../../images/cloud-enterprise-ece-create-deployment.png :alt: Create a deployment @@ -25,11 +25,9 @@ To create a deployment in ECE: 2. Set a name for your deployment. 3. Select a deployment template. + For a description of the available system templates, refer to [](./deployment-templates.md). - ::::{tip} - * 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). - :::: + 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). @@ -39,7 +37,7 @@ To create a deployment in ECE: 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 storage, memory, or customize data tiers. Refer to [Customize your deployment](../../../deploy-manage/deploy/cloud-enterprise/customize-deployment.md) for more details on the available options. +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. diff --git a/deploy-manage/deploy/cloud-enterprise/customize-deployment.md b/deploy-manage/deploy/cloud-enterprise/customize-deployment.md index 2e05415dc1..33afd1de6f 100644 --- a/deploy-manage/deploy/cloud-enterprise/customize-deployment.md +++ b/deploy-manage/deploy/cloud-enterprise/customize-deployment.md @@ -75,10 +75,16 @@ In the deployment edit page, you can configure the following settings and featur 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 node at a time. This strategy performs inline, rolling configuration changes that mutate existing containers. Recommended for most configuration changes. -* **Grow and shrink**: The orchestrator creates nodes with the new configuration, then migrates data from the old ones, and eventually delete the original nodes. This strategy is automatically selected when adding or removing master-eligibie nodes. -* **Rolling grow and shrink**: Similar to grow and shrink, but creating one node at a time. This strategy can take a lot longer than grow and shrink. +* **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. -The `Extended maintenance` option 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. +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. -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}} and {{kib}}. +::::{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. + +This option introduces downtime and is rarely needed. Use it only when you need to block all traffic to the cluster during the update. +:::: + +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 bf6b79a828..54b6536f02 100644 --- a/deploy-manage/deploy/cloud-enterprise/deployment-templates.md +++ b/deploy-manage/deploy/cloud-enterprise/deployment-templates.md @@ -8,16 +8,16 @@ mapped_pages: # 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 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 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 system deployment templates available by default are: @@ -27,15 +27,15 @@ The system deployment templates available by default 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** @@ -47,9 +47,8 @@ The system deployment templates available by default are: ## 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. +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. -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. - -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-regional-deployment-aliases.md b/deploy-manage/deploy/cloud-enterprise/ece-regional-deployment-aliases.md index 023df59a97..9d0118dd31 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-regional-deployment-aliases.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-regional-deployment-aliases.md @@ -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/edit-stack-settings-elasticsearch.md b/deploy-manage/deploy/cloud-enterprise/edit-stack-settings-elasticsearch.md index c3b4fd3cfa..030e1a8cb4 100644 --- a/deploy-manage/deploy/cloud-enterprise/edit-stack-settings-elasticsearch.md +++ b/deploy-manage/deploy/cloud-enterprise/edit-stack-settings-elasticsearch.md @@ -15,7 +15,7 @@ Change how Elasticsearch runs by providing your own user settings. User settings 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 add user settings for {{es}} follow the instructions provided in [](./edit-stack-settings.md) +To change {{es}} user settings: 1. [Log into the Cloud UI](./log-into-cloud-ui.md). 2. On the **Deployments** page, select your deployment. diff --git a/deploy-manage/deploy/cloud-enterprise/edit-stack-settings-enterprise.md b/deploy-manage/deploy/cloud-enterprise/edit-stack-settings-enterprise.md index 4bc6b9657a..16ede35b35 100644 --- a/deploy-manage/deploy/cloud-enterprise/edit-stack-settings-enterprise.md +++ b/deploy-manage/deploy/cloud-enterprise/edit-stack-settings-enterprise.md @@ -15,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: diff --git a/deploy-manage/deploy/cloud-enterprise/resize-deployment.md b/deploy-manage/deploy/cloud-enterprise/resize-deployment.md index f3f53ee39b..c7002ba696 100644 --- a/deploy-manage/deploy/cloud-enterprise/resize-deployment.md +++ b/deploy-manage/deploy/cloud-enterprise/resize-deployment.md @@ -11,7 +11,7 @@ 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](/deploy-manage/autoscaling/autoscaling-in-ece-and-ech.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: @@ -22,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 28f80ebded..e25d36fad2 100644 --- a/deploy-manage/deploy/cloud-enterprise/resource-overrides.md +++ b/deploy-manage/deploy/cloud-enterprise/resource-overrides.md @@ -12,8 +12,20 @@ mapped_pages: 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 664c0afee9..f9b6d6e09a 100644 --- a/deploy-manage/deploy/cloud-enterprise/search-filter-deployments.md +++ b/deploy-manage/deploy/cloud-enterprise/search-filter-deployments.md @@ -20,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/tools-apis.md b/deploy-manage/deploy/cloud-enterprise/tools-apis.md index d19dae35e5..b9e9e981d2 100644 --- a/deploy-manage/deploy/cloud-enterprise/tools-apis.md +++ b/deploy-manage/deploy/cloud-enterprise/tools-apis.md @@ -39,7 +39,7 @@ You can find this console in Cloud UI when selecting a specific deployment to ma 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 Reference](https://www.elastic.co/guide/en/elasticsearch/reference/current). +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.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 2a1bb7586c..5c40541300 100644 --- a/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md +++ b/deploy-manage/deploy/cloud-enterprise/working-with-deployments.md @@ -91,4 +91,4 @@ Use the **Actions** button at deployment or instance level to: {{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. \ No newline at end of file +* [Move affected instances off an allocator](../../../deploy-manage/maintenance/ece/move-nodes-instances-from-allocators.md), if the allocator fails. diff --git a/raw-migrated-files/toc.yml b/raw-migrated-files/toc.yml index 9cebd81481..f26e40a53a 100644 --- a/raw-migrated-files/toc.yml +++ b/raw-migrated-files/toc.yml @@ -23,7 +23,6 @@ toc: - file: cloud/cloud-enterprise/index.md children: - file: cloud/cloud-enterprise/ece_re_running_the_ece_upgrade.md - - file: cloud/cloud-enterprise/ece-autoscaling.md - file: cloud/cloud-enterprise/ece-configuring-keystore.md - file: cloud/cloud-enterprise/ece-delete-deployment.md - file: cloud/cloud-enterprise/ece-getting-started-node-js.md From b5c0419c5bb221a0bab058052424d406494397f0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edu=20Gonz=C3=A1lez=20de=20la=20Herr=C3=A1n?= <25320357+eedugon@users.noreply.github.com> Date: Fri, 14 Mar 2025 11:28:44 +0100 Subject: [PATCH 29/29] fixing links --- .../cloud-enterprise/edit-stack-settings-apm.md | 4 ++-- .../deploy/cloud-enterprise/tools-apis.md | 2 +- .../cloud-enterprise/ece-delete-deployment.md | 15 --------------- 3 files changed, 3 insertions(+), 18 deletions(-) delete mode 100644 raw-migrated-files/cloud/cloud-enterprise/ece-delete-deployment.md diff --git a/deploy-manage/deploy/cloud-enterprise/edit-stack-settings-apm.md b/deploy-manage/deploy/cloud-enterprise/edit-stack-settings-apm.md index 7b7b3edc9f..020ad34113 100644 --- a/deploy-manage/deploy/cloud-enterprise/edit-stack-settings-apm.md +++ b/deploy-manage/deploy/cloud-enterprise/edit-stack-settings-apm.md @@ -14,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). diff --git a/deploy-manage/deploy/cloud-enterprise/tools-apis.md b/deploy-manage/deploy/cloud-enterprise/tools-apis.md index 0628974190..aabe99a0d2 100644 --- a/deploy-manage/deploy/cloud-enterprise/tools-apis.md +++ b/deploy-manage/deploy/cloud-enterprise/tools-apis.md @@ -39,7 +39,7 @@ You can find this console in Cloud UI when selecting a specific deployment to ma 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.md) documentation. +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/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. -::::