Skip to content

Commit b45378d

Browse files
leemthompokarenzoneflorent-leborgne
authored
Flesh out 'Deploy', sidequest to update 'Get Started' (#540)
**get-started/** 1. `index.md`: Major overhaul - Simplified to focus on first steps for users, with clear pathways to learn about Elasticsearch, Kibana, solutions, deployment options, and versioning. Clears out duplication as much possible. 2. `introduction.md`: Significant restructuring - Combined Elasticsearch and Kibana overview into a single comprehensive overview, explaining what they are and their use cases. Lots of `$$$` to clean up eventually on this page. 5. `the-stack.md`: Streamlined - Made more concise and added clearer deployment options references. 6. `versioning-availability.md`: New file - Added detailed explanation of: - Semantic versioning (X.Y.Z format) - Feature availability states (GA, Beta, Preview, etc.) - Deployment type variations 7. `deployment-options.md`: Simplified to serve as a quick reference for deployment options, using content reuse outlined below. 8. Removed: `installing-elastic-stack.md` - anchors moved to deploy-manage section for redirection **deploy-manage/** 1. `deploy.md`: New comprehensive deployment guide including: - Core components overview - Detailed deployment options - Version compatibility considerations - Decision framework for choosing deployment type - Cost considerations 2. New snippet file `_snippets/deployment-options-overview.md`: Created to maintain consistent deployment options documentation across multiple pages, including: - Quick start option (Local development) - Hosted options (Cloud Hosted and Serverless) - Advanced options (Self-managed, Cloud Enterprise, Cloud on K8s) --------- Co-authored-by: Karen Metts <[email protected]> Co-authored-by: florent-leborgne <[email protected]>
1 parent 78228f0 commit b45378d

File tree

17 files changed

+291
-297
lines changed

17 files changed

+291
-297
lines changed
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
**Quick start options**
2+
3+
* [**Elastic Cloud**](/deploy-manage/deploy/elastic-cloud.md): Get a hosted solution up and running in minutes.
4+
* [**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. Sign up for a [14-day free trial](https://cloud.elastic.co/registration).
5+
* [**Elastic Cloud Serverless**](/deploy-manage/deploy/elastic-cloud/serverless.md): Create serverless projects for autoscaled and fully managed Elastic deployments. Sign up for a [14-day free trial](https://cloud.elastic.co/serverless-registration).
6+
* [**Local development**](/solutions/search/run-elasticsearch-locally.md): Get started quickly with {{es}} and {{kib}} in Docker for local development and testing.
7+
8+
**Advanced options**
9+
10+
* [**Self-managed**](/deploy-manage/deploy/self-managed.md): Install, configure, and run Elastic on your own premises.
11+
* [**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.
12+
* [**Elastic Cloud on Kubernetes**](/deploy-manage/deploy/cloud-on-k8s.md): Deploy Elastic Cloud on Kubernetes.

deploy-manage/deploy.md

Lines changed: 85 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ mapped_urls:
44
- https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro-deploy.html
55
---
66

7-
# Deploy
8-
97
% What needs to be done: Write from scratch
108

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

20-
⚠️ **This page is a work in progress.** ⚠️
18+
# Deploy
19+
20+
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.
21+
22+
This page will help you understand your deployment options and choose the approach that best fits your needs.
23+
24+
## Core components
25+
26+
Every Elastic deployment requires {{es}} as its core data store and search/analytics engine.
27+
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.
28+
29+
Your choice of deployment type determines how you'll set up and manage these core components, plus any additional components you need.
30+
31+
:::{tip}
32+
Learn more about the [{{stack}}](/get-started/the-stack.md) to understand the core and optional components of an Elastic deployment.
33+
:::
34+
35+
## Choosing your deployment type
36+
37+
:::{include} _snippets/deployment-options-overview.md
38+
:::
39+
40+
### Who manages the infrastructure?
41+
42+
#### Managed by Elastic
43+
44+
If you want to focus on using Elastic products rather than managing infrastructure, choose:
45+
46+
- **Serverless**: Zero operational overhead, automatic scaling and updates, latest features
47+
- **Cloud hosted**: Balance of control and managed operations, choice of resources and regions
48+
49+
#### Self-hosted options
50+
51+
If you need to run Elastic on your infrastructure, choose between a fully self-managed deployment or using an orchestrator:
52+
53+
- **Fully self-managed**: Complete control and responsibility for your Elastic deployment
54+
- **With orchestration**:
55+
- **Elastic Cloud on Kubernetes (ECK)**: If you need Kubernetes-native orchestration
56+
- **Elastic Cloud Enterprise (ECE)**: If you need a multi-tenant orchestration platform
57+
58+
:::::{note}
59+
:::{dropdown} About orchestration
60+
61+
An orchestrator automates the deployment and management of multiple Elastic clusters, handling tasks like scaling, upgrades, and monitoring.
62+
63+
Consider orchestration if you:
64+
- Need to manage multiple Elastic clusters
65+
- Want automated operations at scale
66+
- Have a Kubernetes environment (ECK)
67+
- Need to build a multi-tenant platform (ECE)
68+
69+
Orchestrators manage the lifecycle of your Elastic deployments but don't change how the core products work. When using ECK or ECE:
70+
- You'll still use the same Elasticsearch and Kibana features and configurations
71+
- Most product documentation remains applicable
72+
- You can add other Elastic products as needed
73+
- The orchestrator handles operational tasks while you focus on using and configuring the products
74+
75+
::::{tip}
76+
Documentation will specify when certain features or configurations are not applicable to specific deployment types.
77+
::::
78+
:::
79+
:::::
80+
81+
### Versioning and compatibility
82+
83+
In {{serverless-full}}, you automatically get access to the latest versions of Elastic features and you don't need to manage version compatibility.
84+
85+
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.
86+
87+
Consider this when choosing your deployment type:
88+
89+
- Choose Serverless if you want automatic access to the latest features and don't want to manage version compatibility
90+
- Choose other deployment types if you need more control over version management
91+
92+
:::{tip}
93+
Learn more about [versioning and availability](/get-started/versioning-availability.md).
94+
:::
95+
96+
### Cost considerations
2197

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

24-
* [/raw-migrated-files/docs-content/serverless/intro.md](/raw-migrated-files/docs-content/serverless/intro.md)
25-
* [/raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md)
102+
:::::{tip}
103+
For a detailed comparison of features and capabilities across deployment types, see the [Deployment comparison reference](./deploy/deployment-comparison.md).
104+
:::::
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
2+
# Deployment comparison reference
3+
4+
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).
5+
6+
## Security features
7+
8+
| Feature/capability | Self-managed | Elastic Cloud Hosted | Serverless |
9+
|-------------------|-------------|--------------------------------|-------------------------|
10+
| Custom security configurations | Yes | Limited | No |
11+
| Authentication realms and custom roles | Yes | Yes | No |
12+
| Audit logging | Yes | Yes | No |
13+
14+
## Management features
15+
16+
| Feature/capability | Self-managed | Elastic Cloud Hosted | Serverless |
17+
|-------------------|-------------|--------------------------------|-------------------------|
18+
| Full control over configuration | Yes | Limited | No |
19+
| Infrastructure flexibility | Yes | No | No |
20+
| Autoscaling | No | Yes | Yes |
21+
| Data tiers management | No | Yes | No |
22+
| Snapshot management | No | Yes | No |
23+
| High availability and disaster recovery | Yes | Yes | Yes |
24+
| Multi-cloud support | No | Yes | Yes |
25+
| Shard management and replicas | Yes | Yes | No |
26+
27+
## Monitoring features
28+
29+
| Feature/capability | Self-managed | Elastic Cloud Hosted | Serverless |
30+
|-------------------|-------------|--------------------------------|-------------------------|
31+
| Watcher | Yes | Yes | No |
32+
33+
## Data lifecycle features
34+
35+
| Feature/capability | Self-managed | Elastic Cloud Hosted | Serverless |
36+
|-------------------|-------------|--------------------------------|-------------------------|
37+
| Index lifecycle management (ILM) | Yes | Yes | No (uses data streams) |
38+
| Data tiers management | No | Yes | No |
39+
| Snapshot management | No | Yes | No |
40+
41+
## Integration features
42+
43+
| Feature/capability | Self-managed | Elastic Cloud Hosted | Serverless |
44+
|-------------------|-------------|--------------------------------|-------------------------|
45+
| Custom plugins | Yes | No | No |
46+
| Self-managed connectors | Yes | No | Limited |
47+
| Elasticsearch-Hadoop integration | Yes | Yes | No |
48+
| Cross cluster search (CCS) | Yes | Yes | No |
49+
| Cross cluster replication | Yes | Yes | Yes |
50+
51+
## Development and testing features
52+
53+
| Feature/capability | Self-managed | Elastic Cloud Hosted | Serverless |
54+
|-------------------|-------------|--------------------------------|-------------------------|
55+
| Advanced testing and development | Yes | No | No |
56+
| Java (JVM) customization | Yes | No | No |
57+

deploy-manage/deploy/self-managed.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,7 @@ mapped_pages:
77

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

10+
$$$installing-elastic-stack$$$
11+
$$$network-requirements$$$
12+
$$$install-order-elastic-stack$$$
13+
$$$install-elastic-stack-for-elastic-cloud$$$

deploy-manage/deploy/self-managed/deploy-cluster.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ $$$dedicated-host$$$
2424

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

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

3029
% Doesn't exist

deploy-manage/toc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ toc:
2424
- file: distributed-architecture/kibana-tasks-management.md
2525
- file: deploy.md
2626
children:
27+
- file: deploy/deployment-comparison.md
2728
- file: deploy/elastic-cloud.md
2829
children:
2930
- file: deploy/elastic-cloud/create-an-organization.md

get-started/deployment-options.md

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,10 @@
1-
---
2-
mapped_pages:
3-
- https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro-deploy.html
4-
---
5-
61
# Deployment options [elasticsearch-intro-deploy]
72

8-
To use {{es}}, you need a running instance of the {{es}} service. You can deploy {{es}} in various ways.
9-
10-
**Quick start option**
11-
12-
* [**Local development**](../solutions/search/get-started.md): Get started quickly with a minimal local Docker setup for development and testing.
13-
14-
**Hosted options**
15-
16-
* [**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. Sign up for a [14-day free trial](https://cloud.elastic.co/registration).
17-
* [**Elastic Cloud Serverless**](https://docs.elastic.co/serverless/general/sign-up-trial): Create serverless projects for autoscaled and fully managed {{es}} deployments. Sign up for a [14-day free trial](https://cloud.elastic.co/serverless-registration).
3+
Use this page for a quick overview of your options for deploying Elastic.
184

19-
**Advanced options**
5+
:::{include} /deploy-manage/_snippets/deployment-options-overview.md
6+
:::
207

21-
* [**Self-managed**](../deploy-manage/deploy/self-managed/installing-elasticsearch.md#elasticsearch-deployment-options): Install, configure, and run {{es}} on your own premises.
22-
* [**Elastic Cloud Enterprise**](/deploy-manage/deploy/cloud-enterprise.md): Deploy Elastic Cloud on public or private clouds, virtual machines, or your own premises.
23-
* [**Elastic Cloud on Kubernetes**](../deploy-manage/deploy/cloud-on-k8s.md): Deploy Elastic Cloud on Kubernetes.
8+
:::{tip}
9+
Refer to [](/deploy-manage/index.md) for detailed information and guidance on choosing the right deployment for your needs.
10+
:::

get-started/index.md

Lines changed: 16 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -5,53 +5,26 @@ mapped_pages:
55
- https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
66
- https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/index.html
77
---
8+
# Get started
89

9-
# Get started [elasticsearch-intro-what-is-es]
10+
## Overview
1011

11-
[{{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.
12+
{{es}} is the heart of the [Elastic Stack](the-stack.md). Combined with {{kib}}, it powers these Elastic solutions and use cases:
1213

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

15-
* [Observability](https://www.elastic.co/observability)
16-
* [Search](https://www.elastic.co/enterprise-search)
17-
* [Security](https://www.elastic.co/security)
18+
:::{tip}
19+
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.
20+
:::
1821

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

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

24-
{{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).
25-
26-
::::
27-
28-
29-
30-
## Use cases [elasticsearch-intro-use-cases]
31-
32-
You can use {{es}} for a wide and growing range of use cases. Here are a few examples:
33-
34-
**Observability**
35-
36-
* **Logs, metrics, and traces**: Collect, store, and analyze logs, metrics, and traces from applications, systems, and services.
37-
* **Application performance monitoring (APM)**: Monitor and analyze the performance of business-critical software applications.
38-
* **Real user monitoring (RUM)**: Monitor, quantify, and analyze user interactions with web applications.
39-
* **OpenTelemetry**: Reuse your existing instrumentation to send telemetry data to the Elastic Stack using the OpenTelemetry standard.
40-
41-
**Search**
42-
43-
* **Full-text search**: Build a fast, relevant full-text search solution using inverted indexes, tokenization, and text analysis.
44-
* **Vector database**: Store and search vectorized data, and create vector embeddings with built-in and third-party natural language processing (NLP) models.
45-
* **Semantic search**: Understand the intent and contextual meaning behind search queries using tools like synonyms, dense vector embeddings, and learned sparse query-document expansion.
46-
* **Hybrid search**: Combine full-text search with vector search using state-of-the-art ranking algorithms.
47-
* **Build search experiences**: Add hybrid search capabilities to apps or websites, or build enterprise search engines over your organization’s internal data sources.
48-
* **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.
49-
* **Geospatial search**: Search for locations and calculate spatial relationships using geospatial queries.
50-
51-
**Security**
52-
53-
* **Security information and event management (SIEM)**: Collect, store, and analyze security data from applications, systems, and services.
54-
* **Endpoint security**: Monitor and analyze endpoint security data.
55-
* **Threat hunting**: Search and analyze data to detect and respond to security threats.
56-
57-
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.
26+
- [{{es}} and {{kib}}](introduction.md), the core components of the {{stack}}.
27+
- [The stack](/get-started/the-stack.md) to understand the relationship between core and optional components of an Elastic deployment.
28+
- [The out-of-the-box solutions and use cases](/solutions/index.md) that Elastic supports.
29+
- [Deploying Elastic](./deployment-options.md) for your use case.
30+
- [Versioning and availability](./versioning-availability.md) in Elastic deployments.

get-started/installing-elastic-stack.md

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

0 commit comments

Comments
 (0)