[checkpoint] Update docs checkpoint #16015
Conversation
Updated the link for documentation enhancement in changelog.
💛 Build succeeded, but was flaky
Failed CI StepsHistory |
andrewkroh
added
documentation
|
Pinging @elastic/integration-experience (Team:Integration-Experience) |
🚀 Benchmarks reportTo see the full report comment with |
mjwolf
left a comment
mjwolf
left a comment
There was a problem hiding this comment.
I think this looks good, there's a few minor things to look at
| ## Compatibility | ||
|
|
||
| - **Check Point**: This integration is compatible with Check Point Security Gateways and Management Servers running R80.x, R81, and R81.x versions. | ||
| - **Elastic Stack**: Requires Kibana version 8.11.0 or later, or 9.0.0 or later. |
There was a problem hiding this comment.
The kibana version is also in the manifest, so it doesn't need to be here. You can either remove it entirely, or say something like "The stack version and agentless support is determined by the manifest."
| - [Check Point sk122323: R80.x / R81.x Log Exporter command line utility](https://support.checkpoint.com/results/sk/sk122323) | ||
| - [Check Point sk115015: How to collect logs from Check Point Security Management Server and Security Gateway](https://support.checkpoint.com/results/sk/sk115015) | ||
|
|
||
| # Documentation sites |
There was a problem hiding this comment.
I don't think you need to have these links duplicated in both sections
| ### Compatibility | ||
|
|
||
| The Check Point integration collects one type of data: logs. | ||
| This integration is compatible with Check Point Security Gateways and Management Servers running R80.x, R81, and R81.x versions. |
There was a problem hiding this comment.
running R80.x, R81, and R81.x versions
Is this true for all these versions? The previous docs only said "This integration has been tested against Check Point Log Exporter on R81.X."
| 5. Configure the input types based on your vendor setup: | ||
| - **For UDP/TCP (Syslog)**: | ||
| - Select **Collect Check Point firewall logs (input: tcp)** or **(input: udp)**. | ||
| - Specify the `Syslog Host` (IP address of the Elastic Agent where logs will be received). |
There was a problem hiding this comment.
Specify the
Syslog Host(IP address of the Elastic Agent where logs will be received).
I think this could be confusing (although the existing variable name of "Syslog Host" is the most confusing part). This is actually the address to listen on. I think we should make the description more clear, given the name is already not the best.
Maybe something like "Specify the Syslog Host (The IP address or hostname for the Elastic Agent to listen on. Use 0.0.0.0 to listen on all available network interfaces.)"
4 participants
Proposed commit message
Update Docs for checkpoint integration.
Checklist
changelog.ymlfile.Author's Checklist
How to test this PR locally
Related issues
Screenshots