[ovs-dev] [PATCH 1/2] install-doc: suggest to use ovs-ctl for start/stop

Ben Pfaff blp at ovn.org
Mon Apr 17 15:02:11 UTC 2017

On Mon, Apr 17, 2017 at 10:48:35AM -0400, Aaron Conole wrote:
> Ben Pfaff <blp at ovn.org> writes:
> > On Thu, Apr 13, 2017 at 01:51:29PM -0400, Aaron Conole wrote:
> >> The install documentation guided users to manually start/stop
> >> daemons.  This is good information to have, but with the
> >> existence of ovs-ctl, is probably not the best way to start
> >> guiding new users of ovs.
> >> 
> >> Suggest that users start by running ovs-ctl start, and
> >> document the ability to selectively start/stop the daemons.
> >> The ovs-ctl script is already mentioned a bit in the install
> >> doc, so this just reinforces its use.
> >> 
> >> Suggested-by: Ben Pfaff <blp at ovn.org>
> >> Signed-off-by: Aaron Conole <aconole at redhat.com>
> >
> > Thanks for working on the documentation!
> >
> > I am a little worried about adding the casual suggestion to call
> > ovs-ctl, because ovs-ctl is installed in an out-of-the-way scripts
> > directory that is not in $PATH by default.  This is because ovs-ctl is
> > mostly meant as a tool for use by system init scripts rather than one
> > for the system administrator.  So, if we suggest that the admin should
> > call it directly, then we should either advise the admin where to find
> > it, or we should consider moving it to the default $PATH.  What do you
> > think is the best idea?
> The same thought was creeping into my head as I was writing the patch.  I
> think it makes sense to install it into $PATH, and treat it as a
> first-class citizen, but it does mean a change to the various
> distribution installation files to make sure it gets put in the correct
> place.  Alternately, I'm fine just saying it's in ${pkgdatadir}/scripts/
> and suggesting to update the local PATH variable with that directory.
> The alternative I can see is to suggest using the distribution
> start/stop scripts instead.  I'm okay with that, too.  If I'm doing
> upstream work, though, I generally call ovs-ctl directly, since a 'make
> install' puts most things in place, but doesn't put the distribution
> specific files in place.  So, probably we would want to have that
> working "out of the box" before suggesting that method.
> I'm inclined to just mention where to find the script, and that way
> any existing distributions aren't impacted by a script file move.  If
> people want to move the ovs-ctl script into the PATH, that could be a
> future enhancement.  Likewise, we could have a future task to have 'make
> install' move the distribution files into the appropriate places.  It
> means my update to this patch would be to suggest looking in
> ${pkgdatadir}/scripts (and probably an example of
> /usr/local/share/openvswitch/scripts as the 'default' directory).  Does
> that make sense?

That makes sense.  I'd support that direction.  Thanks for thinking it
through so carefully

More information about the dev mailing list