Skip to content

Latest commit

 

History

History
171 lines (126 loc) · 6.37 KB

versioning-availability.md

File metadata and controls

171 lines (126 loc) · 6.37 KB
navigation_title mapped_pages
Versioning and availability

Understanding versioning and availability

On this page, you'll learn about our versioning systems, how to understand how we talk about versions and feature availability in our documentation, and where to find docs for your product version.

Elastic Stack versioning

{{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:

  • 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 planning.

Availability of features

Elastic products and features have different availability states across deployment types and lifecycle stages.

Features may have different availability states between:

  • Deployment type: The environment where the feature is available (Stack, Serverless, ECE, ECK, etc.)
  • Lifecycle state: The development or support status of the feature (GA, Beta, etc.)
  • Version: The specific version the lifecycle state applies to

Lifecycle states

State Description
Generally Available (GA) Production-ready feature (default if not specified)
Beta Feature is nearing general availability but not yet production-ready
Technical preview Feature is in early development stage
Coming Feature announced for a future release
Discontinued Feature is being phased out
Unavailable Feature is not supported in this deployment type or version

Where feature availability may differ

Features may have different states between:

Important tips when reading the docs

  • Always check feature lifecycle state for your specific deployment type and version
  • Pay attention to Elastic Stack version requirements
  • Note that Serverless features may vary by project type

Availability badges in the docs

Our documentation uses badges to help you quickly identify where and when features are available for your specific environment.

Badges can appear in two places:

  1. Page headers: Shows the overall availability across all deployment types
  2. Section headers: Indicates specific availability for content in that section

How to read the badges

Here are some examples to help you understand how to read the availability badges.

Example #1: Stack only feature

stack: ga 9.1
  • Deployment type: Elastic Stack
  • Version: 9.1
  • Lifecycle: Generally Available (GA) — default state

Example #2: Serverless-only feature with project differences

serverless:
  security: beta
  elasticsearch: ga
  • Deployment type: Serverless
  • Lifecycle:
    • Beta for Security projects
    • Generally Available for Elasticsearch projects

Example #3: Discontinued feature on one deployment type

deployment:
  ece: discontinued 4.1.0
  • Deployment type: Elastic Cloud Enterprise
  • Lifecycle: Discontinued
  • Version: 4.1.0

:::{tip} For contributors and those interested in the technical details, see the Elastic docs syntax guide for more information on how these badges are implemented. :::

Find docs for your product version

In April 2025, we released our new documentation site. This site includes documentation for our latest product versions.

You can access the previous version of a page, where available, by clicking the View previous version link in the sidebar.

% not sure about curator

The following products versions are documented on this site:

Core products and deployment methods

Product Version
{{stack}}

Includes {{es}}, {{kib}}, {{ls}}, {{fleet}},
{{agent}}, Beats, APM, and query languages		 9.0.0+
Security solution 9.0.0+
Observability solution 9.0.0+
{{serverless-full}} (all project types) All
{{ech}} All*
{{ece}} 4.0.0+
{{eck}} 3.0.0+

* Excludes release notes before January 2025

Schemas, libraries, and tools

Product Version
Elastic Common Schema 9.0.0+
ECS logging Java library 1.x+
Other ECS logging libraries All
{{es}} API clients 9.0.0+
{{es}} for Apache Hadoop 9.0.0+
Curator 8.0+
Elastic Cloud Control (ECCTL) 1.14+
Elastic Serverless Forwarder All
Elastic integrations All
Elastic Search UI library All

APM agents and tools

Product Version
APM Android agent 1.x+
APM .NET agent 1.x+
APM Go agent 2.x+
APM iOS agent 1.x+
APM Java agent 1.x+
APM Node.js agent 4.x+
APM PHP agent All
APM Python agent 6.x+
APM Ruby agent 4.x+
APM Real User Monitoring JavaScript agent 5.x+
APM attacher for Kubernetes All