summaryrefslogtreecommitdiff
path: root/README.rst
Commit message (Collapse)AuthorAgeFilesLines
* doc: Fix the list of supported tunnels in README.Nobuhiro MIKI2023-04-251-1/+1
| | | | | | | | Without distinguishing between IPv4 and IPv6, such as GRE and GRE-IPv6, nine types of tunneling are currently supported. Signed-off-by: Nobuhiro MIKI <nmiki@yahoo-corp.jp> Signed-off-by: Ilya Maximets <i.maximets@ovn.org>
* travis: Drop support.David Marchand2022-12-211-2/+0
| | | | | | | | | | | | | | Following a change in the terms of use, free Travis credits are really too low for a realistic usage by OVS contributors. As a consequence, testing OVS with Travis has been abandoned by most (if not all) contributors to the project. Drop the Travis configuration from our repository, clean references in the documentation and move GHA specifics to the association yml. Acked-by: Aaron Conole <aconole@redhat.com> Signed-off-by: David Marchand <david.marchand@redhat.com> Signed-off-by: Ilya Maximets <i.maximets@ovn.org>
* docs: Remove remaining references to OVS kmod and XenServer.Ilya Maximets2022-08-151-10/+3
| | | | | | | | | | | README file still mentions a kernel module and some parts of the documentation still have XenServer references, e.g. 'xs-*' database configuration options. Removing them. Fixes: 422e90437854 ("make: Remove the Linux datapath.") Fixes: 83c9518e7c67 ("xenserver: Remove xenserver.") Acked-by: Aaron Conole <aconole@redhat.com> Signed-off-by: Ilya Maximets <i.maximets@ovn.org>
* github: Add GitHub Actions workflow.Ilya Maximets2020-11-261-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | This is an initial version of GitHub Actions support. It mostly mimics our current Travis CI build matrix with slight differences. The main issue is that we don't have ARM support here. Minor difference that we can not install 32-bit versions of libunwind and libunbound since those are not avaialble in repository. Higher concurrency level allows to finish all tests less than in 20 minutes. Which is 3 times faster than in Travis. .travis folder renamed to .ci to highlight that it used not only for Travis CI. Travis CI support will be reduced to only test ARM builds soon and will be completely removed when travis-ci.org will be turned into read-only mode. What happened to Travis CI: https://mail.openvswitch.org/pipermail/ovs-dev/2020-November/377773.html Acked-by: Simon Horman <simon.horman@netronome.com> Signed-off-by: Ilya Maximets <i.maximets@ovn.org>
* doc: Add CirrusCI status badge to README.Ilya Maximets2019-05-171-0/+2
| | | | | | | Badge for CirrusCI just like for other CI systems. Signed-off-by: Ilya Maximets <i.maximets@samsung.com> Acked-by: Aaron Conole <aconole@redhat.com>
* doc: Fix cropped what-is-ovs page.Ilya Maximets2019-05-171-2/+3
| | | | | | | | | | | | | | | | Despite of comments in both files no-one ever adjusted start/end-line in 'what-is-ovs' document. As a result, current document contains truncated "tools" section. Let's replace start/end-line with start-after/end-before which requires less attention. Additionally, 'make docs-check' will fail if specified lines will not be found, i.e it'll be harder to mess up the docs again. "Fixes" tag points to commit that broke the lines first. Fixes: 602e24ee189b ("doc: Remove experimental warning for DPDK.") Signed-off-by: Ilya Maximets <i.maximets@samsung.com> Acked-by: Stephen Finucane <stephen@that.guru>
* Edit Open vSwitch license info so that GitHub recognizes it.Andrea Kao2018-04-161-0/+33
| | | | | | | | | | | | | | | | | | | GitHub uses a library called Licensee to identify a project's license type. It shows this information in the status bar and via the API if it can unambiguously identify the license. This commit creates a LICENSE file that stores the full text of the Apache license. It also removes the COPYING file and transfers its contents to a new "License" section in the README. Collectively, these changes allow Licensee to successfully identify the license type of Open vSwitch's codebase as Apache. Submitted-at: https://github.com/openvswitch/ovs/pull/224 Signed-off-by: Andrea Kao <eirinikos@gmail.com> [blp@ovn.org removed references to COPYING and updated Makefile.am] Signed-off-by: Ben Pfaff <blp@ovn.org> Acked-by: Aaron Conole <aconole@redhat.com>
* github: Add Appveyor image and link to ReadmeAlin Gabriel Serdean2017-09-061-0/+2
| | | | | | | | Just a small nit to see current build status of appveyor. Also add a link so one could easily reach the history of the builds. Signed-off-by: Alin Gabriel Serdean <aserdean@ovn.org> Acked-by: Ben Pfaff <blp@ovn.org>
* doc: Clarify how user space is experimental.Ian Stokes2017-02-081-2/+2
| | | | | | | | | | Clarify that the use of the user space datapath with non DPDK devices is considered experimental. Fixes: 602e24ee189b (doc: Remove experimental warning for DPDK.) Signed-off-by: Ian Stokes <ian.stokes@intel.com> Co-authored-by: Joe Stringer <joe@ovn.org> Signed-off-by: Joe Stringer <joe@ovn.org>
* doc: Remove experimental warning for DPDK.Ian Stokes2017-02-061-3/+5
| | | | | | | | | Remove the experimental warning tag in documentation regarding OVS deployed with DPDK. Signed-off-by: Ian Stokes <ian.stokes@intel.com> Acked-by: Kevin Traynor <ktraynor@redhat.com> Signed-off-by: Daniele Di Proietto <diproiettod@vmware.com>
* doc: Add a 'what-is-ovs' documentStephen Finucane2016-12-221-3/+3
| | | | | | | | Add description of Open vSwitch from README, along with the overview image from openvswitch.org. Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Ben Pfaff <blp@ovn.org>
* doc: Populate 'faq' sectionStephen Finucane2016-12-121-1/+1
| | | | | | | | This is mostly the exact same contents, albeit broken up into multiple files. Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Ben Pfaff <blp@ovn.org>
* doc: Populate 'tutorials' sectionStephen Finucane2016-12-121-1/+1
| | | | | | | Rename 'tutorial' to 'ovs-advanced' and 'ovn-tutorial' to 'ovn-basics'. Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Ben Pfaff <blp@ovn.org>
* doc: Populate 'install', 'howto' sectionsStephen Finucane2016-12-121-26/+6
| | | | | | | | | This is a dumb move of all 'INSTALL*' docs, with very little refactoring (mostly updating links and making the titles a little more consistent. Additional refactoring will be done in subsequent changes. Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Ben Pfaff <blp@ovn.org>
* doc: Remove final markdown referencesStephen Finucane2016-11-071-1/+1
| | | | | | | | | There are some leftover Markdown references and Markdown-related tooling. Seeing as there are no Markdown files left, we can kill it all with fire. Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Russell Bryant <russell@ovn.org>
* doc: Convert tutorial/Tutorial to rSTStephen Finucane2016-11-041-1/+1
| | | | | Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Russell Bryant <russell@ovn.org>
* doc: Convert INSTALL.SELinux to rSTStephen Finucane2016-11-031-1/+1
| | | | | | | Refer to 'dnf' and not the deprecated 'yum'. Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Russell Bryant <russell@ovn.org>
* doc: Convert INSTALL.RHEL to rSTStephen Finucane2016-11-031-1/+1
| | | | | Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Russell Bryant <russell@ovn.org>
* doc: Convert INSTALL.Libvirt to rSTStephen Finucane2016-11-031-1/+1
| | | | | Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Russell Bryant <russell@ovn.org>
* doc: Convert INSTALL.SSL to rSTStephen Finucane2016-11-031-1/+1
| | | | | Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Russell Bryant <russell@ovn.org>
* doc: Convert INSTALL.Fedora to rSTStephen Finucane2016-11-031-1/+1
| | | | | Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Russell Bryant <russell@ovn.org>
* doc: Convert FAQ to rSTStephen Finucane2016-10-291-1/+1
| | | | | Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Russell Bryant <russell@ovn.org>
* doc: Convert README to rSTStephen Finucane2016-10-211-0/+116
Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Russell Bryant <russell@ovn.org>