From 05eed4542b881f8db7d32b5edcd87eb14a1a55e7 Mon Sep 17 00:00:00 2001 From: Alfredo Moralejo Date: Feb 06 2023 16:34:51 +0000 Subject: Initial commit --- diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7f1f038 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright Red Hat. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..c085ed4 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# NFV SIG documentation + +This git repository contains the source files required to generate +the NFV SIG documentation hosted at: +https://sigs.centos.org/nfv/ + +The source files are in markdown format. The repository uses [mkdocs](https://mkdocs.org) + +## Testing locally in a fedora system + +1. Install mkdocs + +``` +# dnf install mkdocs -y +``` + +2. To build de html doc, enter the directory where you cloned this repo and made your modifications. + +``` +mkdocs build +``` + +3. Open a browser and navigate to the created html under site/index.html + +4. After you develop the content locally, git commit and push the changes or send a PR. diff --git a/docs/custom_theme/img/centos.png b/docs/custom_theme/img/centos.png new file mode 100644 index 0000000..955a805 Binary files /dev/null and b/docs/custom_theme/img/centos.png differ diff --git a/docs/custom_theme/img/favicon.ico b/docs/custom_theme/img/favicon.ico new file mode 100644 index 0000000..68b708b Binary files /dev/null and b/docs/custom_theme/img/favicon.ico differ diff --git a/docs/custom_theme/img/favicon.png b/docs/custom_theme/img/favicon.png new file mode 100644 index 0000000..4332c1f Binary files /dev/null and b/docs/custom_theme/img/favicon.png differ diff --git a/docs/custom_theme/main.html b/docs/custom_theme/main.html new file mode 100644 index 0000000..76d2615 --- /dev/null +++ b/docs/custom_theme/main.html @@ -0,0 +1,19 @@ +{% extends "base.html" %} + +{%- block site_name %} + + {% if config.logo %} + logo + {% endif %} + {{ config.site_name }} + +{%- endblock %} + + +{%- block footer %} +
+{%- if config.copyright %} +

{{ config.copyright }}

+{%- endif %} + +{%- endblock %} diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..830d673 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,91 @@ +# Welcome to the Network Functions Virtualization (NFV) SIG + +*This site contains general information about the NFV SIG* + +The CentOS NFV SIG provides a CentOS-based stack that will serve as a platform for the deployment and testing of virtual network functions (VNFs) and NFV component packages on compliant CentOS platform. + +Currently, the main goal is to provide RPM packages of [OpenvSwitch](https://www.openvswitch.org/) and [Open Virtual Network](https://www.ovn.org/en/) software for CentOS Stream that can be used by other projects as oVirt, OpenStack or OpenShift. + +The content provided by this SIG is aligned with the packages provided by Red Hat Fast Datapath, where Red Hat includes support for accelerated and non-accelerated data paths such as SR-IOV, OVS (kernel), DPDK, OVS-DPDK, OVS Offload and others. For more information about it, see [this Red Hat article (requires login)](https://access.redhat.com/articles/3538141). + + +## Packages and CentOs Stream versions matrix + +The following table shows the versions of OpenvSwitch and OVN included for the different CentOS Stream versions and which ones are tested together. + +|CentOS | OpenvSwitch | Open Virtual Network| +|-------|-------------|---------------------| +| CentOS Stream 8 | 2.13 | 2.13 | +| CentOS Stream 8 | 2.15 | 2021 | +| CentOS Stream 8 | 2.16 | | +| CentOS Stream 8 | 2.17 | 2022 | +| CentOS Stream 9 | 2.16 | | +| CentOS Stream 9 | 2.17 | 2022 | + +In addition of these packages, the package openvswitch-selinux-extra-policy is provided by NFV SIG as a requirement to run openvswitch/ovn with Selinux enabled. + +Packages are provided for x86_64, aarch64 an ppc64le architectures. + +## Installing OpenvSwitch and OVN + +**1. Install NFV SIG openvswitch repository** + +``` +# sudo dnf install centos-release-nfv-openvswitch -y +``` + +**2. Install the openvswitch package for the desired version** + +In order to allow the installation of the different versions of openvswitch and ovn from a single repository the name of the package is different for each version, +composed of the name (openvswitch or ovn) and the version, as in openvswitch2.17, openvswitch2.15 or ovn2.13, ovn-2021 or ovn22.09. You can list the full list of versions on NFV SIG +repositoris by executing the command: + +``` +# dnf list "openvswitch*" "ovn*" +``` + +Once you have the list of the desired versions, you can install them with the usual dnf command: + + +``` +# sudo dnf install openvswitch2.17 ovn22.09 +``` + +## Considerations about upgrades + +The update from a version of OpenvSwitch or OVN to a newer major one (i.e. from 2.15 to 2.17 or from 2021 to 2022) requires uninstalling the previous one. This can be done in a single command with --allowerasing option. + +Thus, updating from a running openvswitch2.15 to openvswitch2.17: + +``` +# sudo dnf install openvswitch2.17 --allowerasing +``` + +and you will need to enable and start the openvswitch systemd service. + +Alternatively, you can also uninstall the old version and install the desired one. Note that the OpenvSwitch database will stay untouched so the new version will be able to handle the existing bridges, ports and flows. + +## NFV SIGs members + +Current members: + +- Alan Pevec +- Alfredo Moralejo +- Eitan Raviv +- Joel Capitao +- Michael Santana +- Thomas F Herbert +- Yatin Karel + +Current SIG chair is Alfredo Moralejo + +## IRC Meetings + +* Monthly, in the first Wednesday of the month +* Time: 15:00 UTC (date -d "1500 UTC") +* Where: IRC- Libera.chat - #centos-meeting + +## Contact points + +* [CentOS Devel mailing list](https://lists.centos.org/mailman/listinfo/centos-devel) +* IRC channel: `#centos-devel` on `irc.libera.chat`. For more information, see [Libera.Chat](https://libera.chat/). diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..13ef627 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,31 @@ +site_name: CentOS NFV SIG documentation +logo: custom_theme/img/centos.png + +repo_url: https://pagure.io/nfv-sig +repo_name: nfv-sig + +copyright: © Red Hat +nav: + - Home: index.md + +theme: + name: materia + nav_style: dark + navigation_depth: 4 + custom_dir: docs/custom_theme/ + logo: custom_theme/img/centos.png + favicon: custom_theme/img/favicon.ico + features: + - navigation.expand + - navigation.instant + - navigation.tracking + - navigation.top + - toc.integrate + +markdown_extensions: + - toc: + permalink: True + - sane_lists + - smarty + - admonition +# - pymdownx.superfences