Skip to content

Commit 1bf69c9

Browse files
Merge branch 'main' into dm-remote-clusters
2 parents c84e9e1 + 9e85b82 commit 1bf69c9

File tree

54 files changed

+557
-2291
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+557
-2291
lines changed
Lines changed: 60 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,74 @@
11
---
2+
applies_to:
3+
deployment:
4+
ece: all
25
mapped_urls:
36
- https://www.elastic.co/guide/en/cloud-enterprise/current/index.html
47
- https://www.elastic.co/guide/en/cloud-enterprise/current/Elastic-Cloud-Enterprise-overview.html
5-
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-administering-ece.html
68
---
79

8-
# Elastic Cloud Enterprise
10+
# Elastic Cloud Enterprise [Elastic-Cloud-Enterprise-overview]
911

10-
% What needs to be done: Refine
12+
{{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.
1113

12-
% GitHub issue: https://github.com/elastic/docs-projects/issues/339
14+
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.
1315

14-
% 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...
16+
With {{ece}}, you can:
1517

16-
% Use migrated content from existing pages that map to this page:
18+
* Host your regulated or sensitive data on your internal network.
19+
* Reuse your existing investment in on-premise infrastructure and reduce total cost.
20+
* Maximize the hardware utilization for the various clusters.
21+
* Centralize the management of multiple Elastic deployments across teams or geographies.
1722

18-
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/Elastic-Cloud-Enterprise-overview.md
19-
% Notes: 2 child docs
20-
% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-administering-ece.md
21-
% Notes: redirect only
23+
Refer to [](./cloud-enterprise/ece-architecture.md) for details about the ECE platform architecture and the technologies used.
2224

23-
⚠️ **This page is a work in progress.** ⚠️
25+
## ECE features
2426

25-
The documentation team is working to combine content pulled from the following pages:
27+
- **Automated scaling & orchestration**: Handles cluster provisioning, scaling, and upgrades automatically.
28+
- **High availability & resilience**: Ensures uptime through multiple Availability Zones, data replication, and automated restore and snapshot.
29+
- **Centralized monitoring & logging**: Provides insights into cluster performance, resource usage, and logs.
30+
- **Single Sign-On (SSO) & role-based access aontrol (RBAC)**: Allows organizations to manage access and security policies.
31+
- **API & UI management**: Offers a web interface and API to create and manage clusters easily.
32+
- **Air-gapped installations**: Support for off-line installations.
33+
- **Microservices architecture**: All services are containerized through Docker.
2634

27-
* [/raw-migrated-files/cloud/cloud-enterprise/Elastic-Cloud-Enterprise-overview.md](/raw-migrated-files/cloud/cloud-enterprise/Elastic-Cloud-Enterprise-overview.md)
28-
* [/raw-migrated-files/cloud/cloud-enterprise/ece-administering-ece.md](/raw-migrated-files/cloud/cloud-enterprise/ece-administering-ece.md)
35+
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.
36+
37+
## Section overview
38+
39+
This section focuses on deploying the ECE platform, as well as orchestrating and configuring {{es}} clusters, referred to as deployments.
40+
41+
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}}.
42+
43+
The section covers the following tasks:
44+
45+
* [Deploy ECE orchestrator](./cloud-enterprise/deploy-an-orchestrator.md)
46+
- [Prepare the environment](./cloud-enterprise/prepare-environment.md)
47+
- [Install ECE](./cloud-enterprise/install.md)
48+
- [Air gapped installations](./cloud-enterprise/air-gapped-install.md)
49+
- [Configure ECE](./cloud-enterprise/configure.md)
50+
51+
* [Work with deployments](./cloud-enterprise/working-with-deployments.md)
52+
- Use [](./cloud-enterprise/deployment-templates.md) to [](./cloud-enterprise/create-deployment.md)
53+
- [](./cloud-enterprise/customize-deployment.md)
54+
- Use the deployment [Cloud ID](./cloud-enterprise/find-cloud-id.md) and [Endpoint URLs](./cloud-enterprise/find-endpoint-url.md) for clients connection
55+
56+
* Learn about [](./cloud-enterprise/tools-apis.md) that you can use with ECE
57+
58+
Other sections of the documentation provide guidance on additional important tasks related to ECE:
59+
60+
* Platform security and management:
61+
* [Secure your ECE installation](../security/secure-your-elastic-cloud-enterprise-installation.md)
62+
* [Users and roles](../users-roles/cloud-enterprise-orchestrator.md)
63+
* [ECE platform maintenance operations](../maintenance/ece.md)
64+
* [Manage licenses](../license/manage-your-license-in-ece.md)
65+
66+
* Deployments security and management:
67+
* [Secure your deployments](../security/secure-your-cluster-deployment.md)
68+
* [Manage snapshot repositories](../tools/snapshot-and-restore.md)
69+
70+
To learn about other deployment options, refer to [](../deploy.md).
71+
72+
## Supported versions [ece-supported-versions]
73+
74+
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.

deploy-manage/deploy/cloud-enterprise/configure.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
11
---
2+
applies_to:
3+
deployment:
4+
ece: all
25
mapped_pages:
36
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-configuring-ece.html
7+
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-administering-ece.html
48
---
59

6-
# Configure [ece-configuring-ece]
10+
# Configure ECE [ece-configuring-ece]
11+
12+
⚠️ **This page is a work in progress.** ⚠️
713

814
Now that you have Elastic Cloud Enterprise up and running, take a look at some of the additional features that you can configure:
915

@@ -16,3 +22,17 @@ Now that you have Elastic Cloud Enterprise up and running, take a look at some o
1622
* [Change allocator disconnect timeout](change-allocator-disconnect-timeout.md) - Configure how long ECE waits before considering allocators to be disconnected.
1723
* [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.
1824

25+
## Administering your installation [ece-administering-ece]
26+
27+
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.
28+
29+
* [Scale Out Your Installation](../../../deploy-manage/maintenance/ece/scale-out-installation.md) - Need to add more capacity? Here’s how.
30+
* [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.
31+
* [Enable Maintenance Mode](../../../deploy-manage/maintenance/ece/enable-maintenance-mode.md) - Perform administrative actions on allocators safely by putting them into maintenance mode first.
32+
* [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.
33+
* [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.
34+
* [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.
35+
* [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.
36+
* [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.
37+
38+
Lines changed: 49 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,54 @@
1+
---
2+
applies_to:
3+
deployment:
4+
ece: all
5+
---
16
# Deploy an orchestrator
27

3-
% What needs to be done: Write from scratch
8+
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.
49

5-
% GitHub issue: https://github.com/elastic/docs-projects/issues/339
10+
::::{note}
11+
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).
12+
::::
613

7-
% Scope notes: Introduction about the content of this big section (which covers install and configuration possibilities of the orchestrator)
14+
## Deployment tasks
815

9-
⚠️ **This page is a work in progress.** ⚠️
16+
This section provides step-by-step guidance on:
17+
18+
* [Prepare the environment](./prepare-environment.md): Follow the hardware, software, and networking prerequisites before the installation.
19+
20+
* [Install ECE](./install.md): Identify the deployment scenario that best fits your needs, choose an installation method, and complete the setup.
21+
* [Install ECE on a public cloud](./install-ece-on-public-cloud.md)
22+
* [Install ECE on your own premises](./install-ece-on-own-premises.md)
23+
* [Alternative: install ECE with Ansible](./alternative-install-ece-with-ansible.md)
24+
25+
* [Air-gapped installations](./air-gapped-install.md): Review the different options for air-gapped environments.
26+
* [With your private Docker registry](./ece-install-offline-with-registry.md)
27+
* [Without any Docker registry](./ece-install-offline-no-registry.md)
28+
29+
* [Configure ECE](./configure.md): Explore the most common tasks to configure your ECE platform.
30+
* [System deployments configuration](./system-deployments-configuration.md)
31+
* [Configure deployment templates](./deployment-templates.md)
32+
* [Configure endpoint URLs](./change-endpoint-urls.md)
33+
* [Manage {{stack}} versions](./manage-elastic-stack-versions.md)
34+
35+
## Additional topics
36+
37+
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:
38+
39+
* [Secure your ECE installation](../../security/secure-your-elastic-cloud-enterprise-installation.md)
40+
*[](/deploy-manage/security/secure-your-cluster-deployment.md)
41+
* [Users and roles](../../users-roles/cloud-enterprise-orchestrator.md)
42+
* [Manage snapshot repositories](../../tools/snapshot-and-restore.md)
43+
* [Manage licenses](../../license/manage-your-license-in-ece.md)
44+
* [ECE platform maintenance operations](../../maintenance/ece.md)
45+
46+
To start orchestrating your {{es}} clusters, refer to [](./working-with-deployments.md).
47+
48+
## Advanced tasks
49+
50+
The following tasks are only needed on certain circumstances:
51+
52+
* [Migrate ECE to Podman hosts](./migrate-ece-to-podman-hosts.md)
53+
* [Migrate ECE on Podman hosts to SELinux enforce](./migrate-ece-on-podman-hosts-to-selinux-enforce.md)
54+
* [Change allocator disconnect timeout](./change-allocator-disconnect-timeout.md)

deploy-manage/deploy/cloud-enterprise/ece-architecture.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
---
2+
applies_to:
3+
deployment:
4+
ece: all
25
mapped_pages:
36
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-architecture.html
7+
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-containerization.html
48
---
59

610
# Service-oriented architecture [ece-architecture]
@@ -15,7 +19,6 @@ Elastic Cloud Enterprise has a service-oriented architecture that lets you:
1519
:alt: Elastic Cloud Enterprise high level architecture
1620
:::
1721

18-
1922
## Control plane [ece_control_plane]
2023

2124
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
6568

6669
* Advertise the memory capacity of the underlying host machine to ZooKeeper so that the Constructor can make an informed decision on where to deploy.
6770

71+
## Services as Docker containers [ece-containerization]
72+
73+
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:
74+
75+
* **Shares of resources**
76+
77+
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.
78+
79+
* **Better security**
80+
81+
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.
82+
83+
* **Secure communication through Stunnel**
84+
85+
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.
86+

deploy-manage/deploy/cloud-enterprise/ece-containerization.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

deploy-manage/monitor/autoops/ec-autoops-regions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ AutoOps is currently available in the following regions:
1616
| AWS | us-east-1 | US East (N. Virginia) | |
1717
| AWS | us-west-2 | Oregon | |
1818
| AWS | eu-west-1 | Ireland | |
19+
| AWS | ap-southeast-1 | Singapore | |
1920

2021
::::{note}
2122
Currently, a limited number of AWS regions are available. More regions for AWS, Azure and GCP will be added in the future. Also, AutoOps is currently not available for GovCloud customers.

deploy-manage/toc.yml

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -122,22 +122,21 @@ toc:
122122
- file: deploy/cloud-enterprise.md
123123
children:
124124
- file: deploy/cloud-enterprise/ece-architecture.md
125-
- file: deploy/cloud-enterprise/ece-containerization.md
126-
- file: deploy/cloud-enterprise/prepare-environment.md
127-
children:
128-
- file: deploy/cloud-enterprise/ece-hardware-prereq.md
129-
- file: deploy/cloud-enterprise/ece-software-prereq.md
130-
- file: deploy/cloud-enterprise/ece-sysconfig.md
131-
- file: deploy/cloud-enterprise/ece-networking-prereq.md
132-
- file: deploy/cloud-enterprise/ece-ha.md
133-
- file: deploy/cloud-enterprise/ece-roles.md
134-
- file: deploy/cloud-enterprise/ece-load-balancers.md
135-
- file: deploy/cloud-enterprise/ece-users-permissions.md
136-
- file: deploy/cloud-enterprise/ece-jvm.md
137-
- file: deploy/cloud-enterprise/ece-wildcard-dns.md
138-
- file: deploy/cloud-enterprise/ece-manage-capacity.md
139125
- file: deploy/cloud-enterprise/deploy-an-orchestrator.md
140126
children:
127+
- file: deploy/cloud-enterprise/prepare-environment.md
128+
children:
129+
- file: deploy/cloud-enterprise/ece-hardware-prereq.md
130+
- file: deploy/cloud-enterprise/ece-software-prereq.md
131+
- file: deploy/cloud-enterprise/ece-sysconfig.md
132+
- file: deploy/cloud-enterprise/ece-networking-prereq.md
133+
- file: deploy/cloud-enterprise/ece-ha.md
134+
- file: deploy/cloud-enterprise/ece-roles.md
135+
- file: deploy/cloud-enterprise/ece-load-balancers.md
136+
- file: deploy/cloud-enterprise/ece-users-permissions.md
137+
- file: deploy/cloud-enterprise/ece-jvm.md
138+
- file: deploy/cloud-enterprise/ece-wildcard-dns.md
139+
- file: deploy/cloud-enterprise/ece-manage-capacity.md
141140
- file: deploy/cloud-enterprise/install.md
142141
children:
143142
- file: deploy/cloud-enterprise/identify-deployment-scenario.md
-1.8 MB
Binary file not shown.
-443 KB
Binary file not shown.
-9.17 KB
Binary file not shown.

0 commit comments

Comments
 (0)