Add prerequisites doc section. #211
Merged
+9
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
yaauie
requested changes
Jan 7, 2025
Co-authored-by: Ry Biesemeyer <[email protected]>
yaauie
previously approved these changes
Jan 7, 2025
robbavey
reviewed
Jan 7, 2025
docs/index.asciidoc
Outdated
Comment on lines
50
to
54
| [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. |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
@karenzone if you can please add/udpate on top of Rob's change, I will push the final one and merge. Thank you!
There was a problem hiding this comment.
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.
karenzone
reviewed
Jan 8, 2025
An awesome review from Karen! Co-authored-by: Karen Metts <[email protected]>
💚 Build Succeeded
History
|
|
@logstashmachine backport 8.x |
github-actions bot
pushed a commit
that referenced
this pull request
Jan 8, 2025
* Add prerequisites doc section. * Apply suggestions from code review Co-authored-by: Ry Biesemeyer <[email protected]> * Update docs/index.asciidoc An awesome review from Karen! Co-authored-by: Karen Metts <[email protected]> --------- Co-authored-by: Ry Biesemeyer <[email protected]> Co-authored-by: Karen Metts <[email protected]> (cherry picked from commit ade61e5)
mashhurs
added a commit
that referenced
this pull request
Jan 8, 2025
* Add prerequisites doc section. * Apply suggestions from code review Co-authored-by: Ry Biesemeyer <[email protected]> * Update docs/index.asciidoc An awesome review from Karen! Co-authored-by: Karen Metts <[email protected]> --------- Co-authored-by: Ry Biesemeyer <[email protected]> Co-authored-by: Karen Metts <[email protected]> (cherry picked from commit ade61e5) Co-authored-by: Mashhur <[email protected]>
|
@logstashmachine backport 8.16 |
github-actions bot
pushed a commit
that referenced
this pull request
Jan 8, 2025
* Add prerequisites doc section. * Apply suggestions from code review Co-authored-by: Ry Biesemeyer <[email protected]> * Update docs/index.asciidoc An awesome review from Karen! Co-authored-by: Karen Metts <[email protected]> --------- Co-authored-by: Ry Biesemeyer <[email protected]> Co-authored-by: Karen Metts <[email protected]> (cherry picked from commit ade61e5)
mashhurs
added a commit
that referenced
this pull request
Jan 8, 2025
* Add prerequisites doc section. * Apply suggestions from code review Co-authored-by: Ry Biesemeyer <[email protected]> * Update docs/index.asciidoc An awesome review from Karen! Co-authored-by: Karen Metts <[email protected]> --------- Co-authored-by: Ry Biesemeyer <[email protected]> Co-authored-by: Karen Metts <[email protected]> (cherry picked from commit ade61e5) Co-authored-by: Mashhur <[email protected]>
|
@logstashmachine backport 8.17 |
github-actions bot
pushed a commit
that referenced
this pull request
Jan 8, 2025
* Add prerequisites doc section. * Apply suggestions from code review Co-authored-by: Ry Biesemeyer <[email protected]> * Update docs/index.asciidoc An awesome review from Karen! Co-authored-by: Karen Metts <[email protected]> --------- Co-authored-by: Ry Biesemeyer <[email protected]> Co-authored-by: Karen Metts <[email protected]> (cherry picked from commit ade61e5)
mashhurs
added a commit
that referenced
this pull request
Jan 8, 2025
* Add prerequisites doc section. * Apply suggestions from code review Co-authored-by: Ry Biesemeyer <[email protected]> * Update docs/index.asciidoc An awesome review from Karen! Co-authored-by: Karen Metts <[email protected]> --------- Co-authored-by: Ry Biesemeyer <[email protected]> Co-authored-by: Karen Metts <[email protected]> (cherry picked from commit ade61e5) Co-authored-by: Mashhur <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This change adds a prerequisites doc section to list up its requirements/expectations.