Skip to content

Add prerequisites doc section. #211

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 8, 2025
Merged

Add prerequisites doc section. #211

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
813b6fd
Add prerequisites doc section.
mashhurs Dec 19, 2024
54604ad
Apply suggestions from code review
mashhurs Jan 7, 2025
a7c484d
Update docs/index.asciidoc
mashhurs Jan 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
- Releases from `main` are not desired until we get closer to Stack 9.x, and beginning the changelog with something other than release notes matching the version will prevent the plugin release tooling from allowing publication.

## 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)
Expand Down
6 changes: 5 additions & 1 deletion docs/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,11 @@ 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}-prerequisites"]
===== Prerequisites
- This plugin embeds portions of Elasticsearch Ingest Node whose version matches the `major`.`minor` version of the plugin.
- When upgrading the {stack} product(s), this plugin should be upgraded _before_ {kib} to ensure that {agent}-managed pipelines have access to the expected functionality.
- This plugin requires minimum Java 17 with its `8.x` versions and Java 21 with its `9.x` versions.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[id="plugins-{type}s-{plugin}-prerequisites"]
===== Prerequisites
- This plugin embeds portions of Elasticsearch Ingest Node whose version matches the `major`.`minor` version of the plugin.
- When upgrading the {stack} product(s), this plugin should be upgraded _before_ {kib} to ensure that {agent}-managed pipelines have access to the expected functionality.
- This plugin requires minimum Java 17 with its `8.x` versions and Java 21 with its `9.x` versions.
[id="plugins-{type}s-{plugin}-prerequisites"]
===== Prerequisites
- This plugin embeds functionality from the version of {es} Ingest Node matching the `major`.`minor` version of this plugin.
- When upgrading the {stack}, ensure that this plugin is upgraded _before_ upgrading {kib} to ensure the best experience with {agent}-managed pipelines.
- This plugin requires {ls} to run with a minimum of Java 17 with its `8.x` versions and Java 21 with its `9.x` versions.

Some wording suggestions:

  • Replaces Elasticsearch with {es}
  • An attempt to clarify upgrade clause. I suspect @karenzone might have something better here
  • Clarify that Logstash needs to run a minimum of Java 17

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@karenzone if you can please add/udpate on top of Rob's change, I will push the final one and merge. Thank you!

Copy link
Contributor

@karenzone karenzone Jan 8, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we arrive on something different we want to try, I can add it as a suggestion. While we're deciding, I'm pasting what I have here so that I don't lose it.

UPDATE: Replaced by GitHub suggestion. This old stuff here was just noise.


[id="plugins-{type}s-{plugin}-es-tips"]
===== Using `filter-elastic_integration` with `output-elasticsearch`
Expand Down