From ddb59830ffa4f9e55ec007bbeb0e70671a33cae3 Mon Sep 17 00:00:00 2001 From: Ben Pfaff Date: Fri, 15 May 2009 11:02:08 -0700 Subject: [PATCH] Rename "controller" to "ovs-controller" and move to utilities. The controller is unimportant and we don't want people thinking that it is important. (They should be using NOX, not the OpenVSwitch controller.) So kill off its top-level directory. --- COPYING | 4 ++-- INSTALL | 20 +++++++++---------- Makefile.am | 1 - README | 4 ++-- controller/.gitignore | 4 ---- controller/automake.mk | 8 -------- debian/openvswitch-controller.init | 4 ++-- debian/openvswitch-controller.install | 2 +- debian/openvswitch-controller.manpages | 2 +- secchan/.gitignore | 3 --- secchan/secchan.8.in | 2 +- utilities/.gitignore | 2 ++ utilities/automake.mk | 7 +++++++ utilities/dpctl.8.in | 2 +- .../ovs-controller.8.in | 16 +++++++-------- .../ovs-controller.c | 0 utilities/vlogconf.8.in | 2 +- xenserver/vswitch-xen.spec | 4 ++-- 18 files changed, 39 insertions(+), 48 deletions(-) delete mode 100644 controller/.gitignore delete mode 100644 controller/automake.mk rename controller/controller.8.in => utilities/ovs-controller.8.in (90%) rename controller/controller.c => utilities/ovs-controller.c (100%) diff --git a/COPYING b/COPYING index c70d1265..ee6072ef 100644 --- a/COPYING +++ b/COPYING @@ -2,8 +2,8 @@ This file is a summary of the licensing of files in this distribution. Some files may be marked specifically with a different license, in which case that license applies to the file in question. -Files under the controller, debian, doc, include, lib, m4, secchan, -tests, third-party, and utilities directories are licensed under the +Files under the debian, doc, include, lib, m4, secchan, tests, +third-party, and utilities directories are licensed under the following "OpenFlow license": We are making the OpenFlow specification and associated documentation diff --git a/INSTALL b/INSTALL index d8332352..888ab016 100644 --- a/INSTALL +++ b/INSTALL @@ -22,9 +22,7 @@ The current version of this distribution requires a kernel module to be built and loaded. An (optional) entirely userspace switch is on the roadmap for future versions. -The reference implementation also contains a simple OpenFlow -controller (built as controller/controller) and a number of related -utilities. +The distribution also contains a number of related utilities. Build Methods ============= @@ -158,7 +156,7 @@ distribution in the ordinary way using "configure" and "make". Some less important binaries will be built also: - - Controller executable: controller/controller. + - Simple OpenFlow controller: utilities/ovs-controller. - Secure channel executable: secchan/secchan. @@ -303,12 +301,12 @@ Controller Setup ---------------- On the machine that is to be the OpenFlow controller, start the -"controller" program listening for connections from switches on TCP -port 6633 (the default), as shown below. +"ovs-controller" program listening for connections from switches on +TCP port 6633 (the default), as shown below. - # controller -v ptcp: + # ovs-controller -v ptcp: -(See controller(8) for more details) +(See ovs-controller(8) for more details) Make sure the machine hosting the controller is reachable by the switch. @@ -423,7 +421,7 @@ Public Key Infrastructure" below. To configure the controller to listen for SSL connections on port 6633 (the default), invoke it as follows: - # controller -v pssl: --private-key=PRIVKEY --certificate=CERT \ + # ovs-controller -v pssl: --private-key=PRIVKEY --certificate=CERT \ --ca-cert=CACERT where PRIVKEY is a file containing the controller's private key, CERT @@ -432,7 +430,7 @@ controller's public key, and CACERT is a file containing the root certificate for the switch CA. If, for example, your PKI was created with the instructions below, then the invocation would look like: - # controller -v pssl: --private-key=ctl-privkey.pem \ + # ovs-controller -v pssl: --private-key=ctl-privkey.pem \ --certificate=ctl-cert.pem --ca-cert=pki/switchca/cacert.pem To configure a switch to connect to a controller running on port 6633 @@ -500,7 +498,7 @@ and ctl-cert.pem, for example, you could run: ctl-privkey.pem and ctl-cert.pem would need to be copied to the controller for its use at runtime (they could then be deleted from their original locations). The --private-key and --certificate -options of controller, respectively, would point to these files. +options of ovs-controller, respectively, would point to these files. Analogously, to create a switch private key and certificate in files named sc-privkey.pem and sc-cert.pem, for example, you could run: diff --git a/Makefile.am b/Makefile.am index b3c98c8a..5a3be38e 100644 --- a/Makefile.am +++ b/Makefile.am @@ -61,7 +61,6 @@ SUFFIXES = .in include lib/automake.mk include secchan/automake.mk -include controller/automake.mk include utilities/automake.mk include tests/automake.mk include include/automake.mk diff --git a/README b/README index 44afd798..7b5cc9cd 100644 --- a/README +++ b/README @@ -37,10 +37,10 @@ This distribution includes some additional software as well: (without the special features provided by vswitchd) using the same kernel module as vswitchd. - - controller, a simple OpenFlow switch + - ovs-controller, a simple OpenFlow switch - vlogconf, a utility that can adjust the logging levels of a - running secchan or controller. + running secchan, ovs-controller, or vswitchd. - ovs-pki, a utility for creating and managing the public-key infrastructure for OpenFlow switches. diff --git a/controller/.gitignore b/controller/.gitignore deleted file mode 100644 index 8736bbc1..00000000 --- a/controller/.gitignore +++ /dev/null @@ -1,4 +0,0 @@ -/Makefile -/Makefile.in -/controller -/controller.8 diff --git a/controller/automake.mk b/controller/automake.mk deleted file mode 100644 index 80b14da7..00000000 --- a/controller/automake.mk +++ /dev/null @@ -1,8 +0,0 @@ -bin_PROGRAMS += controller/controller -man_MANS += controller/controller.8 -DISTCLEANFILES += controller/controller.8 - -controller_controller_SOURCES = controller/controller.c -controller_controller_LDADD = lib/libopenvswitch.a $(FAULT_LIBS) $(SSL_LIBS) - -EXTRA_DIST += controller/controller.8.in diff --git a/debian/openvswitch-controller.init b/debian/openvswitch-controller.init index c4716a92..43a9c533 100755 --- a/debian/openvswitch-controller.init +++ b/debian/openvswitch-controller.init @@ -31,8 +31,8 @@ PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin DAEMON=/usr/sbin/controller # Introduce the server's location here -NAME=controller # Introduce the short server's name here -DESC=controller # Introduce a short description here +NAME=ovs-controller # Introduce the short server's name here +DESC=ovs-controller # Introduce a short description here LOGDIR=/var/log/openvswitch # Log directory to use PIDFILE=/var/run/$NAME.pid diff --git a/debian/openvswitch-controller.install b/debian/openvswitch-controller.install index 3932ab6a..7d0edbbe 100644 --- a/debian/openvswitch-controller.install +++ b/debian/openvswitch-controller.install @@ -1 +1 @@ -_debian/controller/controller usr/sbin +_debian/utilities/ovs-controller usr/sbin diff --git a/debian/openvswitch-controller.manpages b/debian/openvswitch-controller.manpages index 3fbaaeaf..6a9911e1 100644 --- a/debian/openvswitch-controller.manpages +++ b/debian/openvswitch-controller.manpages @@ -1 +1 @@ -_debian/controller/controller.8 +_debian/utilities/ovs-controller.8 diff --git a/secchan/.gitignore b/secchan/.gitignore index 930a188e..ada65665 100644 --- a/secchan/.gitignore +++ b/secchan/.gitignore @@ -1,7 +1,4 @@ /Makefile /Makefile.in -/controller-lite -/ctlpath-lite -/dpctl-lite /secchan /secchan.8 diff --git a/secchan/secchan.8.in b/secchan/secchan.8.in index a9e5e520..e813c29e 100644 --- a/secchan/secchan.8.in +++ b/secchan/secchan.8.in @@ -456,7 +456,7 @@ require the controller to send the CA certificate, but .BR dpctl (8), .BR ovs-discover (8), -.BR controller (8), +.BR ovs\-controller (8), .BR ovs-pki (8), .BR udatapath (8), .BR vlogconf (8), diff --git a/utilities/.gitignore b/utilities/.gitignore index eed86ca2..b54ac1c2 100644 --- a/utilities/.gitignore +++ b/utilities/.gitignore @@ -5,6 +5,8 @@ /dpctl /dpctl.8 /nlmon +/ovs-controller +/ovs-controller.8 /ovs-discover /ovs-discover.8 /ovs-kill diff --git a/utilities/automake.mk b/utilities/automake.mk index 5c7030fb..8f3fb605 100644 --- a/utilities/automake.mk +++ b/utilities/automake.mk @@ -2,6 +2,7 @@ bin_PROGRAMS += \ utilities/vlogconf \ utilities/cfg-mod \ utilities/dpctl \ + utilities/ovs-controller \ utilities/ovs-discover \ utilities/ovs-kill \ utilities/ovs-wdt @@ -13,6 +14,7 @@ dist_sbin_SCRIPTS += utilities/ovs-monitor EXTRA_DIST += \ utilities/cfg-mod.8.in \ utilities/dpctl.8.in \ + utilities/ovs-controller.8.in \ utilities/ovs-discover.8.in \ utilities/ovs-kill.8.in \ utilities/ovs-parse-leaks.in \ @@ -23,6 +25,7 @@ EXTRA_DIST += \ DISTCLEANFILES += \ utilities/cfg-mod.8 \ utilities/dpctl.8 \ + utilities/ovs-controller.8 \ utilities/ovs-discover.8 \ utilities/ovs-kill.8 \ utilities/ovs-parse-leaks \ @@ -34,6 +37,7 @@ DISTCLEANFILES += \ man_MANS += \ utilities/cfg-mod.8 \ utilities/dpctl.8 \ + utilities/ovs-controller.8 \ utilities/ovs-discover.8 \ utilities/ovs-kill.8 \ utilities/ovs-pki.8 \ @@ -48,6 +52,9 @@ utilities_dpctl_LDADD = lib/libopenvswitch.a $(FAULT_LIBS) $(SSL_LIBS) utilities_vlogconf_SOURCES = utilities/vlogconf.c utilities_vlogconf_LDADD = lib/libopenvswitch.a +utilities_ovs_controller_SOURCES = utilities/ovs-controller.c +utilities_ovs_controller_LDADD = lib/libopenvswitch.a $(FAULT_LIBS) $(SSL_LIBS) + utilities_ovs_discover_SOURCES = utilities/ovs-discover.c utilities_ovs_discover_LDADD = lib/libopenvswitch.a diff --git a/utilities/dpctl.8.in b/utilities/dpctl.8.in index 34f42812..349587db 100644 --- a/utilities/dpctl.8.in +++ b/utilities/dpctl.8.in @@ -641,6 +641,6 @@ Prints the flow entries in the switch. .BR vswitchd (8), .BR secchan (8), -.BR controller (8), +.BR ovs\-controller (8), .BR udatapath (8), .BR vlogconf (8) diff --git a/controller/controller.8.in b/utilities/ovs-controller.8.in similarity index 90% rename from controller/controller.8.in rename to utilities/ovs-controller.8.in index 0e29566e..4f715a05 100644 --- a/controller/controller.8.in +++ b/utilities/ovs-controller.8.in @@ -1,18 +1,18 @@ -.TH controller 8 "March 2009" "OpenVSwitch" "OpenVSwitch Manual" -.ds PN controller +.TH ovs\-controller 8 "March 2009" "OpenVSwitch" "OpenVSwitch Manual" +.ds PN ovs\-controller .SH NAME -controller \- simple OpenFlow controller reference implementation +ovs\-controller \- simple OpenFlow controller reference implementation .SH SYNOPSIS -.B controller +.B ovs\-controller [\fIoptions\fR] \fImethod\fR \fB[\fImethod\fR]\&... .SH DESCRIPTION -\fBcontroller\fR manages any number of remote switches over OpenFlow +\fBovs\-controller\fR manages any number of remote switches over OpenFlow protocol, causing them to function as L2 MAC-learning switches or hub. -\fBcontroller\fR controls one or more OpenFlow switches, specified as +\fBovs\-controller\fR controls one or more OpenFlow switches, specified as one or more of the following OpenFlow connection methods: .TP @@ -79,7 +79,7 @@ first boot using, e.g., the \fB--bootstrap-ca-cert\fR option to \fBsecchan\fR(8). .IP "\fB-n\fR, \fB--noflow\fR" -By default, the controller sets up a flow in each OpenFlow switch +By default, \fBovs\-controller\fR sets up a flow in each OpenFlow switch whenever it receives a packet whose destination is known due through MAC learning. This option disables flow setup, so that every packet in the network passes through the controller. @@ -123,7 +123,7 @@ performance, so it should not be used in production. .TP To bind locally to port 6633 (the default) and wait for incoming connections from OpenFlow switches: -.B % controller ptcp: +.B % ovs\-controller ptcp: .SH "SEE ALSO" diff --git a/controller/controller.c b/utilities/ovs-controller.c similarity index 100% rename from controller/controller.c rename to utilities/ovs-controller.c diff --git a/utilities/vlogconf.8.in b/utilities/vlogconf.8.in index 0c251929..279e778c 100644 --- a/utilities/vlogconf.8.in +++ b/utilities/vlogconf.8.in @@ -154,4 +154,4 @@ error occurs. Use \fB-e help\fR to print a list of available commands. .BR dpctl (8), .BR secchan (8), -.BR controller (8) +.BR ovs\-controller (8) diff --git a/xenserver/vswitch-xen.spec b/xenserver/vswitch-xen.spec index 38161985..035e4617 100644 --- a/xenserver/vswitch-xen.spec +++ b/xenserver/vswitch-xen.spec @@ -72,12 +72,12 @@ install -d -m 755 $RPM_BUILD_ROOT%{_prefix}/kernel_modules find datapath/linux-2.6 -name *.ko -exec install -m 755 \{\} $RPM_BUILD_ROOT%{_prefix}/kernel_modules/ \; # Get rid of stuff we don't want to make RPM happy. -rm -rf $RPM_BUILD_ROOT/root/vswitch/bin/controller \ +rm -rf $RPM_BUILD_ROOT/root/vswitch/bin/ovs-controller \ $RPM_BUILD_ROOT/root/vswitch/bin/ovs-* \ $RPM_BUILD_ROOT/root/vswitch/bin/secchan \ $RPM_BUILD_ROOT/root/vswitch/bin/ovs-wdt \ $RPM_BUILD_ROOT/root/vswitch/sbin/ovs-monitor \ - $RPM_BUILD_ROOT/root/vswitch/share/man/man8/controller.8 \ + $RPM_BUILD_ROOT/root/vswitch/share/man/man8/ovs-controller.8 \ $RPM_BUILD_ROOT/root/vswitch/share/man/man8/ovs-*.8 \ $RPM_BUILD_ROOT/root/vswitch/share/man/man8/secchan.8 \ $RPM_BUILD_ROOT/root/vswitch/share/openvswitch -- 2.30.2