Skip to content

Commit

Permalink
Merge branch 'main' into ea-ess-ech
Browse files Browse the repository at this point in the history
  • Loading branch information
florent-leborgne authored Feb 24, 2025
2 parents 711cf7c + b45378d commit 2a20505
Show file tree
Hide file tree
Showing 17 changed files with 291 additions and 297 deletions.
12 changes: 12 additions & 0 deletions deploy-manage/_snippets/deployment-options-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
**Quick start options**

* [**Elastic Cloud**](/deploy-manage/deploy/elastic-cloud.md): Get a hosted solution up and running in minutes.
* [**Elastic Cloud Hosted**](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md): Our hosted Elastic Stack offering, deployed in the cloud with your provider of choice. # for a [14-day free trial](https://cloud.elastic.co/registration).
* [**Elastic Cloud Serverless**](/deploy-manage/deploy/elastic-cloud/serverless.md): Create serverless projects for autoscaled and fully managed Elastic deployments. # for a [14-day free trial](https://cloud.elastic.co/serverless-registration).
* [**Local development**](/solutions/search/run-elasticsearch-locally.md): Get started quickly with {{es}} and {{kib}} in Docker for local development and testing.

**Advanced options**

* [**Self-managed**](/deploy-manage/deploy/self-managed.md): Install, configure, and run Elastic on your own premises.
* [**Elastic Cloud Enterprise**](https://www.elastic.co/guide/en/cloud-enterprise/current/Elastic-Cloud-Enterprise-overview.html): Deploy Elastic Cloud on public or private clouds, virtual machines, or your own premises.
* [**Elastic Cloud on Kubernetes**](/deploy-manage/deploy/cloud-on-k8s.md): Deploy Elastic Cloud on Kubernetes.
91 changes: 85 additions & 6 deletions deploy-manage/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ mapped_urls:
- https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro-deploy.html
---

# Deploy

% What needs to be done: Write from scratch

% GitHub issue: https://github.com/elastic/docs-projects/issues/334
Expand All @@ -17,9 +15,90 @@ mapped_urls:
% - [ ] ./raw-migrated-files/docs-content/serverless/intro.md
% - [ ] ./raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md

⚠️ **This page is a work in progress.** ⚠️
# Deploy

Whether you're planning to use Elastic's pre-built solutions or Serverless projects, build your own applications with {{es}}, or analyze your data using {{kib}} tools, you'll need to deploy Elastic first.

This page will help you understand your deployment options and choose the approach that best fits your needs.

## Core components

Every Elastic deployment requires {{es}} as its core data store and search/analytics engine.
Additionally, {{kib}} provides the user interface for all Elastic solutions and Serverless projects. It is required for most use cases, from data exploration to monitoring and security analysis.

Your choice of deployment type determines how you'll set up and manage these core components, plus any additional components you need.

:::{tip}
Learn more about the [{{stack}}](/get-started/the-stack.md) to understand the core and optional components of an Elastic deployment.
:::

## Choosing your deployment type

:::{include} _snippets/deployment-options-overview.md
:::

### Who manages the infrastructure?

#### Managed by Elastic

If you want to focus on using Elastic products rather than managing infrastructure, choose:

- **Serverless**: Zero operational overhead, automatic scaling and updates, latest features
- **Cloud hosted**: Balance of control and managed operations, choice of resources and regions

#### Self-hosted options

If you need to run Elastic on your infrastructure, choose between a fully self-managed deployment or using an orchestrator:

- **Fully self-managed**: Complete control and responsibility for your Elastic deployment
- **With orchestration**:
- **Elastic Cloud on Kubernetes (ECK)**: If you need Kubernetes-native orchestration
- **Elastic Cloud Enterprise (ECE)**: If you need a multi-tenant orchestration platform

:::::{note}
:::{dropdown} About orchestration

An orchestrator automates the deployment and management of multiple Elastic clusters, handling tasks like scaling, upgrades, and monitoring.

Consider orchestration if you:
- Need to manage multiple Elastic clusters
- Want automated operations at scale
- Have a Kubernetes environment (ECK)
- Need to build a multi-tenant platform (ECE)

Orchestrators manage the lifecycle of your Elastic deployments but don't change how the core products work. When using ECK or ECE:
- You'll still use the same Elasticsearch and Kibana features and configurations
- Most product documentation remains applicable
- You can add other Elastic products as needed
- The orchestrator handles operational tasks while you focus on using and configuring the products

::::{tip}
Documentation will specify when certain features or configurations are not applicable to specific deployment types.
::::
:::
:::::

### Versioning and compatibility

In {{serverless-full}}, you automatically get access to the latest versions of Elastic features and you don't need to manage version compatibility.

With other deployment types ({{ecloud}} Hosted, ECE, and ECK), you control which {{stack}} versions you deploy and when you upgrade. The ECE and ECK orchestrators themselves also receive regular version updates, independent of the {{stack}} versions they manage.

Consider this when choosing your deployment type:

- Choose Serverless if you want automatic access to the latest features and don't want to manage version compatibility
- Choose other deployment types if you need more control over version management

:::{tip}
Learn more about [versioning and availability](/get-started/versioning-availability.md).
:::

### Cost considerations

The documentation team is working to combine content pulled from the following pages:
- **Serverless**: Pay for what you use
- **Cloud hosted**: Subscription-based with resource allocation
- **Self-hosted options**: Infrastructure costs plus operational overhead mean a higher total cost of ownership (TCO)

* [/raw-migrated-files/docs-content/serverless/intro.md](/raw-migrated-files/docs-content/serverless/intro.md)
* [/raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md)
:::::{tip}
For a detailed comparison of features and capabilities across deployment types, see the [Deployment comparison reference](./deploy/deployment-comparison.md).
:::::
57 changes: 57 additions & 0 deletions deploy-manage/deploy/deployment-comparison.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@

# Deployment comparison reference

This reference provides detailed comparisons of features and capabilities across Elastic's deployment options: self-managed deployments, Elastic Cloud Hosted, and Serverless. For a high-level overview of deployment types and guidance on choosing between them, see the [overview](../deploy.md).

## Security features

| Feature/capability | Self-managed | Elastic Cloud Hosted | Serverless |
|-------------------|-------------|--------------------------------|-------------------------|
| Custom security configurations | Yes | Limited | No |
| Authentication realms and custom roles | Yes | Yes | No |
| Audit logging | Yes | Yes | No |

## Management features

| Feature/capability | Self-managed | Elastic Cloud Hosted | Serverless |
|-------------------|-------------|--------------------------------|-------------------------|
| Full control over configuration | Yes | Limited | No |
| Infrastructure flexibility | Yes | No | No |
| Autoscaling | No | Yes | Yes |
| Data tiers management | No | Yes | No |
| Snapshot management | No | Yes | No |
| High availability and disaster recovery | Yes | Yes | Yes |
| Multi-cloud support | No | Yes | Yes |
| Shard management and replicas | Yes | Yes | No |

## Monitoring features

| Feature/capability | Self-managed | Elastic Cloud Hosted | Serverless |
|-------------------|-------------|--------------------------------|-------------------------|
| Watcher | Yes | Yes | No |

## Data lifecycle features

| Feature/capability | Self-managed | Elastic Cloud Hosted | Serverless |
|-------------------|-------------|--------------------------------|-------------------------|
| Index lifecycle management (ILM) | Yes | Yes | No (uses data streams) |
| Data tiers management | No | Yes | No |
| Snapshot management | No | Yes | No |

## Integration features

| Feature/capability | Self-managed | Elastic Cloud Hosted | Serverless |
|-------------------|-------------|--------------------------------|-------------------------|
| Custom plugins | Yes | No | No |
| Self-managed connectors | Yes | No | Limited |
| Elasticsearch-Hadoop integration | Yes | Yes | No |
| Cross cluster search (CCS) | Yes | Yes | No |
| Cross cluster replication | Yes | Yes | Yes |

## Development and testing features

| Feature/capability | Self-managed | Elastic Cloud Hosted | Serverless |
|-------------------|-------------|--------------------------------|-------------------------|
| Advanced testing and development | Yes | No | No |
| Java (JVM) customization | Yes | No | No |

4 changes: 4 additions & 0 deletions deploy-manage/deploy/self-managed.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,7 @@ mapped_pages:

See [Elastic Stack Third-party Dependencices](https://artifacts.elastic.co/reports/dependencies/dependencies-current.md) for the complete list of dependencies for {{es}}.

$$$installing-elastic-stack$$$
$$$network-requirements$$$
$$$install-order-elastic-stack$$$
$$$install-elastic-stack-for-elastic-cloud$$$
1 change: 0 additions & 1 deletion deploy-manage/deploy/self-managed/deploy-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ $$$dedicated-host$$$

**This page is a work in progress.** The documentation team is working to combine content pulled from the following pages:

* [/raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md)
* [/raw-migrated-files/elasticsearch/elasticsearch-reference/setup.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/setup.md)

% Doesn't exist
Expand Down
1 change: 1 addition & 0 deletions deploy-manage/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ toc:
- file: distributed-architecture/kibana-tasks-management.md
- file: deploy.md
children:
- file: deploy/deployment-comparison.md
- file: deploy/elastic-cloud.md
children:
- file: deploy/elastic-cloud/create-an-organization.md
Expand Down
25 changes: 6 additions & 19 deletions get-started/deployment-options.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,10 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro-deploy.html
---

# Deployment options [elasticsearch-intro-deploy]

To use {{es}}, you need a running instance of the {{es}} service. You can deploy {{es}} in various ways.

**Quick start option**

* [**Local development**](../solutions/search/get-started.md): Get started quickly with a minimal local Docker setup for development and testing.

**Hosted options**

* [**Elastic Cloud Hosted**](../deploy-manage/deploy/elastic-cloud/create-an-organization.md): {{es}} is available as part of the hosted Elastic Stack offering, deployed in the cloud with your provider of choice. # for a [14-day free trial](https://cloud.elastic.co/registration).
* [**Elastic Cloud Serverless**](https://docs.elastic.co/serverless/general/sign-up-trial): Create serverless projects for autoscaled and fully managed {{es}} deployments. # for a [14-day free trial](https://cloud.elastic.co/serverless-registration).
Use this page for a quick overview of your options for deploying Elastic.

**Advanced options**
:::{include} /deploy-manage/_snippets/deployment-options-overview.md
:::

* [**Self-managed**](../deploy-manage/deploy/self-managed/installing-elasticsearch.md#elasticsearch-deployment-options): Install, configure, and run {{es}} on your own premises.
* [**Elastic Cloud Enterprise**](/deploy-manage/deploy/cloud-enterprise.md): Deploy Elastic Cloud on public or private clouds, virtual machines, or your own premises.
* [**Elastic Cloud on Kubernetes**](../deploy-manage/deploy/cloud-on-k8s.md): Deploy Elastic Cloud on Kubernetes.
:::{tip}
Refer to [](/deploy-manage/index.md) for detailed information and guidance on choosing the right deployment for your needs.
:::
59 changes: 16 additions & 43 deletions get-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,53 +5,26 @@ mapped_pages:
- https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
- https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/index.html
---
# Get started

# Get started [elasticsearch-intro-what-is-es]
## Overview

[{{es}}](https://github.com/elastic/elasticsearch/) is a distributed search and analytics engine, scalable data store, and vector database built on Apache Lucene. It’s optimized for speed and relevance on production-scale workloads. Use {{es}} to search, index, store, and analyze data of all shapes and sizes in near real time.
{{es}} is the heart of the [Elastic Stack](the-stack.md). Combined with {{kib}}, it powers these Elastic solutions and use cases:

{{es}} is the heart of the [Elastic Stack](the-stack.md). Combined with [{{kib}}](https://www.elastic.co/kibana), it powers these Elastic solutions:
* [Observability](/solutions/observability.md)
* [Security](/solutions/security.md)
* [Search](/solutions/search.md)

* [Observability](https://www.elastic.co/observability)
* [Search](https://www.elastic.co/enterprise-search)
* [Security](https://www.elastic.co/security)
:::{tip}
Refer to our [customer success stories](https://www.elastic.co/customers/success-stories) for concrete examples of how Elastic is used in real-world scenarios.
:::

Explore the full list of [{{es}} features](https://www.elastic.co/elasticsearch/features) on the product webpage.
## Next steps

::::{admonition} What is the Elastic Stack?
:name: elasticsearch-intro-elastic-stack
Get started by learning about:

{{es}} is the core component of the Elastic Stack, a suite of products for collecting, storing, searching, and visualizing data. [Learn more about the Elastic Stack](the-stack.md).

::::



## Use cases [elasticsearch-intro-use-cases]

You can use {{es}} for a wide and growing range of use cases. Here are a few examples:

**Observability**

* **Logs, metrics, and traces**: Collect, store, and analyze logs, metrics, and traces from applications, systems, and services.
* **Application performance monitoring (APM)**: Monitor and analyze the performance of business-critical software applications.
* **Real user monitoring (RUM)**: Monitor, quantify, and analyze user interactions with web applications.
* **OpenTelemetry**: Reuse your existing instrumentation to send telemetry data to the Elastic Stack using the OpenTelemetry standard.

**Search**

* **Full-text search**: Build a fast, relevant full-text search solution using inverted indexes, tokenization, and text analysis.
* **Vector database**: Store and search vectorized data, and create vector embeddings with built-in and third-party natural language processing (NLP) models.
* **Semantic search**: Understand the intent and contextual meaning behind search queries using tools like synonyms, dense vector embeddings, and learned sparse query-document expansion.
* **Hybrid search**: Combine full-text search with vector search using state-of-the-art ranking algorithms.
* **Build search experiences**: Add hybrid search capabilities to apps or websites, or build enterprise search engines over your organization’s internal data sources.
* **Retrieval augmented generation (RAG)**: Use {{es}} as a retrieval engine to supplement generative AI models with more relevant, up-to-date, or proprietary data for a range of use cases.
* **Geospatial search**: Search for locations and calculate spatial relationships using geospatial queries.

**Security**

* **Security information and event management (SIEM)**: Collect, store, and analyze security data from applications, systems, and services.
* **Endpoint security**: Monitor and analyze endpoint security data.
* **Threat hunting**: Search and analyze data to detect and respond to security threats.

This is just a sample of search, observability, and security use cases enabled by {{es}}. Refer to Elastic [customer success stories](https://www.elastic.co/customers/success-stories) for concrete examples across a range of industries.
- [{{es}} and {{kib}}](introduction.md), the core components of the {{stack}}.
- [The stack](/get-started/the-stack.md) to understand the relationship between core and optional components of an Elastic deployment.
- [The out-of-the-box solutions and use cases](/solutions/index.md) that Elastic supports.
- [Deploying Elastic](./deployment-options.md) for your use case.
- [Versioning and availability](./versioning-availability.md) in Elastic deployments.
49 changes: 0 additions & 49 deletions get-started/installing-elastic-stack.md

This file was deleted.

Loading

0 comments on commit 2a20505

Please # to comment.