Document how to use venv to build

sFlow plugin support

.github/workflows/black.yml

@@ -1,14 +0,0 @@
-name: Lint
-
-on: [push, pull_request]
-
-jobs:
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: psf/black@stable
-        with:
-          options: "--check --verbose --diff"
-          src: ". vppcfg"
-

.gitignore

@@ -6,11 +6,6 @@ __pycache__
 dist
 vppcfg.egg-info
 .pybuild
-debian/vppcfg
-debian/vppcfg.*.log
-debian/vppcfg.*.debhelper
-debian/.debhelper
-debian/files
-debian/vppcfg.substvars
 .*.~undo-tree~
 .eggs
+.venv/

LICENSE

@@ -1,22 +1,202 @@
-Copyright (c) 2021, Pim van Pelt <pim@ipng.nl>
-All rights reserved.
 
-Redistribution and use in source and binary forms, with or without
+                                 Apache License
-modification, are permitted provided that the following conditions are met: 
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-1. Redistributions of source code must retain the above copyright notice, this
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-   list of conditions and the following disclaimer. 
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution. 
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+   1. Definitions.
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+      "License" shall mean the terms and conditions for use, reproduction,
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+      and distribution as defined by Sections 1 through 9 of this document.
-ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+      "Licensor" shall mean the copyright owner or entity authorized by
-LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+      the copyright owner that is granting the License.
-ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+      "Legal Entity" shall mean the union of the acting entity and all
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

Makefile

@@ -1,4 +1,4 @@
-VERSION=0.0.6
+VERSION=0.0.8
 VPPCFG:=vppcfg
 PYTHON?=python3
 PIP?=pip
@@ -16,7 +16,7 @@ build:
 
 .PHONY: install-deps
 install-deps:
-	sudo $(PIP) install $(PIP_DEPENDS)
+	$(PIP) install $(PIP_DEPENDS)
 
 .PHONY: install
 install:

README.md

@@ -11,9 +11,14 @@ If you're interested in helping, reach out to <pim at ipng dot ch> to disc
 ## Building
 
 This program expects Python3 and PIP to be installed. It's known to work on Debian Bullseye and
-Ubuntu Focal/Jammy.
+Bookworm, as well as on Ubuntu Focal, Jammy and Noble.
 
 ```
+
+## Start a Virtual Environment
+python3 -m venv .venv
+source .venv/bin/activate
+
 ## Install python build dependencies 
 $ make install-deps
 
@@ -23,12 +28,11 @@ $ make test
 ## Build vppcfg
 $ make build
 
+## Exit the virtual environment
+$ deactivate
+
 ## Install the tool with PIP
 $ make install
-
-## To build & install debian packaging
-$ make pkg-deb
-$ ls -l ../vppcfg_*_amd64.deb
 ```
 
 ## Running
@@ -66,7 +70,7 @@ Developer deep-dives:
 
 ## Licensing
 
-The code in this project is release under Apache 2.0 license. A copy of the license
+The code in this project is released under Apache 2.0 license. A copy of the license
 is provided in this repo [here](LICENSE). All contributions are held against our
 [contributing](docs/contributing.md) guidelines. Notably, all code must be licensed
 Apache 2.0, and all contributions must come with a certificate of origin in the

debian/changelog

@@ -1,45 +0,0 @@
-vppcfg (0.0.6) unstable; urgency=low
-
-  Feature release:
-    * Re-order the interfaces: loopbacks before phy/sub-int
-
- -- Pim van Pelt <pim@ipng.nl>  Sun, 07 APr 2024 12:15:00 +0000
-vppcfg (0.0.5) unstable; urgency=low
-
-  Feature release:
-    * Allow for 'unnumbered' interfaces.
- -- Pim van Pelt <pim@ipng.nl>  Sun, 07 APr 2024 12:15:00 +0000
-vppcfg (0.0.4) unstable; urgency=low
-
-  Feature release:
-    * Bugfix, ensuring IPv6 addresses are in their canonical form, to avoid
-      spurious diffs when comparing to VPP dataplane addresses.
-    * Document the 'device-type' field for interfaces
- -- Pim van Pelt <pim@ipng.nl>  Sat, 03 Dec 2022 14:15:00 +0000
-vppcfg (0.0.3) unstable; urgency=low
-
-  Feature release:
-    * Allow the ability to set --novpp flag on planners. See user-guide for
-      details.
-    * Add device-type to the schema, which allows the configuratoin to specify
-      'dpdk' type interfaces. This paves the way for RDMA and AVF interfaces
-      in a later release.
-    * Some small bugfixes and refactors
-    * Lint: address a few pylint errors
-
- -- Pim van Pelt <pim@ipng.nl>  Sat, 03 Dec 2022 14:15:00 +0000
-vppcfg (0.0.2) unstable; urgency=low
-
-  Bugfix release:
-    * Fix python load / include paths, now vppcfg runs relative to $PATH
-    * Partial fix for 'make test' (doesn't execute the YAMLTest suite yet,
-      this has no impact to production)
-    * Bugfix: correctly prune vxlan tunnels which have an address set
-    * Lint: address a few pylint errors
-
- -- Ray Kinsella <mdr@ashroe.eu>  Thu, 30 Jun 2022 14:00:00 +0000
-vppcfg (0.0.1) unstable; urgency=low
-
-  * Initial public release
-
- -- Ray Kinsella <mdr@ashroe.eu>  Thu, 30 Jun 2022 14:00:00 +0000

debian/compat

@@ -1 +0,0 @@
-9

debian/control

@@ -1,12 +0,0 @@
-Source: vppcfg
-Section: python
-Priority: extra
-Maintainer: Ray Kinsella <mdr@ashroe.eu>
-Build-Depends: debhelper (>= 9), python3-all, dh-python
-Standards-Version: 3.9.5
-
-Package: vppcfg
-Architecture: any
-Pre-Depends: dpkg (>= 1.16.1), python3 (>=3.8), ${misc:Pre-Depends}
-Depends: python3-netaddr, python3-ipaddr, ${misc:Depends}
-Description: A configuration tool for FD.io VPP

debian/rules

@@ -1,4 +0,0 @@
-#!/usr/bin/make -f
-
-%:
-	dh $@ --with python3 --buildsystem=pybuild --with systemd

debian/vppcfg.service

@@ -1,13 +0,0 @@
-[Unit]
-Description=vppcfg
-BindsTo=vpp.service
-After=vpp.service
-ConditionPathExists=/etc/vpp/config.yaml
-
-[Service]
-Type=oneshot
-ExecStart=vppcfg apply -c /etc/vpp/config.yaml
-RemainAfterExit=yes
-
-[Install]
-WantedBy=multi-user.target

docs/config-guide.md

@@ -522,7 +522,7 @@ be changed.
 
 The following configuration elements are provided for the plugin:
 
-*   **sample-rate**: Capture 1-in-N packets. Defaults to 10000. A good value is the interface
+*   **sampling-rate**: Capture 1-in-N packets. Defaults to 10000. A good value is the interface
     bitrate divided by 1000, so for GigabitEthernet choose 1000, for TenGigabitEthernet choose
     10000 (the default).
 *   **polling-interval**: Determines the period of interface byte and packet counter reads. This
@@ -532,7 +532,7 @@ The following configuration elements are provided for the plugin:
 
 ```
 sflow:
-  sample-rate: 10000
+  sampling-rate: 10000
   polling-interval: 20
   header-bytes: 128
 ```

setup.py

@@ -4,7 +4,7 @@ from setuptools import setup
 
 setup(
     name="vppcfg",
-    version="0.0.6",
+    version="0.0.8",
     install_requires=[
         "requests",
         'importlib-metadata; python_version >= "3.8"',

vppcfg/__init__.py

@@ -13,4 +13,4 @@
 # limitations under the License.
 #
 # -*- coding: utf-8 -*-
-""" __init__.py added to suppress pylint error """
+"""__init__.py added to suppress pylint error"""

vppcfg/config/__init__.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 #
 # -*- coding: utf-8 -*-
-""" A vppcfg configuration module that exposes its semantic/syntax validators """
+"""A vppcfg configuration module that exposes its semantic/syntax validators"""
 from __future__ import (
     absolute_import,
     division,
@@ -40,6 +40,7 @@ from .vxlan_tunnel import validate_vxlan_tunnels
 from .tap import validate_taps
 from .prefixlist import validate_prefixlists
 from .acl import validate_acls
+from .sflow import validate_sflow
 
 
 class IPInterfaceWithPrefixLength(validators.Validator):
@@ -94,6 +95,7 @@ class Validator:
             validate_taps,
             validate_prefixlists,
             validate_acls,
+            validate_sflow,
         ]
 
     def validate(self, yaml):

vppcfg/config/acl.py

@@ -11,7 +11,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-""" A vppcfg configuration module that validates acls """
+"""A vppcfg configuration module that validates acls"""
 import logging
 import socket
 import ipaddress

vppcfg/config/address.py

@@ -11,7 +11,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-""" A vppcfg configuration module that handles addresses """
+"""A vppcfg configuration module that handles addresses"""
 import ipaddress
 
 

vppcfg/config/bondethernet.py

@@ -11,7 +11,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-""" A vppcfg configuration module that handles bondethernets """
+"""A vppcfg configuration module that handles bondethernets"""
 import logging
 from . import interface
 from . import mac

vppcfg/config/bridgedomain.py

@@ -11,7 +11,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-""" A vppcfg configuration module that handles bridgedomains """
+"""A vppcfg configuration module that handles bridgedomains"""
 import logging
 from . import interface
 from . import loopback

vppcfg/config/interface.py

@@ -11,7 +11,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-""" A vppcfg configuration module that validates interfaces """
+"""A vppcfg configuration module that validates interfaces"""
 import logging
 from . import bondethernet
 from . import bridgedomain

vppcfg/config/lcp.py

@@ -11,7 +11,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-""" A vppcfg configuration module that validates Linux Control Plane (lcp) elements """
+"""A vppcfg configuration module that validates Linux Control Plane (lcp) elements"""
 
 
 def get_lcps(yaml, interfaces=True, loopbacks=True, bridgedomains=True):

vppcfg/config/loopback.py

@@ -11,7 +11,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-""" A vppcfg configuration module that validates loopbacks """
+"""A vppcfg configuration module that validates loopbacks"""
 import logging
 from . import lcp
 from . import address

vppcfg/config/mac.py

@@ -11,7 +11,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-""" A vppcfg configuration module that validates MAC addresses """
+"""A vppcfg configuration module that validates MAC addresses"""
 import netaddr
 
 

vppcfg/config/prefixlist.py

@@ -11,7 +11,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-""" A vppcfg configuration module that validates prefixlists """
+"""A vppcfg configuration module that validates prefixlists"""
 import logging
 import ipaddress
 

vppcfg/config/sflow.py

@@ -0,0 +1,30 @@
+#
+# Copyright (c) 2024 Pim van Pelt
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+"""A vppcfg configuration module that validates sflow config"""
+import logging
+
+
+def validate_sflow(yaml):
+    """Validate the semantics of all YAML 'sflow' config entries"""
+    result = True
+    msgs = []
+    logger = logging.getLogger("vppcfg.config")
+    logger.addHandler(logging.NullHandler())
+
+    if not "sflow" in yaml:
+        return result, msgs
+
+    ## NOTE(pim): Nothing to validate. sflow config values are all
+    ##            integers and enforced by yamale.
+    return result, msgs

vppcfg/config/tap.py

@@ -11,7 +11,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-""" A vppcfg configuration module that validates taps """
+"""A vppcfg configuration module that validates taps"""
 import logging
 from . import mac
 

vppcfg/config/test_acl.py

@@ -12,7 +12,7 @@
 # limitations under the License.
 #
 # -*- coding: utf-8 -*-
-""" Unit tests for taps """
+"""Unit tests for taps"""
 import unittest
 import yaml
 from . import acl
@@ -130,28 +130,28 @@ class TestACLMethods(unittest.TestCase):
         for s in ["192.0.2.1", "192.0.2.1/24", "2001:db8::1", "2001:db8::1/64"]:
             l = acl.get_network_list(self.cfg, s)
             self.assertIsInstance(l, list)
-            self.assertEquals(1, len(l))
+            self.assertEqual(1, len(l))
             n = l[0]
 
         l = acl.get_network_list(self.cfg, "trusted")
         self.assertIsInstance(l, list)
-        self.assertEquals(5, len(l))
+        self.assertEqual(5, len(l))
 
         l = acl.get_network_list(self.cfg, "trusted", want_ipv6=False)
         self.assertIsInstance(l, list)
-        self.assertEquals(2, len(l))
+        self.assertEqual(2, len(l))
 
         l = acl.get_network_list(self.cfg, "trusted", want_ipv4=False)
         self.assertIsInstance(l, list)
-        self.assertEquals(3, len(l))
+        self.assertEqual(3, len(l))
 
         l = acl.get_network_list(self.cfg, "trusted", want_ipv4=False, want_ipv6=False)
         self.assertIsInstance(l, list)
-        self.assertEquals(0, len(l))
+        self.assertEqual(0, len(l))
 
         l = acl.get_network_list(self.cfg, "pl-notexist")
         self.assertIsInstance(l, list)
-        self.assertEquals(0, len(l))
+        self.assertEqual(0, len(l))
 
     def test_network_list_has_family(self):
         l = acl.get_network_list(self.cfg, "trusted")

vppcfg/config/test_address.py

@@ -12,7 +12,7 @@
 # limitations under the License.
 #
 # -*- coding: utf-8 -*-
-""" Unit tests for addresses """
+"""Unit tests for addresses"""
 import unittest
 import yaml
 from . import address

vppcfg/config/test_bondethernet.py

@@ -12,7 +12,7 @@
 # limitations under the License.
 #
 # -*- coding: utf-8 -*-
-""" Unit tests for bondethernet """
+"""Unit tests for bondethernet"""
 import unittest
 import yaml
 from . import bondethernet

vppcfg/config/test_bridgedomain.py

@@ -12,7 +12,7 @@
 # limitations under the License.
 #
 # -*- coding: utf-8 -*-
-""" Unit tests for bridgedomains """
+"""Unit tests for bridgedomains"""
 import unittest
 import yaml
 from . import bridgedomain

vppcfg/config/test_interface.py

@@ -12,7 +12,7 @@
 # limitations under the License.
 #
 # -*- coding: utf-8 -*-
-""" Unit tests for interfaces """
+"""Unit tests for interfaces"""
 import unittest
 import yaml
 from . import interface

vppcfg/config/test_lcp.py

@@ -12,7 +12,7 @@
 # limitations under the License.
 #
 # -*- coding: utf-8 -*-
-""" Unit tests for LCPs """
+"""Unit tests for LCPs"""
 import unittest
 import yaml
 from . import lcp

vppcfg/config/test_loopback.py

@@ -12,7 +12,7 @@
 # limitations under the License.
 #
 # -*- coding: utf-8 -*-
-""" Unit tests for loopbacks """
+"""Unit tests for loopbacks"""
 import unittest
 import yaml
 from . import loopback

vppcfg/config/test_mac.py

@@ -12,7 +12,7 @@
 # limitations under the License.
 #
 # -*- coding: utf-8 -*-
-""" Unit tests for MAC addresses """
+"""Unit tests for MAC addresses"""
 import unittest
 from . import mac
 

vppcfg/config/test_prefixlist.py

@@ -12,7 +12,7 @@
 # limitations under the License.
 #
 # -*- coding: utf-8 -*-
-""" Unit tests for taps """
+"""Unit tests for taps"""
 import unittest
 import yaml
 from . import prefixlist
@@ -79,22 +79,22 @@ class TestACLMethods(unittest.TestCase):
     def test_get_network_list(self):
         l = prefixlist.get_network_list(self.cfg, "trusted")
         self.assertIsInstance(l, list)
-        self.assertEquals(5, len(l))
+        self.assertEqual(5, len(l))
 
         l = prefixlist.get_network_list(self.cfg, "trusted", want_ipv6=False)
         self.assertIsInstance(l, list)
-        self.assertEquals(2, len(l))
+        self.assertEqual(2, len(l))
 
         l = prefixlist.get_network_list(self.cfg, "trusted", want_ipv4=False)
         self.assertIsInstance(l, list)
-        self.assertEquals(3, len(l))
+        self.assertEqual(3, len(l))
 
         l = prefixlist.get_network_list(
             self.cfg, "trusted", want_ipv4=False, want_ipv6=False
         )
         self.assertIsInstance(l, list)
-        self.assertEquals(0, len(l))
+        self.assertEqual(0, len(l))
 
         l = prefixlist.get_network_list(self.cfg, "pl-notexist")
         self.assertIsInstance(l, list)
-        self.assertEquals(0, len(l))
+        self.assertEqual(0, len(l))

vppcfg/config/test_tap.py

@@ -12,7 +12,7 @@
 # limitations under the License.
 #
 # -*- coding: utf-8 -*-
-""" Unit tests for taps """
+"""Unit tests for taps"""
 import unittest
 import yaml
 from . import tap

vppcfg/config/test_vxlan_tunnel.py

@@ -12,7 +12,7 @@
 # limitations under the License.
 #
 # -*- coding: utf-8 -*-
-""" Unit tests for vxlan_tunnels """
+"""Unit tests for vxlan_tunnels"""
 import unittest
 import yaml
 from . import vxlan_tunnel

vppcfg/config/unittestyaml.py

@@ -1,4 +1,4 @@
-""" module to help locate unittest resources """
+"""module to help locate unittest resources"""
 
 #!/usr/bin/env python
 #

vppcfg/config/vxlan_tunnel.py

@@ -11,7 +11,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-""" A vppcfg configuration module that validates vxlan_tunnels """
+"""A vppcfg configuration module that validates vxlan_tunnels"""
 import logging
 import ipaddress
 

vppcfg/example.yaml

@@ -10,10 +10,12 @@ interfaces:
     device-type: dpdk
     mtu: 9000
     description: "LAG #1"
+    sflow: true
   GigabitEthernet3/0/1:
     device-type: dpdk
     mtu: 9000
     description: "LAG #2"
+    sflow: false
 
   HundredGigabitEthernet12/0/0:
     device-type: dpdk
@@ -163,3 +165,8 @@ acls:
          icmp-code: any
        - description: "Deny any IPv4 or IPv6"
          action: deny
+
+sflow:
+  header-bytes: 128
+  polling-interval: 30
+  sampling-rate: 1000

vppcfg/schema.yaml

@@ -6,6 +6,7 @@ vxlan_tunnels: map(include('vxlan'),key=str(matches='vxlan_tunnel[0-9]+'),requir
 taps: map(include('tap'),key=str(matches='tap[0-9]+'),required=False)
 prefixlists: map(include('prefixlist'),key=str(matches='[a-z][a-z0-9\-]+',min=1,max=64),required=False)
 acls: map(include('acl'),key=str(matches='[a-z][a-z0-9\-]+',min=1,max=56),required=False)
+sflow: include('sflow',required=False)
 ---
 vxlan:
   description: str(exclude='\'"',len=64,required=False)
@@ -56,7 +57,8 @@ interface:
   l2xc: str(required=False)
   state: enum('up', 'down', required=False)
   mpls: bool(required=False)
-  device-type: enum('dpdk', required=False)
+  device-type: enum('dpdk', 'af-packet', required=False)
+  sflow: bool(required=False)
 ---
 sub-interface:
   description: str(exclude='\'"',len=64,required=False)
@@ -113,3 +115,8 @@ acl-term:
 acl:
   description: str(exclude='\'"',len=64,required=False)
   terms: list(include('acl-term'), min=1, max=100, required=True)
+---
+sflow:
+  header-bytes: int(min=1,max=256,required=False)
+  polling-interval: int(min=5,max=600,required=False)
+  sampling-rate: int(min=100,max=1000000,required=False)

vppcfg/tests.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 #
 # -*- coding: utf-8 -*-
-""" This is a unit test suite for vppcfg """
+"""This is a unit test suite for vppcfg"""
 # pylint: disable=duplicate-code
 import os
 import sys

vppcfg/vpp/__init__.py

@@ -13,4 +13,4 @@
 # limitations under the License.
 #
 # -*- coding: utf-8 -*-
-""" __init__.py added to suppress pylint error """
+"""__init__.py added to suppress pylint error"""

vppcfg/vpp/dumper.py

@@ -67,6 +67,7 @@ class Dumper(VPPApi):
             "taps": {},
             "prefixlists": {},
             "acls": {},
+            "sflow": {},
         }
         for idx, bond_iface in self.cache["bondethernets"].items():
             bond = {"description": ""}
@@ -122,6 +123,7 @@ class Dumper(VPPApi):
                     "bond",
                     "VXLAN",
                     "dpdk",
+                    "af-packet",
                     "virtio",
                     "pg",
                 ]:
@@ -141,6 +143,8 @@ class Dumper(VPPApi):
                             i["addresses"] = self.cache["interface_addresses"][
                                 iface.sw_if_index
                             ]
+                    if iface.sw_if_index in self.cache["interface_mpls"]:
+                        i["mpls"] = self.cache["interface_mpls"][iface.sw_if_index]
                     if iface.sw_if_index in self.cache["l2xcs"]:
                         l2xc = self.cache["l2xcs"][iface.sw_if_index]
                         i["l2xc"] = self.cache["interfaces"][
@@ -152,7 +156,7 @@ class Dumper(VPPApi):
                         i["state"] = "down"
 
                     if (
-                        iface.interface_dev_type == "dpdk"
+                        iface.interface_dev_type in ["dpdk", "af-packet"]
                         and iface.sub_number_of_tags == 0
                     ):
                         i["mac"] = str(iface.l2_address)
@@ -190,6 +194,10 @@ class Dumper(VPPApi):
                     config["interfaces"][sup_iface.interface_name]["sub-interfaces"][
                         iface.sub_id
                     ] = i
+        if iface.interface_dev_type in ["dpdk", "af-packet"]:
+            config["interfaces"][iface.interface_name][
+                "device-type"
+            ] = iface.interface_dev_type
 
         for idx, iface in self.cache["vxlan_tunnels"].items():
             vpp_iface = self.cache["interfaces"][iface.sw_if_index]
@@ -353,4 +361,9 @@ class Dumper(VPPApi):
 
             config["acls"][aclname] = config_acl
 
+        config["sflow"] = self.cache["sflow"]
+        for hw_if_index in self.cache["interface_sflow"]:
+            vpp_iface = self.cache["interfaces"][hw_if_index]
+            config["interfaces"][vpp_iface.interface_name]["sflow"] = True
+
         return config

vppcfg/vpp/reconciler.py

@@ -967,6 +967,9 @@ class Reconciler:
         if not self.__sync_mpls_state():
             self.logger.warning("Could not sync interface MPLS state in VPP")
             ret = False
+        if not self.__sync_sflow_state():
+            self.logger.warning("Could not sync interface sFlow state in VPP")
+            ret = False
         if not self.__sync_admin_state():
             self.logger.warning("Could not sync interface adminstate in VPP")
             ret = False
@@ -1311,6 +1314,55 @@ class Reconciler:
             ret = False
         return ret
 
+    def __sync_sflow_state(self):
+        """Synchronize the VPP Dataplane configuration and phy sFlow state"""
+
+        if "sflow" in self.cfg and self.vpp.cache["sflow"]:
+            if "header-bytes" in self.cfg["sflow"]:
+                if (
+                    self.vpp.cache["sflow"]["header-bytes"]
+                    != self.cfg["sflow"]["header-bytes"]
+                ):
+                    cli = f"sflow header-bytes {self.cfg['sflow']['header-bytes']}"
+                    self.cli["sync"].append(cli)
+            if "polling-interval" in self.cfg["sflow"]:
+                if (
+                    self.vpp.cache["sflow"]["polling-interval"]
+                    != self.cfg["sflow"]["polling-interval"]
+                ):
+                    cli = f"sflow polling-interval {self.cfg['sflow']['polling-interval']}"
+                    self.cli["sync"].append(cli)
+            if "sampling-rate" in self.cfg["sflow"]:
+                if (
+                    self.vpp.cache["sflow"]["sampling-rate"]
+                    != self.cfg["sflow"]["sampling-rate"]
+                ):
+                    cli = f"sflow sampling-rate {self.cfg['sflow']['sampling-rate']}"
+                    self.cli["sync"].append(cli)
+
+        for ifname in interface.get_interfaces(self.cfg):
+            vpp_ifname, config_iface = interface.get_by_name(self.cfg, ifname)
+
+            try:
+                config_sflow = config_iface["sflow"]
+            except KeyError:
+                config_sflow = False
+
+            vpp_sflow = False
+            if vpp_ifname in self.vpp.cache["interface_names"]:
+                hw_if_index = self.vpp.cache["interface_names"][vpp_ifname]
+                try:
+                    vpp_sflow = self.vpp.cache["interface_sflow"][hw_if_index]
+                except KeyError:
+                    pass
+            if vpp_sflow != config_sflow:
+                if config_sflow:
+                    cli = f"sflow enable {vpp_ifname}"
+                else:
+                    cli = f"sflow enable-disable {vpp_ifname} disable"
+                self.cli["sync"].append(cli)
+        return True
+
     def __sync_mpls_state(self):
         """Synchronize the VPP Dataplane configuration for interface and loopback MPLS state"""
         for ifname in loopback.get_loopbacks(self.cfg) + interface.get_interfaces(

vppcfg/vpp/vppapi.py

@@ -130,6 +130,8 @@ class VPPApi:
             "taps": {},
             "acls": {},
             "acl_tags": {},
+            "interface_sflow": {},
+            "sflow": {},
         }
         return True
 
@@ -415,6 +417,33 @@ class VPPApi:
         for tap in api_response:
             self.cache["taps"][tap.sw_if_index] = tap
 
+        try:
+            self.logger.debug("Retrieving sFlow")
+
+            api_response = self.vpp.api.sflow_sampling_rate_get()
+            if api_response:
+                self.cache["sflow"]["sampling-rate"] = api_response.sampling_N
+            api_response = self.vpp.api.sflow_polling_interval_get()
+            if api_response:
+                self.cache["sflow"]["polling-interval"] = api_response.polling_S
+            api_response = self.vpp.api.sflow_header_bytes_get()
+            if api_response:
+                self.cache["sflow"]["header-bytes"] = api_response.header_B
+
+            api_response = self.vpp.api.sflow_interface_dump()
+            for iface in api_response:
+                self.cache["interface_sflow"][iface.hw_if_index] = True
+        except AttributeError as err:
+            self.logger.warning(f"sFlow API not found - missing plugin: {err}")
+
+        self.logger.debug("Retrieving interface Unnumbered state")
+        api_response = self.vpp.api.ip_unnumbered_dump()
+        for iface in api_response:
+            self.cache["interface_unnumbered"][iface.sw_if_index] = iface.ip_sw_if_index
+
+        self.logger.debug("Retrieving bondethernets")
+        api_response = self.vpp.api.sw_bond_interface_dump()
+
         self.cache_read = True
         return self.cache_read
 

vppcfg/vppcfg.py

@@ -14,7 +14,7 @@
 #
 # -*- coding: utf-8 -*-
 """vppcfg is a utility to configure a running VPP Dataplane using YAML
-config files. See http://github.com/pimvanpelt/vppcfg/README.md for details. """
+config files. See http://github.com/pimvanpelt/vppcfg/README.md for details."""
 # pylint: disable=duplicate-code
 import os
 import sys