From 2b42c353f0befb2ae01c4e0220f44a741d382a92 Mon Sep 17 00:00:00 2001 From: lcawl Date: Fri, 22 Nov 2024 16:01:56 -0800 Subject: [PATCH 1/9] Add some deployment pages --- docs/source/docset.yml | 13 +++++ .../deploy/cloud-hosted/create_deployment.md | 14 ++++++ .../deploy/cloud-serverless/create_project.md | 26 ++++++++++ docs/source/elastic/deploy/ece/install_ece.md | 15 ++++++ .../deploy/ece/install_ece_on_cloud.md | 27 +++++++++++ .../elastic/deploy/ece/install_ece_on_prem.md | 20 ++++++++ docs/source/elastic/deploy/index.md | 10 ++++ .../elasticsearch/elasticsearch_targz.md | 47 +++++++++++++++++++ .../deploy/self-managed/install_stack.md | 18 +++++++ docs/source/elastic/index.md | 1 + 10 files changed, 191 insertions(+) create mode 100644 docs/source/elastic/deploy/cloud-hosted/create_deployment.md create mode 100644 docs/source/elastic/deploy/cloud-serverless/create_project.md create mode 100644 docs/source/elastic/deploy/ece/install_ece.md create mode 100644 docs/source/elastic/deploy/ece/install_ece_on_cloud.md create mode 100644 docs/source/elastic/deploy/ece/install_ece_on_prem.md create mode 100644 docs/source/elastic/deploy/index.md create mode 100644 docs/source/elastic/deploy/self-managed/elasticsearch/elasticsearch_targz.md create mode 100644 docs/source/elastic/deploy/self-managed/install_stack.md diff --git a/docs/source/docset.yml b/docs/source/docset.yml index 7ff9426..db14110 100644 --- a/docs/source/docset.yml +++ b/docs/source/docset.yml @@ -41,6 +41,19 @@ toc: children: - file: search/req.md - file: search/setup.md + - folder: deploy + children: + - file: index.md + children: + - file: self-managed/install_stack.md + children: + - file: self-managed/elasticsearch/elasticsearch_targz.md + - file: cloud-hosted/create_deployment.md + - file: cloud-serverless/create_project.md + - file: ece/install_ece.md + children: + - file: ece/install_ece_on_cloud.md + - file: ece/install_ece_on_prem.md - folder: nested children: - folder: content diff --git a/docs/source/elastic/deploy/cloud-hosted/create_deployment.md b/docs/source/elastic/deploy/cloud-hosted/create_deployment.md new file mode 100644 index 0000000..32f9586 --- /dev/null +++ b/docs/source/elastic/deploy/cloud-hosted/create_deployment.md @@ -0,0 +1,14 @@ +--- +title: Create an Elastic Cloud serverless project +--- + +```{note} +This page applies to the current Elastic Cloud Serverless environment. +``` + +. 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. \ No newline at end of file diff --git a/docs/source/elastic/deploy/cloud-serverless/create_project.md b/docs/source/elastic/deploy/cloud-serverless/create_project.md new file mode 100644 index 0000000..abcc6ea --- /dev/null +++ b/docs/source/elastic/deploy/cloud-serverless/create_project.md @@ -0,0 +1,26 @@ +--- +title: Create an Elastic Cloud hosted deployment +--- + +```{note} +This page applies to the current Elastic Cloud Hosted environment. +``` + +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. \ No newline at end of file diff --git a/docs/source/elastic/deploy/ece/install_ece.md b/docs/source/elastic/deploy/ece/install_ece.md new file mode 100644 index 0000000..6cf9fbf --- /dev/null +++ b/docs/source/elastic/deploy/ece/install_ece.md @@ -0,0 +1,15 @@ +--- +title: Install Elastic Cloud Enterprise +--- + +```{note} +This page applies to the latest Elastic Cloud Enterprise environment. +``` + +Before you start, 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. \ No newline at end of file diff --git a/docs/source/elastic/deploy/ece/install_ece_on_cloud.md b/docs/source/elastic/deploy/ece/install_ece_on_cloud.md new file mode 100644 index 0000000..e6a7394 --- /dev/null +++ b/docs/source/elastic/deploy/ece/install_ece_on_cloud.md @@ -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. diff --git a/docs/source/elastic/deploy/ece/install_ece_on_prem.md b/docs/source/elastic/deploy/ece/install_ece_on_prem.md new file mode 100644 index 0000000..3c81ba5 --- /dev/null +++ b/docs/source/elastic/deploy/ece/install_ece_on_prem.md @@ -0,0 +1,20 @@ +--- +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. +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) +- Red Hat Enterprise Linux (RHEL) 8 and 9, and Rocky Linux 8 and 9 +- SUSE Linux Enterprise Server (SLES) 12 SP5 and 15 +- After your hosts are prepared, choose your preferred installation type: + + - [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) \ No newline at end of file diff --git a/docs/source/elastic/deploy/index.md b/docs/source/elastic/deploy/index.md new file mode 100644 index 0000000..a05423d --- /dev/null +++ b/docs/source/elastic/deploy/index.md @@ -0,0 +1,10 @@ +--- +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. + +* [On-premise self-managed installation](self-managed/install_stack.md) +* [Elastic Cloud Hosted](cloud-hosted/create_deployment.md) +* [Elastic Cloud Serverless](cloud-serverless/create_project.md) +* [Elastic Cloud Enterprise](ece/install_ece.md) diff --git a/docs/source/elastic/deploy/self-managed/elasticsearch/elasticsearch_targz.md b/docs/source/elastic/deploy/self-managed/elasticsearch/elasticsearch_targz.md new file mode 100644 index 0000000..0080a70 --- /dev/null +++ b/docs/source/elastic/deploy/self-managed/elasticsearch/elasticsearch_targz.md @@ -0,0 +1,47 @@ +--- +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`. + + diff --git a/docs/source/elastic/deploy/self-managed/install_stack.md b/docs/source/elastic/deploy/self-managed/install_stack.md new file mode 100644 index 0000000..c9bc9a6 --- /dev/null +++ b/docs/source/elastic/deploy/self-managed/install_stack.md @@ -0,0 +1,18 @@ +--- +title: Install a 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. \ No newline at end of file diff --git a/docs/source/elastic/index.md b/docs/source/elastic/index.md index bd19393..347fd5f 100644 --- a/docs/source/elastic/index.md +++ b/docs/source/elastic/index.md @@ -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) \ No newline at end of file From a439797801286a6a2504fc9bc496ec2c2337ba60 Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 27 Nov 2024 17:35:23 -0800 Subject: [PATCH 2/9] Reduce nav --- docs/.DS_Store | Bin 0 -> 6148 bytes docs/source/docset.yml | 11 +---------- .../elasticsearch/elasticsearch_targz.md | 5 +++-- 3 files changed, 4 insertions(+), 12 deletions(-) create mode 100644 docs/.DS_Store diff --git a/docs/.DS_Store b/docs/.DS_Store new file mode 100644 index 0000000000000000000000000000000000000000..be3fbcdb467c2255116bbd5fb77cbe69a4e7d8d0 GIT binary patch literal 6148 zcmeHK%}T>S5Z-NTn^J@v6nb3nS};l#iT3;ks__haeT zO!OB``0Z_$G07GzW!3Nh@aJ)q<&N{o8_m{MyJK~%o^|Iv$)%Ui@dgeV9h21|GcrBc(YmnN}H9>HGbl(B@w05L!e z5CfaXfH@1S-sY7~6%zx*zz+=I{ve>0lQo&NWzQ)ai_?m0=#Ua`|}SYIU#+70$S;k$Pf)7^pJP)I%H3|8w|d zY9IO46dDl&#K1pefVU>zWDG@_v-Mkfc-9JN_s~!JaA| WEHvUQXjkcgbP-U5P)7{>0s~)vu}n7r literal 0 HcmV?d00001 diff --git a/docs/source/docset.yml b/docs/source/docset.yml index db14110..bd27420 100644 --- a/docs/source/docset.yml +++ b/docs/source/docset.yml @@ -44,16 +44,7 @@ toc: - folder: deploy children: - file: index.md - children: - - file: self-managed/install_stack.md - children: - - file: self-managed/elasticsearch/elasticsearch_targz.md - - file: cloud-hosted/create_deployment.md - - file: cloud-serverless/create_project.md - - file: ece/install_ece.md - children: - - file: ece/install_ece_on_cloud.md - - file: ece/install_ece_on_prem.md + - file: self-managed/elasticsearch/elasticsearch_targz.md - folder: nested children: - folder: content diff --git a/docs/source/elastic/deploy/self-managed/elasticsearch/elasticsearch_targz.md b/docs/source/elastic/deploy/self-managed/elasticsearch/elasticsearch_targz.md index 0080a70..d5f55c4 100644 --- a/docs/source/elastic/deploy/self-managed/elasticsearch/elasticsearch_targz.md +++ b/docs/source/elastic/deploy/self-managed/elasticsearch/elasticsearch_targz.md @@ -11,8 +11,9 @@ This page applies to the latest version of the Elastic Stack in an on-premise se {{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). +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 From 3b2901a27269324cdb19991fed3e060855cad886 Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 27 Nov 2024 18:22:13 -0800 Subject: [PATCH 3/9] Add more ECE variations --- docs/source/docset.yml | 13 ++++++++- .../deploy/cloud-hosted/create_deployment.md | 26 +++++++++++------ .../deploy/cloud-serverless/create_project.md | 28 ++++--------------- .../source/elastic/deploy/ece/configure_os.md | 10 +++++++ docs/source/elastic/deploy/ece/install_ece.md | 4 --- docs/source/elastic/deploy/ece/redhat.md | 5 ++++ docs/source/elastic/deploy/ece/suse.md | 20 +++++++++++++ docs/source/elastic/deploy/ece/ubuntu1.md | 17 +++++++++++ docs/source/elastic/deploy/ece/ubuntu2.md | 24 ++++++++++++++++ docs/source/elastic/deploy/ece/ubuntu3.md | 24 ++++++++++++++++ docs/source/elastic/deploy/index.md | 3 -- 11 files changed, 135 insertions(+), 39 deletions(-) create mode 100644 docs/source/elastic/deploy/ece/configure_os.md create mode 100644 docs/source/elastic/deploy/ece/redhat.md create mode 100644 docs/source/elastic/deploy/ece/suse.md create mode 100644 docs/source/elastic/deploy/ece/ubuntu1.md create mode 100644 docs/source/elastic/deploy/ece/ubuntu2.md create mode 100644 docs/source/elastic/deploy/ece/ubuntu3.md diff --git a/docs/source/docset.yml b/docs/source/docset.yml index bd27420..a7a66ac 100644 --- a/docs/source/docset.yml +++ b/docs/source/docset.yml @@ -44,7 +44,18 @@ toc: - folder: deploy children: - file: index.md - - file: self-managed/elasticsearch/elasticsearch_targz.md + - 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/sus.md - folder: nested children: - folder: content diff --git a/docs/source/elastic/deploy/cloud-hosted/create_deployment.md b/docs/source/elastic/deploy/cloud-hosted/create_deployment.md index 32f9586..fee0727 100644 --- a/docs/source/elastic/deploy/cloud-hosted/create_deployment.md +++ b/docs/source/elastic/deploy/cloud-hosted/create_deployment.md @@ -1,14 +1,22 @@ --- -title: Create an Elastic Cloud serverless project +title: Create an Elastic Cloud hosted deployment --- -```{note} -This page applies to the current Elastic Cloud Serverless environment. -``` +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. -. 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. +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. -Now your project is ready to start creating indices, adding data, and performing searches. \ No newline at end of file +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. \ No newline at end of file diff --git a/docs/source/elastic/deploy/cloud-serverless/create_project.md b/docs/source/elastic/deploy/cloud-serverless/create_project.md index abcc6ea..ea646ad 100644 --- a/docs/source/elastic/deploy/cloud-serverless/create_project.md +++ b/docs/source/elastic/deploy/cloud-serverless/create_project.md @@ -1,26 +1,10 @@ --- -title: Create an Elastic Cloud hosted deployment +title: Create an Elastic Cloud serverless project --- -```{note} -This page applies to the current Elastic Cloud Hosted environment. -``` +. 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. -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. \ No newline at end of file +Now your project is ready to start creating indices, adding data, and performing searches. \ No newline at end of file diff --git a/docs/source/elastic/deploy/ece/configure_os.md b/docs/source/elastic/deploy/ece/configure_os.md new file mode 100644 index 0000000..b104f88 --- /dev/null +++ b/docs/source/elastic/deploy/ece/configure_os.md @@ -0,0 +1,10 @@ +--- +title: Configure your operating system for Elastic Cloud Enterprise +--- + +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) +- Red Hat Enterprise Linux (RHEL) 8 and 9 +- Rocky Linux 8 and 9 +- SUSE Linux Enterprise Server (SLES) 12 SP5 and 15 \ No newline at end of file diff --git a/docs/source/elastic/deploy/ece/install_ece.md b/docs/source/elastic/deploy/ece/install_ece.md index 6cf9fbf..5f9e5d4 100644 --- a/docs/source/elastic/deploy/ece/install_ece.md +++ b/docs/source/elastic/deploy/ece/install_ece.md @@ -2,10 +2,6 @@ title: Install Elastic Cloud Enterprise --- -```{note} -This page applies to the latest Elastic Cloud Enterprise environment. -``` - Before you start, 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. diff --git a/docs/source/elastic/deploy/ece/redhat.md b/docs/source/elastic/deploy/ece/redhat.md new file mode 100644 index 0000000..8907d29 --- /dev/null +++ b/docs/source/elastic/deploy/ece/redhat.md @@ -0,0 +1,5 @@ +--- +title: Red Hat Enterprise Linux (RHEL) and Rocky Linux +--- + +TBD \ No newline at end of file diff --git a/docs/source/elastic/deploy/ece/suse.md b/docs/source/elastic/deploy/ece/suse.md new file mode 100644 index 0000000..401464d --- /dev/null +++ b/docs/source/elastic/deploy/ece/suse.md @@ -0,0 +1,20 @@ +--- +title: Ubuntu 20.04 LTS (Focal Fossa) and Ubuntu 22.04 LTS (Jammy Jellyfish) +--- + +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 \ No newline at end of file diff --git a/docs/source/elastic/deploy/ece/ubuntu1.md b/docs/source/elastic/deploy/ece/ubuntu1.md new file mode 100644 index 0000000..0d9a35b --- /dev/null +++ b/docs/source/elastic/deploy/ece/ubuntu1.md @@ -0,0 +1,17 @@ +--- +title: Ubuntu 18.04 LTS (Bionic Beaver) +--- + +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 \ No newline at end of file diff --git a/docs/source/elastic/deploy/ece/ubuntu2.md b/docs/source/elastic/deploy/ece/ubuntu2.md new file mode 100644 index 0000000..b4b634b --- /dev/null +++ b/docs/source/elastic/deploy/ece/ubuntu2.md @@ -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 \ No newline at end of file diff --git a/docs/source/elastic/deploy/ece/ubuntu3.md b/docs/source/elastic/deploy/ece/ubuntu3.md new file mode 100644 index 0000000..6b0a3ee --- /dev/null +++ b/docs/source/elastic/deploy/ece/ubuntu3.md @@ -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 \ No newline at end of file diff --git a/docs/source/elastic/deploy/index.md b/docs/source/elastic/deploy/index.md index a05423d..b3cae86 100644 --- a/docs/source/elastic/deploy/index.md +++ b/docs/source/elastic/deploy/index.md @@ -4,7 +4,4 @@ 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. -* [On-premise self-managed installation](self-managed/install_stack.md) -* [Elastic Cloud Hosted](cloud-hosted/create_deployment.md) -* [Elastic Cloud Serverless](cloud-serverless/create_project.md) * [Elastic Cloud Enterprise](ece/install_ece.md) From f5aab09ede2950e6761edd8a6979769f8f67ec1f Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 27 Nov 2024 18:49:34 -0800 Subject: [PATCH 4/9] Edit navigation titles --- docs/source/docset.yml | 7 ++++++- .../elastic/deploy/cloud-hosted/create_deployment.md | 2 +- .../elastic/deploy/cloud-serverless/create_project.md | 2 +- docs/source/elastic/deploy/ece/configure_os.md | 2 +- docs/source/elastic/deploy/ece/install_ece.md | 4 ++-- docs/source/elastic/deploy/self-managed/install_stack.md | 2 +- 6 files changed, 12 insertions(+), 7 deletions(-) diff --git a/docs/source/docset.yml b/docs/source/docset.yml index a7a66ac..b2b4087 100644 --- a/docs/source/docset.yml +++ b/docs/source/docset.yml @@ -44,6 +44,8 @@ toc: - 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 @@ -55,7 +57,10 @@ toc: - file: ece/ubuntu2.md - file: ece/ubuntu3.md - file: ece/redhat.md - - file: ece/sus.md + - file: ece/suse.md + - file: self-managed/install_stack.md + children: + - file: self-managed/elasticsearch/elasticsearch_targz.md - folder: nested children: - folder: content diff --git a/docs/source/elastic/deploy/cloud-hosted/create_deployment.md b/docs/source/elastic/deploy/cloud-hosted/create_deployment.md index fee0727..2b01595 100644 --- a/docs/source/elastic/deploy/cloud-hosted/create_deployment.md +++ b/docs/source/elastic/deploy/cloud-hosted/create_deployment.md @@ -1,5 +1,5 @@ --- -title: Create an Elastic Cloud hosted deployment +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. diff --git a/docs/source/elastic/deploy/cloud-serverless/create_project.md b/docs/source/elastic/deploy/cloud-serverless/create_project.md index ea646ad..8c9074f 100644 --- a/docs/source/elastic/deploy/cloud-serverless/create_project.md +++ b/docs/source/elastic/deploy/cloud-serverless/create_project.md @@ -1,5 +1,5 @@ --- -title: Create an Elastic Cloud serverless project +title: Elastic Cloud serverless --- . Navigate to cloud.elastic.co and create a new account or log in to your existing account. diff --git a/docs/source/elastic/deploy/ece/configure_os.md b/docs/source/elastic/deploy/ece/configure_os.md index b104f88..fc96a38 100644 --- a/docs/source/elastic/deploy/ece/configure_os.md +++ b/docs/source/elastic/deploy/ece/configure_os.md @@ -1,5 +1,5 @@ --- -title: Configure your operating system for Elastic Cloud Enterprise +title: Configure your operating system --- Before installing Elastic Cloud Enterprise, you have to prepare your hosts with one of the following Linux distributions: diff --git a/docs/source/elastic/deploy/ece/install_ece.md b/docs/source/elastic/deploy/ece/install_ece.md index 5f9e5d4..746aabb 100644 --- a/docs/source/elastic/deploy/ece/install_ece.md +++ b/docs/source/elastic/deploy/ece/install_ece.md @@ -1,8 +1,8 @@ --- -title: Install Elastic Cloud Enterprise +title: Elastic Cloud Enterprise --- -Before you start, make sure you identify your deployment scenario and prepare your hosts. +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. diff --git a/docs/source/elastic/deploy/self-managed/install_stack.md b/docs/source/elastic/deploy/self-managed/install_stack.md index c9bc9a6..2aee312 100644 --- a/docs/source/elastic/deploy/self-managed/install_stack.md +++ b/docs/source/elastic/deploy/self-managed/install_stack.md @@ -1,5 +1,5 @@ --- -title: Install a self-managed Elastic Stack +title: Self-managed Elastic Stack --- ```{note} From 2bd44874735d0924b2847c2fb1d15d013c3be099 Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 27 Nov 2024 19:10:19 -0800 Subject: [PATCH 5/9] More admonitions --- .../elastic/deploy/ece/install_ece_on_prem.md | 7 +------ docs/source/elastic/deploy/ece/suse.md | 19 ++----------------- docs/source/elastic/deploy/ece/ubuntu1.md | 4 ++++ 3 files changed, 7 insertions(+), 23 deletions(-) diff --git a/docs/source/elastic/deploy/ece/install_ece_on_prem.md b/docs/source/elastic/deploy/ece/install_ece_on_prem.md index 3c81ba5..5492697 100644 --- a/docs/source/elastic/deploy/ece/install_ece_on_prem.md +++ b/docs/source/elastic/deploy/ece/install_ece_on_prem.md @@ -9,12 +9,7 @@ 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. -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) -- Red Hat Enterprise Linux (RHEL) 8 and 9, and Rocky Linux 8 and 9 -- SUSE Linux Enterprise Server (SLES) 12 SP5 and 15 -- After your hosts are prepared, choose your preferred installation type: +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) \ No newline at end of file diff --git a/docs/source/elastic/deploy/ece/suse.md b/docs/source/elastic/deploy/ece/suse.md index 401464d..cb8f20c 100644 --- a/docs/source/elastic/deploy/ece/suse.md +++ b/docs/source/elastic/deploy/ece/suse.md @@ -1,20 +1,5 @@ --- -title: Ubuntu 20.04 LTS (Focal Fossa) and Ubuntu 22.04 LTS (Jammy Jellyfish) +title: SUSE Linux Enterprise Server (SLES) 12 SP5 and 15 --- -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 \ No newline at end of file +TBD \ No newline at end of file diff --git a/docs/source/elastic/deploy/ece/ubuntu1.md b/docs/source/elastic/deploy/ece/ubuntu1.md index 0d9a35b..5ff1888 100644 --- a/docs/source/elastic/deploy/ece/ubuntu1.md +++ b/docs/source/elastic/deploy/ece/ubuntu1.md @@ -2,6 +2,10 @@ 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 From bb2fb253c8960295c584445802c503de48af8351 Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 28 Nov 2024 09:12:26 -0800 Subject: [PATCH 6/9] Add list of o/s options --- docs/source/elastic/deploy/ece/configure_os.md | 16 ++++++++++++---- .../elastic/deploy/ece/install_ece_on_prem.md | 2 +- 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/docs/source/elastic/deploy/ece/configure_os.md b/docs/source/elastic/deploy/ece/configure_os.md index fc96a38..3e07292 100644 --- a/docs/source/elastic/deploy/ece/configure_os.md +++ b/docs/source/elastic/deploy/ece/configure_os.md @@ -4,7 +4,15 @@ title: Configure your operating system 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) -- Red Hat Enterprise Linux (RHEL) 8 and 9 -- Rocky Linux 8 and 9 -- SUSE Linux Enterprise Server (SLES) 12 SP5 and 15 \ No newline at end of file +- 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). \ No newline at end of file diff --git a/docs/source/elastic/deploy/ece/install_ece_on_prem.md b/docs/source/elastic/deploy/ece/install_ece_on_prem.md index 5492697..510be88 100644 --- a/docs/source/elastic/deploy/ece/install_ece_on_prem.md +++ b/docs/source/elastic/deploy/ece/install_ece_on_prem.md @@ -9,7 +9,7 @@ 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]. +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) \ No newline at end of file From 0163c0f38512feb44fc152b1e5fd75824731f2d2 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Mon, 20 Jan 2025 17:27:08 -0800 Subject: [PATCH 7/9] Update docs/source/elastic/deploy/self-managed/elasticsearch/elasticsearch_targz.md Co-authored-by: Martijn Laarman --- .../deploy/self-managed/elasticsearch/elasticsearch_targz.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/elastic/deploy/self-managed/elasticsearch/elasticsearch_targz.md b/docs/source/elastic/deploy/self-managed/elasticsearch/elasticsearch_targz.md index d5f55c4..dc745ac 100644 --- a/docs/source/elastic/deploy/self-managed/elasticsearch/elasticsearch_targz.md +++ b/docs/source/elastic/deploy/self-managed/elasticsearch/elasticsearch_targz.md @@ -26,7 +26,7 @@ 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 +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`. From bfc351040fcb3b9b06aad05b5356824808596d40 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Mon, 20 Jan 2025 17:27:16 -0800 Subject: [PATCH 8/9] Update docs/source/elastic/deploy/self-managed/elasticsearch/elasticsearch_targz.md Co-authored-by: Martijn Laarman --- .../deploy/self-managed/elasticsearch/elasticsearch_targz.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/elastic/deploy/self-managed/elasticsearch/elasticsearch_targz.md b/docs/source/elastic/deploy/self-managed/elasticsearch/elasticsearch_targz.md index dc745ac..59d066e 100644 --- a/docs/source/elastic/deploy/self-managed/elasticsearch/elasticsearch_targz.md +++ b/docs/source/elastic/deploy/self-managed/elasticsearch/elasticsearch_targz.md @@ -28,7 +28,7 @@ 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`. +2. This directory is known as `$ES_HOME`. ## Download and install archive for MacOS From f15b6e93b8c70f17ba66e16a0a9843739e3f27f9 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Mon, 20 Jan 2025 17:27:25 -0800 Subject: [PATCH 9/9] Update docs/source/elastic/deploy/self-managed/elasticsearch/elasticsearch_targz.md Co-authored-by: Martijn Laarman --- .../deploy/self-managed/elasticsearch/elasticsearch_targz.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/elastic/deploy/self-managed/elasticsearch/elasticsearch_targz.md b/docs/source/elastic/deploy/self-managed/elasticsearch/elasticsearch_targz.md index 59d066e..b4e9cb3 100644 --- a/docs/source/elastic/deploy/self-managed/elasticsearch/elasticsearch_targz.md +++ b/docs/source/elastic/deploy/self-managed/elasticsearch/elasticsearch_targz.md @@ -41,8 +41,8 @@ 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 +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`. +2. This directory is known as `$ES_HOME`.