-
Notifications
You must be signed in to change notification settings - Fork 110
Update the docs about Journald support. #1272
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
Update the docs about Journald support. #1272
Conversation
Co-authored-by: Copilot <[email protected]>
@kilfoyle this PR introduce docs that are only valid for the next release, we're adding |
Good question! The goal is to have different versions included in the same set of docs. When we add a new page or section that applies to a specific version, we can use these applies_to tags to indicate that. For changes that don't include a new section or page, we're supposed to mention the version right in the text, so I added To avoid including future (say 9.1) changes in the current docs, the plan is to introduce Add: I checked with another team and, for now, they're also staging their docs PRs affecting 9.1, with a plan to merge them all when the release goes live. |
Co-authored-by: David Kilfoyle <[email protected]>
🔍 Preview links for changed docs: 🔔 The preview site may take up to 3 minutes to finish building. These links will become live once it completes. |
…ate-journald-docker-docs
…wr/docs-content into 44040-update-journald-docker-docs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates the documentation to clarify which containerized Elastic Agent flavors include journald dependencies, and adds the appropriate version annotation.
- Adds a
{applies_to}
directive to note that journald support in the servers flavor is available since GA 9.1. - Moves the journald dependency note out of the complete flavor paragraph and into its own line.
- Separates concerns of synthetics dependencies and journald support for clarity.
Comments suppressed due to low confidence (1)
reference/fleet/install-elastic-agents.md:118
- [nitpick] Consider adding a
{applies_to}
directive here to indicate that journald support in the complete flavor is also available starting from GA 9.1, for consistency with the servers flavor.
The complete {{agent}} flavor also includes the [journald](https://www.freedesktop.org/software/systemd/man/latest/systemd-journald.service.html) dependences necessary to use the [journald input](beats://reference/filebeat/filebeat-input-journald.md).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! 🚀
@belimawr, based on our versioning discussions, it sounds like we should add a 9.1 label so that we can revisit if necessary when we nail down our versioning strategy. |
What do you mean? How is this label added? Isn't the applies to enough?
|
🔍 Preview links for changed docs |
This PR updates the docs stating in which Container variantes the Journald dependencies are shipped, allowing Elastic-Agent to run inputs/integrations that read from journald like: system, journald and iptables.
The changes on this PR need to be released together with elastic/elastic-agent#7995 and its backports.
The docs can be previewed at: https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/1272/reference/fleet/install-elastic-agents#flavors-for-container-package-installs