Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/.DS_Store
Binary file not shown.
20 changes: 20 additions & 0 deletions docs/source/docset.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,26 @@ toc:
children:
- file: search/req.md
- file: search/setup.md
- folder: deploy
children:
- file: index.md
- folder: cloud-hosted
- folder: cloud-serverless
- file: ece/install_ece.md
children:
- file: ece/install_ece_on_cloud.md
- file: ece/install_ece_on_prem.md
children:
- file: ece/configure_os.md
children:
- file: ece/ubuntu1.md
- file: ece/ubuntu2.md
- file: ece/ubuntu3.md
- file: ece/redhat.md
- file: ece/suse.md
- file: self-managed/install_stack.md
children:
- file: self-managed/elasticsearch/elasticsearch_targz.md
- folder: nested
children:
- folder: content
Expand Down
22 changes: 22 additions & 0 deletions docs/source/elastic/deploy/cloud-hosted/create_deployment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Elastic Cloud hosted
---

An Elastic Cloud deployment includes Elastic Stack components such as Elasticsearch, Kibana, and other features, allowing you to store, search, and analyze your data.
You can spin up a proof-of-concept deployment to learn more about what Elastic can do for you.

To explore Elasticsearch Service and its solutions, create your first deployment by following one of these getting started guides.
If you are instead interested in serverless Elastic Cloud, check the serverless documentation.

You can also create a deployment using the Elastic Cloud API.
This can be an interesting alternative for more advanced needs, such as for creating a deployment encrypted with your own key.

. Log in to your cloud.elastic.co account and select Create deployment from the Elasticsearch Service main page. Once you are on the Create deployment page, you can create the deployment with the defaults assigned, where you can edit the basic settings, or configure more advanced settings.
. From the main Settings, you can change the cloud provider and region that host your deployment, the stack version, and the hardware profile, or restore data from another deployment (Restore snapshot data).
. Expand Advanced settings to configure your deployment for encryption using a customer-managed key, autoscaling, storage, memory, and vCPU. Check Customize your deployment for more details.
Trial users won’t find the Advanced settings when they create their first deployment. This option is available on the deployment’s edit page once the deployment is created.

. Select Create deployment. It takes a few minutes before your deployment gets created. While waiting, you are prompted to save the admin credentials for your deployment which provides you with superuser access to Elasticsearch. Keep these credentials safe as they are shown only once. These credentials also help you add data using Kibana. If you need to refresh these credentials, you can reset the password.
. Once the deployment is ready, select Continue to open the deployment’s main page. From here, you can start ingesting data or simply try a sample data set to get started.

At any time, you can manage and adjust the configuration of your deployment to your needs, add extra layers of security, or (highly recommended) set up health monitoring.
10 changes: 10 additions & 0 deletions docs/source/elastic/deploy/cloud-serverless/create_project.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Elastic Cloud serverless
---

. Navigate to cloud.elastic.co and create a new account or log in to your existing account.
. Within Serverless Projects, choose Create project.
. Choose an Elasticsearch, Observability, or Security project type.
. Select a configuration for your project, based on your use case.

Now your project is ready to start creating indices, adding data, and performing searches.
18 changes: 18 additions & 0 deletions docs/source/elastic/deploy/ece/configure_os.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Configure your operating system
---

Before installing Elastic Cloud Enterprise, you have to prepare your hosts with one of the following Linux distributions:

- ECE 3.7:
- [Ubuntu 20.04 LTS (Focal Fossa)](ubuntu2.md)
- [Ubuntu 22.04 LTS (Jammy Jellyfish)](ubuntu3.md)
- [Red Hat Enterprise Linux (RHEL) 8 and 9](redhat.md)
- Rocky Linux 8 and 9
- [SUSE Linux Enterprise Server (SLES) 12 SP5 and 15](suse.md)
- ECE 3.6:
- [Ubuntu 20.04 LTS (Focal Fossa)](ubuntu2.md)
- Red Hat Enterprise Linux (RHEL) and CentOS
- [SUSE Linux Enterprise Server (SLES) 12 SP5](suse.md)

For the definitive list, check the [Elastic support matrix](https://www.elastic.co/support/matrix#matrix_os).
11 changes: 11 additions & 0 deletions docs/source/elastic/deploy/ece/install_ece.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Elastic Cloud Enterprise
---

Before you start installing ECE, make sure you identify your deployment scenario and prepare your hosts.

You can get ECE up and running using the official bash script on a public cloud or on your own premises.
Alternatively, you can install ECE with the Ansible playbook.
The ECE Ansible playbook is a community project, supported by Elastic, aimed at installing ECE at scale.

Once you have installed ECE, check some final post-installation steps to get ready for production.
27 changes: 27 additions & 0 deletions docs/source/elastic/deploy/ece/install_ece_on_cloud.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: Install ECE on a public cloud
---

```{note}
This page applies to the latest Elastic Cloud Enterprise environment.
```

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)
- Red Hat Enterprise Linux (RHEL) 8 and 9
- Rocky Linux 8 and 9
- SUSE Linux Enterprise Server (SLES) 12 SP5 and 15

Choose the Elastic Cloud Enterprise deployment scenario that best fits your business needs:

[Deploy a small installation](https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-small-cloud.html): For development, test, and small-scale use cases.
[Deploy a medium installation](https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-medium-cloud.html): For many production setups.
[Deploy a large installation](https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-large-cloud.html): For deployments with significant overall search and indexing throughput.
[Deploy using Podman](https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-using-podman-cloud.html): Fresh installation of ECE using Podman hosts.
15 changes: 15 additions & 0 deletions docs/source/elastic/deploy/ece/install_ece_on_prem.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Install ECE on your own premises
---

```{note}
This page applies to the latest Elastic Cloud Enterprise environment.
```

Before you start, make sure that your existing infrastructure meets the requirements.

ECE supports a wide range of OS versions.
For the definitive list, check the [Elastic support matrix](https://www.elastic.co/support/matrix#matrix_os).

- [Install ECE online](https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-onprem.html)
- [Install ECE offline](https://www.elastic.co/guide/en/cloud-enterprise/current/ece-install-offline.html)
5 changes: 5 additions & 0 deletions docs/source/elastic/deploy/ece/redhat.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Red Hat Enterprise Linux (RHEL) and Rocky Linux
---

TBD
5 changes: 5 additions & 0 deletions docs/source/elastic/deploy/ece/suse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: SUSE Linux Enterprise Server (SLES) 12 SP5 and 15
---

TBD
21 changes: 21 additions & 0 deletions docs/source/elastic/deploy/ece/ubuntu1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Ubuntu 18.04 LTS (Bionic Beaver)
---

```{deprecated} 3.6
Support for Ubuntu 18.04 LTS (Bionic Beaver) was removed in Elastic Cloud Enterprise 3.7.
```

The following instructions show you how to prepare your hosts on 18.04 LTS (Bionic Beaver).

. Check the supported Linux kernel
. Install Docker 18.09.9
. Set up XFS quotas
. Update the configurations settings
. Configure the Docker daemon options
. Check the supported Linux kernel
. Elastic Cloud Enterprise requires 3.10 or higher, except between 4.4.156 and 4.9. To check your kernel version, run uname -r.

## Install Docker

Install Docker LTS version 19.03 for Ubuntu 18.04
24 changes: 24 additions & 0 deletions docs/source/elastic/deploy/ece/ubuntu2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Ubuntu 20.04 LTS (Focal Fossa)
---

```{versionadded} 3.3
Elastic Cloud Enterprise 3.3 and later support Ubuntu 20.04 LTS (Focal Fossa).
```

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
. Set up XFS quotas
. Update the configurations settings
. Configure the Docker daemon options

## Install Docker

Install Docker LTS version 24.0 for Ubuntu 20.04 or 22.04.

Make sure to use a combination of Linux distribution and Docker version that is supported, following our official Support matrix. 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.

Docker 25 and higher are not compatible with ECE 3.7.

. Install the Docker repository dependencies
24 changes: 24 additions & 0 deletions docs/source/elastic/deploy/ece/ubuntu3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Ubuntu 22.04 LTS (Jammy Jellyfish)
---

```{versionadded} 3.7
Support for Ubuntu 20.04 LTS (Focal Fossa) was added in Elastic Cloud Enterprise 3.7.
```

The following instructions show you how to prepare your hosts on Ubuntu 22.04 LTS (Jammy Jellyfish).

1. Install Docker 24.0
1. Set up XFS quotas
1. Update the configurations settings
1. Configure the Docker daemon options

## Install Docker

Install Docker LTS version 24.0 for Ubuntu 20.04 or 22.04.

Make sure to use a combination of Linux distribution and Docker version that is supported, following our official Support matrix. 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.

Docker 25 and higher are not compatible with ECE 3.7.

1. Install the Docker repository dependencies
7 changes: 7 additions & 0 deletions docs/source/elastic/deploy/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Deploy and manage
---

The goal of this section is to play with what it looks like to have all the installation instructions together in the IA.

* [Elastic Cloud Enterprise](ece/install_ece.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: Install Elasticsearch from an archive on Linux or MacOS
sub:
'es': "Elasticsearch"
'version': "8.16.1"
---

```{note}
This page applies to the latest version of the Elastic Stack in an on-premise self-managed environment.
```

{{es}} is available as a `.tar.gz` archive for Linux and MacOS.

The latest stable version of {{es}} can be found on the
[Download {{es}}](https://www.elastic.co/downloads/elasticsearch) page. Other
versions can be found on the [Past Releases page](https://www.elastic.co/downloads/past-releases).

## Download and install archive for Linux

The Linux archive for {{es}} v{{version}} can be downloaded and installed as follows:

```{code} sh
wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{version}}-linux-x86_64.tar.gz
wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{version}}-linux-x86_64.tar.gz.sha512
shasum -a 512 -c elasticsearch-{{version}}-linux-x86_64.tar.gz.sha512 <1>
tar -xzf elasticsearch-{{version}}-linux-x86_64.tar.gz
cd elasticsearch-{{version}}/ <2>
```
1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output
`elasticsearch-{{version}}-linux-x86_64.tar.gz: OK`.
2. This directory is known as `$ES_HOME`.

## Download and install archive for MacOS

The MacOS archive for {{es}} v{{version}} can be downloaded and installed as follows:

```{code} sh
curl -O https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{version}}-darwin-x86_64.tar.gz
curl https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{{version}}-darwin-x86_64.tar.gz.sha512 | shasum -a 512 -c - <1>
tar -xzf elasticsearch-{{version}}-darwin-x86_64.tar.gz
cd elasticsearch-{{version}}/ <2>
```

1. Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output
`elasticsearch-{{version}}-darwin-x86_64.tar.gz: OK`.
2. This directory is known as `$ES_HOME`.


18 changes: 18 additions & 0 deletions docs/source/elastic/deploy/self-managed/install_stack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Self-managed Elastic Stack
---

```{note}
This page applies to the latest version of the Elastic Stack in an on-premise self-managed environment.
```

Install the Elastic Stack products you want to use in the following order:

. Elasticsearch
. Kibana
. Logstash
. Elastic Agent or Beats
. APM
. Elasticsearch Hadoop

Installing in this order ensures that the components each product depends on are in place.
1 change: 1 addition & 0 deletions docs/source/elastic/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ Here's what we have so far:
* [Search Labs Tutorial](search-labs/index.md) — A partial port of the Search Labs Tutorials content currently hosted [here](https://www.elastic.co/search-labs/tutorials).
* [Automated Settings Reference](reference/index.md) — An example of an automatically automated setting
* [Observability overview](observability/index.md) — Nothing special, just a bunch of images and text.
* [Deploy and manage](deploy/index.md)
Loading