From 3e5b64a803b7eacd811367d52f1e14184bb05567 Mon Sep 17 00:00:00 2001 From: Liam Thompson Date: Thu, 20 Feb 2025 18:42:37 +0100 Subject: [PATCH 01/15] Flesh out 'Deploy', sidequest to update 'Get Started' --- .../_snippets/deployment-options-overview.md | 14 ++ deploy-manage/deploy.md | 78 ++++++- deploy-manage/deploy/self-managed.md | 4 + get-started/deployment-options.md | 25 +-- get-started/index.md | 63 ++---- get-started/installing-elastic-stack.md | 49 ----- get-started/introduction.md | 203 +++++------------- get-started/the-stack.md | 8 +- get-started/toc.yml | 6 +- get-started/versioning-availability.md | 47 ++++ manage-data/data-store.md | 2 +- .../elasticsearch-intro-deploy.md | 4 +- 12 files changed, 223 insertions(+), 280 deletions(-) create mode 100644 deploy-manage/_snippets/deployment-options-overview.md delete mode 100644 get-started/installing-elastic-stack.md create mode 100644 get-started/versioning-availability.md diff --git a/deploy-manage/_snippets/deployment-options-overview.md b/deploy-manage/_snippets/deployment-options-overview.md new file mode 100644 index 0000000000..7833432eca --- /dev/null +++ b/deploy-manage/_snippets/deployment-options-overview.md @@ -0,0 +1,14 @@ +**Quick start option** + +* [**Local development**](/solutions/search/run-elasticsearch-locally.md): Get started quickly with {{es}} and {{kib}} in Docker for local development and testing. + +**Hosted options** + +* [**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). +* [**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). + +**Advanced options** + +* [**Self-managed**](/deploy-manage/deploy/self-managed.md): Install, configure, and run Elastic on your own premises. +* [**Elastic Cloud Enterprise**](https://www.elastic.co/guide/en/cloud-enterprise/current/Elastic-Cloud-Enterprise-overview.html): Deploy Elastic Cloud on public or private clouds, virtual machines, or your own premises. +* [**Elastic Cloud on Kubernetes**](/deploy-manage/deploy/cloud-on-k8s.md): Deploy Elastic Cloud on Kubernetes. \ No newline at end of file diff --git a/deploy-manage/deploy.md b/deploy-manage/deploy.md index 1e64c731b2..834bdf6945 100644 --- a/deploy-manage/deploy.md +++ b/deploy-manage/deploy.md @@ -17,9 +17,79 @@ mapped_urls: % - [ ] ./raw-migrated-files/docs-content/serverless/intro.md % - [ ] ./raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md -⚠️ **This page is a work in progress.** ⚠️ +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. -The documentation team is working to combine content pulled from the following pages: +This page will help you understand your deployment options and choose the approach that best fits your needs. -* [/raw-migrated-files/docs-content/serverless/intro.md](/raw-migrated-files/docs-content/serverless/intro.md) -* [/raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md) \ No newline at end of file +## Core components + +Every Elastic deployment requires Elasticsearch as its core data store and search/analytics engine. +Additionally, Kibana provides the user interface for all Elastic solutions and Serverless projects. It is required for most use cases, from data exploration to monitoring and security analysis. + +Your choice of deployment type determines how you'll set up and manage these core components, plus any additional components you need. + +Elastic offers deployment options ranging from fully automated to fully self-managed. + +:::{tip} +Learn more about the [{{stack}}](/get-started/the-stack.md) to understand the core and optional components of an Elastic deployment. +::: + +## Deployment types overview + +:::{include} _snippets/deployment-options-overview.md +::: + +## Versioning and compatability + +In {{serverless-full}}, you automatically get access to the latest versions of Elastic features and you don't need to manage version compatibility. + +All other deployment types use stack versioning, where components are tested and versioned together to ensure compatibility. ECE and ECK have their own deployment versions, in addition to stack versioning. + +Consider this when choosing your deployment type: + +- Choose Serverless if you want automatic access to the latest features and don't want to manage version compatibility +- Choose other deployment types if you need more control over version management + +:::{tip} +Learn more about [versioning and availability](/get-started/versioning-availability.md). +::: + +## Choose your deployment path + +Your deployment choice determines how you'll set up and manage these components. + +### Step 1: Who manages the infrastructure? + +#### Managed by Elastic + +If you want to focus on using Elastic products rather than managing infrastructure, choose: + +- **Serverless**: Zero operational overhead, automatic scaling and updates, latest features +- **Cloud hosted**: Balance of control and managed operations, choice of resources and regions + +#### Self-managed with your infrastructure + +If you need to run Elastic on your infrastructure, you have three options: + +- **Basic self-managed**: Direct control over all aspects of deployment +- **Elastic Cloud on Kubernetes (ECK)**: Kubernetes-native orchestration +- **Elastic Cloud Enterprise (ECE)**: Multi-tenant orchestration platform + +### Step 2: For self-managed - do you need orchestration? + +If you chose self-managed, consider whether you need orchestration: + +- **No orchestration needed**: + Choose basic self-managed deployment for full control and direct management + +- **Kubernetes environment**: + Use ECK for native Kubernetes orchestration and automated operations + +- **Multi-tenant platform**: + Use ECE to deploy {{ecloud}} on your own infrastructure + +## Cost considerations + +- **Serverless**: Pay for what you use +- **Cloud hosted**: Subscription-based with resource allocation +- **Self-managed options**: Infrastructure costs plus operational overhead mean a higher total cost of ownership (TCO) diff --git a/deploy-manage/deploy/self-managed.md b/deploy-manage/deploy/self-managed.md index bdecd1745b..cb783938a1 100644 --- a/deploy-manage/deploy/self-managed.md +++ b/deploy-manage/deploy/self-managed.md @@ -7,3 +7,7 @@ mapped_pages: See [Elastic Stack Third-party Dependencices](https://artifacts.elastic.co/reports/dependencies/dependencies-current.md) for the complete list of dependencies for {{es}}. +$$$installing-elastic-stack$$$ +$$$network-requirements$$$ +$$$install-order-elastic-stack$$$ +$$$install-elastic-stack-for-elastic-cloud$$$ \ No newline at end of file diff --git a/get-started/deployment-options.md b/get-started/deployment-options.md index 8b79fd9d3e..c48c9ae0e6 100644 --- a/get-started/deployment-options.md +++ b/get-started/deployment-options.md @@ -1,23 +1,10 @@ ---- -mapped_pages: - - https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro-deploy.html ---- - # Deployment options [elasticsearch-intro-deploy] -To use {{es}}, you need a running instance of the {{es}} service. You can deploy {{es}} in various ways. - -**Quick start option** - -* [**Local development**](../solutions/search/get-started.md): Get started quickly with a minimal local Docker setup for development and testing. - -**Hosted options** - -* [**Elastic Cloud Hosted**](../deploy-manage/deploy/elastic-cloud/create-an-organization.md): {{es}} is available as part of the hosted Elastic Stack offering, deployed in the cloud with your provider of choice. Sign up for a [14-day free trial](https://cloud.elastic.co/registration). -* [**Elastic Cloud Serverless**](https://docs.elastic.co/serverless/general/sign-up-trial): Create serverless projects for autoscaled and fully managed {{es}} deployments. Sign up for a [14-day free trial](https://cloud.elastic.co/serverless-registration). +Use this page for a quick overview of your options for deploying Elastic. -**Advanced options** +:::{include} /deploy-manage/_snippets/deployment-options-overview.md +::: -* [**Self-managed**](../deploy-manage/deploy/self-managed/installing-elasticsearch.md#elasticsearch-deployment-options): Install, configure, and run {{es}} on your own premises. -* [**Elastic Cloud Enterprise**](https://www.elastic.co/guide/en/cloud-enterprise/current/Elastic-Cloud-Enterprise-overview.html): Deploy Elastic Cloud on public or private clouds, virtual machines, or your own premises. -* [**Elastic Cloud on Kubernetes**](../deploy-manage/deploy/cloud-on-k8s.md): Deploy Elastic Cloud on Kubernetes. +:::{tip} +Refer to [](/deploy-manage/index.md) for detailed information and guidance on choosing the right deployment for your needs. +::: \ No newline at end of file diff --git a/get-started/index.md b/get-started/index.md index 1d5f068c75..34191e2a4c 100644 --- a/get-started/index.md +++ b/get-started/index.md @@ -1,54 +1,21 @@ ---- -mapped_pages: - - https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro-what-is-es.html ---- +# Get started -# Get started [elasticsearch-intro-what-is-es] +{{es}} is the heart of the [Elastic Stack](the-stack.md). Combined with {{kib}}, it powers these Elastic solutions and use cases: -[{{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. +* [Observability](/solutions/observability.md) +* [Security](/solutions/security.md) +* [Search](/solutions/search.md) -{{es}} is the heart of the [Elastic Stack](the-stack.md). Combined with [{{kib}}](https://www.elastic.co/kibana), it powers these Elastic solutions: +:::{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. +::: -* [Observability](https://www.elastic.co/observability) -* [Search](https://www.elastic.co/enterprise-search) -* [Security](https://www.elastic.co/security) +## First steps -Explore the full list of [{{es}} features](https://www.elastic.co/elasticsearch/features) on the product webpage. +Depending on your experience with Elastic, you might want to start with one of these resources: -::::{admonition} What is the Elastic Stack? -:name: elasticsearch-intro-elastic-stack - -{{es}} is the core component of the Elastic Stack, a suite of products for collecting, storing, searching, and visualizing data. [Learn more about the Elastic Stack](the-stack.md). - -:::: - - - -## Use cases [elasticsearch-intro-use-cases] - -You can use {{es}} for a wide and growing range of use cases. Here are a few examples: - -**Observability** - -* **Logs, metrics, and traces**: Collect, store, and analyze logs, metrics, and traces from applications, systems, and services. -* **Application performance monitoring (APM)**: Monitor and analyze the performance of business-critical software applications. -* **Real user monitoring (RUM)**: Monitor, quantify, and analyze user interactions with web applications. -* **OpenTelemetry**: Reuse your existing instrumentation to send telemetry data to the Elastic Stack using the OpenTelemetry standard. - -**Search** - -* **Full-text search**: Build a fast, relevant full-text search solution using inverted indexes, tokenization, and text analysis. -* **Vector database**: Store and search vectorized data, and create vector embeddings with built-in and third-party natural language processing (NLP) models. -* **Semantic search**: Understand the intent and contextual meaning behind search queries using tools like synonyms, dense vector embeddings, and learned sparse query-document expansion. -* **Hybrid search**: Combine full-text search with vector search using state-of-the-art ranking algorithms. -* **Build search experiences**: Add hybrid search capabilities to apps or websites, or build enterprise search engines over your organization’s internal data sources. -* **Retrieval augmented generation (RAG)**: Use {{es}} as a retrieval engine to supplement generative AI models with more relevant, up-to-date, or proprietary data for a range of use cases. -* **Geospatial search**: Search for locations and calculate spatial relationships using geospatial queries. - -**Security** - -* **Security information and event management (SIEM)**: Collect, store, and analyze security data from applications, systems, and services. -* **Endpoint security**: Monitor and analyze endpoint security data. -* **Threat hunting**: Search and analyze data to detect and respond to security threats. - -This is just a sample of search, observability, and security use cases enabled by {{es}}. Refer to Elastic [customer success stories](https://www.elastic.co/customers/success-stories) for concrete examples across a range of industries. +- Learn about [{{es}} and {{kib}}](introduction.md), the core components of the Elastic Stack. + - Learn about [the stack](/get-started/the-stack.md) to understand the relationship between core and optional components of an Elastic deployment. +- Learn about the [out-of-the-box solutions and use cases](/solutions/index.md) that Elastic supports. +- Learn how to [deploy Elastic](./deployment-options.md) for your use case. +- Understand how [versioning and availability](./versioning-availability.md) work with Elastic deployments. \ No newline at end of file diff --git a/get-started/installing-elastic-stack.md b/get-started/installing-elastic-stack.md deleted file mode 100644 index a1a1423860..0000000000 --- a/get-started/installing-elastic-stack.md +++ /dev/null @@ -1,49 +0,0 @@ -# Installing the Elastic Stack [installing-elastic-stack] - -When installing the Elastic Stack, you must use the same version across the entire stack. For example, if you are using Elasticsearch 9.0.0-beta1, you install Beats 9.0.0-beta1, APM Server 9.0.0-beta1, Elasticsearch Hadoop 9.0.0-beta1, Kibana 9.0.0-beta1, and Logstash 9.0.0-beta1. - -If you’re upgrading an existing installation, see [Upgrading the Elastic Stack](../deploy-manage/upgrade/deployment-or-cluster.md) for information about how to ensure compatibility with 9.0.0-beta1. - -For an example of installing and configuring the {{stack}}, you can try out our [Tutorial 1: Installing a self-managed {{stack}}](../deploy-manage/deploy/self-managed/installing-elasticsearch.md). After that, you can also learn how to secure your installation for production following the steps in [Tutorial 2: Securing a self-managed {{stack}}](../deploy-manage/security/secure-your-cluster-deployment.md). - - -## Network requirements [network-requirements] - -To install the Elastic Stack on-premises, these ports need to be open for each component. - -| Default port | Component | -| ------------- | ------------- | -| 5044 | {{agent}} → {{ls}}
{{beats}} → {{ls}} | -| 5601 | {{kib}}
{{agent}} → {{fleet}}
{{fleet-server}} → {{fleet}} | -| 8220 | {{agent}} → {{fleet-server}}
APM Server | -| 9200-9300 | {{es}} REST API | -| 9300-9400 | {{es}} node transport and communication | -| 9600-9700 | {{ls}} REST API | - -Each Elastic integration has its own ports and dependencies. Verify these ports and dependencies before installation. Refer to [{{integrations}}](https://docs.elastic.co/en/integrations). - -For more information on supported network configurations, refer to [{{es}} Ingest Architectures](https://www.elastic.co/guide/en/ingest/current). - - -## Installation order [install-order-elastic-stack] - -Install the Elastic Stack products you want to use in the following order: - -1. [Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html) -2. [Kibana](https://www.elastic.co/guide/en/kibana/current/install.html) -3. [Logstash](https://www.elastic.co/guide/en/logstash/current/installing-logstash.html) -4. [Elastic Agent](https://www.elastic.co/guide/en/fleet/current/elastic-agent-installation.html) or [Beats](https://www.elastic.co/guide/en/beats/libbeat/current/getting-started.html) -5. [APM](https://www.elastic.co/guide/en/apm/guide/current/apm-quick-start.html) -6. [Elasticsearch Hadoop](https://www.elastic.co/guide/en/elasticsearch/hadoop/current/install.html) - -Installing in this order ensures that the components each product depends on are in place. - - -## Installing on {{ecloud}} [install-elastic-stack-for-elastic-cloud] - -Installing on {{ecloud}} is easy: a single click creates an {{es}} cluster configured to the size you want, with or without high availability. The subscription features are always installed, so you automatically have the ability to secure and monitor your cluster. {{kib}} is enabled automatically, and a number of popular plugins are readily available. - -Some {{ecloud}} features can be used only with a specific subscription. For more information, refer to [https://www.elastic.co/pricing/](https://www.elastic.co/pricing/). - - - diff --git a/get-started/introduction.md b/get-started/introduction.md index b39e5479c2..2c805f9e9c 100644 --- a/get-started/introduction.md +++ b/get-started/introduction.md @@ -1,174 +1,79 @@ --- -navigation_title: "What is Kibana?" +mapped_pages: + - https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro-what-is-es.html +navigation_title: "Elasticsearch and Kibana" --- -# {{kib}}—your window into Elastic [introduction] +# Elasticsearch and Kibana [introduction] +## What is {{es}}? -{{kib}} enables you to give shape to your data and navigate the Elastic Stack. With {{kib}}, you can: +[{{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. -* **Search, observe, and protect your data.** From discovering documents to analyzing logs to finding security vulnerabilities, {{kib}} is your portal for accessing these capabilities and more. -* **Analyze your data.** Search for hidden insights, visualize what you’ve found in charts, gauges, maps, graphs, and more, and combine them in a dashboard. -* **Manage, monitor, and secure the Elastic Stack.** Manage your data, monitor the health of your Elastic Stack cluster, and control which users have access to which features. +You can deploy {{es}} as a standalone service to build custom search and analytics solutions or deploy it together with other Elastic products, using various [deployment options](./deployment-options.md). -:::{image} ../images/kibana-analytics-home-page.png -:alt: Analytics home page -:name: kibana-home-page -:class: screenshot -::: +Explore the full list of [{{es}} features](https://www.elastic.co/elasticsearch/features) on the product webpage. -**{{kib}} is for administrators, analysts, and business users.** As an admin, your role is to manage the Elastic Stack, from creating your deployment to getting {{es}} data into {{kib}}, and then managing the data. As an analyst, you’re looking to discover insights in the data, visualize your data on dashboards, and share your findings. As a business user, you want to view existing dashboards and drill down into details. +To learn more about the internals of the data store, refer to [](/manage-data/data-store.md). -**{{kib}} works with all types of data.** Your data can be structured or unstructured text, numerical data, time series data, geospatial data, logs, metrics, security events, and more. No matter your data, {{kib}} can help you uncover patterns and relationships and visualize the results. +::::{tip} +Want to get started quickly with the {{es}} API? Check out our hands-on [quick start tutorials](/solutions/search/api-quickstarts.md) and [Python notebooks](https://github.com/elastic/elasticsearch-labs/tree/main/notebooks#readme). +:::: +## What is {{kib}}? -## Search, observe, and protect [extend-your-use-case] +[{{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. -Being able to search, observe, and protect your data is a requirement for any analyst. {{kib}} provides solutions for each of these use cases. +Together, {{es}} and {{kib}} form the core of the [Elastic Stack](the-stack.md). -* [**Elastic Search**](/solutions/search.md) enables you to implement premier search experiences for your apps, organizations, and websites. -* [**Elastic Observability**](../solutions/observability/get-started/what-is-elastic-observability.md) enables you to monitor and apply analytics in real time to events happening across all your environments. You can analyze log events, monitor performance metrics for hosts and containers, trace transactions, and maintain service availability. -* Designed for security analysts, [**Elastic Security**](../solutions/security.md) includes a multitude of prebuilt detection rules and data integrations to help you collect important information in one place, get an overview of events and alerts, and secure your environments from endpoints to the cloud. +They power all Elastic solutions and use cases: +- [Observability](/solutions/observability.md) +- [Security](/solutions/security.md) +- [Search](/solutions/search.md) -## Analyze [visualize-and-analyze] +## Use cases -With {{kib}} [**Analytics**](/explore-analyze/index.md), you can quickly search through large amounts of data, explore fields and values, and then use the drag-and-drop interface to rapidly build charts, tables, metrics, and more. +The {{stack}} is used for a wide and growing range of use cases. Here are a few examples: -:::{image} ../images/kibana-visualization-journey.png -:alt: User data analysis journey -:class: screenshot -::: +**Observability** -$$$get-data-into-kibana$$$ +- **Logs, metrics, and traces**: Collect, store, and analyze logs, metrics, and traces from applications, systems, and services. +- **Application performance monitoring (APM)**: Monitor and analyze the performance of business-critical software applications. +- **Real user monitoring (RUM)**: Monitor, quantify, and analyze user interactions with web applications. +- **OpenTelemetry**: Reuse your existing instrumentation to send telemetry data to the Elastic Stack using the OpenTelemetry standard. -| | | -| --- | --- | -| **1** | **Add data.** The best way to add data to the Elastic Stack is to use one of our many [integrations](../manage-data/ingest.md). On the **Integrations** page, you can also find options to add sample data sets or to upload a file. | -| **2** | **Explore.** With [**Discover**](../explore-analyze/discover.md), you can search your data for hidden insights and relationships. Ask your questions, and then filter the results using a wide range of criteria. | -| **3** | **Visualize.** {{kib}} provides many options to create visualizations of your data, from aggregation-based data to time series data to geospatial data. Use [**Dashboards**](../explore-analyze/dashboards.md) to visualize your data from multiple perspectives tailored for your use case. Use [**Canvas**](../explore-analyze/visualize/canvas.md) to give your data the “wow” factor for display on a big screen. Use **Graph** to identify patterns and relationships. | -| **4** | **Model data behavior.** Use [**{{ml-cap}}**](../explore-analyze/machine-learning/machine-learning-in-kibana.md) to gain a deeper understanding of your data. You can use a wide range of models for supervised and unsupervised learning on tasks including classification, regression, trend forecasting, and anomaly detection. | -| **5** | **Share.** Ready to [share](../explore-analyze/report-and-share.md) your findings with a larger audience? {{kib}} offers many options—embed a dashboard, share a link, export to PDF, and more. | +**Security** +- **Security information and event management (SIEM)**: Collect, store, and analyze security data from applications, systems, and services. +- **Endpoint security**: Monitor and analyze endpoint security data. +- **Threat hunting**: Search and analyze data to detect and respond to security threats. -## Manage your data [_manage_your_data] +**Search** -{{kib}} helps you perform your data management tasks from the convenience of a UI. You can: +- **Full-text search**: Build a fast, relevant full-text search solution using inverted indexes, tokenization, and text analysis. +- **Vector database**: Store and search vectorized data, and create vector embeddings with built-in and third-party natural language processing (NLP) models. +- **Semantic search**: Understand the intent and contextual meaning behind search queries using tools like synonyms, dense vector embeddings, and learned sparse query-document expansion. +- **Hybrid search**: Combine full-text search with vector search using state-of-the-art ranking algorithms. +- **Build search experiences**: Add hybrid search capabilities to apps or websites, or build enterprise search engines over your organization’s internal data sources. +- **Retrieval augmented generation (RAG)**: Use Elasticsearch as a retrieval engine to supplement generative AI models with more relevant, up-to-date, or proprietary data for a range of use cases. +- **Geospatial search**: Search for locations and calculate spatial relationships using geospatial queries. -* Refresh, flush, and clear the cache of your indices. -* Define the lifecycle of an index as it ages. -* Define a policy for taking snapshots of your cluster. -* Roll up data from one or more indices into a new, compact index. -* Replicate indices on a remote cluster and copy them to a local cluster. +This is just a sample of search, observability, and security use cases enabled by Elasticsearch. Refer to Elastic [customer success stories](https://www.elastic.co/customers/success-stories) for concrete examples across a range of industries. -For a full list of data management UIs, refer to [**Stack Management**](../deploy-manage/index.md). +% TODO: cleanup these links, consolidate with Explore and analyze -:::{image} ../images/kibana-stack-management.png -:alt: Index Management view in Stack Management -:class: screenshot -::: - - -## Alert and take action [_alert_and_take_action] - -Detecting and acting on significant shifts and signals in your data is a need that exists in almost every use case. Alerting allows you to detect conditions in different {{kib}} apps and trigger actions when those conditions are met. For example, you might trigger an alert when a shift occurs in your business critical KPIs or when memory, CPU, or disk space take a dip. When the alert triggers, you can send a notification to a system that is part of your daily workflow: email, Slack, PagerDuty, ServiceNow, and other third party integrations. - -The [**{{rules-ui}}**](../explore-analyze/alerts-cases/alerts/create-manage-rules.md) page provides a dedicated view for creating, searching, and editing rules. - - -## Organize content [organize-and-secure] - -You might be managing tens, hundreds, or even thousands of dashboards, visualizations, and other {{kib}} assets. {{kib}} has several features for keeping your content organized. - - -### Collect related items in a space [organize-in-spaces] - -{{kib}} [spaces](../deploy-manage/manage-spaces.md) help you organize your visualizations, dashboards, {{data-sources}}, and more. Think of a space as its own mini {{kib}} instance—it’s isolated from all other spaces, so you can tailor it to your specific needs without impacting others. - -:::{image} ../images/kibana-select-your-space.png -:alt: Space selector view -:class: screenshot -::: - - -### Organize your content with tags [_organize_your_content_with_tags] - -Tags are keywords or labels that you assign to saved objects, such as dashboards and visualizations, so you can classify them in a way that is meaningful to you. For example, if you tag objects with “design”, you can search and filter on the tag to display all related objects. Tags are also good for grouping content into categories within a space. - -Don’t worry if you have hundreds of dashboards that need to be tagged. Use [**Tags**](../explore-analyze/find-and-organize/tags.md) in **Stack Management** to create your tags, then assign and delete them using bulk operations. - - -## Secure {{kib}} [intro-kibana-Security] - -{{kib}} offers a range of security features for you to control who has access to what. [Security is enabled automatically](../deploy-manage/security/security-certificates-keys.md) when you enroll {{kib}} with a secured {{es}} cluster. For a description of all available configuration options, refer to [Security settings in {{kib}}](https://www.elastic.co/guide/en/kibana/current/security-settings-kb.html). - - -### Log in [_log_in] - -{{kib}} supports several [authentication providers](../deploy-manage/users-roles/cluster-or-deployment-auth/user-authentication.md), allowing you to login using {{es}} or your own single sign-on provider. - -:::{image} ../images/kibana-kibana-login.png -:alt: Login page -:class: screenshot -::: - - -### Secure access [_secure_access] - -{{kib}} provides roles and privileges for controlling which users can view and manage {{kib}} features. Privileges grant permission to view an application or perform a specific action and are assigned to roles. Roles allow you to describe a “template” of capabilities that you can grant to many users, without having to redefine what each user should be able to do. - -When you create a role, you can scope the assigned {{kib}} privileges to specific spaces. This makes it possible to grant users different access levels in different spaces, or even give users their very own private space. For example, power users might have privileges to create and edit visualizations and dashboards, while analysts or executives might have **Dashboard** and **Canvas** with read-only privileges. - -The {{kib}} role management interface allows you to describe these various access levels, or you can automate role creation by using [role APIs](https://www.elastic.co/docs/api/doc/kibana/group/endpoint-roles). - -:::{image} ../images/kibana-spaces-roles.png -:alt: {kib privileges} -:class: screenshot -::: - - -### Audit access [_audit_access] - -Once you have your users and roles configured, you might want to maintain a record of who did what, when. The {{kib}} audit log will record this information for you, which can then be correlated with {{es}} audit logs to gain more insights into your users’ behavior. For more information, refer to [{{kib}} audit logging](/deploy-manage/monitor/logging-configuration/enabling-audit-logs.md). - - -## Find apps and objects [kibana-navigation-search] - -To quickly find apps and the objects you create, use the search field in the global header. Search suggestions include deep links into applications, allowing you to directly navigate to the views you need most. - -:::{image} ../images/kibana-app-navigation-search.png -:alt: Example of searching for apps -:class: screenshot -::: - -You can search for objects by type, name, and tag. To get the most from the search feature, follow these tips: - -* Use the keyboard shortcut—Ctrl+/ on Windows and Linux, Command+/ on MacOS—to focus on the search bar at any time. -* Use the provided syntax keywords. - - | | | - | --- | --- | - | Search by type | `type:dashboard`
Available types: `application`, `canvas-workpad`, `dashboard`, `data-view`, `lens`, `maps`, `query`, `search`, `visualization` | - | Search by tag | `tag:mytagname`
`tag:"tag name with spaces"` | - | Search by type and name | `type:dashboard my_dashboard_title` | - | Advanced searches | `tag:(tagname1 or tagname2) my_dashboard_title`
`type:lens tag:(tagname1 or tagname2)`
`type:(dashboard or canvas-workpad) logs`
| - - -This example searches for visualizations with the tag `design`. - -:::{image} ../images/kibana-tags-search.png -:alt: Example of searching for tags -:class: screenshot -::: - - -## View all {{kib}} has to offer [_view_all_kib_has_to_offer] - -To view the full list of apps and features, go to [{{kib}} features](https://www.elastic.co/kibana/features). - - -## Get help [try-kibana] - -Click ![Help icon in navigation bar](../images/kibana-intro-help-icon.png "") for help with questions or to provide feedback. - -To keep up with what’s new and changed in Elastic, click the celebration icon in the global header. +$$$visualize-and-analyze$$$ +$$$extend-your-use-case$$$ +$$$_manage_your_data$$$ +$$$_alert_and_take_action$$$ +$$$organize-and-secure$$$ +$$$organize-in-spaces$$$ +$$$_organize_your_content_with_tags$$$ +$$$intro-kibana-Security$$$ +$$$_log_in$$$ +$$$extend-your-use-case$$$ +$$$try-kibana$$$ +$$$_view_all_kib_has_to_offer$$$ +$$$_audit_access$$$ +$$$_secure_access$$$ \ No newline at end of file diff --git a/get-started/the-stack.md b/get-started/the-stack.md index 984e142a61..928d07fcb4 100644 --- a/get-started/the-stack.md +++ b/get-started/the-stack.md @@ -5,17 +5,17 @@ mapped_urls: - https://www.elastic.co/guide/en/elastic-stack/current/installing-elastic-stack.html --- -# The stack +# The {{stack}} -This section provides an overview of the {{stack}} and its components — including {{kib}}, the primary user interface for all of Elastic's solutions: Elastic Search, Elastic Observability, and Elastic Security. It then describes how to install the {{stack}}. +This section provides an overview of the {{stack}} and its components — powered by [{{es}} and {{kib}}](introduction.md). $$$kibana-navigation-search$$$ ## An overview of the {{stack}} [stack-components] -What exactly is the "{{stack}}?" It’s a fast and highly scalable set of components — {{es}}, {{kib}}, {{beats}}, {{ls}}, and others — that together enable you to securely take data from any source, in any format, and then search, analyze, and visualize it. +What is the {{stack}}? It’s a fast and highly scalable set of components — {{es}}, {{kib}}, {{beats}}, {{ls}}, and others — that together enable you to securely take data from any source, in any format, and then search, analyze, and visualize it. -You can deploy the {{stack}} as a Cloud service supported on AWS, Google Cloud, and Azure, or as an on-prem installation on your own hardware. +You have many options for [deploying the {{stack}}](./deployment-options.md) to suit your needs. You can deploy it on your own hardware, in the cloud, or use a managed service on {{ecloud}}. ![Components of the Elastic Stack](../images/stack-components-diagram.svg) diff --git a/get-started/toc.yml b/get-started/toc.yml index a5e3edcc40..0b7dc85a23 100644 --- a/get-started/toc.yml +++ b/get-started/toc.yml @@ -1,8 +1,8 @@ project: 'Get started' toc: - file: index.md - - file: the-stack.md children: - file: introduction.md - - file: installing-elastic-stack.md - - file: deployment-options.md \ No newline at end of file + - file: the-stack.md + - file: deployment-options.md + - file: versioning-availability.md \ No newline at end of file diff --git a/get-started/versioning-availability.md b/get-started/versioning-availability.md new file mode 100644 index 0000000000..b15289dfe8 --- /dev/null +++ b/get-started/versioning-availability.md @@ -0,0 +1,47 @@ +--- +navigation_title: Versioning and availability +--- + +# Understanding versioning and availability + +## Elastic Stack versioning + +Elasticsearch and the core components of the Elastic Stack use a semantic versioning scheme. This consists of three numbers separated by periods in the: `X.Y.Z`. + +Each number represents a specific level of change: + +- **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. + +It's important to understand this versioning system, for compatibility and [upgrade](/deploy-manage/upgrade.md) planning. + +## Availability of features + +Elastic products and features have different availability states across deployment types: + +- **Generally Available**: Feature is production-ready +- **Beta**: Feature is complete but may have limitations +- **Preview**: Feature is in early development +- **Coming**: Feature is announced for a future release +- **Discontinued**: Feature is being phased out +- **Unavailable**: Feature is not supported in this deployment type or version + +Features may have different availability states between: + +- Elastic Stack versions (for example, 9.0, 9.1) +- Serverless projects (Security, Elasticsearch, Observability) +- Deployment types (and versions) + - [Elastic Cloud Hosted](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md) + - [Elastic Cloud Serverless](/deploy-manage/deploy/elastic-cloud/serverless.md) + - [Self-managed deployments](/deploy-manage/deploy/self-managed.md) + - [Elastic Cloud Enterprise (ECE)](/deploy-manage/deploy/cloud-enterprise.md) + - ECE deployment versions (for example, 4.0.0) + - [Elastic Cloud on Kubernetes (ECK)](/deploy-manage/deploy/cloud-on-k8s.md) + - ECK deployment versions (for example, 3.0.0) + +When reading the Elastic documentation be sure to: + +- Check feature availability for your deployment type and version +- Note stack version requirements +- Be aware that Serverless features may vary by project type \ No newline at end of file diff --git a/manage-data/data-store.md b/manage-data/data-store.md index 28ff3fa345..73d5fb0d72 100644 --- a/manage-data/data-store.md +++ b/manage-data/data-store.md @@ -3,7 +3,7 @@ mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro-what-is-es.html --- -# The Elasticsearch data store +# The Elasticsearch data store [elasticsearch-intro-what-is-es] [{{es}}](https://github.com/elastic/elasticsearch/) is a distributed search and analytics engine, scalable data store, and vector database built on Apache Lucene. diff --git a/raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md b/raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md index 2fed06c53d..ff7cffa0cf 100644 --- a/raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md +++ b/raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md @@ -1,10 +1,8 @@ # Run {{es}} [elasticsearch-intro-deploy] -To use {{es}}, you need a running instance of the {{es}} service. You can deploy {{es}} in various ways. - **Quick start option** -* [**Local development**](../../../solutions/search/get-started.md): Get started quickly with a minimal local Docker setup for development and testing. +* [**Local development**](../../../solutions/search/get-started.md): Get started quickly with {{es}} and {{kib}} for local development and testing. **Hosted options** From 7f89e6b1db1aba269db6f83dcaaaaeaffd7acea1 Mon Sep 17 00:00:00 2001 From: Liam Thompson Date: Thu, 20 Feb 2025 18:57:59 +0100 Subject: [PATCH 02/15] Fix link --- manage-data/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/manage-data/index.md b/manage-data/index.md index 0ab446c488..0399945127 100644 --- a/manage-data/index.md +++ b/manage-data/index.md @@ -1,6 +1,6 @@ # Manage data -Whether you're looking to build a fast and relevant full-text search solution, monitor business-critical applications and infrastructure, monitor endpoint security data, or one of the [many other use cases Elastic supports](/get-started/index.md#elasticsearch-intro-use-cases), you'll need to understand how to ingest and manage data stored in {{es}}. +Whether you're looking to build a fast and relevant search solution, monitor business-critical applications and infrastructure, monitor endpoint security data, or one of the [many other use cases Elastic supports](/get-started/introduction.md#use-cases), you'll need to understand how to ingest and manage data stored in {{es}}. ## Learn how data is stored From d7bba36e262658ebc997d8ee0eddedd79ee0813f Mon Sep 17 00:00:00 2001 From: Liam Thompson Date: Thu, 20 Feb 2025 19:12:19 +0100 Subject: [PATCH 03/15] Update link --- get-started/the-stack.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/get-started/the-stack.md b/get-started/the-stack.md index 55ec0e66cb..b208e6c87f 100644 --- a/get-started/the-stack.md +++ b/get-started/the-stack.md @@ -73,7 +73,7 @@ Use {{kib}} to query and visualize the data that’s stored in {{es}}. Or, use t $$$stack-components-kibana$$$ {{kib}} -: {{kib}} is the tool to harness your {{es}} data and to manage the {{stack}}. Use it to analyze and visualize the data that’s stored in {{es}}. {{kib}} is also the home for the Search, Observability and Security solutions. [Learn more about {{kib}}](/get-started/the-stack.md). +: {{kib}} is the tool to harness your {{es}} data and to manage the {{stack}}. Use it to analyze and visualize the data that’s stored in {{es}}. {{kib}} is also the home for the Search, Observability and Security solutions. [Learn more about {{kib}}](/explore-analyze/index.md). $$$stack-components-elasticsearch-clients$$$ From e1fd25b0d7e7be68f9b5df3fc4022bdf5d349943 Mon Sep 17 00:00:00 2001 From: Liam Thompson Date: Thu, 20 Feb 2025 19:20:33 +0100 Subject: [PATCH 04/15] Delete duplicate --- .../elasticsearch-intro-deploy.md | 16 ---------------- raw-migrated-files/toc.yml | 1 - 2 files changed, 17 deletions(-) delete mode 100644 raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md diff --git a/raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md b/raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md deleted file mode 100644 index 1bdfcf28be..0000000000 --- a/raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md +++ /dev/null @@ -1,16 +0,0 @@ -# Run {{es}} [elasticsearch-intro-deploy] - -**Quick start option** - -* [**Local development**](../../../solutions/search/get-started.md): Get started quickly with {{es}} and {{kib}} for local development and testing. - -**Hosted options** - -* [**Elastic Cloud Hosted**](../../../deploy-manage/deploy/elastic-cloud/create-an-organization.md): {{es}} is available as part of the hosted Elastic Stack offering, deployed in the cloud with your provider of choice. Sign up for a [14-day free trial](https://cloud.elastic.co/registration). -* [**Elastic Cloud Serverless**](https://docs.elastic.co/serverless/general/sign-up-trial): Create serverless projects for autoscaled and fully managed {{es}} deployments. Sign up for a [14-day free trial](https://cloud.elastic.co/serverless-registration). - -**Advanced options** - -* [**Self-managed**](../../../deploy-manage/deploy/self-managed/installing-elasticsearch.md#elasticsearch-deployment-options): Install, configure, and run {{es}} on your own premises. -* [**Elastic Cloud Enterprise**](/deploy-manage/deploy/cloud-enterprise.md): Deploy Elastic Cloud on public or private clouds, virtual machines, or your own premises. -* [**Elastic Cloud on Kubernetes**](../../../deploy-manage/deploy/cloud-on-k8s.md): Deploy Elastic Cloud on Kubernetes. diff --git a/raw-migrated-files/toc.yml b/raw-migrated-files/toc.yml index dbdad16163..c1a8b15965 100644 --- a/raw-migrated-files/toc.yml +++ b/raw-migrated-files/toc.yml @@ -396,7 +396,6 @@ toc: - file: elasticsearch/elasticsearch-reference/defining-roles.md - file: elasticsearch/elasticsearch-reference/document-level-security.md - file: elasticsearch/elasticsearch-reference/documents-indices.md - - file: elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md - file: elasticsearch/elasticsearch-reference/es-security-principles.md - file: elasticsearch/elasticsearch-reference/esql-using.md - file: elasticsearch/elasticsearch-reference/field-and-document-access-control.md From cdc6ede942de1c0e73bf94847432e70fc5fdd2fe Mon Sep 17 00:00:00 2001 From: Liam Thompson Date: Fri, 21 Feb 2025 09:35:54 +0100 Subject: [PATCH 05/15] fix link --- deploy-manage/deploy/self-managed/deploy-cluster.md | 1 - 1 file changed, 1 deletion(-) diff --git a/deploy-manage/deploy/self-managed/deploy-cluster.md b/deploy-manage/deploy/self-managed/deploy-cluster.md index 7e5316cd90..37e0472937 100644 --- a/deploy-manage/deploy/self-managed/deploy-cluster.md +++ b/deploy-manage/deploy/self-managed/deploy-cluster.md @@ -24,7 +24,6 @@ $$$dedicated-host$$$ **This page is a work in progress.** The documentation team is working to combine content pulled from the following pages: -* [/raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md) * [/raw-migrated-files/elasticsearch/elasticsearch-reference/setup.md](/raw-migrated-files/elasticsearch/elasticsearch-reference/setup.md) % Doesn't exist From d38bb3a00f3967200accc75ceea7f1cddf11a96a Mon Sep 17 00:00:00 2001 From: Liam Thompson Date: Fri, 21 Feb 2025 09:44:19 +0100 Subject: [PATCH 06/15] Fix toc --- get-started/index.md | 3 +-- get-started/toc.yml | 5 ++--- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/get-started/index.md b/get-started/index.md index 96402c7a3f..6c75256a67 100644 --- a/get-started/index.md +++ b/get-started/index.md @@ -1,5 +1,3 @@ -# Get started -======= --- mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro-what-is-es.html @@ -7,6 +5,7 @@ mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html - https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/index.html --- +# Get started {{es}} is the heart of the [Elastic Stack](the-stack.md). Combined with {{kib}}, it powers these Elastic solutions and use cases: diff --git a/get-started/toc.yml b/get-started/toc.yml index 0b7dc85a23..b5cae382dd 100644 --- a/get-started/toc.yml +++ b/get-started/toc.yml @@ -1,8 +1,7 @@ project: 'Get started' toc: - file: index.md - children: - - file: introduction.md - - file: the-stack.md + - file: introduction.md + - file: the-stack.md - file: deployment-options.md - file: versioning-availability.md \ No newline at end of file From 61557d26424e3b86f4b2d8d63833666cfbd0967c Mon Sep 17 00:00:00 2001 From: Liam Thompson Date: Fri, 21 Feb 2025 09:46:29 +0100 Subject: [PATCH 07/15] tweak --- get-started/versioning-availability.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/get-started/versioning-availability.md b/get-started/versioning-availability.md index b15289dfe8..dd8565a16f 100644 --- a/get-started/versioning-availability.md +++ b/get-started/versioning-availability.md @@ -20,7 +20,7 @@ It's important to understand this versioning system, for compatibility and [upgr Elastic products and features have different availability states across deployment types: -- **Generally Available**: Feature is production-ready +- **Generally Available**: Feature is production-ready (default if not specified) - **Beta**: Feature is complete but may have limitations - **Preview**: Feature is in early development - **Coming**: Feature is announced for a future release From a1bda011195b575ac255cfd79a5cbec2eab77fe5 Mon Sep 17 00:00:00 2001 From: Liam Thompson Date: Fri, 21 Feb 2025 13:43:41 +0100 Subject: [PATCH 08/15] tweak --- get-started/versioning-availability.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/get-started/versioning-availability.md b/get-started/versioning-availability.md index dd8565a16f..01761feb9d 100644 --- a/get-started/versioning-availability.md +++ b/get-started/versioning-availability.md @@ -6,7 +6,7 @@ navigation_title: Versioning and availability ## Elastic Stack versioning -Elasticsearch and the core components of the Elastic Stack use a semantic versioning scheme. This consists of three numbers separated by periods in the: `X.Y.Z`. +Elasticsearch and the core components of the Elastic Stack use a semantic versioning scheme. This scheme consists of three numbers separated by periods in the form `X.Y.Z`, for example: `9.0.0`. Each number represents a specific level of change: From dcae26bdfa9c431044d6f3a27fc27f5521e0dfac Mon Sep 17 00:00:00 2001 From: Liam Thompson <32779855+leemthompo@users.noreply.github.com> Date: Fri, 21 Feb 2025 16:30:12 +0100 Subject: [PATCH 09/15] Apply suggestions from code review Co-authored-by: Karen Metts <35154725+karenzone@users.noreply.github.com> --- get-started/index.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/get-started/index.md b/get-started/index.md index 6c75256a67..3f88363bab 100644 --- a/get-started/index.md +++ b/get-started/index.md @@ -19,10 +19,10 @@ Refer to our [customer success stories](https://www.elastic.co/customers/success ## First steps -Depending on your experience with Elastic, you might want to start with one of these resources: +Get started by learning about: -- Learn about [{{es}} and {{kib}}](introduction.md), the core components of the Elastic Stack. - - Learn about [the stack](/get-started/the-stack.md) to understand the relationship between core and optional components of an Elastic deployment. -- Learn about the [out-of-the-box solutions and use cases](/solutions/index.md) that Elastic supports. -- Learn how to [deploy Elastic](./deployment-options.md) for your use case. -- Understand how [versioning and availability](./versioning-availability.md) work with Elastic deployments. \ No newline at end of file +- [{{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. \ No newline at end of file From 2e44545413c399f8e38206c28e7379b55399258c Mon Sep 17 00:00:00 2001 From: Liam Thompson Date: Fri, 21 Feb 2025 16:35:11 +0100 Subject: [PATCH 10/15] Use variables --- get-started/introduction.md | 8 ++++---- get-started/versioning-availability.md | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/get-started/introduction.md b/get-started/introduction.md index f61a0765f2..7fac066993 100644 --- a/get-started/introduction.md +++ b/get-started/introduction.md @@ -1,10 +1,10 @@ --- mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro-what-is-es.html -navigation_title: "Elasticsearch and Kibana" +navigation_title: "{{ess}} and {{kib}}" --- -# Elasticsearch and Kibana [introduction] +# {{ess}} and {{kib}} [introduction] ## What is {{es}}? @@ -56,10 +56,10 @@ The {{stack}} is used for a wide and growing range of use cases. Here are a few - **Semantic search**: Understand the intent and contextual meaning behind search queries using tools like synonyms, dense vector embeddings, and learned sparse query-document expansion. - **Hybrid search**: Combine full-text search with vector search using state-of-the-art ranking algorithms. - **Build search experiences**: Add hybrid search capabilities to apps or websites, or build enterprise search engines over your organization’s internal data sources. -- **Retrieval augmented generation (RAG)**: Use Elasticsearch as a retrieval engine to supplement generative AI models with more relevant, up-to-date, or proprietary data for a range of use cases. +- **Retrieval augmented generation (RAG)**: Use {{ess}} as a retrieval engine to supplement generative AI models with more relevant, up-to-date, or proprietary data for a range of use cases. - **Geospatial search**: Search for locations and calculate spatial relationships using geospatial queries. -This is just a sample of search, observability, and security use cases enabled by Elasticsearch. Refer to Elastic [customer success stories](https://www.elastic.co/customers/success-stories) for concrete examples across a range of industries. +This is just a sample of search, observability, and security use cases enabled by {{ess}}. Refer to Elastic [customer success stories](https://www.elastic.co/customers/success-stories) for concrete examples across a range of industries. % TODO: cleanup these links, consolidate with Explore and analyze diff --git a/get-started/versioning-availability.md b/get-started/versioning-availability.md index 01761feb9d..9cb156e8b9 100644 --- a/get-started/versioning-availability.md +++ b/get-started/versioning-availability.md @@ -6,7 +6,7 @@ navigation_title: Versioning and availability ## Elastic Stack versioning -Elasticsearch and the core components of the Elastic Stack use a semantic versioning scheme. This scheme consists of three numbers separated by periods in the form `X.Y.Z`, for example: `9.0.0`. +{{ess}} and the core components of the Elastic Stack use a semantic versioning scheme. This scheme consists of three numbers separated by periods in the form `X.Y.Z`, for example: `9.0.0`. Each number represents a specific level of change: @@ -30,7 +30,7 @@ Elastic products and features have different availability states across deployme Features may have different availability states between: - Elastic Stack versions (for example, 9.0, 9.1) -- Serverless projects (Security, Elasticsearch, Observability) +- Serverless projects (Security, {{ess}}, Observability) - Deployment types (and versions) - [Elastic Cloud Hosted](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md) - [Elastic Cloud Serverless](/deploy-manage/deploy/elastic-cloud/serverless.md) From 739f1860dd2eccfec34f419a5563704d190ca492 Mon Sep 17 00:00:00 2001 From: Liam Thompson Date: Fri, 21 Feb 2025 16:39:44 +0100 Subject: [PATCH 11/15] Little fixes --- get-started/index.md | 6 ++++-- get-started/introduction.md | 3 +-- get-started/versioning-availability.md | 2 +- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/get-started/index.md b/get-started/index.md index 3f88363bab..ac7a0b1421 100644 --- a/get-started/index.md +++ b/get-started/index.md @@ -7,6 +7,8 @@ mapped_pages: --- # Get started +## Overview + {{es}} is the heart of the [Elastic Stack](the-stack.md). Combined with {{kib}}, it powers these Elastic solutions and use cases: * [Observability](/solutions/observability.md) @@ -17,11 +19,11 @@ mapped_pages: 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. ::: -## First steps +## Next steps Get started by learning about: -- [{{es}} and {{kib}}](introduction.md), the core components of the {{{stack}}}. +- [{{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. diff --git a/get-started/introduction.md b/get-started/introduction.md index 7fac066993..8fb48ab1ec 100644 --- a/get-started/introduction.md +++ b/get-started/introduction.md @@ -1,10 +1,9 @@ --- mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro-what-is-es.html -navigation_title: "{{ess}} and {{kib}}" --- -# {{ess}} and {{kib}} [introduction] +# {{es}} and {{kib}} [introduction] ## What is {{es}}? diff --git a/get-started/versioning-availability.md b/get-started/versioning-availability.md index 9cb156e8b9..347db56edb 100644 --- a/get-started/versioning-availability.md +++ b/get-started/versioning-availability.md @@ -6,7 +6,7 @@ navigation_title: Versioning and availability ## Elastic Stack versioning -{{ess}} and the core components of the Elastic Stack use a semantic versioning scheme. This scheme consists of three numbers separated by periods in the form `X.Y.Z`, for example: `9.0.0`. +{{es}} and the core components of the Elastic Stack use a semantic versioning scheme. This scheme consists of three numbers separated by periods in the form `X.Y.Z`, for example: `9.0.0`. Each number represents a specific level of change: From 8248f2d49e25770190df5487c9f0da9a4a202074 Mon Sep 17 00:00:00 2001 From: Liam Thompson Date: Fri, 21 Feb 2025 16:40:37 +0100 Subject: [PATCH 12/15] wrong variable --- get-started/versioning-availability.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/get-started/versioning-availability.md b/get-started/versioning-availability.md index 347db56edb..7d0eae975c 100644 --- a/get-started/versioning-availability.md +++ b/get-started/versioning-availability.md @@ -30,7 +30,7 @@ Elastic products and features have different availability states across deployme Features may have different availability states between: - Elastic Stack versions (for example, 9.0, 9.1) -- Serverless projects (Security, {{ess}}, Observability) +- Serverless projects (Security, {{es}}, Observability) - Deployment types (and versions) - [Elastic Cloud Hosted](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md) - [Elastic Cloud Serverless](/deploy-manage/deploy/elastic-cloud/serverless.md) From bbce78cfa38c5314d36b63c43f221c0763319525 Mon Sep 17 00:00:00 2001 From: Liam Thompson Date: Fri, 21 Feb 2025 17:35:20 +0100 Subject: [PATCH 13/15] Mention orchestration, cleanup, add comparison table subpage --- deploy-manage/deploy.md | 89 ++++++++++--------- deploy-manage/deploy/deployment-comparison.md | 57 ++++++++++++ deploy-manage/toc.yml | 1 + 3 files changed, 107 insertions(+), 40 deletions(-) create mode 100644 deploy-manage/deploy/deployment-comparison.md diff --git a/deploy-manage/deploy.md b/deploy-manage/deploy.md index 834bdf6945..ec0ce7b08d 100644 --- a/deploy-manage/deploy.md +++ b/deploy-manage/deploy.md @@ -4,8 +4,6 @@ mapped_urls: - https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro-deploy.html --- -# Deploy - % What needs to be done: Write from scratch % GitHub issue: https://github.com/elastic/docs-projects/issues/334 @@ -17,79 +15,90 @@ mapped_urls: % - [ ] ./raw-migrated-files/docs-content/serverless/intro.md % - [ ] ./raw-migrated-files/elasticsearch/elasticsearch-reference/elasticsearch-intro-deploy.md +# Deploy + Whether you're planning to use Elastic's pre-built solutions or Serverless projects, build your own applications with {{es}}, or analyze your data using {{kib}} tools, you'll need to deploy Elastic first. This page will help you understand your deployment options and choose the approach that best fits your needs. ## Core components -Every Elastic deployment requires Elasticsearch as its core data store and search/analytics engine. -Additionally, Kibana 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. +Every Elastic deployment requires {{es}} as its core data store and search/analytics engine. +Additionally, {{kib}} provides the user interface for all Elastic solutions and Serverless projects. It is required for most use cases, from data exploration to monitoring and security analysis. Your choice of deployment type determines how you'll set up and manage these core components, plus any additional components you need. -Elastic offers deployment options ranging from fully automated to fully self-managed. - :::{tip} Learn more about the [{{stack}}](/get-started/the-stack.md) to understand the core and optional components of an Elastic deployment. -::: +::: -## Deployment types overview +## Choosing your deployment type :::{include} _snippets/deployment-options-overview.md ::: -## Versioning and compatability - -In {{serverless-full}}, you automatically get access to the latest versions of Elastic features and you don't need to manage version compatibility. - -All other deployment types use stack versioning, where components are tested and versioned together to ensure compatibility. ECE and ECK have their own deployment versions, in addition to stack versioning. +### Who manages the infrastructure? -Consider this when choosing your deployment type: +#### Managed by Elastic -- Choose Serverless if you want automatic access to the latest features and don't want to manage version compatibility -- Choose other deployment types if you need more control over version management +If you want to focus on using Elastic products rather than managing infrastructure, choose: -:::{tip} -Learn more about [versioning and availability](/get-started/versioning-availability.md). -::: +- **Serverless**: Zero operational overhead, automatic scaling and updates, latest features +- **Cloud hosted**: Balance of control and managed operations, choice of resources and regions -## Choose your deployment path +#### Self-managed options -Your deployment choice determines how you'll set up and manage these components. +If you need to run Elastic on your infrastructure, choose between a fully self-managed deployment or using an orchestrator: -### Step 1: Who manages the infrastructure? +- **Fully self-managed**: Complete control and responsibility for your Elastic deployment +- **With orchestration**: + - **Elastic Cloud on Kubernetes (ECK)**: If you need Kubernetes-native orchestration + - **Elastic Cloud Enterprise (ECE)**: If you need a multi-tenant orchestration platform -#### Managed by Elastic +:::::{note} +:::{dropdown} About orchestration -If you want to focus on using Elastic products rather than managing infrastructure, choose: +An orchestrator automates the deployment and management of multiple Elastic clusters, handling tasks like scaling, upgrades, and monitoring. -- **Serverless**: Zero operational overhead, automatic scaling and updates, latest features -- **Cloud hosted**: Balance of control and managed operations, choice of resources and regions +Consider orchestration if you: +- Need to manage multiple Elastic clusters +- Want automated operations at scale +- Have a Kubernetes environment (ECK) +- Need to build a multi-tenant platform (ECE) -#### Self-managed with your infrastructure +Orchestrators manage the lifecycle of your Elastic deployments but don't change how the core products work. When using ECK or ECE: +- You'll still use the same Elasticsearch and Kibana features and configurations +- Most product documentation remains applicable +- You can add other Elastic products as needed +- The orchestrator handles operational tasks while you focus on using and configuring the products -If you need to run Elastic on your infrastructure, you have three options: +::::{tip} +Documentation will specify when certain features or configurations are not applicable to specific deployment types. +:::: +::: +::::: -- **Basic self-managed**: Direct control over all aspects of deployment -- **Elastic Cloud on Kubernetes (ECK)**: Kubernetes-native orchestration -- **Elastic Cloud Enterprise (ECE)**: Multi-tenant orchestration platform +### Versioning and compatibility -### Step 2: For self-managed - do you need orchestration? +In {{serverless-full}}, you automatically get access to the latest versions of Elastic features and you don't need to manage version compatibility. -If you chose self-managed, consider whether you need orchestration: +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. -- **No orchestration needed**: - Choose basic self-managed deployment for full control and direct management +Consider this when choosing your deployment type: -- **Kubernetes environment**: - Use ECK for native Kubernetes orchestration and automated operations +- Choose Serverless if you want automatic access to the latest features and don't want to manage version compatibility +- Choose other deployment types if you need more control over version management -- **Multi-tenant platform**: - Use ECE to deploy {{ecloud}} on your own infrastructure +:::{tip} +Learn more about [versioning and availability](/get-started/versioning-availability.md). +::: -## Cost considerations +### Cost considerations - **Serverless**: Pay for what you use - **Cloud hosted**: Subscription-based with resource allocation - **Self-managed options**: Infrastructure costs plus operational overhead mean a higher total cost of ownership (TCO) + +:::::{tip} +For a detailed comparison of features and capabilities across deployment types, see the [Deployment comparison reference](./deploy/deployment-comparison.md). +::::: \ No newline at end of file diff --git a/deploy-manage/deploy/deployment-comparison.md b/deploy-manage/deploy/deployment-comparison.md new file mode 100644 index 0000000000..c4e4bec293 --- /dev/null +++ b/deploy-manage/deploy/deployment-comparison.md @@ -0,0 +1,57 @@ + +# Deployment comparison reference + +This reference provides detailed comparisons of features and capabilities across Elastic's deployment options: self-managed deployments, Elastic Cloud Hosted, and Serverless. For a high-level overview of deployment types and guidance on choosing between them, see the [overview](../deploy.md). + +## Security features + +| Feature/capability | Self-managed | Elastic Cloud Hosted | Serverless | +|-------------------|-------------|--------------------------------|-------------------------| +| Custom security configurations | Yes | Limited | No | +| Authentication realms and custom roles | Yes | Yes | No | +| Audit logging | Yes | Yes | No | + +## Management features + +| Feature/capability | Self-managed | Elastic Cloud Hosted | Serverless | +|-------------------|-------------|--------------------------------|-------------------------| +| Full control over configuration | Yes | Limited | No | +| Infrastructure flexibility | Yes | No | No | +| Autoscaling | No | Yes | Yes | +| Data tiers management | No | Yes | No | +| Snapshot management | No | Yes | No | +| High availability and disaster recovery | Yes | Yes | Yes | +| Multi-cloud support | No | Yes | Yes | +| Shard management and replicas | Yes | Yes | No | + +## Monitoring features + +| Feature/capability | Self-managed | Elastic Cloud Hosted | Serverless | +|-------------------|-------------|--------------------------------|-------------------------| +| Watcher | Yes | Yes | No | + +## Data lifecycle features + +| Feature/capability | Self-managed | Elastic Cloud Hosted | Serverless | +|-------------------|-------------|--------------------------------|-------------------------| +| Index lifecycle management (ILM) | Yes | Yes | No (uses data streams) | +| Data tiers management | No | Yes | No | +| Snapshot management | No | Yes | No | + +## Integration features + +| Feature/capability | Self-managed | Elastic Cloud Hosted | Serverless | +|-------------------|-------------|--------------------------------|-------------------------| +| Custom plugins | Yes | No | No | +| Self-managed connectors | Yes | No | Limited | +| Elasticsearch-Hadoop integration | Yes | Yes | No | +| Cross cluster search (CCS) | Yes | Yes | No | +| Cross cluster replication | Yes | Yes | Yes | + +## Development and testing features + +| Feature/capability | Self-managed | Elastic Cloud Hosted | Serverless | +|-------------------|-------------|--------------------------------|-------------------------| +| Advanced testing and development | Yes | No | No | +| Java (JVM) customization | Yes | No | No | + diff --git a/deploy-manage/toc.yml b/deploy-manage/toc.yml index e869e0adda..d3d0fbc290 100644 --- a/deploy-manage/toc.yml +++ b/deploy-manage/toc.yml @@ -24,6 +24,7 @@ toc: - file: distributed-architecture/kibana-tasks-management.md - file: deploy.md children: + - file: deploy/deployment-comparison.md - file: deploy/elastic-cloud.md children: - file: deploy/elastic-cloud/create-an-organization.md From daf797490f8eb4ef9b2fc4412ce3c196f3c3a36c Mon Sep 17 00:00:00 2001 From: Liam Thompson Date: Fri, 21 Feb 2025 17:55:55 +0100 Subject: [PATCH 14/15] say hosted --- deploy-manage/deploy.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/deploy-manage/deploy.md b/deploy-manage/deploy.md index ec0ce7b08d..2802fa92f0 100644 --- a/deploy-manage/deploy.md +++ b/deploy-manage/deploy.md @@ -46,7 +46,7 @@ If you want to focus on using Elastic products rather than managing infrastructu - **Serverless**: Zero operational overhead, automatic scaling and updates, latest features - **Cloud hosted**: Balance of control and managed operations, choice of resources and regions -#### Self-managed options +#### Self-hosted options If you need to run Elastic on your infrastructure, choose between a fully self-managed deployment or using an orchestrator: @@ -97,7 +97,7 @@ Learn more about [versioning and availability](/get-started/versioning-availabil - **Serverless**: Pay for what you use - **Cloud hosted**: Subscription-based with resource allocation -- **Self-managed options**: Infrastructure costs plus operational overhead mean a higher total cost of ownership (TCO) +- **Self-hosted options**: Infrastructure costs plus operational overhead mean a higher total cost of ownership (TCO) :::::{tip} For a detailed comparison of features and capabilities across deployment types, see the [Deployment comparison reference](./deploy/deployment-comparison.md). From 712d5f4a950247f3b921052b1b8268fc88504ebb Mon Sep 17 00:00:00 2001 From: Liam Thompson <32779855+leemthompo@users.noreply.github.com> Date: Mon, 24 Feb 2025 10:54:11 +0100 Subject: [PATCH 15/15] Apply suggestions from code review Co-authored-by: florent-leborgne --- deploy-manage/_snippets/deployment-options-overview.md | 10 ++++------ get-started/versioning-availability.md | 4 ++-- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/deploy-manage/_snippets/deployment-options-overview.md b/deploy-manage/_snippets/deployment-options-overview.md index 7833432eca..4d370bc7b9 100644 --- a/deploy-manage/_snippets/deployment-options-overview.md +++ b/deploy-manage/_snippets/deployment-options-overview.md @@ -1,12 +1,10 @@ -**Quick start option** +**Quick start options** +* [**Elastic Cloud**](/deploy-manage/deploy/elastic-cloud.md): Get a hosted solution up and running in minutes. + * [**Elastic Cloud Hosted**](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md): Our hosted Elastic Stack offering, deployed in the cloud with your provider of choice. Sign up for a [14-day free trial](https://cloud.elastic.co/registration). + * [**Elastic Cloud Serverless**](/deploy-manage/deploy/elastic-cloud/serverless.md): Create serverless projects for autoscaled and fully managed Elastic deployments. Sign up for a [14-day free trial](https://cloud.elastic.co/serverless-registration). * [**Local development**](/solutions/search/run-elasticsearch-locally.md): Get started quickly with {{es}} and {{kib}} in Docker for local development and testing. -**Hosted options** - -* [**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). -* [**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). - **Advanced options** * [**Self-managed**](/deploy-manage/deploy/self-managed.md): Install, configure, and run Elastic on your own premises. diff --git a/get-started/versioning-availability.md b/get-started/versioning-availability.md index 7d0eae975c..fb859ed04f 100644 --- a/get-started/versioning-availability.md +++ b/get-started/versioning-availability.md @@ -21,8 +21,8 @@ It's important to understand this versioning system, for compatibility and [upgr Elastic products and features have different availability states across deployment types: - **Generally Available**: Feature is production-ready (default if not specified) -- **Beta**: Feature is complete but may have limitations -- **Preview**: Feature is in early development +- **Beta**: Feature is nearing general availability but is not yet ready for production usage +- **Technical preview**: Feature is in early development - **Coming**: Feature is announced for a future release - **Discontinued**: Feature is being phased out - **Unavailable**: Feature is not supported in this deployment type or version