Quick reference
This content is still in development. If you have questions about how to write cumulative documentation while contributing, reach out to @elastic/docs in the related GitHub issue or PR.
The applies_to directive uses the following format:
<key>: <lifecycle> <version>
This page provides minimal reference information on the applies_to directive. For more detailed information, refer to the applies_to syntax guide.
applies_to accepts the following keys in this structure.
serverless: Applies to Elastic Cloud Serverless.security: Applies to Serverless security projects.elasticsearch: Applies to Serverless search projects.observability: Applies to Serverless observability projects.
stack: Applies to the Elastic Stack including any Elastic Stack components.deployment: Applies to some deployment type(s).ece: Applies to Elastic Cloud Enterprise deployments.eck: Applies to Elastic Cloud on Kubernetes deployments.self: Applies to self-managed deployments.ess: Applies to Elastic Cloud Hosted deployments.
product: Applies to a specific product that uses a unique versioning scheme (for example, notstack,ece,eck).apm_agent_dotnet: Applies to the Elastic APM .NET agent.apm_agent_go: Applies to the Elastic APM Go agent.apm_agent_java: Applies to the Elastic APM Java agent.apm_agent_node: Applies to the Elastic APM Node.js agent.apm_agent_php: Applies to the Elastic APM PHP agent.apm_agent_python: Applies to the Elastic APM Python agent.apm_agent_ruby: Applies to the Elastic APM Ruby agent.apm_agent_rum: Applies to the APM RUM JavaScript agent.curator: Applies to Elasticsearch Curator (Curator).ecctl: Applies to Elastic cloud control (ECCTL).edot_android: Applies to the Elastic Distribution of OpenTelemetry Android (EDOT Android).edot_cf_aws: Applies to the Elastic Distribution of OpenTelemetry Cloud Forwarder (EDOT Cloud Forwarder).edot_cf_azure: Applies to the Elastic Distribution of OpenTelemetry Cloud Forwarder (EDOT Cloud Forwarder).edot_collector: Applies to the Elastic Distribution of OpenTelemetry Collector (EDOT Collector).edot_dotnet: Applies to the Elastic Distribution of OpenTelemetry .NET (EDOT .NET).edot_ios: Applies to the Elastic Distribution of OpenTelemetry iOS (EDOT iOS).edot_java: Applies to the Elastic Distribution of OpenTelemetry Java (EDOT Java).edot_node: Applies to the Elastic Distribution of OpenTelemetry Node.js (EDOT Node.js).edot_php: Applies to the Elastic Distribution of OpenTelemetry PHP (EDOT PHP).edot_python: Applies to the Elastic Distribution of OpenTelemetry Python (EDOT Python).
The product key and its subkeys are used to indicate feature availability and applicability. The similarly named products frontmatter field is used to drive elastic.co search filters.
applies_to accepts the following lifecycle states:
previewbetagadeprecatedremovedunavailable
applies_to accepts the following version formats:
Major.MinorMajor.Minor.Patch
Regardless of the version format used in the source file, the version number is always rendered in the Major.Minor.Patch format.
Automatic Version Sorting: When you specify multiple versions for the same product, the build system automatically sorts them in descending order (highest version first) regardless of the order you write them in the source file. For example, stack: ga 8.18.6, ga 9.1.2, ga 8.19.2, ga 9.0.6 will be displayed as stack: ga 9.1.2, ga 9.0.6, ga 8.19.2, ga 8.18.6. Items without versions (like ga without a version or all) are sorted last.