OSDOCS-10730: NetObserv 1.8 CLI reference by skrthomas · Pull Request #86824 · openshift/openshift-docs

skrthomas · 2025-01-08T18:54:26Z

Version(s):

merge only to no-1.8, which will be incorporated to 4.12+ on 2/25, Network Observability GA.
Issue:

https://issues.redhat.com/browse/OSDOCS-10730
Link to docs preview:

https://86824--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/network_observability/netobserv_cli/netobserv-cli-reference.html
QE review:

QE has approved this change.

Additional information:

openshift-ci-robot · 2025-01-08T18:54:30Z

@skrthomas: This pull request references OSDOCS-10730 which is a valid jira issue.

Details

In response to this:

Version(s):

Issue:

https://issues.redhat.com/browse/OSDOCS-10730
Link to docs preview:

QE review:

QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

ocpdocs-previewbot · 2025-01-08T19:14:28Z

🤖 Wed Feb 12 19:47:18 - Prow CI generated the docs preview:

https://86824--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/network_observability/netobserv_cli/netobserv-cli-reference.html
https://86824--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/network_observability/netobserv_cli/netobserv-cli-using.html

ocpdocs-vale-bot · 2025-01-08T19:15:21Z

modules/network-observability-netobserv-cli-reference.adoc

 |--icmp_code|             filter ICMP code                           | n/a
 |--peer_ip|               filter peer IP                             | n/a
+|--drops|                 filter flows with only dropped packets     | false
+|--regexes|               filter flows using regex                   | n/a


🤖 [error] RedHat.TermsErrors: Use 'regular expression' rather than 'regex'. For more information, see RedHat.TermsErrors.

Maybe we can expand this to "regular expression"

modules/network-observability-netobserv-cli-reference.adoc

ocpdocs-vale-bot · 2025-01-08T19:15:23Z

modules/network-observability-netobserv-cli-reference.adoc

+|--node-selector|         capture on specific nodes                  | n/a
+|--enable_filter|         enable flow filter                         | false
+|--direction|             filter direction                           | n/a
+|--cidr|                  filter CIDR                                | 0.0.0.0/0


🤖 [error] RedHat.CaseSensitiveTerms: Use 'CIDR' rather than 'cidr'. For more information, see RedHat.CaseSensitiveTerms.

modules/network-observability-netobserv-cli-reference.adoc

skrthomas

@jpinsonneau I left some comments for some things to adjust in the asciidoc source. We can talk about these further too if you have any questions or want to change anything.

modules/network-observability-netobserv-cli-reference.adoc

skrthomas · 2025-01-08T21:44:10Z

modules/network-observability-netobserv-cli-reference.adoc

-| Capture flows information. For subcommands, see the "Flows capture options" table.
+| Capture flows information. For subcommands, see the "Flow capture subcommands" table.
 | packets
-| Capture packets data. For subcommands, see the "Packets capture options" table.
+| Capture packets data. For subcommands, see the "Packet capture subcommand" table.


For these two, can we revert back to "options" instead of "subcommands", or did you intend to change this? If its a change we want to make, then I can update the headings for those "Packet capture" and "Flow capture" sections.

Additionally, there's "Packets" vs "Packet". I think in previous releases, we've intentionally used the plural.

skrthomas · 2025-01-08T21:44:49Z

modules/network-observability-netobserv-cli-reference.adoc

 |--icmp_code|             filter ICMP code                           | n/a
 |--peer_ip|               filter peer IP                             | n/a
+|--drops|                 filter flows with only dropped packets     | false
+|--regexes|               filter flows using regex                   | n/a


Maybe we can expand this to "regular expression"

modules/network-observability-netobserv-cli-reference.adoc

skrthomas · 2025-01-09T15:29:11Z

modules/network-observability-netobserv-cli-reference.adoc

 |===

-.Example running flows capture on TCP protocol and port 49051 with PacketDrop and RTT features enabled:
+.Example running flow capture on TCP protocol and port 49051 with PacketDrop and RTT features enabled:


Another flow/flows question here.

modules/network-observability-netobserv-cli-reference.adoc

openshift-ci-robot · 2025-01-09T18:22:57Z

@skrthomas: This pull request references OSDOCS-10730 which is a valid jira issue.

Details

In response to this:

Version(s):

Issue:

https://issues.redhat.com/browse/OSDOCS-10730
Link to docs preview:

https://86824--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/network_observability/netobserv_cli/netobserv-cli-reference.html
QE review:

QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

jpinsonneau · 2025-01-10T13:47:38Z

@skrthomas I'm addressing this in netobserv/netobserv-cli#146
You can see the preview in https://github.com/jpinsonneau/network-observability-cli/blob/2021/docs/netobserv_cli.adoc

modules/network-observability-netobserv-cli-reference.adoc

jpinsonneau · 2025-01-24T16:16:05Z

@skrthomas FYI packet translation and udn mapping features been added in netobserv/netobserv-cli#146 (comment)

The generated doc will need to be updated here also 😸
We can wait for my PR to be merge in case something else change in between

Thanks !

jpinsonneau · 2025-02-03T08:42:38Z

The PRs are now merged. The final CLI doc for 1.8 is available at https://github.com/netobserv/network-observability-cli/blob/release-1.8/docs/netobserv_cli.adoc

skrthomas · 2025-02-06T16:06:04Z

@jpinsonneau @memodi can I get final reviews on this PR for the CLI updates? I incorporated your recent CLI reference updates Julien.

jpinsonneau

Just a small nit; not sure if it's mandatory

Other than that looks good 👌
Thanks @skrthomas !

modules/network-observability-netobserv-cli-reference.adoc

memodi

couple of minor comments from me @skrthomas, otherwise looks good.

modules/network-observability-netobserv-cli-reference.adoc

tmalove · 2025-02-10T21:52:13Z

/remove-label peer-review-needed
/label peer-review-in-progress

modules/network-observability-cli-capturing-metrics.adoc

modules/network-observability-netobserv-cli-reference.adoc

openshift-ci · 2025-02-12T19:48:21Z

@skrthomas: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

openshift-ci-robot · 2025-02-12T19:52:24Z

@skrthomas: This pull request references OSDOCS-10730 which is a valid jira issue.

Details

In response to this:

Version(s):

merge only to no-1.8, which will be incorporated to 4.12+ on 2/25, Network Observability GA.
Issue:

https://issues.redhat.com/browse/OSDOCS-10730
Link to docs preview:

https://86824--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/network_observability/netobserv_cli/netobserv-cli-reference.html
QE review:

QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

memodi

/label qe-approved

thanks!

openshift-ci-robot · 2025-02-12T19:54:52Z

@skrthomas: This pull request references OSDOCS-10730 which is a valid jira issue.

Details

In response to this:

Version(s):

merge only to no-1.8, which will be incorporated to 4.12+ on 2/25, Network Observability GA.
Issue:

https://issues.redhat.com/browse/OSDOCS-10730
Link to docs preview:

https://86824--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/network_observability/netobserv_cli/netobserv-cli-reference.html
QE review:

QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

jeana-redhat

LGTM
/remove-label merge-review-in-progress
/remove-label merge-review-needed

jeana-redhat · 2025-02-12T20:26:27Z

modules/network-observability-cli-capturing-metrics.adoc

+
+[NOTE]
+====
+Features that are not enabled present as empty graphs.


I am not sure what this means but I am guessing it makes sense to the intended audience :)

Yeah, I think it should make sense. Network Observability has some features that are widely known in the docs and use-case-wise, but optional to turn on/off. So if you have any of these features off, then you get empty graphs.

openshift-ci-robot · 2025-02-12T20:29:22Z

@skrthomas: This pull request references OSDOCS-10730 which is a valid jira issue.

Details

In response to this:

Version(s):

merge only to no-1.8, which will be incorporated to 4.12+ on 2/25, Network Observability GA.
Issue:

https://issues.redhat.com/browse/OSDOCS-10730
Link to docs preview:

https://86824--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/network_observability/netobserv_cli/netobserv-cli-reference.html
QE review:

QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jan 8, 2025

openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jan 8, 2025

skrthomas force-pushed the OSDOCS-10730 branch from ffcd5cf to e430433 Compare January 8, 2025 18:56

ocpdocs-vale-bot reviewed Jan 8, 2025

View reviewed changes

modules/network-observability-netobserv-cli-reference.adoc Outdated Show resolved Hide resolved

ocpdocs-vale-bot reviewed Jan 8, 2025

View reviewed changes

modules/network-observability-netobserv-cli-reference.adoc Outdated Show resolved Hide resolved

skrthomas force-pushed the OSDOCS-10730 branch from e430433 to 7c97802 Compare January 9, 2025 15:35

skrthomas commented Jan 9, 2025

View reviewed changes

modules/network-observability-netobserv-cli-reference.adoc Outdated Show resolved Hide resolved

jpinsonneau mentioned this pull request Jan 10, 2025

NETOBSERV-2021: Improve UX netobserv/netobserv-cli#146

Merged

22 tasks

skrthomas force-pushed the OSDOCS-10730 branch from 7c97802 to 1a43a8e Compare January 10, 2025 17:51

ocpdocs-vale-bot reviewed Jan 10, 2025

View reviewed changes

modules/network-observability-netobserv-cli-reference.adoc Outdated Show resolved Hide resolved

skrthomas force-pushed the OSDOCS-10730 branch from 1a43a8e to 3802475 Compare January 10, 2025 21:26

openshift-ci bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jan 10, 2025

skrthomas force-pushed the OSDOCS-10730 branch 2 times, most recently from 51edce2 to 5ebce8c Compare January 13, 2025 21:31

skrthomas force-pushed the OSDOCS-10730 branch 2 times, most recently from 1a13e49 to 2c64275 Compare January 23, 2025 19:15

skrthomas requested a review from memodi January 23, 2025 19:15

skrthomas force-pushed the OSDOCS-10730 branch from 2c64275 to f0cfc5c Compare February 3, 2025 19:21

jpinsonneau approved these changes Feb 6, 2025

View reviewed changes

modules/network-observability-netobserv-cli-reference.adoc Outdated Show resolved Hide resolved

memodi reviewed Feb 6, 2025

View reviewed changes

modules/network-observability-netobserv-cli-reference.adoc Outdated Show resolved Hide resolved

modules/network-observability-netobserv-cli-reference.adoc Outdated Show resolved Hide resolved

skrthomas force-pushed the OSDOCS-10730 branch from f0cfc5c to ca216da Compare February 7, 2025 21:10

skrthomas added the peer-review-needed Signifies that the peer review team needs to review this PR label Feb 10, 2025

adellape self-assigned this Feb 10, 2025

adellape added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Feb 10, 2025

openshift-ci bot removed the peer-review-needed Signifies that the peer review team needs to review this PR label Feb 10, 2025

adellape reviewed Feb 10, 2025

View reviewed changes

adellape added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR labels Feb 10, 2025

tmalove approved these changes Feb 10, 2025

View reviewed changes

skrthomas force-pushed the OSDOCS-10730 branch 2 times, most recently from 7114764 to cbd4e4f Compare February 12, 2025 19:29

OSDOCS-10730: NetObserv 1.8 CLI reference

9b8a45a

skrthomas force-pushed the OSDOCS-10730 branch from cbd4e4f to 9b8a45a Compare February 12, 2025 19:31

skrthomas added the merge-review-needed Signifies that the merge review team needs to review this PR label Feb 12, 2025

memodi approved these changes Feb 12, 2025

View reviewed changes

openshift-ci bot added the qe-approved Signifies that QE has signed off on this PR label Feb 12, 2025

jeana-redhat added the merge-review-in-progress Signifies that the merge review team is reviewing this PR label Feb 12, 2025

jeana-redhat approved these changes Feb 12, 2025

View reviewed changes

openshift-ci bot removed merge-review-in-progress Signifies that the merge review team is reviewing this PR merge-review-needed Signifies that the merge review team needs to review this PR labels Feb 12, 2025

jeana-redhat merged commit 4d2b454 into openshift:no-1.8 Feb 12, 2025
2 checks passed

This was referenced Feb 13, 2025

OSDOCS-10730: Adding peer review feedback to upstream docs jpinsonneau/network-observability-cli#4

Merged

Update docs netobserv/netobserv-cli#173

Merged

Conversation

skrthomas commented Jan 8, 2025 • edited by jeana-redhat Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci-robot commented Jan 8, 2025 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ocpdocs-previewbot commented Jan 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

skrthomas left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

openshift-ci-robot commented Jan 9, 2025 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jpinsonneau commented Jan 10, 2025

Uh oh!

Uh oh!

jpinsonneau commented Jan 24, 2025

Uh oh!

jpinsonneau commented Feb 3, 2025

Uh oh!

skrthomas commented Feb 6, 2025

Uh oh!

jpinsonneau left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

memodi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

tmalove commented Feb 10, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

openshift-ci bot commented Feb 12, 2025

Uh oh!

openshift-ci-robot commented Feb 12, 2025 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

memodi left a comment

Choose a reason for hiding this comment

Uh oh!

openshift-ci-robot commented Feb 12, 2025 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jeana-redhat left a comment

Choose a reason for hiding this comment

skrthomas commented Jan 8, 2025 •

edited by jeana-redhat

Loading

openshift-ci-robot commented Jan 8, 2025 •

edited by openshift-ci bot

Loading

ocpdocs-previewbot commented Jan 8, 2025 •

edited

Loading

openshift-ci-robot commented Jan 9, 2025 •

edited by openshift-ci bot

Loading

openshift-ci-robot commented Feb 12, 2025 •

edited by openshift-ci bot

Loading

openshift-ci-robot commented Feb 12, 2025 •

edited by openshift-ci bot

Loading

openshift-ci-robot commented Feb 12, 2025 •

edited by openshift-ci bot

Loading