From 2cce510dfa10cd902de5d1fa0ee29c71e8a93be1 Mon Sep 17 00:00:00 2001 From: Mashhur <99575341+mashhurs@users.noreply.github.com> Date: Tue, 7 Jan 2025 17:11:07 -0800 Subject: [PATCH] Add prerequisites doc section. (#211) * Add prerequisites doc section. * Apply suggestions from code review Co-authored-by: Ry Biesemeyer * Update docs/index.asciidoc An awesome review from Karen! Co-authored-by: Karen Metts <35154725+karenzone@users.noreply.github.com> --------- Co-authored-by: Ry Biesemeyer Co-authored-by: Karen Metts <35154725+karenzone@users.noreply.github.com> (cherry picked from commit ade61e50fa611daaa40aba134bee4f94c3c13e4a) --- CHANGELOG.md | 2 +- docs/index.asciidoc | 9 ++++++++- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 830f5e3d..ca78b2dc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,7 @@ - Compatible with Logstash 8.15+ ## 0.1.17 - - Add `x-elastic-product-origin` header to Elasticsearch requests [#197](https://github.com/elastic/logstash-filter-elastic_integration/pull/197) + - Add `x-elastic-product-origin` header to Elasticsearch requests [#197](https://github.com/elastic/logstash-filter-elastic_integration/pull/197) ## 0.1.16 - Reflects the Elasticsearch GeoIP changes into the plugin and syncs with Elasticsearch 8.16 branch [#170](https://github.com/elastic/logstash-filter-elastic_integration/pull/170) diff --git a/docs/index.asciidoc b/docs/index.asciidoc index d8e986d4..3d96e233 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -47,7 +47,14 @@ NOTE: Some multi-pipeline configurations such as logstash-to-logstash over http( Events that _fail_ ingest pipeline processing will be tagged with `_ingest_pipeline_failure`, and their `[@metadata][_ingest_pipeline_failure]` will be populated with details as a key/value map. -IMPORTANT: This plugin requires minimum Java 17 and Logstash 8.7.0 versions. +[id="plugins-{type}s-{plugin}-requirements"] +===== Requirements and upgrade guidance + +- This plugin requires Java 17 minimum with {ls} `8.x` versions and Java 21 minimum with {ls} `9.x` versions. +- When you upgrade the {stack}, upgrade {ls} (or this plugin specifically) _before_ you upgrade {kib}. + (Note that this requirement is a departure from the typical {stack} https://www.elastic.co/guide/en/elastic-stack/current/installing-elastic-stack.html#install-order-elastic-stack[installation order].) ++ +The {es}-{ls}-{kib} installation order ensures the best experience with {agent}-managed pipelines, and embeds functionality from a version of {es} Ingest Node that is compatible with the plugin version (`major`.`minor`). [id="plugins-{type}s-{plugin}-es-tips"] ===== Using `filter-elastic_integration` with `output-elasticsearch`