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 documentation for NodeLatencyMonitor feature #6561

Merged
merged 2 commits into from
Jul 30, 2024

Conversation

antoninbas
Copy link
Contributor

The feature is quite simple at the moment, so maybe no need for a dedicated documentation page.

Fixes #6551

@antoninbas antoninbas requested review from tnqn and luolanzone July 26, 2024 22:49
@antoninbas
Copy link
Contributor Author

cc @IRONICBo

@antoninbas antoninbas added kind/documentation Categorizes issue or PR as related to a documentation. action/backport Indicates a PR that requires backports. labels Jul 26, 2024
pingIntervalSeconds: 60
```

You can adjust `pingIntervalSeconds` to your desired value. To stop latency measurements, simply
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
You can adjust `pingIntervalSeconds` to your desired value. To stop latency measurements, simply
You can adjust `pingIntervalSeconds` to any positive value that suits your needs. To stop latency measurements, simply

apiVersion: stats.antrea.io/v1alpha1
kind: NodeLatencyStats
metadata:
creationTimestamp: null
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe remove this line?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is the current output of the command, so we should not hand modify it manually for the documentation.
However, we could look into setting it correctly in the REST server, as a subsequent PR.

Comment on lines 512 to 513
policyOnly mode is used), inter-Node latency will be measured between Antrea gateway
interfaces. Therefore, in encap mode, ICMP probes will traverse the overlay, just like regular
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
policyOnly mode is used), inter-Node latency will be measured between Antrea gateway
interfaces. Therefore, in encap mode, ICMP probes will traverse the overlay, just like regular
`networkPolicyOnly` mode is used), inter-Node latency will be measured between Antrea gateway
interfaces. Therefore, in `encap` mode, ICMP probes will traverse the overlay, just like regular

tnqn
tnqn previously approved these changes Jul 29, 2024
Copy link
Member

@tnqn tnqn left a comment

Choose a reason for hiding this comment

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

LGTM

The feature is quite simple at the moment, so maybe no need for a
dedicated documentation page.

Fixes antrea-io#6551

Signed-off-by: Antonin Bas <[email protected]>
Signed-off-by: Antonin Bas <[email protected]>
@antoninbas
Copy link
Contributor Author

/skip-all

@antoninbas antoninbas merged commit 6c05655 into antrea-io:main Jul 30, 2024
51 of 54 checks passed
@antoninbas antoninbas deleted the add-documentation-for-nlm branch July 30, 2024 05:21
antoninbas added a commit to antoninbas/antrea that referenced this pull request Jul 30, 2024
The feature is quite simple at the moment, so maybe no need for a
dedicated documentation page.

Fixes antrea-io#6551

Signed-off-by: Antonin Bas <[email protected]>
antoninbas added a commit that referenced this pull request Jul 30, 2024
The feature is quite simple at the moment, so maybe no need for a
dedicated documentation page.

Fixes #6551

Signed-off-by: Antonin Bas <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
action/backport Indicates a PR that requires backports. kind/documentation Categorizes issue or PR as related to a documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation for NodeLatencyMonitor
3 participants