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