summaryrefslogtreecommitdiff
path: root/manpages.mk
Commit message (Collapse)AuthorAgeFilesLines
* dist-docs: New utility to generate a documentation bundle for the website.Ben Pfaff2014-12-021-0/+2
| | | | | | | | | | | | | | This utility isn't going to be as portable as most of the Open vSwitch utilities, unfortunately. I'm happy to take improvements to make it able to work with, e.g., the "man" program from BSD. (I haven't tested with that program, but I suspect that it is somewhat different from the GNU version.) The output of this program can already be viewed at: http://openvswitch.org/support/dist-docs/ Signed-off-by: Ben Pfaff <blp@nicira.com> Acked-by: Thomas Graf <tgraf@noironetworks.com>
* openvswitch: Userspace tunneling.Pravin B Shelar2014-11-121-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | Following patch adds support for userspace tunneling. Tunneling needs three more component first is routing table which is configured by caching kernel routes and second is ARP cache which build automatically by snooping arp. And third is tunnel protocol table which list all listening protocols which is populated by vswitchd as tunnel ports are added. GRE and VXLAN protocol support is added in this patch. Tunneling works as follows: On packet receive vswitchd check if this packet is targeted to tunnel port. If it is then vswitchd inserts tunnel pop action which pops header and sends packet to tunnel port. On packet xmit rather than generating Set tunnel action it generate tunnel push action which has tunnel header data. datapath can use tunnel-push action data to generate header for each packet and forward this packet to output port. Since tunnel-push action contains most of packet header vswitchd needs to lookup routing table and arp table to build this action. Signed-off-by: Pravin B Shelar <pshelar@nicira.com> Acked-by: Jarno Rajahalme <jrajahalme@nicira.com> Acked-by: Thomas Graf <tgraf@noironetworks.com> Acked-by: Ben Pfaff <blp@nicira.com>
* ovs-vswitchd: Document the '--unixctl' option.Gurucharan Shetty2014-10-061-0/+2
| | | | | | | | The option is documented for ovsdb-server but not for ovs-vswitchd. This commit adds the documentation for ovs-vswitchd too. Signed-off-by: Gurucharan Shetty <gshetty@nicira.com> Acked-by: Alex Wang <alexw@nicira.com>
* test-controller: Rename to ovs-testcontroller, again install.Ben Pfaff2014-08-261-20/+20
| | | | | | | | | | | mininet uses the Open vSwitch controller by default, for testing. CC: 757761@bugs.debian.org Reported-at: https://bugs.debian.org/757761 Requested-by: Tomasz Buchert <tomasz.buchert@inria.fr> Requested-by: Dariusz Dwornikowski <dariusz.dwornikowski@cs.put.poznan.pl> Signed-off-by: Ben Pfaff <blp@nicira.com> Acked-by: Justin Pettit <jpettit@nicira.com>
* dpctl: add ovs-appctl dpctl/* commands to talk to dpif-netdevDaniele Di Proietto2014-08-041-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This commit introduces multiple appctl commands (dpctl/*) They are needed to interact with userspace datapaths (dpif-netdev), because the ovs-dpctl command runs in a separate process and cannot see the userspace datapaths inside vswitchd. This change moves most of the code of utilities/ovs-dpctl.c in lib/dpctl.c. Both the ovs-dpctl command and the ovs-appctl dpctl/* commands make calls to lib/dpctl.c functions, to interact with datapaths. The code from utilities/ovs-dpctl.c has been moved to lib/dpctl.c and has been changed for different reasons: - An exit() call in the old code made perfectly sense. Now (since the code can be run inside vswitchd) it would terminate the daemon. Same reasoning can be applied to ovs_fatal_*() calls. - The lib/dpctl.c code _should_ not leak memory. - All the print* have been replaced with a function pointer provided by the caller, since this code can be run in the ovs-dpctl process (in which case we need to print to stdout) or in response to a unixctl request (and in this case we need to send everything through a socket, using JSON encapsulation). The syntax is ovs-appctl dpctl/(COMMAND) [OPTIONS] [PARAMETERS] while the ovs-dpctl syntax (which _should_ remain the same after this change) is ovs-dpctl [OPTIONS] (COMMAND) [PARAMETERS] Signed-off-by: Daniele Di Proietto <ddiproietto@vmware.com> [blp@nicira.com made stylistic and documentation changes] Signed-off-by: Ben Pfaff <blp@nicira.com>
* ovs-ofctl: Add --unixctl command line option.Ben Pfaff2014-07-281-0/+2
| | | | | | | | This matches the option offered by some other Open vSwitch daemons. I intend to use it in tests in an upcoming commit. Signed-off-by: Ben Pfaff <blp@nicira.com> Acked-by: Justin Pettit <jpettit@nicira.com>
* man: Document common options in ovs-vsctl and vtep-ctl.Justin Pettit2014-02-281-0/+4
| | | | | Signed-off-by: Justin Pettit <jpettit@nicira.com> Acked-by: Ben Pfaff <blp@nicira.com>
* daemon-windows: Add users for windows services.Gurucharan Shetty2014-02-041-0/+6
| | | | | | Start with ovs-vswitchd and ovsdb-server. Signed-off-by: Gurucharan Shetty <gshetty@nicira.com>
* ovs-controller: Rename test-controller and do not install or package.Ben Pfaff2013-11-021-19/+19
| | | | | | | | | Too many users have incorrectly assumed that ovs-controller is a necessary or desirable part of an Open vSwitch deployment. This commit should fix the problem by renaming it test-controller and removing it from the default install and from packaging. Signed-off-by: Ben Pfaff <blp@nicira.com>
* vtep: Add vtep-ctl command.Justin Pettit2013-10-171-0/+22
| | | | | | | | The vtep-ctl command provides a user interface to manipulate the VTEP OVSDB schema. Signed-off-by: Justin Pettit <jpettit@nicira.com> Acked-by: Ben Pfaff <blp@nicira.com>
* classifier: Speed up lookup when metadata partitions the flow table.Ben Pfaff2013-09-261-4/+4
| | | | | | | | | | | | | | | | | | | We have a controller that puts many rules with different metadata values into the flow table, where metadata is used (by "resubmit"s) to distinguish stages in a pipeline. Thus, any given flow only needs to be hashed into classifier "cls_table"s that contain a match for the flow's metadata value. This commit optimizes the classifier lookup by (probabilistically) skipping the "cls_table"s that can't possibly match. (The "metadata" referred to here is the OpenFlow 1.1+ "metadata" field, which is a 64-bit field similar in purpose to the "registers" defined by Open vSwitch.) Previous versions of this patch, with earlier versions of the controller in question, improved flow setup performance by about 19%. Bug #14282. Signed-off-by: Ben Pfaff <blp@nicira.com>
* utilities: a top like tool for ovs-dpctl dump-flows.Mark Hamilton2013-09-171-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | This python script summarizes ovs-dpctl dump-flows content by aggregating the number of packets, total bytes and occurrence of the following fields: - Datapath in_port - Ethernet type - Source and destination MAC addresses - IP protocol - Source and destination IPv4 addresses - Source and destination IPv6 addresses - UDP and TCP destination port - Tunnel source and destination addresses Testing included confirming both mega-flows and non-megaflows are properly parsed. Bit masks are applied in the case of mega-flows prior to aggregation. Test --script parameter which runs in non-interactive mode. Tested syntax against python 2.4.3, 2.6 and 2.7. Confirmed script passes pep8 and pylint run as: pylint --disable=I0011 --include-id=y --reports=n This tool has been added to these distribution: - add ovs-dpctl-top to debian distribution - add ovs-dpctl-top to rpm distribution. - add ovs-dpctl-top to XenServer RPM. Signed-off-by: Mark Hamilton <mhamilton@nicira.com> Signed-off-by: Gurucharan Shetty <gshetty@nicira.com>
* stress: Remove essentially unused library.Ben Pfaff2013-07-151-4/+0
| | | | | | | | | | | | | The "stress" library was introduced years ago. We intended at the time to start using it to provoke errors in testing, to make sure that Open vSwitch was resilient against those errors. The intention was good, but there were few actual implementations of stress options, and the testing never materialized. Rather than adapt the stress library for thread safety, this seems like a good opportunity to remove it, so this commit does so. Signed-off-by: Ben Pfaff <blp@nicira.com>
* leak-checker: Remove because it cannot be made thread-safe.Ben Pfaff2013-06-171-2/+0
| | | | | | | | | The underlying glibc interface is deprecated because the interface itself is not thread-safe. That means that there's no way for a layer on top of it to be thread-safe. Signed-off-by: Ben Pfaff <blp@nicira.com> Acked-by: Ethan Jackson <ethan@nicira.com>
* vswitchd: Document coverage/show command.Gurucharan Shetty2013-03-251-0/+2
| | | | | | | coverage/show command documentation is currently missing from ovs-vswitchd's man page. Signed-off-by: Gurucharan Shetty <gshetty@nicira.com>
* manpages.mk: Install auto-generated update.Ben Pfaff2013-01-071-0/+4
| | | | Signed-off-by: Ben Pfaff <blp@nicira.com>
* openvswitch: Remove Linux bridge compatibility.Pravin B Shelar2012-12-271-12/+0
| | | | | | | | | Currently brcompat does not work on master due to recent datapath changes. We have decided to remove it as it is not used very widely. Signed-off-by: Pravin B Shelar <pshelar@nicira.com> Acked-by: Jesse Gross <jesse@nicira.com>
* ovs-ofctl: Add option to set allowed OpenFlow versionsSimon Horman2012-11-291-0/+2
| | | | | | | | | | | | | | | | | --protocols allows configuration of the versions that may be used when establishing an OpenFlow connection. The default is 'OpenFlow10' which is consistent with the behaviour prior to this patch. The useful values at this time are: 'OpenFlow10', 'OpenFlow12', 'OpenFlow13', Values may be combined in a comma delimited list. e.g.: --protocols 'OpenFlow10,OpenFlow12,OpenFlow13' Signed-off-by: Simon Horman <horms@verge.net.au> Signed-off-by: Ben Pfaff <blp@nicira.com>
* ofproto-dpif: Add ovs-appctl commands for ovs-dpctl functions.Justin Pettit2012-11-011-0/+2
| | | | | | | | | | | These commands will be useful in a future commit that makes multiple bridges share a single backing datapath. The ovs-dpctl commands will show information about the backing datapath, so it will be difficult to determine which information belongs to which bridge. The new "dpif/*" ovs-appctl commands return information about the bridge--regardless of how the backing datapath is configured. Signed-off-by: Justin Pettit <jpettit@nicira.com>
* memory: Document the memory/show unixctl command.Ben Pfaff2012-07-131-0/+4
| | | | | Suggested-by: Justin Pettit <jpettit@nicira.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
* ovs-l3ping: A new test utility that allows to detect L3 tunneling issuesAnsis Atteka2012-07-021-0/+8
| | | | | | | | | | | | | | | | | | ovs-l3ping is similar to ovs-test, but the main difference is that it does not require administrator to open firewall holes for the XML/RPC control connection. This is achieved by encapsulating the Control Connection over the L3 tunnel itself. This tool is not intended as a replacement for ovs-test, because ovs-test covers much broader set of test cases. Sample usage: Node1: ovs-l3ping -s 192.168.122.236,10.1.1.1 -t gre Node2: ovs-l3ping -c 192.168.122.220,10.1.1.2,10.1.1.1 -t gre Issue#11791 Signed-off-by: Ansis Atteka <aatteka@nicira.com>
* coverage: Make ovs-appctl command more useful and less alarming.Ben Pfaff2012-04-261-0/+2
| | | | | | | | | | | | | | | | | I've had a few complaints that ovs-vswitchd logs its coverage counters at WARN level, but this is mainly wrong: ovs-vswitchd only logs coverage counters at WARN level when the "coverage/log" command is used through ovs-appctl. This was even documented. The reason to log at such a high level was to make it fairly certain that these messages specifically requested by the admin would not be filtered out before making it to the log. But it's even better if the admin just gets the coverage counters as a reply to the ovs-appctl command. So that is what this commit does. This commit also improves the documentation of the ovs-appctl command. Signed-off-by: Ben Pfaff <blp@nicira.com>
* ovs-ofctl: Support daemonization for monitor and snoop.Ethan Jackson2012-01-101-0/+2
| | | | | | This will ease implementation of future unit tests. Signed-off-by: Ethan Jackson <ethan@nicira.com>
* ovs-test: A new tool that allows to diagnose connectivity and performance issuesAnsis Atteka2011-11-181-0/+10
| | | | | | | | | This tool will be a replacement for the current ovs-vlan-test utility. Besides from connectivity issues it will also be able to detect performance related issues in Open vSwitch setups. Currently it uses UDP and TCP protocols for stressing. Issue #6976
* Fix manpage-check on RHEL 5.Ben Pfaff2011-10-271-1/+3
| | | | | | | | | The version of groff on RHEL 5 doesn't include the .SY, .OP, or .YS macros that ovs-benchmark.1 uses, so the manpage-check target fails on that platform. This commit adds the groff definitions of those macros to a file and includes it into ovs-benchmark.1. I tested that this allows RHEL 5 to pass manpage-check.
* Implement automatic dependency generation for manpages.Ben Pfaff2011-10-261-0/+231
This ensures that manpages actually get rebuilt if any of the lib/*.man fragments that they depend upon are modified.