Skip to content
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.

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

Add known issue for PipelineBusv2 to 8.15.x release notes #16661

Merged
merged 5 commits into from
Nov 11, 2024

Conversation

yaauie
Copy link
Member

@yaauie yaauie commented Nov 8, 2024

Release notes

[rn: skip]

What does this PR do?

Adds release notes for the #16657 known issue in v2 of the pipeline bus which can prevent shutdown.

@yaauie yaauie added the docs label Nov 8, 2024
@yaauie yaauie requested a review from karenzone November 8, 2024 22:26
@robbavey
Copy link
Member

robbavey commented Nov 8, 2024

@yaauie Can you update the issue name please - the automatic issue namer kicked in with the two commits

@yaauie yaauie changed the title Yaauie pipelinebusv2 known issue 8 15 Add known issue for PipelineBusv2 to 8.15.x release notes Nov 8, 2024
Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

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

I left suggestions for consideration and discussion in the 8.15.0 section.
When we nail down the content, we can add it to other sections.
LMKWYT

docs/static/releasenotes.asciidoc Outdated Show resolved Hide resolved
docs/static/releasenotes.asciidoc Outdated Show resolved Hide resolved
docs/static/releasenotes.asciidoc Outdated Show resolved Hide resolved
Copy link
Member Author

@yaauie yaauie left a comment

Choose a reason for hiding this comment

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

copy-pasted the deltas in review from 8.15.0 to the other sections, and removed a duplicate link to the issue.

In the 8.15.1 notes, this entry is bulleted but otherwise unchanged.

docs/static/releasenotes.asciidoc Outdated Show resolved Hide resolved
docs/static/releasenotes.asciidoc Outdated Show resolved Hide resolved
docs/static/releasenotes.asciidoc Outdated Show resolved Hide resolved
docs/static/releasenotes.asciidoc Outdated Show resolved Hide resolved
docs/static/releasenotes.asciidoc Outdated Show resolved Hide resolved
@yaauie yaauie requested a review from karenzone November 11, 2024 19:20
Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

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

I had added comments that we had double entries for 8.15.1 and no entries for 8.15.2, but it appears that issue got resolved while I was reviewing.

Now it appears that the only change needed is to remove the + but keep the line as indicated inline.

I think we're close, but I'll verify in the preview and then sign off.

docs/static/releasenotes.asciidoc Outdated Show resolved Hide resolved
docs/static/releasenotes.asciidoc Outdated Show resolved Hide resolved
docs/static/releasenotes.asciidoc Outdated Show resolved Hide resolved
@@ -172,6 +196,14 @@ If this situation occurs, {ls} may fail to start or some plugins may use a malfo
Check out issue https://github.com/elastic/logstash/issues/16437[#16437] for details.
+
Workaround: Downgrade to {ls} 8.15.0, or temporarily avoid using environment and keystore variable references.
* **{ls} can fail to shut down under some circumstances when you are using <<pipeline-to-pipeline>>.**
Check out issue https://github.com/elastic/logstash/issues/16657[#16657] for details.
+
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
+

Copy link
Member Author

Choose a reason for hiding this comment

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

I think this one is necessary because it's in a bulleted list?

Copy link
Contributor

@karenzone karenzone Nov 11, 2024

Choose a reason for hiding this comment

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

I suggested removing the bullet because it was a single item. When the bullet went away, the + needed to go away, too, to avoid it rendering.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ideally, the + should go, but the line should remain to force rendering into two distinct paragraphs.

Copy link
Contributor

@karenzone karenzone Nov 11, 2024

Choose a reason for hiding this comment

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

This is what it looks like now. Not the worst, but not the best.

Screen Shot 2024-11-11 at 4 38 12 PM

docs/static/releasenotes.asciidoc Outdated Show resolved Hide resolved
Copy link
Member Author

@yaauie yaauie left a comment

Choose a reason for hiding this comment

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

Trailing newline consistency before next header

docs/static/releasenotes.asciidoc Show resolved Hide resolved
docs/static/releasenotes.asciidoc Show resolved Hide resolved
docs/static/releasenotes.asciidoc Show resolved Hide resolved
docs/static/releasenotes.asciidoc Outdated Show resolved Hide resolved
formatting:
- plus-to-continue only in lists,
- consistency of linebreaks before next section

Co-authored-by: Karen Metts <[email protected]>
Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

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

LGTM. Let's go with what we have.
I'll tweak it later.

@yaauie yaauie merged commit e17ad0c into 8.15 Nov 11, 2024
5 checks passed
@yaauie yaauie deleted the yaauie-pipelinebusv2-known-issue-8-15 branch November 11, 2024 22:25
@karenzone
Copy link
Contributor

@logstashmachine backport 8.16

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants