Skip to content
Merged
Show file tree
Hide file tree
Changes from 43 commits
Commits
Show all changes
65 commits
Select commit Hold shift + click to select a range
127557d
Add Elastic fundamentals
theletterf Sep 3, 2025
06af8d7
Add Solutions topic
theletterf Sep 3, 2025
c825849
Additional docs
theletterf Sep 3, 2025
3fedd12
Fix anchor links
theletterf Sep 3, 2025
3b7eb42
Add fallback anchor
theletterf Sep 3, 2025
c56e358
Merge branch 'main' into add-elastic-new-intro-section
theletterf Sep 3, 2025
bcc20b9
Remove introduction
theletterf Sep 3, 2025
9e4e97d
Merge branch 'add-elastic-new-intro-section' of github.com:elastic/do…
theletterf Sep 3, 2025
f45f736
Add heading
theletterf Sep 3, 2025
52a644f
Merge branch 'main' into add-elastic-new-intro-section
theletterf Sep 3, 2025
7257efe
Update get-started/index.md
theletterf Sep 4, 2025
fb225e7
Update get-started/the-stack.md
theletterf Sep 4, 2025
991590c
Rename doc
theletterf Sep 4, 2025
e77ae9e
Switch to full title
theletterf Sep 4, 2025
c519fcb
Peer review edits
theletterf Sep 4, 2025
a18e934
Supplemental fixes
theletterf Sep 4, 2025
19cfe38
Merge branch 'main' into add-elastic-new-intro-section
theletterf Sep 4, 2025
71469f0
Update get-started/index.md
theletterf Sep 4, 2025
a748232
Update get-started/versioning-availability.md
theletterf Sep 4, 2025
41f205c
Update get-started/howto-use-the-docs.md
theletterf Sep 4, 2025
2b45927
Update get-started/versioning-availability.md
theletterf Sep 4, 2025
3533348
Update get-started/versioning-availability.md
theletterf Sep 4, 2025
2c01536
Update get-started/versioning-availability.md
theletterf Sep 4, 2025
35028ec
More peer edits
theletterf Sep 4, 2025
9723da3
Merge branch 'add-elastic-new-intro-section' of github.com:elastic/do…
theletterf Sep 4, 2025
dee924e
Merge branch 'main' into add-elastic-new-intro-section
theletterf Sep 4, 2025
5d17933
Revert "Remove introduction"
lcawl Sep 4, 2025
55a7c89
Re-separate solutions and stack overview
lcawl Sep 4, 2025
0cabbca
Merge branch 'main' into add-elastic-new-intro-section
lcawl Sep 4, 2025
2e79592
Re-add lingering anchors
lcawl Sep 4, 2025
214d14e
Update introduction.md
jmikell821 Sep 5, 2025
da35dc4
Move the-stack.md to search-ai-platform.md
lcawl Sep 6, 2025
955a58c
Edit search-api-platform.md
lcawl Sep 6, 2025
7bce30f
Merge branch 'main' into add-elastic-new-intro-section
lcawl Sep 6, 2025
f238c59
Merge branch 'main' into add-elastic-new-intro-section
lcawl Sep 8, 2025
bdaec64
Fix broken links to the-stack.md
lcawl Sep 8, 2025
9c8f2b5
Update introduction.md
jmikell821 Sep 8, 2025
a0cc0e9
Merge branch 'add-elastic-new-intro-section' of github.com:elastic/do…
jmikell821 Sep 8, 2025
3e0a07b
Edit more stack references in get-started
lcawl Sep 9, 2025
7c4a1c1
Add applies_to in all get-started pages
lcawl Sep 9, 2025
31afdc7
Add updated stack diagram
lcawl Sep 9, 2025
ebc39c0
More search-ai-platform.md edits
lcawl Sep 9, 2025
8895ccf
Fixes directives + other edits
jmikell821 Sep 9, 2025
1894d9a
Quit commit to flip the order of solutions
jmikell821 Sep 11, 2025
da1c6c1
Merge branch 'main' into add-elastic-new-intro-section
lcawl Sep 11, 2025
cd5e8bf
Revert "Move the-stack.md to search-ai-platform.md"
lcawl Sep 11, 2025
1947d14
Revert changes related to Elastic Stack
lcawl Sep 11, 2025
349065d
Remove use of search-platform variable
lcawl Sep 11, 2025
c90f485
Updates anchor links + attributes and headings
jmikell821 Sep 11, 2025
4a3e353
Update index.md
jmikell821 Sep 12, 2025
0f87d9f
Merge branch 'main' into add-elastic-new-intro-section
theletterf Sep 15, 2025
fd58924
Merge branch 'main' into add-elastic-new-intro-section
theletterf Sep 15, 2025
40195f9
Add Glossary crosslink
theletterf Sep 15, 2025
7d84775
Minor edits + formatting changes
jmikell821 Sep 16, 2025
14d0008
Merge branch 'main' into add-elastic-new-intro-section
jmikell821 Sep 16, 2025
44c03ec
Incorporating some feedback.
jmikell821 Sep 16, 2025
e4ac982
Merge branch 'main' into add-elastic-new-intro-section
lcawl Sep 16, 2025
bbe5a67
Simplify Elasticsearch solution overview
lcawl Sep 17, 2025
d4a00be
Update extend/index.md
theletterf Sep 17, 2025
215adf3
Merge branch 'main' into add-elastic-new-intro-section
lcawl Sep 18, 2025
dc0e7c7
Reset changes to introduction.md
lcawl Sep 18, 2025
4eb3b45
Reset changes to versioning-availability.md
lcawl Sep 18, 2025
7c2dd14
Add link to client docs
lcawl Sep 18, 2025
98438ec
Merge branch 'main' into add-elastic-new-intro-section
theletterf Sep 19, 2025
16962ba
Merge branch 'main' into add-elastic-new-intro-section
theletterf Sep 25, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion deploy-manage/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ In most cases, you also need to deploy **{{kib}}**. {{kib}} provides the user in
Your choice of deployment type determines how you'll set up and manage these core components, as well as any additional components you need.

:::{admonition} Other {{stack}} components
This section focuses on deploying and managing {{es}} and {{kib}}, as well as supporting orchestration technologies. However, depending on your use case, you might need to deploy [other {{stack}} components](/get-started/the-stack.md). For example, you might need to add components to ingest logs or metrics.
This section focuses on deploying and managing {{es}} and {{kib}}, as well as supporting orchestration technologies. However, depending on your use case, you might need to deploy [other components](/get-started/search-ai-platform.md). For example, you might need to add components to ingest logs or metrics.

To learn how to deploy optional {{stack}} components, refer to the following sections:
* [Fleet and Elastic Agent](/reference/fleet/index.md)
Expand Down Expand Up @@ -89,6 +89,9 @@ Consider this when choosing your deployment type:
- Choose {{serverless-full}} 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

:::{include} /deploy-manage/deploy/_snippets/stack-version-compatibility.md
:::

:::{tip}
Learn more about [versioning and availability](/get-started/versioning-availability.md).
:::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ products:

# Deploy a {{kib}} instance [k8s-deploy-kibana]

To deploy a simple [{{kib}}](/get-started/the-stack.md#stack-components-kibana) specification, with one {{kib}} instance:
To deploy a simple {{kib}} specification, with one {{kib}} instance:

1. Specify a {{kib}} instance and associate it with your {{es}} `quickstart` cluster created previously under [Deploying an {{es}} cluster](elasticsearch-deployment-quickstart.md):

Expand Down
8 changes: 7 additions & 1 deletion deploy-manage/deploy/self-managed.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,17 @@ Self-hosted options:
For a comparison of these deployment options, refer to [Choosing your deployment type](/deploy-manage/deploy.md#choosing-your-deployment-type) and [](/deploy-manage/deploy/deployment-comparison.md).
:::

## Installation order

:::{include} /deploy-manage/deploy/_snippets/installation-order.md
:::

## Section overview

This section focuses on deploying {{es}} and {{kib}} without an orchestrator.

Depending on your use case, you might need to deploy other components, such as APM, Fleet, or Logstash. Deploying those components is not covered in this section. [Learn more about optional components](/get-started/the-stack.md).
Depending on your use case, you might need to deploy other components, such as APM, Fleet, or Logstash.
Deploying those components is not covered in this section. [Learn more about optional components](/get-started/search-ai-platform.md).

This section covers the following tasks:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ You now have a test {{es}} environment set up. Before you start serious developm

You can also do the following:

* Consider installing [additional {{stack}} components](/get-started/the-stack.md).
* Consider installing [additional {{stack}} components](/get-started/search-ai-platform.md).
* Learn how to [ingest data into {{es}}](/manage-data/index.md).
* Learn about [production considerations](/deploy-manage/production-guidance.md).
* Explore [other topics](/deploy-manage/deploy/self-managed.md#other-important-sections) to learn how to secure and manage your cluster.
2 changes: 1 addition & 1 deletion deploy-manage/deploy/self-managed/_snippets/ports.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ These settings can be overridden in the relevant configuration file.
| 9300 and onwards | TCP | Transport API. Used for intra-cluster communications and client access via the transport API (Java client). | Elasticsearch [`transport.port`](elasticsearch://reference/elasticsearch/configuration-reference/networking-settings.md#common-network-settings) |
| 5601 | HTTP | {{kib}} default access port. | Kibana [`server.port`](kibana://reference/configuration-reference/general-settings.md#server-port) |

Additional ports might be required for [optional {{stack}} components](/get-started/the-stack.md). Refer to the installation guide for the component that you want to install.
Additional ports might be required for [optional {{stack}} components](/get-started/search-ai-platform.md). Refer to the installation guide for the component that you want to install.
2 changes: 1 addition & 1 deletion deploy-manage/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ To get started with Elastic, you need to choose a deployment method and deploy {

In this section, you'll learn about how to deploy and manage all aspects of your Elastic environment. You'll learn how to design resilient, highly available clusters and deployments, and how to maintain and scale your environment to grow with your use case.

This section focuses on deploying and managing the core components of the {{stack}}: {{es}} and {{kib}}. It also documents deploying and managing supporting orchestration technologies. However, depending on your use case, you might need to deploy other components. [Learn more](/get-started/the-stack.md).
This section focuses on deploying and managing the core components of the {{stack}}: {{es}} and {{kib}}. It also documents deploying and managing supporting orchestration technologies. However, depending on your use case, you might need to deploy other components. [Learn more](/get-started/search-ai-platform.md).

:::{tip}
To get started quickly, you can set up a [local development and testing environment](/deploy-manage/deploy/self-managed/local-development-installation-quickstart.md), or sign up for a [Serverless](https://cloud.elastic.co/serverless-registration) or [Hosted](https://cloud.elastic.co/registration) trial in {{ecloud}}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ The following topics, covered in other sections of the documentation, offer valu

### Security and monitoring [security-and-monitoring]

As with any enterprise system, you need tools to secure, manage, and monitor your deployments. Security, monitoring, and administrative features that are integrated into {{es}} enable you to use [Kibana](/get-started/the-stack.md) as a control center for managing a cluster.
As with any enterprise system, you need tools to secure, manage, and monitor your deployments. Security, monitoring, and administrative features that are integrated into {{es}} enable you to use {{kib}} as a control center for managing a cluster.

* [Learn about securing an {{es}} cluster](../security.md)

Expand Down
1 change: 1 addition & 0 deletions docset.yml
Original file line number Diff line number Diff line change
Expand Up @@ -295,3 +295,4 @@ subs:
ece-apis: https://www.elastic.co/docs/api/doc/cloud-enterprise/
intake-apis: https://www.elastic.co/docs/api/doc/observability-serverless/
models-app: "Trained Models"
search-platform: "Search AI Platform"
2 changes: 1 addition & 1 deletion explore-analyze/alerts-cases/alerts/view-alerts.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ The alert cleanup task permanently deletes alerts in your `.alert-*` indices. Ma

Remove old or rarely-accessed alerts in your space by running an alert cleanup task, which deletes alerts according to the criteria that you define. Alerts that are attached to cases are not deleted.

1. Open the **Rules** page by going to **Stack Management > Alerts and Insights > Rules** in the main menu or using the global search field.
1. Open the **Rules** page by going to **Stack Management > Alerts and Insights > Rules** in the main menu or using the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
2. Click **Settings** to open the settings for all rules in the space.
3. In the **Clean up alert history** section, click **Clean up**.
4. Define criteria for the alert cleanup task. You can choose to delete alerts that are active or inactive and meet a certain age.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ You’ll need:

2. The [sample eCommerce data](../../index.md#gs-get-data-into-kibana) loaded into {{es}}. To load sample data follow these steps in your UI:

* Open the **Integrations** pages by searching in the global search field.
* Open the **Integrations** pages by searching in the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
* Search for `sample data` in the **Integrations** search field.
* Open the **Sample data** page.
* Select the **Other sample data sets** collapsible.
Expand Down
60 changes: 46 additions & 14 deletions extend/index.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,58 @@
# Extend and contribute
# Extend and contribute

This section contains information on how to extend or contribute to our various products.
You can extend and build on the Elastic Platform in several ways. Whether you need to get data into Elasticsearch, add new functionality, edit the documentation, or build a custom application, here is an overview of the primary development paths to help you choose the right one for your project.

## Contributing to Elastic documentation
There are two main approaches to extending Elastic: creating standardized Integrations for data ingestion or building custom solutions by developing directly against our REST APIs.

## Path 1: Create an Elastic Integration

If your primary goal is to bring a new data source into the Elastic Stack in a standardized, reusable way, building an Elastic Integration is the best path. Integrations are pre-packaged assets that make it simple for users to collect and process data from a specific service or platform.

This approach is ideal for shipping data, logs, metrics, and traces. By building an integration, you contribute to the ever-growing ecosystem that both you and the community can benefit from.

* Integrations are built on a consistent framework, providing users with a turnkey experience, including dashboards, visualizations, and alerts.
* **`elastic-package`** is a command-line tool that is your primary interface for creating, testing, and packaging your integration. It scaffolds the entire project structure, letting you focus on the logic for data collection.
* Your integration will run on the Elastic Agent, our single, unified agent for data shipping.

**When to choose this path**

You can contribute to the Elastic documentation in several ways.
* You want to ingest data from a new data source, like a database, API, or log file.
* You want to provide a standardized, out-of-the-box experience for other users.
* You need to process and structure data according to the Elastic Common Schema (ECS).

Refer to [Contribute to Elastic documentation](./contribute/index.md) for an overview.
**Ready to start?** Head over to the [Create an Integration](integrations://extend/index.md) guide.

## Contributing to Elastic Projects
## Path 2: Develop against the REST APIs

You can contribute to various projects, including:
For complete control and custom development, you can interact directly with Elastic's REST APIs. This path is perfect for building custom applications, automating complex workflows, and integrating Elastic into your existing infrastructure in a bespoke way. For example, you can programmatically manage your cluster, run complex queries, manage security settings, and interact with Kibana.

- [Kibana](kibana://extend/index.md): Enhance our data visualization platform by contributing to Kibana.
- [Logstash](logstash://extend/index.md): Help us improve the data processing pipeline with your contributions to Logstash.
- [Beats](beats://extend/index.md): Add new features or beats to our lightweight data shippers.
* The APIs provide direct access to the core capabilities of Elasticsearch and Kibana. If you can do it in the UI, you can automate it with the API.
* Elastic provides and supports official clients for popular languages like Java, Go, .NET, PHP, Python, Ruby, and JavaScript. These clients simplify interacting with the API, handling requests, and processing responses.
* The APIs are secured using role-based access control (RBAC). You can create API keys or use bearer tokens with fine-grained permissions to ensure your interactions are safe.

## Creating Integrations
### Elastic APIs at a glance

Extend the capabilities of Elastic by creating integrations that connect Elastic products with other tools and systems. Visit our [Integrations Guide](integrations://extend/index.md) to get started.
* Use the Elasticsearch APIs to:

## Elasticsearch Plugins
* Create, read, update, and delete documents.
* Perform everything from simple keyword searches to complex analytical aggregations.
* Monitor cluster health, manage nodes, and configure settings.
* Manage users, roles, and API keys.

Develop custom plugins to add new functionalities to Elasticsearch. Check out our [Elasticsearch Plugins Development Guide](elasticsearch://extend/index.md) for detailed instructions and best practices.
* Use the Kibana APIs to programmatically control the Kibana front-end and its objects:

* Create and manage dashboards, visualizations, and saved searches.
* Automate the organization of content within Kibana.
* Create and manage rules for detecting conditions within your data.

**When to choose this path**

* You are building a custom application that uses Elasticsearch as its backend.
* You need to automate administrative tasks, such as creating users or managing index lifecycle policies.
* You are integrating Elastic's search and analytics capabilities into another platform.

Ready to get started? Explore the [Elasticsearch API Reference](elasticsearch://reference/elasticsearch/rest-apis/index.md) and the [Kibana API Reference](https://www.elastic.co/docs/api/doc/kibana/).

## Contributing to Elastic documentation

You can contribute to the Elastic documentation in several ways. Refer to [Contribute to Elastic documentation](./contribute/index.md) for an overview.
32 changes: 28 additions & 4 deletions get-started/deployment-options.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,41 @@
---
navigation_title: Deployment options
mapped_pages:
- https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro-deploy.html
products:
- id: elasticsearch
applies_to:
serverless:
stack:
---

# Deployment options [elasticsearch-intro-deploy]
# Deployment options

You can run Elastic on any infrastructure, allowing you to select the model that best fits your operational needs.

Use this page for a quick overview of your options for deploying Elastic.

:::{include} /deploy-manage/_snippets/deployment-options-overview.md
:::
## Why your deployment choice matters

Your deployment type significantly impacts both the capabilities available across your Elastic environment and the amount of manual work required to set up and maintain it. Some deployment types provide automated orchestration that handles scaling, upgrades, and monitoring across multiple clusters, while others require you to manage these operational tasks manually.

The choice you make determines how much time you'll spend on infrastructure management versus focusing on using Elastic's features to solve your business problems.

## Quick start options

These are the most common deployment types and their main features:

* **[{{ecloud}}](/deploy-manage/deploy/elastic-cloud.md)**: Get a hosted solution up and running in minutes.
* **[{{ech}}](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md)**: This managed SaaS offering managed through [{{ecloud}}](/deploy-manage/deploy/elastic-cloud.md) provides you with a dedicated cluster on your choice of cloud provider (AWS, GCP, or Azure). It offers a high degree of control over your cluster's configuration, allowing you to fine-tune nodes, hardware, and versions to meet specific performance and architectural requirements. Sign up for a [14-day free trial](https://cloud.elastic.co/registration).
* **[{{serverless-full}}](/deploy-manage/deploy/elastic-cloud/serverless.md)**: This fully managed SaaS offering managed through [{{ecloud}}](/deploy-manage/deploy/elastic-cloud.md) abstracts away all underlying infrastructure, automatically and seamlessly scaling resources to meet your workload demands. It's designed for operational simplicity, with usage-based pricing that allows you to focus on your data without managing clusters. Sign up for a [14-day free trial](https://cloud.elastic.co/serverless-registration).
* **[Local development](/deploy-manage/deploy/self-managed/local-development-installation-quickstart.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)**: This approach allows you to install, operate, and maintain components of the {{search-platform}} on your own hardware, whether on-premises or in your private cloud. It provides maximum control over your environment.
* **[{{ece}}](/deploy-manage/deploy/cloud-enterprise.md)**: This Elastic self-managed offering allows you to provision, manage, and monitor components of the {{search-platform}} at any scale, on any infrastructure, while managing everything from a single console.
* **[{{eck}}](/deploy-manage/deploy/cloud-on-k8s.md)**: This extends Kubernetes by providing an official operator for deploying and managing components of the {{search-platform}}. It's ideal if you want to run and orchestrate Elastic on your own Kubernetes platform.

:::{tip}
Refer to [](/deploy-manage/index.md) for detailed information and guidance on choosing the right deployment for your needs.
Refer to [Deploy and manage](/deploy-manage/index.md) for detailed information and guidance on selecting the right deployment for your needs.
:::
Loading