diff --git a/deploy-manage/deploy/self-managed.md b/deploy-manage/deploy/self-managed.md index 7591b2f9ac..582df38e81 100644 --- a/deploy-manage/deploy/self-managed.md +++ b/deploy-manage/deploy/self-managed.md @@ -33,7 +33,8 @@ For a comparison of these deployment options, refer to [Choosing your deployment 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/the-stack.md). This section covers the following tasks: diff --git a/extend/index.md b/extend/index.md index 110f8b8de8..d76e3c9ccc 100644 --- a/extend/index.md +++ b/extend/index.md @@ -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. diff --git a/get-started/deployment-options.md b/get-started/deployment-options.md index b6dcdf4e5b..a4977e5efd 100644 --- a/get-started/deployment-options.md +++ b/get-started/deployment-options.md @@ -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 {{stack}} 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 {{stack}} 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 {{stack}}. 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. ::: diff --git a/get-started/howto-use-the-docs.md b/get-started/howto-use-the-docs.md new file mode 100644 index 0000000000..86a199a02c --- /dev/null +++ b/get-started/howto-use-the-docs.md @@ -0,0 +1,176 @@ +--- +applies_to: + serverless: + stack: +--- +# How to use the documentation + +Our documentation is organized to guide you through your journey with Elastic, from learning the basics to deploying and managing complex solutions. + +Here is a detailed breakdown of the documentation structure: + +* [**Elastic fundamentals**](/get-started/index.md): Understand the basics about the deployment options, platform, and solutions, and features of the documentation. +* [**Solutions and use cases**](/solutions/index.md): Learn use cases, evaluate, and implement Elastic's solutions: Observability, Search, and Security. +* [**Manage data**](/manage-data/index.md): Learn about data store primitives, ingestion and enrichment, managing the data lifecycle, and migrating data. +* [**Explore and analyze**](/explore-analyze/index.md): Get value from data through querying, visualization, machine learning, and alerting. +* [**Deploy and manage**](/deploy-manage/index.md): Deploy and manage production-ready clusters. Covers deployment options and maintenance tasks. +* [**Manage your Cloud account**](/cloud-account/index.md): A dedicated section for user-facing cloud account tasks like resetting passwords. +* [**Troubleshoot**](/troubleshoot/index.md): Identify and resolve problems. +* [**Extend and contribute**](/extend/index.md): How to contribute to or integrate with Elastic, from open source to plugins to integrations. +* [**Release notes**](/release-notes/index.md): Contains release notes and changelogs for each new release. +* [**Reference**](/reference/index.md): Reference material for core tasks and manuals for optional products. + +## Applicability badges + +Because Elastic products can be deployed in different ways (like on {{ecloud}} or in your own data center) and have different versions, not all documentation applies to every user. To help you quickly see if a topic is relevant to your situation, we use **applicability badges**. + +These badges appear at the top of a page or section and tell you which products, deployment models, and versions the content applies to. They also indicate the maturity level of a feature, such as **beta**, **technical preview**, or **generally available (GA)**. This system ensures that you can identify content specific to your environment and version. + +:::{tip} +An {{stack}} badge indicates that a page applies to [{{stack}}](/get-started/the-stack.md) components across all deployment options except {{serverless-full}}. If a page applies to all deployment options, it will have both {{serverless-short}} and Stack badges. +::: + +## Page options + +On each documentation page, you'll find several links that allow you to interact with the content: + +* **View as Markdown**: This link shows you the raw Markdown source code for the page you're viewing. This can be helpful if you want to reuse the source or feed the document to AI. +* **Edit this page**: Selecting this link will take you directly to the page's source file in our GitHub repository. From there, you can propose edits, which our team will review. +* **Report an issue**: If you've found a problem, like a typo, a technical error, or confusing content, but don't want to edit the page yourself, use this link. It will open a new issue in our GitHub repository, pre-filled with information about the page you were on, so you can describe the problem in detail. + +## Versioned documentation + +Starting with Elastic Stack 9.0, Elastic no longer publishes separate documentation sets for each minor release. Instead, all changes in the 9.x series are included in a single, continuously updated documentation set. + +This approach helps: + +* Reduce duplicate pages. +* Show the full history and context of a feature. +* Simplify search and navigation. + +We clearly mark content added or changed in a specific version using availability badges. The availability badges appear in page headers, section headers, and inline. + +### Elastic Stack example + +{applies_to}`stack: ga 9.1.0` + +This means the feature is: + +* Generally Available (GA) in the [{{stack}}](/get-started/the-stack.md) across all deployment options except {{serverless-full}} +* Introduced in version 9.1.0 + +:::{tip} +If a page applies to all deployment options including {{serverless-full}}, it will have both {{serverless-short}} and Stack badges. +::: + +### Serverless example + +{applies_to}`serverless: ga` {applies_to}`security: beta` + +This means the feature is: + +* Generally Available for {{es-serverless}} projects +* Beta for {{sec-serverless}} projects + +### Elastic Cloud Enterprise example + +{applies_to}`ece: deprecated 4.1.0` + +This means the feature is: + +* Available on Elastic Cloud Enterprise +* Deprecated starting in version 4.1.0 + +:::{tip} +Want to learn more about how availability badges are used? Check the [Elastic Docs syntax guide](https://elastic.github.io/docs-builder/syntax/applies/). +::: + +## Accessing previous versions + +You can browse documentation for different versions of our products in two ways: + +* **Version menu:** On most documentation pages, you'll find a version menu. Clicking this menu allows you to switch to a different version of the documentation for the content you are currently viewing. +* **All documentation versions page:** For a complete list of all available documentation versions for all Elastic products, you can visit the [All documentation versions](/versions.md) page. + +## Find docs for your product version + +Find the documentation for your Elastic product versions or releases. + +### Elastic Stack product versions + +| Product | Version | +| ----- | ----- | +| [Elasticsearch](https://www.elastic.co/docs/release-notes/elasticsearch) | 9.0.0 and later | +| [Kibana](https://www.elastic.co/docs/release-notes/kibana) | 9.0.0 and later | +| [Fleet and Elastic Agent](https://www.elastic.co/docs/release-notes/fleet) | 9.0.0 and later | +| [Logstash](https://www.elastic.co/docs/release-notes/logstash) | 9.0.0 and later | +| [Beats](https://www.elastic.co/docs/release-notes/beats) | 9.0.0 and later | +| [Elastic Observability](https://www.elastic.co/docs/release-notes/observability) | 9.0.0 and later | +| [Elastic APM](https://www.elastic.co/docs/release-notes/apm) | 9.0.0 and later | +| [Elastic Security](https://www.elastic.co/docs/release-notes/security) | 9.0.0 and later | + +### Deployment type versions or releases + +| Product | Version or release | +| ----- | ----- | +| All [Elastic Cloud Serverless](https://www.elastic.co/docs/release-notes/cloud-serverless) project types | All releases | +| [Elastic Cloud Hosted](https://www.elastic.co/docs/release-notes/cloud-hosted) | All releases for January 2025 and later | +| [Elastic Cloud Enterprise](https://www.elastic.co/docs/release-notes/cloud-enterprise) | 4.0.0 and later | +| [Elastic Cloud on Kubernetes](https://www.elastic.co/docs/release-notes/cloud-on-k8s) | 3.0.0 and later | + +### Schema, library, and tool versions + +| Product | Version or release | +| ----- | ----- | +| [Elasticsearch Java Client](https://www.elastic.co/docs/release-notes/elasticsearch/clients/java) | 9.0.0 and later | +| [Elasticsearch JavaScript Client](https://www.elastic.co/docs/release-notes/elasticsearch/clients/javascript) | 9.0.0 and later | +| [Elasticsearch .NET Client](https://www.elastic.co/docs/release-notes/elasticsearch/clients/dotnet) | 9.0.0 and later | +| [Elasticsearch PHP Client](https://www.elastic.co/docs/release-notes/elasticsearch/clients/php) | 9.0.0 and later | +| [Elasticsearch Python Client](https://www.elastic.co/docs/release-notes/elasticsearch/clients/python) | 9.0.0 and later | +| [Elasticsearch Ruby Client](https://www.elastic.co/docs/release-notes/elasticsearch/clients/ruby) | 9.0.0 and later | +| [Elastic Common Schema (ECS)](https://www.elastic.co/docs/release-notes/ecs) | 9.0.0 and later | +| [ECS Logging .NET library](https://www.elastic.co/docs/reference/ecs/logging/dotnet) | 8.18.1 and later | +| [ECS Logging Go (Logrus) library](https://www.elastic.co/docs/reference/ecs/logging/go-logrus) | 1.0.0 and later | +| [ECS Logging Go (Zap) library](https://www.elastic.co/docs/reference/ecs/logging/go-zap) | 1.0.3 and later | +| [ECS Logging Go (Zerolog) library](https://www.elastic.co/docs/reference/ecs/logging/go-zerolog) | 0.2.0 and later | +| [ECS Logging Java library](https://www.elastic.co/docs/reference/ecs/logging/java) | 1.x and later | +| [ECS Logging Node.js library](https://www.elastic.co/docs/reference/ecs/logging/nodejs) | 1.5.3 and later | +| [ECS Logging PHP library](https://www.elastic.co/docs/reference/ecs/logging/php) | 2.0.0 and later | +| [ECS Logging Python library](https://www.elastic.co/docs/reference/ecs/logging/python) | 2.2.0 and later | +| [ECS Logging Ruby library](https://www.elastic.co/docs/reference/ecs/logging/ruby) | 1.0.0 and later | +| [Elasticsearch for Apache Hadoop](https://www.elastic.co/docs/release-notes/elasticsearch-hadoop) | 9.0.0 and later | +| [Elasticsearch Curator](https://www.elastic.co/docs/reference/elasticsearch/curator) | 8.0.0 and later | +| [Elastic Cloud Control (ECCTL)](https://www.elastic.co/docs/release-notes/ecctl) | 1.14.0 and later | +| [Elastic Serverless Forwarder for AWS](https://www.elastic.co/docs/reference/aws-forwarder) | 1.20.1 and later | +| [Elastic integrations](https://www.elastic.co/docs/reference/integrations/all_integrations) | All versions | +| [Search UI JavaScript library](https://www.elastic.co/docs/reference/search-ui) | 1.24.0 and later | + +### APM agent and tool versions + +| Product | Version | +| ----- | ----- | +| [Elastic Distribution of OpenTelemetry Android](https://www.elastic.co/docs/release-notes/edot/sdks/android) | 0.1.0 and later | +| [Elastic Distribution of OpenTelemetry iOS](https://www.elastic.co/docs/release-notes/edot/sdks/ios) | 1.0.0 and later | +| [Elastic Distribution of OpenTelemetry Java](https://www.elastic.co/docs/release-notes/edot/sdks/java) | 1.0.0 and later | +| [Elastic Distribution of OpenTelemetry .NET](https://www.elastic.co/docs/release-notes/edot/sdks/dotnet) | 1.0.0 and later | +| [Elastic Distribution of OpenTelemetry Node.js](https://www.elastic.co/docs/release-notes/edot/sdks/node) | 0.1.0 and later | +| [Elastic Distribution of OpenTelemetry Python](https://www.elastic.co/docs/release-notes/edot/sdks/python) | 0.1.0 and later | +| [Elastic Distribution of OpenTelemetry PHP](https://www.elastic.co/docs/release-notes/edot/sdks/php) | 0.1.0 and later | +| [Elastic APM .NET Agent](https://www.elastic.co/docs/release-notes/apm/agents/dotnet) | 1.0.0 and later | +| [Elastic APM Go Agent](https://www.elastic.co/docs/release-notes/apm/agents/go) | 2.0.0 and later | +| [Elastic APM Java Agent](https://www.elastic.co/docs/release-notes/apm/agents/java) | 1.0.0 and later | +| [Elastic APM Node.js Agent](https://www.elastic.co/docs/release-notes/apm/agents/nodejs) | 4.0.0 and later | +| [Elastic APM PHP Agent](https://www.elastic.co/docs/release-notes/apm/agents/php) | 1.0.0 and later | +| [Elastic APM Python Agent](https://www.elastic.co/docs/release-notes/apm/agents/python) | 6.0.0 and later | +| [Elastic APM Ruby Agent](https://www.elastic.co/docs/release-notes/apm/agents/ruby) | 4.0.0 and later | +| [Elastic APM Real User Monitoring JavaScript Agent](https://www.elastic.co/docs/release-notes/apm/agents/rum-js) | 5.0.0 and later | +| [Elastic APM AWS Lambda extension](https://www.elastic.co/docs/release-notes/apm/aws-lambda/release-notes) | 1.0.0 and later | +| [Elastic APM Attacher for Kubernetes](https://www.elastic.co/docs/reference/apm/k8s-attacher) | 1.1.3 | + +## Glossary + +To help you understand the terminology used throughout our documentation, we provide a [glossary of common Elastic terms](/reference/glossary/index.md). This is a great resource for new users or anyone looking to clarify the meaning of a specific term. + +## How to contribute + +We value contributions from our community. For detailed instructions on how to contribute to both the main documentation and the API references, refer to our [contribution guide](https://www.elastic.co/docs/extend/contribute/). \ No newline at end of file diff --git a/get-started/images/elastic-platform.png b/get-started/images/elastic-platform.png new file mode 100644 index 0000000000..85fe50148c Binary files /dev/null and b/get-started/images/elastic-platform.png differ diff --git a/get-started/index.md b/get-started/index.md index 661649afa4..e59b6f14d1 100644 --- a/get-started/index.md +++ b/get-started/index.md @@ -7,45 +7,55 @@ mapped_pages: products: - id: elasticsearch - id: elastic-stack + - id: observability + - id: security +applies_to: + serverless: + stack: --- -# Get started -## Overview [what-is-es] +# Elastic fundamentals -[{{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. [{{kib}}](https://github.com/elastic/kibana) is the graphical user interface for {{es}}. It’s a powerful tool for visualizing and analyzing your data, and for managing and monitoring the Elastic Stack. +Welcome to Elastic fundamentals! -{{es}} is the heart of the [Elastic Stack](the-stack.md). Combined with {{kib}}, it powers these Elastic solutions and use cases: +In this section, we'll walk you through the basics of what our products offer, what they do, how they can help your business, and how to set them up. You'll get a quick look at the core features and concepts, real-world use cases, and deployment options to understand how everything fits together. -* **[Elasticsearch](/solutions/search.md)**: Build powerful search and RAG applications using Elasticsearch's vector database, AI toolkit, and advanced retrieval capabilities. -* **[Observability](/solutions/observability.md)**: Resolve problems with open, flexible, and unified observability powered by advanced machine learning and analytics. -* **[Security](/solutions/security.md)**: Detect, investigate, and respond to threats with AI-driven security analytics to protect your organization at scale. +You'll also find other helpful information, such as how to use our docs, training resources, and a link to our glossary so you can familiarize yourself with our terminology. Whether you're exercising your options and are curious about what Elastic can offer, are just getting started, or are looking to dive deeper, this is a great place to begin. -:::{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. +## What is Elastic? [what-is-es] + +:::{image} /get-started/images/elastic-platform.png +:alt: The Elastic platform ::: -## Choose your deployment type +Elastic provides an open source search, analytics, and AI platform, and out-of-the-box solutions for observability and security. The Search AI platform combines the power of search and generative AI to provide near real-time search and analysis with relevance to reduce your time to value. -:::{include} /deploy-manage/_snippets/deployment-options-overview.md -::: +Elastic offers three main solutions or types of projects: + +* [{{es}}](/solutions/search.md): Build powerful search and RAG applications using Elasticsearch's vector database, AI toolkit, and advanced retrieval capabilities. +* [Elastic {{observability}}](/solutions/observability.md): Gain comprehensive visibility into applications, infrastructure, and user experience through logs, metrics, traces, and other telemetry data, all in a single interface. +* [{{elastic-sec}}](/solutions/security.md): Combine SIEM, endpoint security, and cloud security to provide comprehensive tools for threat detection and prevention, investigation, and response. + +## Explore the fundamentals -## Explore the solutions +Continue your journey with these essential guides that will help you understand and work with Elastic: -Elasticsearch supports diverse use cases. Select a solution and follow its dedicated getting-started guide: +* **[Solutions and the Search AI platform](/get-started/the-stack.md)**: Dive deeper into how the Search AI platform—our suite of open-source tools, including {{es}}, {{kib}}, {{beats}}, and {{ls}}—components work together, learn about data ingestion methods, and understand the core concepts of storing, visualizing, and querying your data. -| | | -| :---: | --- | -| ![elasticsearch](images/64x64_Color_elasticsearch-logo-color-64px.png "elasticsearch =50%") | **Elasticsearch**
Create seamless search experiences for apps, websites, or workplaces.

[**Get started →**](../solutions/search/get-started.md)
| -| ![observability](images/64x64_Color_observability-logo-color-64px.png "observability =50%") | **Observability**
Monitor logs, metrics, and traces to gain insight into your systems.

[**Get started →**](../solutions/observability/get-started.md)
| -| ![security](images/64x64_Color_security-logo-color-64px.png "security =50%") | **Security**
Monitor logs, metrics, and traces to gain insight into your systems.

[**Get started →**](../solutions/security/get-started.md)
| +* **[Deployment options](/get-started/deployment-options.md)**: Explore the different ways you can deploy Elastic, from fully managed serverless solutions to self-managed installations, and choose the approach that best fits your operational needs. -## Next steps +* **[Versioning and availability](/get-started/versioning-availability.md)**: Learn how Elastic handles versioning, understand feature availability across different deployment types, and navigate our continuously updated documentation with confidence. -To learn more about our products and solutions, check out: +## Training resources -- [{{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. +Whether you are just getting started with Elastic, an expert, or simply want to expand your knowledge, we provide role-based and solution-based training to empower you to get the most out of our solutions. You can even receive accreditation for completing our courses. +Ready to dive in? Check out [https://www.elastic.co/training](https://www.elastic.co/training) to browse our virtual and on-demand training courses. If you're unsure where to start, check out the [Elasticsearch Engineer](https://www.elastic.co/training/elasticsearch-engineer) course. + +To explore particular, more granular facets of the Elastic Stack, check out our [demo gallery](https://www.elastic.co/demo-gallery). You can filter by solution or subject area and choose the training style that best suits you. + +If you prefer a deep dive where you can learn at your own pace, check out our six-part [Beginner's Crash Course to Elastic Stack](https://www.youtube.com/playlist?list=PL_mJOmq4zsHZYAyK606y7wjQtC0aoE6Es) on YouTube. + +:::{tip} +Read **[How to use the documentation](/get-started/howto-use-the-docs.md)** to discover how our documentation is organized, find the right version information for your products, and understand how to contribute to our community. +::: \ No newline at end of file diff --git a/get-started/introduction.md b/get-started/introduction.md index 32f8f19024..5edb291c5d 100644 --- a/get-started/introduction.md +++ b/get-started/introduction.md @@ -3,11 +3,183 @@ mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro-what-is-es.html products: - id: elasticsearch +applies_to: + stack: + serverless: --- +# Solutions and use cases [introduction] +Elastic offers three major search-powered solutions: {{es}}, {{observability}}, and {{elastic-sec}}— all built on {{es}}. Whether you're building a search experience, monitoring your infrastructure, or securing your environment, this topic helps you understand what each Elastic solution offers—and how to choose the right one for your business needs. + +Refer to the following table for a quick reference of which solution you may need based on your needs. + +| Your need | Recommended solution | Best for | +|-----------|-------------------|----------| +| Build powerful, scalable searches to quickly search, analyze, and visualize large amounts of data for real-time insights | [{{es}}](#search-overview) | Developers, architects, data engineers | +| Observe and monitor system health and performance or send telemetry data | [Elastic {{observability}}](#observability-overview) | DevOps, SREs, IT operations | +| Monitor data for anomalous activity, detect, prevent, and respond to security incidents | [{{elastic-sec}}](#security-overview) | SOC teams, security analysts, IT security admins | + +:::{tip} +Check out our [customer success stories](https://www.elastic.co/customers/success-stories) to learn how various organizations utilize our products for their specific business needs. +::: + +Each of our solutions is available as a fully managed {{serverless-short}} project or a self-managed deployment. Refer to [deployment options](../get-started/deployment-options.md) to learn about these options. + +## Elasticsearch + +### {{es}} overview [search-overview] + +{{es}} is an open-source, distributed search and analytics engine built on Apache Lucene, used for high-performance full-text search, log analytics, business analytics, and operational intelligence. It stores data in JSON documents, provides REST APIs for easy interaction, and functions as a NoSQL database that enables fast searches, analytics, and AI-driven applications. Built on Apache Lucene, {{es}} is the core of the Search AI platform. + +### Elasticsearch use cases [search-use-cases] +Use {{es}} for a wide range of business needs. + +:::{dropdown} Use cases +* **Full-text search:** Find specific words or phrases within large volumes of text-based data, such as documents, articles, or product descriptions. Documents and search queries are transformed to enable returning relevant results instead of exact term matches. +* **Semantic search:** Go beyond keyword matching to understand the user's intent. Understanding synonyms and related concepts helps your search engine recognize what users mean, not just what they type. +* **Hybrid search:** Get the best of both worlds by combining traditional keyword search with modern, meaning-based vector search. This ensures your users get the most accurate and relevant results every time. +* **Vector database:** Search for data based on its meaning and context, not just keywords. Understanding the underlying concepts allows you to find similar items, like pictures with the same style or songs with a similar vibe. +* **Retrieval Augmented Generation (RAG):** Connect your generative AI applications (like chatbots) to your private data. This allows your AI to provide more accurate, up-to-date, and relevant answers based on your proprietary information. +* **Geospatial search:** Build location-aware features into your applications. This allows you to do things like find all available services within a certain radius, calculate the distance between two points, or identify the most efficient delivery routes. +::: + +### {{es}} core concepts [search-concepts] +Before you decide what type of search to use with {{es}} or bring in your data, familiarize yourself with the following {{es}} concepts. + +::::{dropdown} Concepts + +* **Index:** A collection of documents with similar characteristics that are uniquely identified by a name or an alias. The name is used to target the index in search queries and other operations. + **Field:** The smallest individual unit of data within a document. It represents a specific property or attribute of the data you're indexing (for example, title, author, date, summary, etc.). Fields are critical for indexing, as they determine how data is analyzed and stored to enable efficient searching. +* **Document:** Any structured data encoded in JSON. {{es}} organizes and stores data into documents. +* **Primary shard:** A self-contained Lucene index that contains some or all data for an index. Shards allow {{es}} to scale horizontally by splitting an index's data into smaller, manageable partitions, improving performance. Each document in an index belongs to one primary shard. +* **Replica:** A copy of a primary shard. Replicas maintain redundant copies of your data across the nodes in your cluster. This protects against hardware failure and increases capacity to serve read requests like searching or retrieving a document. +* **Node:** A single running instance of the {{es}} server. +* **Cluster:** A collection of one or more nodes that holds all your data and provides indexing and search capabilities across all nodes. {{es}} clusters feature primary and replica shards to provide failover in the case of a node going down. When a primary shard goes down, the replica takes its place. + :::{note} + If you're running {{es}} on a serverless deployment, you don't have to worry a bout shards, nodes, or clusters. Elastic manages these for you. + ::: +* **Mapping:** The process that defines how a document and its fields are stored and indexed. +* **Client:** Software or an application that facilitates communication and interaction with an {{es}} cluster. It enables applications written in various programming languages to send requests to {{es}}, process the response, and then push that data into the cluster. + +:::: + +## Elastic Security + +### {{elastic-sec}} overview [security-overview] + +{{elastic-sec}} is a unified security solution that integrates SIEM (Security Information and Event Management), endpoint security, and cloud security into a single platform so you can detect, prevent, and respond to cyber threats across your entire environment in near real time. Elastic Security leverages {{es}}'s powerful platform for its searching and analytic capabilities, and {{kib}} for its visualization features. By combining prevention, detection, and response capabilities, {{elastic-sec}} helps your organization reduce the risk of successful attacks. + +Install {{elastic-sec}} on one of our Elastic-managed Cloud deployments or your own self-managed infrastructure. + +### {{elastic-sec}} use cases [security-use-cases] + +Use {{elastic-sec}} for numerous security needs to ensure your systems are protected from the latest threats. + +:::{dropdown} Use cases +* **SIEM:** {{elastic-sec}} is a modern SIEM that provides a centralized platform for ingesting, analyzing, and managing security data from various sources. +* **Third-party integration support:** Ingest data from a variety of tools and data sources so you can centralize your security data. +* **Threat detection and analytics:** Identify unknown threats by enabling prebuilt or custom detection rules, automatically detect anomalous activity with built-in machine learning jobs, or proactively search for threats using our powerful threat hunting and interactive visualization tools. +* **Automatic migration:** Migrate SIEM rules from other platforms to {{elastic-sec}}. +* **Endpoint protection and threat prevention:** Automatically stop cybersecurity attacks—such as malware and ransomware—before damage and loss can occur. +* **AI-powered features:** Elastic Security leverages generative AI to help enhance threat detection, assist with incident response, and day-to-day security operations. For example, the AI Assistant can summarize alerts, identify relevant information, suggest investigation steps, and generate complex queries from natural language input. +* **Custom dashboards and visualizations:** Create custom dashboards and visualizations to gain insights into security events. +* **Cloud Security:** {{elastic-sec}} provides the following cloud features: + * **Cloud Security Posture Management (CSPM) and Kubernetes Security Posture Management (KSPM):** Check cloud service configurations against security benchmarks to identify and resolve misconfigurations that can be exploited. + * **Cloud Workload Protection:** Get visibility and runtime protection for cloud workloads. + * **Vulnerability Management:** Uncover vulnerabilities within your cloud infrastructure. +::: + +### Elastic Security core concepts [security-concepts] + +Before diving into setup and configuration, familiarize yourself with the foundational terms and core concepts that power {{elastic-sec}}. + +:::{dropdown} Concepts + +* {{agent}}: A single, unified way to add monitoring for logs, metrics, and other types of data to a host. Elastic Agent can also protect hosts from security threats, query data from operating systems, and forward data from remote services or hardware. +* {{elastic-defend}}: {{elastic-sec}}'s Endpoint Detection and Response (EDR) tool that protects endpoints from malicious activity. {{elastic-defend}} uses a combination of techniques like machine learning, behavioral analysis, and prebuilt rules to detect, prevent, and respond to threats in real-time. +* {{elastic-endpoint}}: The installed component that performs {{elastic-defend}}'s threat monitoring and prevention capabilities. +* Detection engine: The framework that detects threats by using rules to search for suspicious events in data sources and generating alerts when those rules meet the defined criteria. +* Detection rules: Sets of conditions that identify potential threats and malicious activities. Rules analyze various data sources, including logs and network traffic, to detect anomalies, suspicious behaviors, or known attack patterns. {{elastic-sec}} ships out-of-the-box prebuilt rules, or you can create your own custom rules. +* Alerts: A notification that's generated when a rule’s criteria are met. You can then investigate an alert to dive into deeper details. +* Machine learning and anomaly detection: Anomaly detection jobs identify anomalous events or patterns in your data. Use these with machine learning detection rules to generate alerts when behavior deviates from normal activity. +* Entity analytics: A threat detection feature that combines the power of Elastic’s detection engine and machine learning capabilities to identify unusual user behaviors across hosts, users, and services. Entity analytics uses a risk scoring engine to calculate a risk score, which is evaluated at a recurring interval. +* Cases: A tool that allows you to collect and share information about security issues. Opening a case lets you track key investigation details and collect alerts in a central location. You can also send cases to external systems. +* Timeline: A threat hunting tool that allows you to investigate security events so you can gather and analyze data related to alerts or suspicious activity. You can add events to Timeline from various sources, build custom queries, and import/export a Timeline to collaborate and share. +* Security posture management: Includes two Cloud Security features–Cloud Security Posture Management (CSPM) and Kubernetes Security Posture Management (KSPM)--that help you evaluate the services and resources in your cloud environment, such as storage, compute, IAM, and more — against security guidelines defined by the Center for Internet Security (CIS). These features help you identify and remediate configuration risks in your environment. +* AI Assistant: A generative AI-powered tool that helps with tasks like alert investigation, incident response, and query generation. It utilizes natural language processing and knowledge retrieval to provide context-aware assistance, summarize threats, suggest next steps, and automate workflows. Use AI Assistant to better understand and respond to security incidents. +::: + + +## Elastic {{observability}} + +### Elastic {{observability}} overview [observability-overview] + +Elastic {{observability}} provides unified observability across applications and infrastructure. It combines logs, metrics, application traces, user experience data, and more into a single, integrated platform. This consolidation allows for powerful, cross-referenced analysis, enabling teams to move from detecting issues to understanding their root causes with speed and efficiency. By leveraging the search and analytics capabilities of {{es}}, it offers a holistic view of system behavior. + +Elastic {{observability}} embraces open standards like OpenTelemetry for flexible data collection, and offers scalable, cost-efficient data retention with tiered storage. + +### Elastic {{observability}} use cases [observability-use-cases] + +Apply Elastic {{observability}} to various scenarios to improve operational awareness and system reliability. +:::{dropdown} Use cases +* **Log Monitoring and Analytics:** Centralize and analyze petabytes of log data from any source. This enables quick searching, ad-hoc queries with ES|QL, and visualization with prebuilt dashboards to diagnose issues. +* **Application Performance Monitoring (APM):** Gain code-level visibility into application performance. By collecting and analyzing traces with native OTel support, teams can identify bottlenecks, track errors, and optimize the end-user experience. +* **Infrastructure Monitoring:** Monitor metrics from servers, virtual machines, containers, and serverless environments with over 400 out-of-the-box integrations, including OpenTelemetry. This provides deep insights into resource utilization and overall system health. +* **Digital Experience Monitoring:** + * **Real User Monitoring (RUM):** Capture and analyze data on how real users interact with web applications to improve perceived performance. + * **Synthetic Monitoring:** Proactively simulate user journeys and API calls to test application availability and functionality. + * **Uptime Monitoring:** Continuously check the status of services and applications to ensure they are available. +* **Universal Profiling:** Gain visibility into system performance and identify expensive lines of code without application instrumentation, helping to increase CPU efficiency and reduce cloud spend. +* **LLM Observability:** Gain deep insights into the performance, usage, and costs of Large Language Model (LLM) prompts and responses. +* **Incident Response and Management:** Facilitate the investigation of operational incidents by correlating data from multiple sources, which accelerates root cause analysis and resolution. +::: + +### Elastic {{observability}} core concepts [observability-concepts] +At the heart of Elastic {{observability}} are several key concepts that enable its capabilities. + +:::{dropdown} Concepts +* The three pillars of {{observability}} are: + * Logs: Timestamped records of events that provide detailed, contextual information. + * Metrics: Numerical measurements of system performance and health over time. + * Traces: A representation of the end-to-end journey of a request as it travels through a distributed system. +* OpenTelemetry: Elastic Observability offers first-class, production-grade support for OpenTelemetry. This allows organizations to use vendor-neutral instrumentation and stream native OTel data without proprietary agents, leveraging the Elastic Distribution of OpenTelemetry (EDOT). +* AIOps and AI Assistant: Leverages predictive analytics and an LLM-powered AI Assistant to reduce the time required to detect, investigate, and resolve incidents. This includes zero-config anomaly detection, pattern analysis, and the ability to surface correlations and root causes. +* Alerting and Cases: A built-in feature for creating rules to detect complex conditions and trigger actions. It allows teams to stay aware of potential issues and use Cases to track investigation details, assign tasks, and collaborate on resolutions. +* Service Level Objectives (SLOs): A framework for defining and monitoring the reliability of a service. Elastic Observability allows for creating and tracking SLOs to ensure that performance targets are being met. +::: + + + + + % TODO: cleanup these links, consolidate with Explore and analyze - +$$$what-is-kib$$$ +$$$what-is-es$$$ $$$visualize-and-analyze$$$ $$$extend-your-use-case$$$ $$$_manage_your_data$$$ diff --git a/get-started/toc.yml b/get-started/toc.yml index b5cae382dd..3a28e67655 100644 --- a/get-started/toc.yml +++ b/get-started/toc.yml @@ -4,4 +4,5 @@ toc: - file: introduction.md - file: the-stack.md - file: deployment-options.md - - file: versioning-availability.md \ No newline at end of file + - file: versioning-availability.md + - file: howto-use-the-docs.md \ No newline at end of file diff --git a/get-started/versioning-availability.md b/get-started/versioning-availability.md index 6afc51de38..0ac445d1e4 100644 --- a/get-started/versioning-availability.md +++ b/get-started/versioning-availability.md @@ -2,20 +2,24 @@ navigation_title: Versioning and availability mapped_pages: - https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/introducing-elastic-documentation.html +applies_to: + serverless: + stack: products: - id: elastic-stack description: Learn how Elastic handles versioning and feature availability in the docs. Find the product versions that are supported, how to read availability badges, and... --- -# Versioning and availability in Elastic Docs +# Versioning and availability -Learn how Elastic Docs handles versioning, feature availability, and how to find the right documentation for your deployment type and product version. Find answers to common questions about the Elastic Stack versioning and confidently navigate our continuously updated documentation. +Learn how Elastic products are versioned, the lifecycle of features, and how to find the right documentation for your deployment type and product version. Find answers to common questions about the versioning and confidently navigate our continuously updated documentation. -## Frequently asked questions +## Understanding versioning -### Where can I find documentation for the latest version of the {{stack}}? +Many components of the [{{stack}}](/get-started/the-stack.md) (such as {{es}} and {{kib}}) share the same versioning pattern. +In the documentation, this group of components is typically referred to as the {{stack}}. -You’re in the right place! All documentation for Elastic Stack 9.0.0 and later is available at [elastic.co/docs](https://www.elastic.co/docs), including the latest {{version.stack| M.M}} version and any future versions in the 9.x series. +Orchestrators such as {{ece}} and {{eck}}, and other tools such as code clients and SDKs, are versioned independently of the {{stack}}. The {{ecloud}} console and {{serverless-short}} projects are always automatically updated with the latest changes. Need docs for an earlier version? Go to [elastic.co/guide](https://www.elastic.co/guide). @@ -91,45 +95,47 @@ To make sure you're always viewing the most up-to-date and relevant documentatio ## Understanding {{stack}} versioning -{{stack}} uses semantic versioning in the `X.Y.Z` format, such as `9.0.0`. +The components of the {{stack}} typically use semantic versioning in the `X.Y.Z` format, such as `9.0.0`. | Version | Description | -|-------|-------------| -| **Major (X)** | Indicates significant changes, such as new features, breaking changes, and major enhancements. Upgrading to a new major version may require changes to your existing setup and configurations. | -| **Minor (Y)** | Introduces new features and improvements, while maintaining backward compatibility with the previous minor versions within the same major version. Upgrading to a new minor version should not require any changes to your existing setup. | -| **Patch (Z)** | Contains bug fixes and security updates, without introducing new features or breaking changes. Upgrading to a new patch version should be seamless and not require any changes to your existing setup. | +| ----- | ----- | +| Major (X) | Indicates significant changes, such as new features, breaking changes, and major enhancements. Upgrading to a new major version may require changes to your existing setup and configurations. | +| Minor (Y) | Introduces new features and improvements, while maintaining backward compatibility with the previous minor versions within the same major version. Upgrading to a new minor version should not require any changes to your existing setup. | +| Patch (Z) | Contains bug fixes and security updates, without introducing new features or breaking changes. Upgrading to a new patch version should be seamless and not require any changes to your existing setup. | -Understanding {{stack}} versioning is essential for [upgrade planning](/deploy-manage/upgrade.md) and ensuring compatibility. +Understanding versioning is essential for [upgrade planning](/deploy-manage/upgrade.md) and ensuring compatibility, particularly in the self-managed [deployment option](/get-started/deployment-options.md). ## Availability of features -The features available to you can differ based on deployment type, product lifecycle stage, and specific version. +Features available to you can differ based on deployment type, product lifecycle stage, and specific version. ### Feature availability factors | Factor | Description | -|-------|-------------| -| **Deployment type** | The environment where the feature is available, for example, {{stack}}, {{serverless-full}}, {{ece}} (ECE), {{eck}} (ECK) | -| **Lifecycle state** | The development or support status of the feature, for example, GA and Beta | -| **Version** | The specific version the lifecycle state applies to | +| ----- | ----- | +| Deployment type | The environment where the feature is available, for example, self-managed, {{serverless-full}}, {{ece}}, {{eck}} | +| Lifecycle state | The development or support status of the feature, for example, GA, Technical preview, Beta | +| Version | The specific version the lifecycle state applies to | ### Lifecycle states | Lifecycle state | Description | -|-------|-------------| -| **Generally Available (GA)** | Production-ready feature. When unspecified, GA is the default | -| **Beta** | Feature is nearing general availability but not yet production-ready | -| **Technical preview** | Feature is in early development stage | -| **Unavailable** | Feature is not supported in this deployment type or version | +| ----- | ----- | +| Technical preview | Feature is in early development stage | +| Beta | Feature is nearing general availability but not yet production-ready | +| Generally Available (GA) | Production-ready feature. When unspecified, GA is the default | +| Deprecated | Feature is still usable but is set to be removed or replaced in a future update | +| Removed | Feature can no longer be used | +| Unavailable | Feature is not supported in this deployment type or version | ### Examples of where availability can vary | Category | Example | -|-------|-------------| -| **Elastic Stack versions** | [Elastic Stack](the-stack.md) version 9.0.0 and later, including 9.1.0 | -| **Deployment types** | [Elastic Cloud Serverless](/deploy-manage/deploy/elastic-cloud/serverless.md), [Elastic Cloud Hosted](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md), [Elastic Cloud Enterprise (ECE)](/deploy-manage/deploy/cloud-enterprise.md), [Elastic Cloud on Kubernetes (ECK)](/deploy-manage/deploy/cloud-on-k8s.md), and [Self-managed deployments](/deploy-manage/deploy/self-managed.md) | -| **Deployment versions** | [Elastic Cloud Enterprise (ECE)](/deploy-manage/deploy/cloud-enterprise.md) 4.0.0 and later, [Elastic Cloud on Kubernetes (ECK)](/deploy-manage/deploy/cloud-on-k8s.md) 3.0.0 and later | -| **Serverless project types** | {{es}}, {{observability}}, and {{elastic-sec}} +| ----- | ----- | +| {{stack}} versions | [{{stack}}](/get-started/the-stack.md) version 9.0.0 and later, including 9.1.0 | +| Deployment types | [{{serverless-full}}](/deploy-manage/deploy/elastic-cloud/serverless.md), [{{ech}}](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md), [{{ece}}](/deploy-manage/deploy/cloud-enterprise.md), [{{eck}}](/deploy-manage/deploy/cloud-on-k8s.md), and [Self-managed deployments](/deploy-manage/deploy/self-managed.md) | +| Orchestrator versions | [{{ece}}](/deploy-manage/deploy/cloud-enterprise.md) 4.0.0 and later, [{{eck}}](/deploy-manage/deploy/cloud-on-k8s.md) 3.0.0 and later | +| Serverless project types | {{es}}, Elastic {{observability}}, and {{elastic-sec}} | ## Find docs for your product version @@ -207,10 +213,3 @@ Find the documentation for your Elastic product versions or releases. | [Elastic APM AWS Lambda extension](apm-aws-lambda://release-notes/release-notes.md) | 1.0.0 and later | | [Elastic APM Attacher for Kubernetes](apm-k8s-attacher://reference/index.md) | 1.1.3 | - - - - - - - diff --git a/redirects.yml b/redirects.yml index 85a0e4e9b9..aca7080650 100644 --- a/redirects.yml +++ b/redirects.yml @@ -340,4 +340,4 @@ redirects: 'release-notes/fleet-elastic-agent/index.md': 'fleet-server://release-notes/index.md' 'release-notes/fleet-elastic-agent/breaking-changes.md': 'fleet-server://release-notes/breaking-changes.md' 'release-notes/fleet-elastic-agent/deprecations.md': 'fleet-server://release-notes/deprecations.md' - 'release-notes/fleet-elastic-agent/known-issues.md': 'fleet-server://release-notes/known-issues.md' \ No newline at end of file + 'release-notes/fleet-elastic-agent/known-issues.md': 'fleet-server://release-notes/known-issues.md' diff --git a/versions.md b/versions.md index ee307f5991..0c47e1900d 100644 --- a/versions.md +++ b/versions.md @@ -2,7 +2,7 @@ In April 2025, we released our new documentation site. This site includes documentation for our latest product versions, including {{stack}} 9.0+ and {{serverless-full}}. -To review the product versions covered on elastic.co/docs, refer to [Find docs for your product version](/get-started/versioning-availability.md#find-docs-for-your-product-version). +To review the product versions covered on elastic.co/docs, refer to [Find docs for your product version](/get-started/howto-use-the-docs.md#find-docs-for-your-product-version). To access our previous documentation system, which contains the documentation for older releases including {{stack}} 8.x, use the following links.