mir/openvswitch
2
0
Fork 0
mirror of https://github.com/openvswitch/ovs synced 2025-10-21 14:49:41 +00:00
Code Issues Releases Wiki Activity
Files
00da1ac5299c054fe0bd41a4e0113fc36d0c3be8
openvswitch/lib/daemon.man

69 lines
2.8 KiB
Groff
Raw Normal View History

daemon-windows: Ability to handle windows service calls. The following code does not add any users yet. The visioned workflow that this piece of code should work with is: * Create a windows service through a startup script with a tool like 'sc' ex: sc create ovsdb-server binpath= "C:\openvswitch\usr\sbin\ovsdb-server.exe -vconsole:off -vsyslog:off -vfile:info --remote=ptcp:6632:127.0.0.1 --log-file --service-monitor --service" * Start the service from the startup script. ex: sc start ovsdb-server * Terminate the service during shutdown process. ex: sc stop ovsdb-server * Abrupt termination will restart the service. Signed-off-by: Gurucharan Shetty <gshetty@nicira.com> Acked-by: Ben Pfaff <blp@nicira.com>
2014-01-16 16:16:24 -08:00
The following options are valid on POSIX based platforms.
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.TP
daemon: Clarify documentation. CC: Yu Zhiguo <yuzg@cn.fujitsu.com>
2010-06-29 12:32:16 -07:00
\fB\-\-pidfile\fR[\fB=\fIpidfile\fR]
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
Causes a file (by default, \fB\*(PN.pid\fR) to be created indicating
daemon: Clarify documentation. CC: Yu Zhiguo <yuzg@cn.fujitsu.com>
2010-06-29 12:32:16 -07:00
the PID of the running process. If the \fIpidfile\fR argument is not
specified, or
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
if it does not begin with \fB/\fR, then it is created in
\fB@RUNDIR@\fR.
daemon: Clarify documentation. CC: Yu Zhiguo <yuzg@cn.fujitsu.com>
2010-06-29 12:32:16 -07:00
.IP
doc: Change "-" to "\-" in appropriate places. The newer manpages tend to get this right more often than the old ones, but there were lots of places that needed to be corrected.
2010-06-29 14:29:40 -07:00
If \fB\-\-pidfile\fR is not specified, no pidfile is created.
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.TP
doc: Change "-" to "\-" in appropriate places. The newer manpages tend to get this right more often than the old ones, but there were lots of places that needed to be corrected.
2010-06-29 14:29:40 -07:00
\fB\-\-overwrite\-pidfile\fR
By default, when \fB\-\-pidfile\fR is specified and the specified pidfile
daemon: Remove short options from daemon library The daemon library provides a few short options, but these then take away their availability from programs that wish to use the library. Since the daemon options are generally going to be called from a script (which doesn't care how much typing is involved), we'll only provide long options.
2009-08-05 14:20:24 -07:00
already exists and is locked by a running process, \fB\*(PN\fR refuses
doc: Change "-" to "\-" in appropriate places. The newer manpages tend to get this right more often than the old ones, but there were lots of places that needed to be corrected.
2010-06-29 14:29:40 -07:00
to start. Specify \fB\-\-overwrite\-pidfile\fR to cause it to instead
daemon: Remove short options from daemon library The daemon library provides a few short options, but these then take away their availability from programs that wish to use the library. Since the daemon options are generally going to be called from a script (which doesn't care how much typing is involved), we'll only provide long options.
2009-08-05 14:20:24 -07:00
overwrite the pidfile.
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.IP
doc: Change "-" to "\-" in appropriate places. The newer manpages tend to get this right more often than the old ones, but there were lots of places that needed to be corrected.
2010-06-29 14:29:40 -07:00
When \fB\-\-pidfile\fR is not specified, this option has no effect.
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
.TP
doc: Change "-" to "\-" in appropriate places. The newer manpages tend to get this right more often than the old ones, but there were lots of places that needed to be corrected.
2010-06-29 14:29:40 -07:00
\fB\-\-detach\fR
Import from old repository commit 61ef2b42a9c4ba8e1600f15bb0236765edc2ad45.
2009-07-08 13:19:16 -07:00
Causes \fB\*(PN\fR to detach itself from the foreground session and
ovs-vswitchd: Complete daemonization only after initial configuration. Otherwise when we add support for saving and restoring configuration of internal devices around kernel module unload and reload, there's no easy way for the "restore" code to tell when all the interfaces should be set up and ready for configuration.
2011-01-28 12:44:00 -08:00
run as a background process. \*(DD
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
daemon: Add support for process monitoring and restart.
2010-01-15 12:13:46 -08:00
.TP
doc: Change "-" to "\-" in appropriate places. The newer manpages tend to get this right more often than the old ones, but there were lots of places that needed to be corrected.
2010-06-29 14:29:40 -07:00
\fB\-\-monitor\fR
daemon: Add support for process monitoring and restart.
2010-01-15 12:13:46 -08:00
Creates an additional process to monitor the \fB\*(PN\fR daemon. If
the daemon dies due to a signal that indicates a programming error
daemon: Precisely document signals that cause the monitor to restart. Signed-off-by: Ben Pfaff <blp@nicira.com> Acked-by: Joe Stringer <joestringer@nicira.com>
2013-10-11 16:52:50 -07:00
(\fBSIGABRT\fR, \fBSIGALRM\fR, \fBSIGBUS\fR, \fBSIGFPE\fR,
\fBSIGILL\fR, \fBSIGPIPE\fR, \fBSIGSEGV\fR, \fBSIGXCPU\fR, or
\fBSIGXFSZ\fR) then the monitor process starts a new copy of it. If
the daemon dies or exits for another reason, the monitor process exits.
daemon: Add support for process monitoring and restart.
2010-01-15 12:13:46 -08:00
.IP
doc: Change "-" to "\-" in appropriate places. The newer manpages tend to get this right more often than the old ones, but there were lots of places that needed to be corrected.
2010-06-29 14:29:40 -07:00
This option is normally used with \fB\-\-detach\fR, but it also
daemon: Add support for process monitoring and restart.
2010-01-15 12:13:46 -08:00
functions without it.
Fix excessive white space in manpages. In nroff manpages, a blank line adds vertical white space. When this is followed by another command that also starts a new paragraph, the result is a vertical skip twice as big as the normal inter-paragraph gap. The solution is to use a line that contains just "." for white space within the manpage, instead of a blank line. The resulting manpages look better.
2010-02-24 13:42:43 -08:00
.
daemon: Provide option to not chdir to root By default, Open vSwitch daemons change their working directories to the root directory. This commit provides a --no-chdir option to prevent this behavior.
2009-08-04 22:41:46 -07:00
.TP
doc: Change "-" to "\-" in appropriate places. The newer manpages tend to get this right more often than the old ones, but there were lots of places that needed to be corrected.
2010-06-29 14:29:40 -07:00
\fB\-\-no\-chdir\fR
By default, when \fB\-\-detach\fR is specified, \fB\*(PN\fR
daemon: Provide option to not chdir to root By default, Open vSwitch daemons change their working directories to the root directory. This commit provides a --no-chdir option to prevent this behavior.
2009-08-04 22:41:46 -07:00
changes its current working directory to the root directory after it
detaches. Otherwise, invoking \fB\*(PN\fR from a carelessly chosen
directory would prevent the administrator from unmounting the file
system that holds that directory.
.IP
doc: Change "-" to "\-" in appropriate places. The newer manpages tend to get this right more often than the old ones, but there were lots of places that needed to be corrected.
2010-06-29 14:29:40 -07:00
Specifying \fB\-\-no\-chdir\fR suppresses this behavior, preventing
daemon: Provide option to not chdir to root By default, Open vSwitch daemons change their working directories to the root directory. This commit provides a --no-chdir option to prevent this behavior.
2009-08-04 22:41:46 -07:00
\fB\*(PN\fR from changing its current working directory. This may be
useful for collecting core files, since it is common behavior to write
core dumps into the current working directory and the root directory
is not a good directory to use.
.IP
doc: Change "-" to "\-" in appropriate places. The newer manpages tend to get this right more often than the old ones, but there were lots of places that needed to be corrected.
2010-06-29 14:29:40 -07:00
This option has no effect when \fB\-\-detach\fR is not specified.
lib/daemon: support --user option for all OVS daemon OVS daemons can now support --user option to run as a non-root user with less privileges. See the manpage patch for more descriptions. Signed-off-by: Andy Zhou <azhou@nicira.com> Acked-by: Ben Pfaff <blp@nicira.com>
2015-09-11 11:26:39 -07:00
.
.TP
\fB\-\-user\fR
lib: simplify daemon_become_new_user__() A global variable 'switch_user' was used to make sure we switch process's current user only once. This logic is now simplified by testing for uid directly; if switch process has taken place, the current uid will be not be zero. Signed-off-by: Andy Zhou <azhou@nicira.com> Acked-by: Ansis Atteka <aatteka@nicira.com>
2015-10-09 18:48:59 -07:00
Causes \fB\*(PN\fR to run as a different user specified in "user:group", thus
dropping most of the root privileges. Short forms "user" and ":group" are also
lib/daemon: support --user option for all OVS daemon OVS daemons can now support --user option to run as a non-root user with less privileges. See the manpage patch for more descriptions. Signed-off-by: Andy Zhou <azhou@nicira.com> Acked-by: Ben Pfaff <blp@nicira.com>
2015-09-11 11:26:39 -07:00
allowed, with current user or group are assumed respectively. Only daemons
started by the root user accepts this argument.
.IP
On Linux, daemons will be granted CAP_IPC_LOCK and CAP_NET_BIND_SERVICES
before dropping root privileges. Daemons interact with datapath,
such as ovs-vswitchd, will be granted two additional capabilities, namely
lib: simplify daemon_become_new_user__() A global variable 'switch_user' was used to make sure we switch process's current user only once. This logic is now simplified by testing for uid directly; if switch process has taken place, the current uid will be not be zero. Signed-off-by: Andy Zhou <azhou@nicira.com> Acked-by: Ansis Atteka <aatteka@nicira.com>
2015-10-09 18:48:59 -07:00
CAP_NET_ADMIN and CAP_NET_RAW. The capability change will apply even if
new user is "root".
lib/daemon: support --user option for all OVS daemon OVS daemons can now support --user option to run as a non-root user with less privileges. See the manpage patch for more descriptions. Signed-off-by: Andy Zhou <azhou@nicira.com> Acked-by: Ben Pfaff <blp@nicira.com>
2015-09-11 11:26:39 -07:00
.IP
On Windows, this option is not currently supported. For security reasons,
specifying this option will cause the daemon process not to start.
Reference in New Issue Copy Permalink