[Iptables] update documentation #17350
Open
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
haetamoudi
added
enhancement
Contributor
Vale Linting ResultsSummary: 19 warnings, 17 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| packages/iptables/_dev/build/docs/README.md | 32 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/iptables/_dev/build/docs/README.md | 70 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/iptables/_dev/build/docs/README.md | 99 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/iptables/docs/README.md | 32 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/iptables/docs/README.md | 70 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/iptables/docs/README.md | 99 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/iptables/docs/README.md | 214 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/iptables/docs/README.md | 226 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/iptables/docs/README.md | 241 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/iptables/docs/README.md | 301 | Elastic.DontUse | Don't use 'Note that'. |
| packages/iptables/docs/README.md | 301 | Elastic.DontUse | Don't use 'note that'. |
| packages/iptables/docs/README.md | 301 | Elastic.DontUse | Don't use 'note that'. |
| packages/iptables/docs/README.md | 361 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'and so on' instead of 'etc'. |
| packages/iptables/docs/README.md | 362 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'and so on' instead of 'etc'. |
| packages/iptables/docs/README.md | 363 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
| packages/iptables/docs/README.md | 363 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'and so on' instead of 'etc'. |
| packages/iptables/docs/README.md | 364 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
| packages/iptables/docs/README.md | 364 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'and so on' instead of 'etc'. |
| packages/iptables/docs/knowledge_base/service_info.md | 50 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'and so on' instead of 'etc'. |
💡 Suggestions (17)
| File | Line | Rule | Message |
|---|---|---|---|
| packages/iptables/_dev/build/docs/README.md | 18 | Elastic.Versions | Use 'or later' instead of 'or higher' when referring to versions. |
| packages/iptables/_dev/build/docs/README.md | 119 | Elastic.HeadingColons | Capitalize ': u'. |
| packages/iptables/_dev/build/docs/README.md | 130 | Elastic.HeadingColons | Capitalize ': l'. |
| packages/iptables/_dev/build/docs/README.md | 139 | Elastic.HeadingColons | Capitalize ': j'. |
| packages/iptables/docs/README.md | 18 | Elastic.Versions | Use 'or later' instead of 'or higher' when referring to versions. |
| packages/iptables/docs/README.md | 119 | Elastic.HeadingColons | Capitalize ': u'. |
| packages/iptables/docs/README.md | 130 | Elastic.HeadingColons | Capitalize ': l'. |
| packages/iptables/docs/README.md | 139 | Elastic.HeadingColons | Capitalize ': j'. |
| packages/iptables/docs/README.md | 296 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| packages/iptables/docs/README.md | 301 | Elastic.WordChoice | Consider using 'efficiently' instead of 'simply', unless the term is in the UI. |
| packages/iptables/docs/README.md | 301 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| packages/iptables/docs/README.md | 349 | Elastic.WordChoice | Consider using 'start, run' instead of 'boot', unless the term is in the UI. |
| packages/iptables/docs/README.md | 349 | Elastic.WordChoice | Consider using 'start, run' instead of 'boot', unless the term is in the UI. |
| packages/iptables/docs/README.md | 368 | Elastic.Wordiness | Consider using 'all' instead of 'All of '. |
| packages/iptables/docs/knowledge_base/service_info.md | 80 | Elastic.HeadingColons | Capitalize ': u'. |
| packages/iptables/docs/knowledge_base/service_info.md | 92 | Elastic.HeadingColons | Capitalize ': l'. |
| packages/iptables/docs/knowledge_base/service_info.md | 101 | Elastic.HeadingColons | Capitalize ': j'. |
The Vale linter checks documentation changes against the Elastic Docs style guide.
To use Vale locally or report issues, refer to Elastic style guide for Vale.
haetamoudi
added
documentation
|
Pinging @elastic/integration-experience (Team:Integration-Experience) |
🚀 Benchmarks reportPackage
|
| Data stream | Previous EPS | New EPS | Diff (%) | Result |
|---|---|---|---|---|
log |
8620.69 | 6666.67 | -1954.02 (-22.67%) | 💔 |
To see the full report comment with /test benchmark fullreport
💚 Build Succeeded
History
|
mjwolf
reviewed
Feb 11, 2026
| @@ -1,4 +1,9 @@ | |||
| # newer versions go on top | |||
| - version: "1.22.1" | |||
Contributor
There was a problem hiding this comment.
We're going to use minor version increase for the documentation updates
Suggested change
| - version: "1.22.1" | |
| - version: "1.23.0" |
|
|
||
| The module is by default configured to run with the `udp` input on port `9001`. | ||
| However, it can also be configured to read from a file path or journald. | ||
| This integration facilitates: |
Contributor
There was a problem hiding this comment.
These use cases can be removed. They are duplicated in the "Supported Use cases" section
|
|
||
| Before you install the integration, ensure your environment is configured correctly: | ||
| - Root or sudo permissions are required on the Linux host to modify `iptables` rules and `rsyslog` configurations. | ||
| - Port `9001` (UDP) must be accessible on the Elastic Agent host to receive syslog traffic. |
Contributor
There was a problem hiding this comment.
I think you can remove this line, having the port open on the agent host isn't really a vendor prerequisite.
It also makes it sound like port 9001 must be used, when it's actually configurable.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Proposed commit message
[iptables] Documentation Update
generated new knowledge base file
generated new documentation
Checklist
changelog.ymlfile.