diff --git a/deploy-manage/deploy/cloud-enterprise.md b/deploy-manage/deploy/cloud-enterprise.md index ebb43529d4..56e1eeb9fc 100644 --- a/deploy-manage/deploy/cloud-enterprise.md +++ b/deploy-manage/deploy/cloud-enterprise.md @@ -1,28 +1,74 @@ --- +applies_to: + deployment: + ece: all mapped_urls: - https://www.elastic.co/guide/en/cloud-enterprise/current/index.html - https://www.elastic.co/guide/en/cloud-enterprise/current/Elastic-Cloud-Enterprise-overview.html - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-administering-ece.html --- -# Elastic Cloud Enterprise +# Elastic Cloud Enterprise [Elastic-Cloud-Enterprise-overview] -% What needs to be done: Refine +{{ece}} (ECE) is an Elastic self-managed solution for deploying, orchestrating, and managing {{es}} clusters at scale. It provides a centralized platform that allows organizations to run {{es}}, {{kib}}, and other {{stack}} components across multiple machines. -% GitHub issue: https://github.com/elastic/docs-projects/issues/339 +ECE evolves from the Elastic hosted Cloud SaaS offering into a standalone product. You can deploy ECE on public or private clouds, virtual machines, or your own premises. -% Scope notes: Ensure the landing page makes sense and its aligned with the section overview and the overview about orchestators. What content should be in deployment types overview or in the main overview and what in the ECE landing page... +With {{ece}}, you can: -% Use migrated content from existing pages that map to this page: +* Host your regulated or sensitive data on your internal network. +* Reuse your existing investment in on-premise infrastructure and reduce total cost. +* Maximize the hardware utilization for the various clusters. +* Centralize the management of multiple Elastic deployments across teams or geographies. -% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/Elastic-Cloud-Enterprise-overview.md -% Notes: 2 child docs -% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-administering-ece.md -% Notes: redirect only +Refer to [](./cloud-enterprise/ece-architecture.md) for details about the ECE platform architecture and the technologies used. -⚠️ **This page is a work in progress.** ⚠️ +## ECE features -The documentation team is working to combine content pulled from the following pages: +- **Automated scaling & orchestration**: Handles cluster provisioning, scaling, and upgrades automatically. +- **High availability & resilience**: Ensures uptime through multiple Availability Zones, data replication, and automated restore and snapshot. +- **Centralized monitoring & logging**: Provides insights into cluster performance, resource usage, and logs. +- **Single Sign-On (SSO) & role-based access aontrol (RBAC)**: Allows organizations to manage access and security policies. +- **API & UI management**: Offers a web interface and API to create and manage clusters easily. +- **Air-gapped installations**: Support for off-line installations. +- **Microservices architecture**: All services are containerized through Docker. -* [/raw-migrated-files/cloud/cloud-enterprise/Elastic-Cloud-Enterprise-overview.md](/raw-migrated-files/cloud/cloud-enterprise/Elastic-Cloud-Enterprise-overview.md) -* [/raw-migrated-files/cloud/cloud-enterprise/ece-administering-ece.md](/raw-migrated-files/cloud/cloud-enterprise/ece-administering-ece.md) \ No newline at end of file +Check the [glossary](asciidocalypse:///docs-content/docs/reference/glossary.md) to get familiar with the terminology for ECE as well as other Elastic products and solutions. + +## Section overview + +This section focuses on deploying the ECE platform, as well as orchestrating and configuring {{es}} clusters, referred to as deployments. + +In ECE, a deployment is a managed {{stack}} environment that provides users with an {{es}} cluster along with supporting components such as {{kib}} and other optional services like APM and {{fleet}}. + +The section covers the following tasks: + +* [Deploy ECE orchestrator](./cloud-enterprise/deploy-an-orchestrator.md) + - [Prepare the environment](./cloud-enterprise/prepare-environment.md) + - [Install ECE](./cloud-enterprise/install.md) + - [Air gapped installations](./cloud-enterprise/air-gapped-install.md) + - [Configure ECE](./cloud-enterprise/configure.md) + +* [Work with deployments](./cloud-enterprise/working-with-deployments.md) + - Use [](./cloud-enterprise/deployment-templates.md) to [](./cloud-enterprise/create-deployment.md) + - [](./cloud-enterprise/customize-deployment.md) + - Use the deployment [Cloud ID](./cloud-enterprise/find-cloud-id.md) and [Endpoint URLs](./cloud-enterprise/find-endpoint-url.md) for clients connection + +* Learn about [](./cloud-enterprise/tools-apis.md) that you can use with ECE + +Other sections of the documentation provide guidance on additional important tasks related to ECE: + +* Platform security and management: + * [Secure your ECE installation](../security/secure-your-elastic-cloud-enterprise-installation.md) + * [Users and roles](../users-roles/cloud-enterprise-orchestrator.md) + * [ECE platform maintenance operations](../maintenance/ece.md) + * [Manage licenses](../license/manage-your-license-in-ece.md) + +* Deployments security and management: + * [Secure your deployments](../security/secure-your-cluster-deployment.md) + * [Manage snapshot repositories](../tools/snapshot-and-restore.md) + +To learn about other deployment options, refer to [](../deploy.md). + +## Supported versions [ece-supported-versions] + +Refer to the [Elastic Support Matrix](https://www.elastic.co/support/matrix#elastic-cloud-enterprise) for more information about supported Operating Systems, Docker, and Podman versions. \ No newline at end of file diff --git a/deploy-manage/deploy/cloud-enterprise/configure.md b/deploy-manage/deploy/cloud-enterprise/configure.md index 2ad081b96a..7a71714ea5 100644 --- a/deploy-manage/deploy/cloud-enterprise/configure.md +++ b/deploy-manage/deploy/cloud-enterprise/configure.md @@ -1,9 +1,15 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configuring-ece.html + - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-administering-ece.html --- -# Configure [ece-configuring-ece] +# Configure ECE [ece-configuring-ece] + +⚠️ **This page is a work in progress.** ⚠️ Now that you have Elastic Cloud Enterprise up and running, take a look at some of the additional features that you can configure: @@ -16,3 +22,17 @@ Now that you have Elastic Cloud Enterprise up and running, take a look at some o * [Change allocator disconnect timeout](change-allocator-disconnect-timeout.md) - Configure how long ECE waits before considering allocators to be disconnected. * [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. + + diff --git a/deploy-manage/deploy/cloud-enterprise/deploy-an-orchestrator.md b/deploy-manage/deploy/cloud-enterprise/deploy-an-orchestrator.md index 4ba2431a87..a23a4873d6 100644 --- a/deploy-manage/deploy/cloud-enterprise/deploy-an-orchestrator.md +++ b/deploy-manage/deploy/cloud-enterprise/deploy-an-orchestrator.md @@ -1,9 +1,54 @@ +--- +applies_to: + deployment: + ece: all +--- # Deploy an orchestrator -% What needs to be done: Write from scratch +Elastic Cloud Enterprise (ECE) provides a centralized platform that allows organizations to run Elasticsearch, Kibana, and other Elastic Stack components across multiple machines, whether in a private or public cloud, virtual machines, or your own premises. -% GitHub issue: https://github.com/elastic/docs-projects/issues/339 +::::{note} +This section focuses on deploying the ECE orchestrator. If you want to deploy {{es}}, {{kib}} or other {{stack}} applications on ECE, refer to [](./working-with-deployments.md). +:::: -% Scope notes: Introduction about the content of this big section (which covers install and configuration possibilities of the orchestrator) +## Deployment tasks -⚠️ **This page is a work in progress.** ⚠️ \ No newline at end of file +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) + * [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) + +* [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) + * [Configure endpoint URLs](./change-endpoint-urls.md) + * [Manage {{stack}} versions](./manage-elastic-stack-versions.md) + +## Additional topics + +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) +* [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) +* [ECE platform maintenance operations](../../maintenance/ece.md) + +To start orchestrating your {{es}} clusters, refer to [](./working-with-deployments.md). + +## Advanced tasks + +The following tasks are only needed on certain circumstances: + +* [Migrate ECE to Podman hosts](./migrate-ece-to-podman-hosts.md) +* [Migrate ECE on Podman hosts to SELinux enforce](./migrate-ece-on-podman-hosts-to-selinux-enforce.md) +* [Change allocator disconnect timeout](./change-allocator-disconnect-timeout.md) diff --git a/deploy-manage/deploy/cloud-enterprise/ece-architecture.md b/deploy-manage/deploy/cloud-enterprise/ece-architecture.md index 6aa1d3256f..cb3235be09 100644 --- a/deploy-manage/deploy/cloud-enterprise/ece-architecture.md +++ b/deploy-manage/deploy/cloud-enterprise/ece-architecture.md @@ -1,6 +1,10 @@ --- +applies_to: + deployment: + ece: all mapped_pages: - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-architecture.html + - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-containerization.html --- # Service-oriented architecture [ece-architecture] @@ -15,7 +19,6 @@ Elastic Cloud Enterprise has a service-oriented architecture that lets you: :alt: Elastic Cloud Enterprise high level architecture ::: - ## Control plane [ece_control_plane] The *control plane* of ECE include the following management services: @@ -65,3 +68,19 @@ Provide web and API access for administrators to manage and monitor the ECE inst * Advertise the memory capacity of the underlying host machine to ZooKeeper so that the Constructor can make an informed decision on where to deploy. +## Services as Docker containers [ece-containerization] + +Services are deployed as Docker containers, which simplifies the operational effort and makes it easy to provision similar environments for development and staging. Using Docker containers has the following advantages: + +* **Shares of resources** + + Each cluster node is run within a Docker container to make sure that all of the nodes have access to a guaranteed share of host resources. This mitigates the *noisy neighbor effect* where one busy deployment can overwhelm the entire host. The CPU resources are relative to the size of the Elasticsearch cluster they get assigned to. For example, a cluster with 32GB of RAM gets assigned twice as many CPU resources as a cluster with 16GB of RAM. + +* **Better security** + + On the assumption that any cluster can be compromised, containers are given no access to the platform. The same is true for the services: each service can read or write only those parts of the system state that are relevant to it. Even if some services are compromised, the attacker won’t get hold of the keys to the rest of them and will not compromise the whole platform. + +* **Secure communication through Stunnel** + + Docker containers communicate securely with one another through Transport Layer Security, provided by [Stunnel](https://www.stunnel.org/) (as not all of the services or components support TLS natively). Tunneling all traffic between containers makes sure that it is not possible to eavesdrop, even when someone else has access to the underlying cloud or network infrastructure. + diff --git a/deploy-manage/deploy/cloud-enterprise/ece-containerization.md b/deploy-manage/deploy/cloud-enterprise/ece-containerization.md deleted file mode 100644 index d17e19ea32..0000000000 --- a/deploy-manage/deploy/cloud-enterprise/ece-containerization.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -mapped_pages: - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-containerization.html ---- - -# Services as Docker containers [ece-containerization] - -Services are deployed as Docker containers, which simplifies the operational effort and makes it easy to provision similar environments for development and staging. Using Docker containers has the following advantages: - -* **Shares of resources** - - Each cluster node is run within a Docker container to make sure that all of the nodes have access to a guaranteed share of host resources. This mitigates the *noisy neighbor effect* where one busy deployment can overwhelm the entire host. The CPU resources are relative to the size of the Elasticsearch cluster they get assigned to. For example, a cluster with 32GB of RAM gets assigned twice as many CPU resources as a cluster with 16GB of RAM. - -* **Better security** - - On the assumption that any cluster can be compromised, containers are given no access to the platform. The same is true for the services: each service can read or write only those parts of the system state that are relevant to it. Even if some services are compromised, the attacker won’t get hold of the keys to the rest of them and will not compromise the whole platform. - -* **Secure communication through Stunnel** - - Docker containers communicate securely with one another through Transport Layer Security, provided by [Stunnel](https://www.stunnel.org/) (as not all of the services or components support TLS natively). Tunneling all traffic between containers makes sure that it is not possible to eavesdrop, even when someone else has access to the underlying cloud or network infrastructure. diff --git a/deploy-manage/toc.yml b/deploy-manage/toc.yml index 81f16c287f..fb6a2bdac7 100644 --- a/deploy-manage/toc.yml +++ b/deploy-manage/toc.yml @@ -122,22 +122,21 @@ toc: - file: deploy/cloud-enterprise.md children: - file: deploy/cloud-enterprise/ece-architecture.md - - file: deploy/cloud-enterprise/ece-containerization.md - - file: deploy/cloud-enterprise/prepare-environment.md - children: - - file: deploy/cloud-enterprise/ece-hardware-prereq.md - - 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-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/deploy-an-orchestrator.md children: + - file: deploy/cloud-enterprise/prepare-environment.md + children: + - file: deploy/cloud-enterprise/ece-hardware-prereq.md + - 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-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 diff --git a/raw-migrated-files/cloud/cloud-enterprise/Elastic-Cloud-Enterprise-overview.md b/raw-migrated-files/cloud/cloud-enterprise/Elastic-Cloud-Enterprise-overview.md deleted file mode 100644 index c89107e577..0000000000 --- a/raw-migrated-files/cloud/cloud-enterprise/Elastic-Cloud-Enterprise-overview.md +++ /dev/null @@ -1,30 +0,0 @@ -# Introducing Elastic Cloud Enterprise [Elastic-Cloud-Enterprise-overview] - -This page provides a high-level introduction to Elastic Cloud Enterprise (ECE). - -::::{note} -Try one of the [getting started guides](https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/getting-started-guides.html) to discover the core concepts of the Elastic Stack and understand how Elastic can help you. -:::: - - -**What is ECE?** - -ECE evolves from the Elastic hosted Cloud SaaS offering into a standalone product. You can deploy ECE on public or private clouds, virtual machines, or your own premises. - -**Why ECE?** - -* Host your regulated or sensitive data on your internal network. -* Reuse your existing investment in on-premise infrastructure and reduce total cost. -* Maximize the hardware utilization for the various clusters. -* Centralize the management of multiple Elastic deployments across teams or geographies. - -**ECE features** - -* All services are containerized through Docker. -* High Availability through multiple Availability Zones. -* Deployment state coordination using ZooKeeper. -* Easy access for admins through the Cloud UI and API. -* Support for off-line installations. -* Automated restore and snapshot. - -Check the [glossary](asciidocalypse://docs/docs-content/docs/reference/glossary/index.md) to get familiar with the terminology for ECE as well as other Elastic products and solutions. diff --git a/raw-migrated-files/cloud/cloud-enterprise/ece-administering-ece.md b/raw-migrated-files/cloud/cloud-enterprise/ece-administering-ece.md deleted file mode 100644 index 7ab3fd8a69..0000000000 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-administering-ece.md +++ /dev/null @@ -1,13 +0,0 @@ -# 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: - -* [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. - diff --git a/raw-migrated-files/toc.yml b/raw-migrated-files/toc.yml index 199b6c8340..bc2700e831 100644 --- a/raw-migrated-files/toc.yml +++ b/raw-migrated-files/toc.yml @@ -32,7 +32,6 @@ toc: - file: cloud/cloud-enterprise/ece-add-custom-bundle-plugin.md - file: cloud/cloud-enterprise/ece-add-user-settings.md - file: cloud/cloud-enterprise/ece-administering-deployments.md - - file: cloud/cloud-enterprise/ece-administering-ece.md - file: cloud/cloud-enterprise/ece-api-console.md - file: cloud/cloud-enterprise/ece-autoscaling.md - file: cloud/cloud-enterprise/ece-change-deployment.md @@ -77,7 +76,6 @@ toc: - file: cloud/cloud-enterprise/ece-upgrade-deployment.md - file: cloud/cloud-enterprise/ece-upgrade.md - file: cloud/cloud-enterprise/editing-user-settings.md - - file: cloud/cloud-enterprise/Elastic-Cloud-Enterprise-overview.md - file: cloud/cloud-heroku/index.md children: - file: cloud/cloud-heroku/ech-about.md