diff --git a/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md b/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md index 06fc1afe34..da252cc9d7 100644 --- a/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md +++ b/deploy-manage/deploy/cloud-enterprise/air-gapped-install.md @@ -1,26 +1,33 @@ --- +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 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 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 a private Docker registry](./ece-install-offline-no-registry.md) -The documentation team is working to combine content pulled from the following pages: +After installing ECE in your hosts, you can continue with [](./post-installation-steps.md). -* [/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..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 @@ -1,6 +1,10 @@ --- +applies_to: + deployment: + 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/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 d3c4db11e4..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,14 +1,19 @@ --- +navigation_title: Data tiers and autoscaling support +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 --- # 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-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..034a7637ce 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 --- @@ -9,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 @@ -29,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-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-onprem.md b/deploy-manage/deploy/cloud-enterprise/configure-host-rhel-onprem.md deleted file mode 100644 index cf3a64ff12..0000000000 --- a/deploy-manage/deploy/cloud-enterprise/configure-host-rhel-onprem.md +++ /dev/null @@ -1,351 +0,0 @@ ---- -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: - - * Install the latest available version `4.*` using dnf. - - ```sh - sudo dnf install podman-4.* podman-remote-4.* - ``` - - * To prevent automatic Podman major version updates, configure the Podman version to be locked while still allowing minor and patch updates. - - ```sh - ## Install versionlock - sudo dnf install 'dnf-command(versionlock)' - - ## Lock major version - sudo dnf versionlock add --raw 'podman-4.*' - sudo dnf versionlock add --raw 'podman-remote-4.*' - - ## Verify that podman-4.* and podman-remote-4.* appear in the output - sudo dnf versionlock list - ``` - -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 99410a9f13..f9a1aa670d 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-host-rhel-cloud.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-host-rhel.md @@ -1,31 +1,32 @@ --- +applies_to: + deployment: + 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 +navigation_title: RHEL --- -# Configure host RHEL cloud [ece-configure-hosts-rhel-centos-cloud] +# 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-cloud] 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 cd18a0c708..0000000000 --- a/deploy-manage/deploy/cloud-enterprise/configure-host-suse-onprem.md +++ /dev/null @@ -1,344 +0,0 @@ ---- -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 80% rename from deploy-manage/deploy/cloud-enterprise/configure-host-suse-cloud.md rename to deploy-manage/deploy/cloud-enterprise/configure-host-suse.md index d397f7a1dc..5fd99dd82b 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-host-suse-cloud.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-host-suse.md @@ -1,26 +1,31 @@ --- +applies_to: + deployment: + 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 +navigation_title: SUSE --- -# Configure host SUSE cloud [ece-configure-hosts-sles12-cloud] +# Configure a SUSE host [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: +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-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 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-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. @@ -80,14 +85,14 @@ 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. 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. :::: @@ -110,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 @@ -124,7 +129,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: @@ -176,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. @@ -221,7 +226,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`): @@ -243,7 +248,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:
@@ -261,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 @@ -269,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. @@ -341,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-host-ubuntu-onprem.md b/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu-onprem.md deleted file mode 100644 index c0a23de7db..0000000000 --- a/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu-onprem.md +++ /dev/null @@ -1,309 +0,0 @@ ---- -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 94% rename from deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu-cloud.md rename to deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu.md index 86d667482a..fd98d15e69 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu-cloud.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-host-ubuntu.md @@ -1,19 +1,24 @@ --- +applies_to: + deployment: + 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 +navigation_title: Ubuntu --- -# Configure host Ubuntu cloud [ece-configure-hosts-ubuntu-cloud] +# 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). -* [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. @@ -56,7 +61,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. @@ -101,7 +106,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: @@ -197,7 +202,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`): @@ -219,7 +224,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 17ae9b46c0..0000000000 --- a/deploy-manage/deploy/cloud-enterprise/configure-operating-system-cloud.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -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 51% rename from deploy-manage/deploy/cloud-enterprise/configure-operating-system-onprem.md rename to deploy-manage/deploy/cloud-enterprise/configure-operating-system.md index 599d6e2257..6cf39a8f64 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure-operating-system-onprem.md +++ b/deploy-manage/deploy/cloud-enterprise/configure-operating-system.md @@ -1,17 +1,17 @@ --- +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 [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/configure.md b/deploy-manage/deploy/cloud-enterprise/configure.md index 7a71714ea5..cc569297ad 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure.md +++ b/deploy-manage/deploy/cloud-enterprise/configure.md @@ -9,30 +9,38 @@ 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. -* [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. +* [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) – 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). +* [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] - -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. - -* [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. +## Maintenance activities +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. 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..a9a70ba715 100644 --- a/deploy-manage/deploy/cloud-enterprise/deploy-an-orchestrator.md +++ b/deploy-manage/deploy/cloud-enterprise/deploy-an-orchestrator.md @@ -17,15 +17,17 @@ 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 on a public cloud](./install-ece-on-public-cloud.md) - * [Install ECE on your own premises](./install-ece-on-own-premises.md) +* [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-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-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) * [Configure deployment templates](./deployment-templates.md) @@ -36,8 +38,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-onprem.md b/deploy-manage/deploy/cloud-enterprise/deploy-large-installation-onprem.md deleted file mode 100644 index 4de56154ae..0000000000 --- a/deploy-manage/deploy/cloud-enterprise/deploy-large-installation-onprem.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -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 84% rename from deploy-manage/deploy/cloud-enterprise/deploy-large-installation-cloud.md rename to deploy-manage/deploy/cloud-enterprise/deploy-large-installation.md index 20e7e75a62..fe2e56c516 100644 --- a/deploy-manage/deploy/cloud-enterprise/deploy-large-installation-cloud.md +++ b/deploy-manage/deploy/cloud-enterprise/deploy-large-installation.md @@ -1,9 +1,13 @@ --- +applies_to: + deployment: + 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 cloud [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: @@ -21,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). @@ -41,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] @@ -82,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-onprem.md b/deploy-manage/deploy/cloud-enterprise/deploy-medium-installation-onprem.md deleted file mode 100644 index 93997d08cd..0000000000 --- a/deploy-manage/deploy/cloud-enterprise/deploy-medium-installation-onprem.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -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 78% rename from deploy-manage/deploy/cloud-enterprise/deploy-medium-installation-cloud.md rename to deploy-manage/deploy/cloud-enterprise/deploy-medium-installation.md index 990fd96f7c..5e5d630d11 100644 --- a/deploy-manage/deploy/cloud-enterprise/deploy-medium-installation-cloud.md +++ b/deploy-manage/deploy/cloud-enterprise/deploy-medium-installation.md @@ -1,9 +1,13 @@ --- +applies_to: + deployment: + 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 cloud [ece-install-medium-cloud] +# Deploy a medium installation [ece-install-medium] This type of installation is recommended for many production setups. You need: @@ -15,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. @@ -36,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] @@ -64,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-onprem.md b/deploy-manage/deploy/cloud-enterprise/deploy-small-installation-onprem.md deleted file mode 100644 index 2c511663a1..0000000000 --- a/deploy-manage/deploy/cloud-enterprise/deploy-small-installation-onprem.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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 84% rename from deploy-manage/deploy/cloud-enterprise/deploy-small-installation-cloud.md rename to deploy-manage/deploy/cloud-enterprise/deploy-small-installation.md index 16541a1d47..9196d92453 100644 --- a/deploy-manage/deploy/cloud-enterprise/deploy-small-installation-cloud.md +++ b/deploy-manage/deploy/cloud-enterprise/deploy-small-installation.md @@ -1,9 +1,13 @@ --- +applies_to: + deployment: + 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 cloud [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: @@ -14,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. @@ -36,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] @@ -64,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-cloud.md). +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 dbb9d75dcc..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,8 @@ --- +navigation_title: Integrations server support +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-ce-add-support-for-integrations-server.html --- @@ -42,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 0c0525241c..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,9 +1,13 @@ --- +navigation_title: Configure index management +applies_to: + deployment: + ece: all 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 b9dd286c4c..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,16 +1,21 @@ --- +navigation_title: Configure default templates +applies_to: + deployment: + ece: all 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] @@ -18,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 20939bb793..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,8 @@ --- +navigation_title: Create templates +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..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 @@ -1,11 +1,14 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configuring-ece-instance-configurations-create.html --- # 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-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..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 @@ -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 --- @@ -16,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. :::: @@ -47,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-configuring-ece-tag-allocators.md b/deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-tag-allocators.md index 5e44fd9a2d..7daf8d1c10 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..8db8390d24 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-ha.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-ha.md @@ -1,20 +1,26 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-ha.html --- # 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 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] -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. @@ -22,18 +28,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. @@ -41,8 +45,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: @@ -55,18 +57,18 @@ 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. - ## 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/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..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,8 @@ --- +navigation_title: Include additional Kibana plugins +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..f9019483ed 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 --- @@ -58,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 5f0b2ded8e..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,9 +1,13 @@ --- +navigation_title: Without a private Docker registry +applies_to: + deployment: + ece: all 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. @@ -65,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 @@ -79,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 a2faa50ed7..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,9 +1,13 @@ --- +navigation_title: With your private Docker registry +applies_to: + deployment: + ece: all 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. @@ -36,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 @@ -50,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 @@ -70,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: @@ -89,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 6cc8797d36..64ed541a13 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 --- @@ -9,12 +12,11 @@ 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-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/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 ab8440506e..70b30415ff 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 deleted file mode 100644 index c41e865400..0000000000 --- a/deploy-manage/deploy/cloud-enterprise/fresh-installation-of-ece-using-podman-hosts-cloud.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -mapped_pages: - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-using-podman-cloud.html ---- - -# Fresh installation of ECE using Podman hosts cloud [ece-install-using-podman-cloud] - -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-onprem.md b/deploy-manage/deploy/cloud-enterprise/fresh-installation-of-ece-using-podman-hosts.md similarity index 69% rename from deploy-manage/deploy/cloud-enterprise/fresh-installation-of-ece-using-podman-hosts-onprem.md rename to deploy-manage/deploy/cloud-enterprise/fresh-installation-of-ece-using-podman-hosts.md index 290c64fa8a..4a5770dcf5 100644 --- 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.md @@ -1,9 +1,14 @@ --- +applies_to: + deployment: + ece: all mapped_pages: + - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-using-podman-cloud.html - 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 onprem [ece-install-using-podman-onprem] +# 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. @@ -11,26 +16,17 @@ 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. - 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. @@ -42,12 +38,11 @@ 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 - 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. @@ -74,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/identify-deployment-scenario.md b/deploy-manage/deploy/cloud-enterprise/identify-deployment-scenario.md index c25b3a8748..45de3ec9ef 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 --- @@ -23,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] @@ -47,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] @@ -70,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 501b8fa549..0000000000 --- a/deploy-manage/deploy/cloud-enterprise/install-ece-cloud.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -mapped_pages: - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-cloud.html ---- - -# Install ECE 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. - - - - - 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 deleted file mode 100644 index cf05d016b2..0000000000 --- a/deploy-manage/deploy/cloud-enterprise/install-ece-on-own-premises.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -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 36d0826217..0000000000 --- a/deploy-manage/deploy/cloud-enterprise/install-ece-on-public-cloud.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -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: - -* Amazon Web Services (AWS) -* Google Cloud Platform (GCP) -* Microsoft Azure - -with one of the following operating systems: - -* [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 via [Perform host maintenance](../../maintenance/ece/perform-ece-hosts-maintenance.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 a7f52b8cf4..0000000000 --- a/deploy-manage/deploy/cloud-enterprise/install-ece-onprem.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -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..d1b7833df0 --- /dev/null +++ b/deploy-manage/deploy/cloud-enterprise/install-ece-procedures.md @@ -0,0 +1,18 @@ +--- +navigation_title: Installation procedures +applies_to: + deployment: + ece: all +--- + +# ECE installation procedures + +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. +* [Deploy a large installation](deploy-large-installation.md): For deployments with significant overall search and indexing throughput. + +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 63076e6766..4ebc1e30cd 100644 --- a/deploy-manage/deploy/cloud-enterprise/install.md +++ b/deploy-manage/deploy/cloud-enterprise/install.md @@ -1,23 +1,68 @@ --- +applies_to: + deployment: + 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 [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). +You can deploy {{ece}} (ECE) on public or private clouds, virtual machines, or on-premises. -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. +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. -Once you have installed ECE, check some final [post-installation steps](post-installation-steps.md) to get ready for production. +For public cloud deployments, you can choose from the following providers: -::::{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. -:::: +* Amazon Web Services (AWS) +* 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 [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. + +## Configure your ECE hosts [ece-configure-hosts] + +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 using the [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/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..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 @@ -1,11 +1,18 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-migrate-to-selinux-in-enforcing-mode.html --- # 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 95e5ed3436..ea8a242433 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 --- @@ -23,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. @@ -393,7 +385,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/deploy/cloud-enterprise/post-installation-steps.md b/deploy-manage/deploy/cloud-enterprise/post-installation-steps.md index ee7bafd326..2580c1d895 100644 --- a/deploy-manage/deploy/cloud-enterprise/post-installation-steps.md +++ b/deploy-manage/deploy/cloud-enterprise/post-installation-steps.md @@ -1,26 +1,49 @@ --- +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). + +::::{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. + + ::::{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. + + :::{{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). + ::: + +* 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 3f30d671b2..594a2730d3 100644 --- a/deploy-manage/deploy/cloud-enterprise/prepare-environment.md +++ b/deploy-manage/deploy/cloud-enterprise/prepare-environment.md @@ -1,29 +1,34 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-prereqs.html --- # 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] +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) * [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 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..f0a89b3206 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 --- @@ -21,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. @@ -39,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. @@ -49,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. @@ -62,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. @@ -73,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/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/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 diff --git a/deploy-manage/toc.yml b/deploy-manage/toc.yml index 1fa538f020..809b55934c 100644 --- a/deploy-manage/toc.yml +++ b/deploy-manage/toc.yml @@ -117,49 +117,34 @@ 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 - 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/alternative-install-ece-with-ansible.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/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/migrate-ece-to-podman-hosts.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: @@ -183,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 @@ -192,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: 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 2d957c8aca..e3d4436061 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 @@ -24,7 +24,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/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 1044f72a86..963189d266 100644 --- a/raw-migrated-files/toc.yml +++ b/raw-migrated-files/toc.yml @@ -41,7 +41,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 diff --git a/redirects.yml b/redirects.yml index 47f9ac8ef2..c81e1c8ef4 100644 --- a/redirects.yml +++ b/redirects.yml @@ -12,6 +12,7 @@ redirects: 'anonymous-authentication': 'basic-authentication': 'http-authentication': + 'deploy-manage/deploy/cloud-enterprise/deploy-large-installation-cloud.md': '!deploy-manage/deploy/cloud-enterprise/deploy-large-installation.md' ## reference 'reference/security/elastic-defend/index.md': 'solutions/security/configure-elastic-defend.md' @@ -31,4 +32,4 @@ redirects: 'reference/security/elastic-defend/create-defend-policy-api.md': 'solutions/security/configure-elastic-defend/create-an-elastic-defend-policy-using-api.md' 'reference/security/elastic-defend/offline-endpoint.md': 'solutions/security/configure-elastic-defend/configure-offline-endpoints-air-gapped-environments.md' 'reference/security/elastic-defend/uninstall-agent.md': 'solutions/security/configure-elastic-defend/uninstall-elastic-agent.md' - 'reference/security/fields-and-object-schemas/runtime-fields.md': 'solutions/security/get-started/create-runtime-fields-in-elastic-security.md' \ No newline at end of file + 'reference/security/fields-and-object-schemas/runtime-fields.md': 'solutions/security/get-started/create-runtime-fields-in-elastic-security.md' 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. 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]