T6452: Add QoS Op Commands #3591

l0crian1 · 2024-06-06T14:46:22Z

Change Summary

Added the following Commands

show qos shaping
show qos shaping detail
show qos shaping interface
show qos shaping interface detail
show qos shaping interface class show qos shaping interface class detail show qos cake interface

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Code style update (formatting, renaming)
Refactoring (no functional changes)
Migration from an old Vyatta component to vyos-1x, please link to related PR inside obsoleted component
Other (please describe):

Related Task(s)

https://vyos.dev/T6452

Related PR(s)

Component(s) name

qos, op-mode

Proposed changes

This PR will add op mode commands for QoS. The following commands will be added:
show qos shaping
show qos shaping detail
show qos shaping interface
show qos shaping interface detail
show qos shaping interface class
show qos shaping interface class detail
show qos cake interface

Shaping commands will offer a table view by default, and an optional detailed view, which is presented in a list view:
Table View:

vyos@vyos:~$ show qos shaping interface eth1 class 10
--------------------------------------------------------------------------------
Interface: eth1
Policy Name: test

Class    Type            BW    Max. BW    Bytes    Pkts.    Drops    Queued
-------  --------  --------  ---------  -------  -------  -------  --------
root     htb       1.000 Gb   1.000 Gb     0  B        0        0         0
10       fq_codel  3.750 Mb   3.750 Mb     0  B        0        0         0
default  fq_codel  1.000 Mb   1.000 Mb     0  B        0        0         0

Detailed View:

vyos@vyos:~$ show qos shaping interface eth1 class 10 detail
-----------------------------------
Interface: eth1
Policy Name: test

 Interface   | eth1
 Policy Name | test
 Direction   | egress
 Class       | root
 Type        | htb
 BW          | 1000000000
 Max. BW     | 1000000000
 Bytes       | 0
 Pkts.       | 0
 Drops       | 0
 Queued      | 0
 Overlimit   | 0
 Requeue     | 0
 Lended      | 0
 Borrowed    | 0
 Giants      | 0

 Interface   | eth1
 Policy Name | test
 Direction   | egress
 Class       | 10
 Type        | fq_codel
 BW          | 3750000
 Max. BW     | 3750000
 Bytes       | 0
 Pkts.       | 0
 Drops       | 0
 Queued      | 0
 Overlimit   | 0
 Requeue     | 0
 Lended      | 0
 Borrowed    | 0
 Giants      | 0

 Interface   | eth1
 Policy Name | test
 Direction   | egress
 Class       | default
 Type        | fq_codel
 BW          | 1000000
 Max. BW     | 1000000
 Bytes       | 0
 Pkts.       | 0
 Drops       | 0
 Queued      | 0
 Overlimit   | 0
 Requeue     | 0
 Lended      | 0
 Borrowed    | 0
 Giants      | 0

How to test

Smoketest result

Checklist:

I have read the CONTRIBUTING document
I have linked this PR to one or more Phabricator Task(s)
I have run the components SMOKETESTS if applicable
My commit headlines contain a valid Task id
My change requires a change to the documentation
I have updated the documentation accordingly

Added the following commands: show qos shaping show qos shaping detail show qos shaping interface <int name> show qos shaping interface <int name> detail show qos shaping interface <int name> class <class name> show qos shaping interface <int name> class <class name> detail show qos cake interface <int name>

src/op_mode/qos.py

op-mode-definitions/show-qos.xml.in

src/op_mode/qos.py

Added the following commands: show qos shaping show qos shaping detail show qos shaping interface <int name> show qos shaping interface <int name> detail show qos shaping interface <int name> class <class name> show qos shaping interface <int name> class <class name> detail show qos cake interface <int name>

sever-sever · 2024-06-18T09:10:16Z

I do not have any qos confiugred

vyos@r4:~$ show qos shaper interface eth1
Traceback (most recent call last):
  File "/usr/libexec/vyos/op_mode/qos.py", line 224, in <module>
    res = vyos.opmode.run(sys.modules[__name__])
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3/dist-packages/vyos/opmode.py", line 263, in run
    res = func(**args)
          ^^^^^^^^^^^^
  File "/usr/libexec/vyos/op_mode/qos.py", line 79, in show_shaping
    policy_name, class_dict = get_tc_info(interface_dict, interface_name, 'shaper')
                              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/libexec/vyos/op_mode/qos.py", line 38, in get_tc_info
    class_dict = op_mode_config_dict(['qos', 'policy', policy_type, policy_name], key_mangling=('-', '_'),
                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3/dist-packages/vyos/configquery.py", line 168, in op_mode_config_dict
    rc, out = op_mode_run(command + path)
              ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3/dist-packages/vyos/configquery.py", line 155, in op_mode_run
    p = subprocess.Popen(cmd, stdout=subprocess.PIPE)
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.11/subprocess.py", line 1024, in __init__
    self._execute_child(args, executable, preexec_fn, close_fds,
  File "/usr/lib/python3.11/subprocess.py", line 1834, in _execute_child
    self.pid = _fork_exec(
               ^^^^^^^^^^^
TypeError: expected str, bytes or os.PathLike object, not NoneType
vyos@r4:~$

Added the following commands: show qos shaping show qos shaping detail show qos shaping interface <int name> show qos shaping interface <int name> detail show qos shaping interface <int name> class <class name> show qos shaping interface <int name> class <class name> detail show qos cake interface <int name>

l0crian1 · 2024-06-18T13:59:24Z

I do not have any qos confiugred

@sever-sever
I didn't have any checks against an empty config path. I added them. You'll now see this when trying to do "show qos" when it is not applied to an interface.

vyos@vyos# run show qos shaper
QoS is not applied to any interface!

vyos@vyos# run show qos shaper interface eth1
QoS is not applied to eth1!

Added the following commands: show qos shaping show qos shaping detail show qos shaping interface <int name> show qos shaping interface <int name> detail show qos shaping interface <int name> class <class name> show qos shaping interface <int name> class <class name> detail show qos cake interface <int name>

sever-sever · 2024-06-19T10:31:10Z

vyos@r4# run show conf com | match qos
set qos interface eth1
set qos policy

fails

vyos@r4# run show qos shaper 
Traceback (most recent call last):
  File "/usr/libexec/vyos/op_mode/qos.py", line 230, in <module>
    res = vyos.opmode.run(sys.modules[__name__])
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3/dist-packages/vyos/opmode.py", line 263, in run
    res = func(**args)
          ^^^^^^^^^^^^
  File "/usr/libexec/vyos/op_mode/qos.py", line 85, in show_shaping
    policy_name, class_dict = get_tc_info(interface_dict, interface_name, 'shaper')
                              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/libexec/vyos/op_mode/qos.py", line 38, in get_tc_info
    class_dict = op_mode_config_dict(['qos', 'policy', policy_type, policy_name], key_mangling=('-', '_'),
                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3/dist-packages/vyos/configquery.py", line 168, in op_mode_config_dict
    rc, out = op_mode_run(command + path)
              ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3/dist-packages/vyos/configquery.py", line 155, in op_mode_run
    p = subprocess.Popen(cmd, stdout=subprocess.PIPE)
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.11/subprocess.py", line 1024, in __init__
    self._execute_child(args, executable, preexec_fn, close_fds,
  File "/usr/lib/python3.11/subprocess.py", line 1834, in _execute_child
    self.pid = _fork_exec(
               ^^^^^^^^^^^
TypeError: expected str, bytes or os.PathLike object, not NoneType
[edit]
vyos@r4#

Could you also change show_shaping => show_shaper?

Subcommand required!
usage: qos.py [-h] {show_cake,show_shaping} ...
[edit]
vyos@r4#

Added the following commands: show qos shaping show qos shaping detail show qos shaping interface <int name> show qos shaping interface <int name> detail show qos shaping interface <int name> class <class name> show qos shaping interface <int name> class <class name> detail show qos cake interface <int name>

l0crian1 · 2024-06-19T14:16:23Z

vyos@r4# run show conf com | match qos
set qos interface eth1
set qos policy
fails
@sever-sever Added checks against empty config elements and renamed the function to show_shaper

src/op_mode/qos.py

Added the following commands: show qos shaping show qos shaping detail show qos shaping interface <int name> show qos shaping interface <int name> detail show qos shaping interface <int name> class <class name> show qos shaping interface <int name> class <class name> detail show qos cake interface <int name>

src/op_mode/qos.py

Added the following commands: show qos shaping show qos shaping detail show qos shaping interface <int name> show qos shaping interface <int name> detail show qos shaping interface <int name> class <class name> show qos shaping interface <int name> class <class name> detail show qos cake interface <int name>

github-actions · 2024-06-27T17:10:09Z

👍 VyOS CLI smoketests finished successfully!

HollyGurza · 2024-10-19T11:38:49Z

@c-po @dmbaturin
Need to backport on Sagitta?

l0crian1 requested a review from a team as a code owner June 6, 2024 14:46

l0crian1 requested review from dmbaturin, sarthurdev, zdc, jestabro, sever-sever and c-po June 6, 2024 14:46

github-actions bot added the current label Jun 6, 2024

github-actions bot assigned l0crian1 Jun 6, 2024

sever-sever requested changes Jun 12, 2024

View reviewed changes

src/op_mode/qos.py Outdated Show resolved Hide resolved

op-mode-definitions/show-qos.xml.in Outdated Show resolved Hide resolved

src/op_mode/qos.py Outdated Show resolved Hide resolved

src/op_mode/qos.py Outdated Show resolved Hide resolved

l0crian1 and others added 3 commits June 12, 2024 10:30

Merge branch 'vyos:current' into t6452-qos-op

7e89434

c-po requested changes Jun 20, 2024

View reviewed changes

src/op_mode/qos.py Outdated Show resolved Hide resolved

sever-sever approved these changes Jun 21, 2024

View reviewed changes

sever-sever requested a review from c-po June 26, 2024 07:59

c-po requested changes Jun 27, 2024

View reviewed changes

src/op_mode/qos.py Outdated Show resolved Hide resolved

c-po approved these changes Jun 27, 2024

View reviewed changes

fett0 approved these changes Jun 28, 2024

View reviewed changes

sever-sever merged commit 206c07a into vyos:current Jun 28, 2024
11 of 12 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

T6452: Add QoS Op Commands #3591

T6452: Add QoS Op Commands #3591

l0crian1 commented Jun 6, 2024

sever-sever commented Jun 18, 2024

l0crian1 commented Jun 18, 2024

sever-sever commented Jun 19, 2024

l0crian1 commented Jun 19, 2024

github-actions bot commented Jun 27, 2024

HollyGurza commented Oct 19, 2024

T6452: Add QoS Op Commands #3591

T6452: Add QoS Op Commands #3591

Conversation

l0crian1 commented Jun 6, 2024

Change Summary

Types of changes

Related Task(s)

Related PR(s)

Component(s) name

Proposed changes

How to test

Smoketest result

Checklist:

sever-sever commented Jun 18, 2024

l0crian1 commented Jun 18, 2024

sever-sever commented Jun 19, 2024

l0crian1 commented Jun 19, 2024

github-actions bot commented Jun 27, 2024

HollyGurza commented Oct 19, 2024