summaryrefslogtreecommitdiff
path: root/tutorial
Commit message (Collapse)AuthorAgeFilesLines
* ovs-sandbox: add '--vswitchd-unforced-dummy' option.nickcooper-zhangtonghao2016-12-121-1/+9
| | | | | | | | | | | The ovs-sandbox runs in the "dummy mode" by default. In this mode of testing, no packets travel across physical or virtual networks. But sometimes, we may create veth network devices and add them to ovs bridge for developing and testing. It's necessary to add an option. Signed-off-by: nickcooper-zhangtonghao <nic@opencloud.tech> Signed-off-by: Ben Pfaff <blp@ovn.org>
* doc: Move WHY-OVSStephen Finucane2016-12-121-1/+1
| | | | | | | | This is moved separately due to the sheer number of references to this file in the codebase. Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Ben Pfaff <blp@ovn.org>
* doc: Populate 'tutorials' sectionStephen Finucane2016-12-125-1853/+2
| | | | | | | 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-122-5/+8
| | | | | | | | | 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: Convert tutorial/OVN-Tutorial to rSTStephen Finucane2016-11-044-394/+333
| | | | | | | | | | | | | | | There's a mismash of absolute and relative URLs, but these will be resolved by the move to Sphinx. In addition, the URLs pointing to the test scripts are removed as they will break when we move to Sphinx. This is because they won't be published with the Sphinx docs, ruling out relative links, and OVS evolves too fast to rely on non-breaking links to GitHub. Better to rely on shell examples like we do elsewhere and let the user figure it out. Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Russell Bryant <russell@ovn.org>
* doc: Convert tutorial/Tutorial to rSTStephen Finucane2016-11-044-861/+872
| | | | | Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Russell Bryant <russell@ovn.org>
* Correct references to env7 packet scriptsGenevieve LEsperance2016-11-031-2/+2
| | | | | | Submitted-at: https://github.com/openvswitch/ovs/pull/160 Signed-off-by: Genevieve LEsperance <glesperance@pivotal.io> Signed-off-by: Russell Bryant <russell@ovn.org>
* doc: Convert WHY-OVS to rSTStephen Finucane2016-10-261-1/+1
| | | | | Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Russell Bryant <russell@ovn.org>
* doc: Convert INSTALL.Docker to rSTStephen Finucane2016-10-181-1/+1
| | | | | Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Russell Bryant <russell@ovn.org>
* doc: Convert INSTALL to rSTStephen Finucane2016-10-181-2/+2
| | | | | Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Russell Bryant <russell@ovn.org>
* Change some old references to nicira-ext.h.Thadeu Lima de Souza Cascardo2016-09-301-1/+2
| | | | | | | | Some of these references are not valid anymore, as things were moved to either meta-flow.h or ofp-actions.c. Signed-off-by: Thadeu Lima de Souza Cascardo <cascardo@redhat.com> Signed-off-by: Ben Pfaff <blp@ovn.org>
* lib: Retire packet buffering feature.Jarno Rajahalme2016-08-301-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | OVS implementation of buffering packets that are sent to the controller is not compliant with the OpenFlow specifications after OpenFlow 1.0, which is possibly true since OpenFlow 1.0 is not really specifying the packet buffering behavior. OVS implementation executes the buffered packet against the actions of the modified or added rule, whereas OpenFlow (since 1.1) specifies that the packet should be matched against the flow table 0 and processed accordingly. Rather than fix this behavior, and potentially break OVS users, the packet buffering feature is removed altogether. After all, such packet buffering is an optional OpenFlow feature, and as such any possible users should continue to work without this feature. This patch also makes OVS check the received 'buffer_id' values more rigorously, and fixes some internal users accordingly. Found by inspection. Signed-off-by: Jarno Rajahalme <jarno@ovn.org> Acked-by: Ben Pfaff <blp@ovn.org>
* OVN-Tutorial: Replace example with ASCII quotes.Justin Pettit2016-08-121-1/+1
| | | | | | | | The "--ovn" argument for SANDBOXFLAGS used unicode quotes, which when copy and pasted made the command mysteriously fail. Signed-off-by: Justin Pettit <jpettit@ovn.org> Acked-by: Lance Richardson <lrichard@redhat.com>
* sandbox: launch SB backup server when running in OVN modeAndy Zhou2016-08-152-3/+23
| | | | | | | | | | Automatically launch backup server for OVN SB database that replicates all transactions of the active server. This can be handy for experimenting with the newly added replication feature. Signed-off-by: Andy Zhou <azhou@ovn.org> Acked-by: Ben Pfaff <blp@ovn.org> Acked-by: Russell Bryant <russell@ovn.org>
* ovn: improve OVN tutorial.nickcooper-zhangtonghao2016-08-0212-169/+288
| | | | | | | | | | Improve the tutorial of the basic OVN features. Update the contents of the "Locally attached networks" and "Locally attached networks with VLANs" in detail. The logical ports of type "l2gateway" is described. Submitted-at: https://github.com/openvswitch/ovs/pull/144 Signed-off-by: nickcooper-zhangtonghao <nickcooper-zhangtonghao@opencloud.tech> Signed-off-by: Russell Bryant <russell@ovn.org>
* ovn: Make it possible for CMS to detect when the OVN system is up-to-date.Ben Pfaff2016-07-261-1/+4
| | | | | | | | | | | | | | | | | Until now, there has been no reliable for the CMS (or ovn-nbctl, or anything else) to detect when changes made to the northbound configuration have been passed through to the southbound database or to the hypervisors. This commit adds this feature to the system, by adding sequence numbers to the northbound and southbound databases and adding code in ovn-nbctl, ovn-northd, and ovn-controller to keep those sequence numbers up-to-date. The biggest user-visible change from this commit is new a new option --wait to ovn-nbctl. With --wait=sb, ovn-nbctl now waits for ovn-northd to update the southbound database; with --wait=hv, it waits for the changes to make their way to Open vSwitch on every hypervisor. Signed-off-by: Ben Pfaff <blp@ovn.org> Acked-by: Russell Bryant <russell@ovn.org>
* OVN-Tutorial: Update sample output.Russell Bryant2016-07-141-15/+22
| | | | | | | | | A previous patch made some additions to section 1 of this tutorial. This patch includes updates to the sample output that I got while testing the additions to the tutorial. Signed-off-by: Russell Bryant <russell@ovn.org> Acked-by: Ryan Moats <rmoats@us.ibm.com>
* ovn-sbctl: Adjust formatting of lflow-list.Russell Bryant2016-07-131-79/+120
| | | | | | | | | | | | | | Adjust the field width for a couple of elements in the output of the lflow-list sub-command of ovn-sbctl. We now have a table ID of 10, so set a field width of 2 to keep output aligned. Table names have grown to a max of 19 characters, so update the field width to keep output aligned. Finally, left justify values in fields, as I find that to look a little nicer. Also update sample output in OVN-Tutorial.md to match the current state. Signed-off-by: Russell Bryant <russell@ovn.org> Acked-by: Ben Pfaff <blp@ovn.org>
* ovn-sbctl: Change lport-(un)bind to lsp-(un)bind.Russell Bryant2016-07-073-8/+8
| | | | | | | | | A previous commit changed the command names in ovn-nbctl from lport-* to lsp-*. Change lport-bind and lport-unbind in ovn-sbctl to match. Signed-off-by: Russell Bryant <russell@ovn.org> Acked-by: Amitabha Biswas <abiswas@us.ibm.com> Acked-by: Ben Pfaff <blp@ovn.org>
* ovn: improve OVN tutorial.nickcooper-zhangtonghao2016-07-076-0/+128
| | | | | | | | Improve the tutorial of the basic OVN features. The addresses and port_security columns of the logical port is described in more detail. Signed-off-by: nickcooper-zhangtonghao <nickcooper-zhangtonghao@opencloud.tech> Signed-off-by: Russell Bryant <russell@ovn.org>
* ovn: Add 'na' action and lflow for NDZong Kai LI2016-07-021-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch tries to support ND versus ARP for OVN. It adds a new OVN action 'na' in ovn-controller side, and modify lflows for 'na' action and relevant packets in ovn-northd. First, for ovn-northd, it will generate lflows per each lport with its IPv6 addresses and mac addresss, with 'na' action, such as: match=(icmp6 && icmp6.type == 135 && (nd.target == fd81:ce49:a948:0:f816:3eff:fe46:8a42 || nd.target == fd81:ce49:b123:0:f816:3eff:fe46:8a42)), action=(na { eth.src = fa:16:3e:46:8a:42; nd.tll = fa:16:3e:46:8a:42; outport = inport; inport = ""; /* Allow sending out inport. */ output; };) and new lflows will be set in tabel ls_in_arp_nd_rsp, which is renamed from previous ls_in_arp_rsp. Later, for ovn-controller, when it received a ND packet, it frames a template NA packet for reply. The NA packet will be initialized based on ND packet, such as NA packet will use: - ND packet eth.src as eth.dst, - ND packet eth.dst as eth.src, - ND packet ip6.src as ip6.dst, - ND packet nd.target as ip6.src, - ND packet eth.dst as nd.tll. Finally, nested actions in 'na' action will update necessary fileds for NA packet, such as: - eth.src, nd.tll - inport, outport Since patch port for IPv6 router interface is not ready yet, this patch will only try to deal with ND from VM. This patch will set RSO flags to 011 for NA packets. This patch also modified current ACL lflows for ND, not to do conntrack on ND and NA packets in following tables: - S_SWITCH_IN_PRE_ACL - S_SWITCH_OUT_PRE_ACL - S_SWITCH_IN_ACL - S_SWITCH_OUT_ACL Signed-off-by: Zong Kai LI <zealokii@gmail.com> [blp@ovn.org made several minor simplifications and improvements] Signed-off-by: Ben Pfaff <blp@ovn.org>
* ovn-nbctl: Update logical switch commands.Justin Pettit2016-06-119-32/+32
| | | | | | | | | | | | | A few minor changes related to logical switch commands: - Use "ls" instead of "lswitch" to be more consistent with other command changes. - Use commands where possible in ovn unit tests. - Update references from "lswitch" to "ls" (code) or "switch" (user). Signed-off-by: Justin Pettit <jpettit@ovn.org> Acked-by: Ryan Moats <rmoats@us.ibm.com> Acked-by: Ben Pfaff <blp@ovn.org>
* ovn-nbctl: Update logical switch port commands.Justin Pettit2016-06-1110-112/+112
| | | | | | | | | | | | | A few minor changes related to logical switch port commands: - Use "lsp" instead of "lport" to be more consistent with later changes. - Use commands where possible in ovn unit tests. - Update references from "lport" to "lsp" (code) or "port" (user). Signed-off-by: Justin Pettit <jpettit@ovn.org> Acked-by: Ryan Moats <rmoats@us.ibm.com> Acked-by: Ben Pfaff <blp@ovn.org>
* ovn: Fix link in tutorialJamie Lennox2016-04-211-1/+1
| | | | | | | | Correct the link to the ovn-northd man page in the OVN tutorial. Signed-off-by: Jamie Lennox <jamielennox@gmail.com> [russell@ovn.org updated AUTHORS file] Signed-off-by: Russell Bryant <russell@ovn.org>
* ovn-tutorial: Update expected output from show commandsFlavio Fernandes2016-04-151-50/+121
| | | | | | | | | | | Highlighted requirement on how a fresh sandbox is expected before doing each of the tutorial sections. Also added some mentioning of the gdb flags available for debugging ovn programs. Signed-off-by: Flavio Fernandes <flavio@flaviof.com> Signed-off-by: Russell Bryant <russell@ovn.org>
* ovs-ctl: Store hostname as an external-id.Russell Bryant2016-03-241-0/+1
| | | | | | | | | | | | | | Update ovs-ctl to store the system hostname as an external-id, similar to the system-id. This is largely for convenience. ovn-controller will make use of it in a future commit. Someone in the OpenDaylight community requested the same thing in a discussion earlier this week. While we're at it, set external-ids:hostname in ovs-sandbox as well. Suggested-by: Justin Pettit <jpettit@ovn.org> Suggested-at: http://openvswitch.org/pipermail/dev/2016-March/068225.html Signed-off-by: Russell Bryant <russell@ovn.org> Acked-by: Justin Pettit <jpettit@ovn.org>
* Separating OVN NB and SB database processesRYAN D. MOATS2016-03-231-5/+23
| | | | | | | | | | | | OVN NB & SB DB's should be run in separate ovsdb-server processes and should run with ovn-ctl start_northd / stop_northd. This patch includes changes to unit tests, tutorial and debian scripts to remain self-consistent. Signed-off-by: RYAN D. MOATS <rmoats@us.ibm.com> Signed-off-by: Michael Arnaldi <arnaldimichael@gmail.com> Co-authored-by: Michael Arnaldi <arnaldimichael@gmail.com> Signed-off-by: Russell Bryant <russell@ovn.org>
* ovs-sandbox: Add note about OVN to initial output.Russell Bryant2016-03-071-1/+9
| | | | | | | | | | When you run ovs-sandbox, it finishes with a note describing the dummy environment it has set up. Add some additional text that indicates that OVN is also enabled when that is the case. Signed-off-by: Russell Bryant <russell@ovn.org> Acked-by: Ben Pfaff <blp@ovn.org> Acked-by: Ryan Moats <rmoats@us.ibm.com>
* ovn: Add a section on containers in OVN TutorialNuman Siddique2016-02-256-2/+216
| | | | | | Signed-Off-by: Numan Siddique <nusiddiq@redhat.com> Signed-off-by: Ben Pfaff <blp@ovn.org>
* ovn: Remove top ovn directory from PATHs.Ilya Maximets2016-01-291-1/+1
| | | | | | | | | | | | | | | Since 5b5c922b0ca6 ("ovn-nbctl: Move ovn-nbctl to utilities directory.") there is no more executables in top ovn directory. Removing of this directory from PATHs helps to avoid problems when old executable ./ovn/ovn-nbctl used instead of ./ovn/utilities/ovn-nbctl. This may happen if source directory was updated to commit 5b5c922b0ca6 without calling 'make clean'. Fixes: 5b5c922b0ca6 ("ovn-nbctl: Move ovn-nbctl to utilities directory.") Signed-off-by: Ilya Maximets <i.maximets@samsung.com> Signed-off-by: Russell Bryant <russell@ovn.org>
* ovn-tutorial: fix a typoWilliam Tu2016-01-181-1/+1
| | | | | | | switch_in_pre_acl -> switch_out_pre_acl Signed-off-by: William Tu <u9012063@gmail.com> Signed-off-by: Russell Bryant <russell@ovn.org>
* ovs-sandbox: assign default value to ${MAKE}qhjindev2016-01-041-1/+1
| | | | | | | | | | | | | | | | When run ovs-sandbox directly from the tutorial directory (the second method in Tutorial.md), the following result show up: $ ./ovs-sandbox -b /media/sda6/network/ovs/build ./ovs-sandbox: line 304: install-man: command not found The reason is that ${MAKE} is not set in the situation. So change ${MAKE} to ${MAKE-make} to resolve the issue. GitHub-PR: #104 Signed-off-by: Qinghua Jin <qhjin_dev@163.com> Signed-off-by: Russell Bryant <russell@ovn.org>
* ovn-tutorial: Use github instead of relative links.Russell Bryant2015-11-121-23/+23
| | | | | | | | | | All of these links when viewing OVN-Tutorial on github, but most of these links didn't work when viewing OVN-Tutorial.md.html in dist-docs. Use full github links so that they always work (as long as you have internet access). Signed-off-by: Russell Bryant <russell@ovn.org> Acked-By: Kyle Mestery <mestery@mestery.com>
* ovn-tutorial: Add a section on ACLs.Russell Bryant2015-11-044-1/+154
| | | | | | | | | | | | | | | Add a section that gives a quick introduction to applying ACLs. It discusses how the ACLs are translated into OVN logical flows. It doesn't get down to the OpenFlow level because that's not supported in ovs-sandbox yet. Instead, it provides a reference to an OpenStack related blog post that talks about how OVN ACLs are used there and gives examples of the resulting OpenFlow flows. In theory, once we have a userspace conntrack implementation available, we'll be able to provide better suppot for it in ovs-sandbox. Signed-off-by: Russell Bryant <rbryant@redhat.com> Acked-by: Kyle Mestery <mestery@mestery.com>
* ovn-nb: Rename Port_Bindings 'macs' column to 'addresses'.Ben Pfaff2015-10-167-49/+49
| | | | | | | In an upcoming commit this column will also support IP+MAC pairs. Signed-off-by: Ben Pfaff <blp@nicira.com> Acked-by: Justin Pettit <jpettit@nicira.com>
* ovn-tutorial: Add more links.Russell Bryant2015-10-131-6/+17
| | | | | | | | | | Add links to several man pages. Also fix a minor typo. Note that openvswitch.org needs to be updated as it's missing the ovn-northd man page. Signed-off-by: Russell Bryant <rbryant@redhat.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
* ovn: Add an ovs-sandbox based OVN tutorial.Russell Bryant2015-10-0222-2/+1209
| | | | | | | | | | | | | While working on OVN and OVN integration, I've collected a set of scripts for quickly setting up simple test environments using ovs-sandbox with OVN enabled. It seemed like they could be useful to others for learning about OVN or doing quick testing. This patch introduces an ovs-sandbox based tutorial for exploring OVN features in a simulated environment. Signed-off-by: Russell Bryant <rbryant@redhat.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
* ovn: Automatically create br-int in ovn-controller.Russell Bryant2015-09-081-2/+0
| | | | | | | | | ovn-controller previously required the integration bridge to be created before running ovn-controller. This patch makes ovn-controller automatically create it if it doesn't already exist. Signed-off-by: Russell Bryant <rbryant@redhat.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
* sandbox: Include vtep dir into the sandbox pathMiguel Angel Ajo2015-09-041-1/+1
| | | | | | | | | Otherwise the built vtep-ctl is not available from the sandbox command line. Signed-off-by: Miguel Angel Ajo <mangelajo@redhat.com> Acked-by: Russell Bryant <rbryant@redhat.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
* ovs-sandbox: Add support for ovn-controller-vtep.Russell Bryant2015-08-211-2/+16
| | | | | | | | | | | | | | | When ovs-sandbox is run with ovn enabled, create the vtep database and run ovn-controller-vtep. This lets you do some basic testing with ovn-controller-vtep. For example: $ make sandbox SANDBOXFLAGS="--ovn" $ vtep-ctl add-ps ps0 After those commands, you can see that ovn-controller-vtep added a Chassis row to OVN_Southbound for the physical switch. Signed-off-by: Russell Bryant <rbryant@redhat.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
* ovn-nbctl: Move ovn-nbctl to utilities directory.Alex Wang2015-08-081-1/+1
| | | | | Signed-off-by: Alex Wang <alexw@nicira.com> Acked-by: Russell Bryant <rbryant@redhat.com>
* ovs-sandbox: Fix ovn support.Russell Bryant2015-05-151-2/+12
| | | | | | | | | The last merge from master broke ovs-sandbox OVN support. The rungdb function now takes an additional argument for whether or not the daemon should be automatically started under gdb. Signed-off-by: Russell Bryant <rbryant@redhat.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
* Merge "master" into "ovn".Justin Pettit2015-05-072-3/+41
|\ | | | | | | | | | | | | This brings in STT. Conflicts: tutorial/ovs-sandbox
| * ovs-sandbox: add '-r' and '-e' optionsAndy Zhou2015-04-142-3/+29
| | | | | | | | | | | | | | | | '-e' option will run ovs-vswitchd under gdb, but runs immediately instead of waiting for user input. '-r' options applies to ovsdb-server. Signed-off-by: Andy Zhou <azhou@nicira.com> Acked-by: Russell Bryant <rbryant@redhat.com>
| * ovs-sandbox: add delay before running ovs-vsctlAndy Zhou2015-04-141-0/+12
| | | | | | | | | | | | | | | | | | | | | | When running ovsdb-server under gdb, there is a race that ovs-vsctl command can be called before ovsdb-server is fully launched. This will cause ovs-vsctl to fail. This patch fixes this by delay issuing the ovs-vsctl command until ovsdb-server is fully launched. Signed-off-by: Andy Zhou <azhou@nicira.com> Acked-by: Russell Bryant <rbryant@redhat.com> Acked-by: Ben Pfaff <blp@nicira.com>
* | ovs-architecture: Recommend disable-in-band=true for integration bridge.Ben Pfaff2015-05-051-1/+2
| | | | | | | | | | | | | | Also implement in ovs-sandbox. Signed-off-by: Ben Pfaff <blp@nicira.com> Acked-by: Justin Pettit <jpettit@nicira.com>
* | ovs-sandbox: Use "secure" mode for br-int, in OVN mode.Ben Pfaff2015-05-051-1/+1
| | | | | | | | | | | | | | | | This is documented in ovn-architecture(7). Signed-off-by: Ben Pfaff <blp@nicira.com> Acked-by: Russell Bryant <rbryant@redhat.com> Acked-by: Justin Pettit <jpettit@nicira.com>
* | ovn: Constrain supported tunnel types.Justin Pettit2015-04-301-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | Limit the supported tunnel types to Geneve and STT on hypervisors, and VXLAN, Geneve, and STT on gateways. This commit adds "DESIGN.md" that describes the reasoning. Wes Felter provided suggestions for improving the wording in the architecture document. Signed-off-by: Justin Pettit <jpettit@nicira.com> Acked-by: Ben Pfaff <blp@nicira.com>
* | ovn: Rename ovn-nbd to ovn-northd.Russell Bryant2015-04-161-6/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | It came up in a recent discussion that the use of 'nbd' could cause confusion since nbd is used for "Network Block Device", which may be used in many of the same environments that OVN would be used in. To avoid the possible issue, just rename ovn-nbd to ovn-northd. While we're at it, create a subdirectory under ovn/ to hold all files related to ovn-northd. For now it's just a single C file, but we may add more source files in the future. Signed-off-by: Russell Bryant <rbryant@redhat.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
* | Merge remote-tracking branch 'origin/master' into ovnJustin Pettit2015-04-121-2/+5
|\ \ | |/ | | | | | | Conflicts: tutorial/ovs-sandbox