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

move the help menu for filters to the main help menu #36

Merged
merged 1 commit into from
Apr 26, 2024

Conversation

msherif1234
Copy link
Contributor

Description

move filters help to the main help menu

 ./commands/netobserv help

Netobserv allows you to capture flow and packets from your cluster.
Find more information at: https://github.com/netobserv/network-observability-cli/

Syntax: netobserv [flows|packets|cleanup] [filters]

options:
  flows      Capture flows information. You can specify an optionnal interface name as filter such as 'netobserv flows br-ex'.
    Options:
    --interfaces: interfaces to monitor
    --enable_pktdrop: enable packet drop (default: true)
    --enable_dns: enable DNS tracking (default: true)
    --enable_rtt: enable RTT tracking (default: true)
    --enable_filter: enable flow filter (default: false)
    --direction: flow filter direction
    --cidr: flow filter CIDR (default: 0.0.0.0/0)
    --protocol: flow filter protocol (default: TCP)
    --sport: flow filter source port
    --dport: flow filter destination port
    --port: flow filter port
    --sport_range: flow filter source port range
    --dport_range: flow filter destination port range
    --port_range: flow filter port range
    --icmp_type: ICMP type
    --icmp_code: ICMP code
    --peer_ip: peer IP
    --action: flow filter action (default: Accept)
  packets    Capture packets from a specific protocol/port pair such as 'netobserv packets tcp,80'.
  cleanup    Remove netobserv components.
  version    Print software version.

Dependencies

n/a

Checklist

If you are not familiar with our processes or don't know what to answer in the list below, let us know in a comment: the maintainers will take care of that.

  • Is this PR backed with a JIRA ticket? If so, make sure it is written as a title prefix (in general, PRs affecting the NetObserv/Network Observability product should be backed with a JIRA ticket - especially if they bring user facing changes).
  • Does this PR require product documentation?
    • If so, make sure the JIRA epic is labelled with "documentation" and provides a description relevant for doc writers, such as use cases or scenarios. Any required step to activate or configure the feature should be documented there, such as new CRD knobs.
  • Does this PR require a product release notes entry?
    • If so, fill in "Release Note Text" in the JIRA.
  • Is there anything else the QE team should know before testing? E.g: configuration changes, environment setup, etc.
    • If so, make sure it is described in the JIRA ticket.
  • QE requirements (check 1 from the list):
    • Standard QE validation, with pre-merge tests unless stated otherwise.
    • Regression tests only (e.g. refactoring with no user-facing change).
    • No QE (e.g. trivial change with high reviewer's confidence, or per agreement with the QE team).

@Amoghrd
Copy link

Amoghrd commented Apr 26, 2024

/lgtm

@msherif1234
Copy link
Contributor Author

/approve

Copy link

openshift-ci bot commented Apr 26, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: msherif1234

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Copy link

codecov bot commented Apr 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 31.49%. Comparing base (55562be) to head (1b234f3).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #36   +/-   ##
=======================================
  Coverage   31.49%   31.49%           
=======================================
  Files           5        5           
  Lines         962      962           
=======================================
  Hits          303      303           
  Misses        637      637           
  Partials       22       22           
Flag Coverage Δ
unittests 31.49% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@openshift-merge-bot openshift-merge-bot bot merged commit f4b3a96 into netobserv:main Apr 26, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants