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 docs for Kafka output UI for Fleet managed agents #336

Merged
merged 15 commits into from
Aug 14, 2023

Conversation

kilfoyle
Copy link
Contributor

@kilfoyle kilfoyle commented Jul 18, 2023

This adds docs for the new Kafka output settings UI

Preview site

Closes: #68

@kilfoyle kilfoyle marked this pull request as draft July 18, 2023 17:44
@mergify
Copy link
Contributor

mergify bot commented Jul 18, 2023

This pull request does not have a backport label. Could you fix it @kilfoyle? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

@mergify
Copy link
Contributor

mergify bot commented Aug 2, 2023

This pull request is now in conflict. Could you fix it @kilfoyle? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch <remote-repo>
git checkout -b 68/kafka-output <remote-repo>/68/kafka-output
git merge <remote-repo>/main
git push <remote-repo> 68/kafka-output

@kilfoyle kilfoyle marked this pull request as ready for review August 2, 2023 16:57
@kilfoyle
Copy link
Contributor Author

kilfoyle commented Aug 3, 2023

Removed the Channel Buffer Size parameter per elastic/kibana#162875 (comment)

@criamico
Copy link
Contributor

criamico commented Aug 7, 2023

Hi @kilfoyle, I think it would be good to involve @szwarckonrad in this review as he actually worked on implementing the feature so he has more in-depth knowledge of the kafka options. I'll request his review as well.

@kilfoyle
Copy link
Contributor Author

kilfoyle commented Aug 7, 2023

@faec Would you mind taking a look at these descriptions of the Kafka authentication settings, just to be sure I'm on the right track?

@kilfoyle kilfoyle requested a review from faec August 7, 2023 17:35
Copy link
Contributor

@juliaElastic juliaElastic left a comment

Choose a reason for hiding this comment

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

LGTM overall, haven't checked the Kafka settings in detail.
It would be nice to add some screenshots about where to find the Add output button in Fleet settings, and how the Add new output flyout looks like. Though the instructions are there as text, so that's fine too.

@szwarckonrad
Copy link

Looks great! I've added a few comments - just some suggestions on how we might enhance clarity.

Another consideration arose today - whenever an user selects the Kafka output type, we will display the warning detailed in this ticket and depicted in this pull request.

@kilfoyle
Copy link
Contributor Author

kilfoyle commented Aug 10, 2023

Thanks for the excellent feedback!

@szwarckonrad I adopted all your suggestions (via f0e68b3) and added a tip at the top of the docs page Kafka output is currently not supported on {agents} using the {elastic-defend} integration..

@juliaElastic Good idea to add a graphic. I've added one to help people find the Add output button. I didn't add the Add new output UI itself. We try to minimize showing larger UIs since they change frequently and the docs can go out of sync easily.

@kilfoyle kilfoyle merged commit 2014425 into elastic:main Aug 14, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Elastic Agent] Document Kafka Output UI for fleet managed agents
5 participants