OSDOCS-10730: NetObserv 1.8 CLI reference #86824
Conversation
openshift-ci-robot
added
the
jira/valid-reference
|
@skrthomas: This pull request references OSDOCS-10730 which is a valid jira issue. In response to this:
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
bot
added
the
size/M
skrthomas
force-pushed
the
OSDOCS-10730
branch
from
ffcd5cf to
e430433
Compare
|
🤖 Thu Jan 09 15:45:29 - Prow CI generated the docs preview: |
| @@ -72,18 +70,18 @@ $ oc netobserv flows [<feature_option>] [<command_options>] | |||
| |--icmp_type| filter ICMP type | n/a | |||
| |--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 | |||
There was a problem hiding this comment.
🤖 [error] RedHat.TermsErrors: Use 'regular expression' rather than 'regex'. For more information, see RedHat.TermsErrors.
There was a problem hiding this comment.
Maybe we can expand this to "regular expression"
| @@ -114,10 +115,57 @@ $ oc netobserv packets [<option>] | |||
| |--icmp_type| filter ICMP type | n/a | |||
| |--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 | |||
There was a problem hiding this comment.
🤖 [error] RedHat.TermsErrors: Use 'regular expression' rather than 'regex'. For more information, see RedHat.TermsErrors.
There was a problem hiding this comment.
Can we expand to regular expression?
| |--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 |
There was a problem hiding this comment.
🤖 [error] RedHat.CaseSensitiveTerms: Use 'CIDR' rather than 'cidr'. For more information, see RedHat.CaseSensitiveTerms.
| |--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 |
There was a problem hiding this comment.
🤖 [error] RedHat.TermsErrors: Use 'regular expression' rather than 'regex'. For more information, see RedHat.TermsErrors.
skrthomas
force-pushed
the
OSDOCS-10730
branch
from
e430433 to
7c97802
Compare
There was a problem hiding this comment.
@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.
| = Network Observability CLI usage | ||
|
|
||
| You can use the Network Observability CLI (`oc netobserv`) to pass command line arguments to capture flow data and packet data for further analysis, enable Network Observability Operator features, or pass configuration options to the eBPF agent and `flowlogs-pipeline`. | ||
|
|
||
| [id="cli-syntax_{context}"] |
There was a problem hiding this comment.
@jpinsonneau all the headings have to have a unique ID. Can we add the ones I have here just so there's not any future removal of them as we update the reference?
There was a problem hiding this comment.
I think last time I added these in peer review and didn't sync with the upstream. Its just a requirement for Pantheon docs builds.
| | 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. |
There was a problem hiding this comment.
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.
| @@ -72,18 +70,18 @@ $ oc netobserv flows [<feature_option>] [<command_options>] | |||
| |--icmp_type| filter ICMP type | n/a | |||
| |--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 | |||
There was a problem hiding this comment.
Maybe we can expand this to "regular expression"
| == Packets capture options | ||
| You can filter on port and protocol for packet capture data. | ||
| You can filter packet capture data as same as flow capture using the filters. However, the features are not available here. |
There was a problem hiding this comment.
| You can filter packet capture data as same as flow capture using the filters. However, the features are not available here. | |
| You can filter packet capture data, the same as flow capture, using the filters. However, the features are not available here. |
There was a problem hiding this comment.
What does "The features are not available here" mean? I'm a little confused. There is the --enable_filter option in the Packets captures options.
There was a problem hiding this comment.
The features (pkt drop, dns, rtt and network events) are only available for flows and metrics capture.
The packet capture will return an error if you try to enable these.
There was a problem hiding this comment.
Ahhh, I got it sorry about that. Its THE features, not the filter. Sorry. I was focused too much on the "However" modifying the "filter" part of the preceding sentence but its about the "same as flow capture", noting that the features available in flow capture aren't available here. I suggest we could say that more explicitly, like:
Note that the features, such as packet drop, dns, rtt, and network events, are only available for flows and metrics capture
There was a problem hiding this comment.
Thanks works for me ! Thanks for the feedback. I will open a PR to adress all of these changes
| |--interfaces| interfaces to monitor | n/a | ||
| |=== | ||
|
|
||
| .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: |
There was a problem hiding this comment.
Another flow/flows question here.
| @@ -114,10 +115,57 @@ $ oc netobserv packets [<option>] | |||
| |--icmp_type| filter ICMP type | n/a | |||
| |--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 | |||
There was a problem hiding this comment.
Can we expand to regular expression?
| [source,terminal] | ||
| ---- | ||
| $ oc netobserv packets --action=Accept --cidr=0.0.0.0/0 --protocol=TCP --port=49051 | ||
| ---- | ||
| == Metrics capture options | ||
| You can enable features and use filters on metrics capture as same as flow capture. The generated graphs will fill accordingly. |
There was a problem hiding this comment.
| You can enable features and use filters on metrics capture as same as flow capture. The generated graphs will fill accordingly. | |
| You can enable features and use filters on metrics capture, the same as flow capture. The generated graphs fill accordingly. |
| You can use the Network Observability CLI (`oc netobserv`) to pass command line arguments to capture flow data and packet data for further analysis, enable Network Observability Operator features, or pass configuration options to the eBPF agent and `flowlogs-pipeline`. | ||
|
|
||
| [id="cli-syntax_{context}"] | ||
| You can use the The Network Observability CLI (`oc netobserv`) to pass command line arguments to capture flow data and packet data for further analysis, enable Network Observability Operator features or pass configuration options to the eBPF agent and flowlogs-pipeline. |
There was a problem hiding this comment.
| You can use the The Network Observability CLI (`oc netobserv`) to pass command line arguments to capture flow data and packet data for further analysis, enable Network Observability Operator features or pass configuration options to the eBPF agent and flowlogs-pipeline. | |
| You can use the The Network Observability CLI (`oc netobserv`) to pass command line arguments to capture flow data and packet data for further analysis, enable Network Observability Operator features or pass configuration options to the eBPF agent and `flowlogs-pipeline`. |
|
@skrthomas: all tests passed! Full PR test history. Your PR dashboard. 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. |
| Flow capture has mandatory commands as well as additional options, such as enabling extra features about packet drops, DNS latencies, Round-trip time, and filtering. | ||
| .`oc netobserv flows` syntax |
There was a problem hiding this comment.
| Flow capture has mandatory commands as well as additional options, such as enabling extra features about packet drops, DNS latencies, Round-trip time, and filtering. | |
| .`oc netobserv flows` syntax | |
| Flow capture has mandatory commands as well as additional options, such as enabling extra features about packet drops, DNS latencies, Round-trip time, and filtering. | |
| .`oc netobserv flows` syntax |
There was a problem hiding this comment.
Need a return here, otherwise the heading rendering is off:
|
@skrthomas: This pull request references OSDOCS-10730 which is a valid jira issue. In response to this:
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. |
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:
Additional information: