service启动文件的制作
title:systemd service boot fileauthor: 一抹忘忧tags:service系统categories:serviceabbrlink: 2989date: 2021-12-22 09:26:00我们看看一个服务包含哪些内容:[root@k8s5588 ~]# systemctl cat sshd.service# /usr/lib/systemd/system/s
·
systemd service boot file
我们看看一个服务包含哪些内容:
[root@k8s5588 ~]# systemctl cat sshd.service
# /usr/lib/systemd/system/sshd.service
[Unit]
Description=OpenSSH server daemon #定义服务描述
Documentation=man:sshd(8) man:sshd_config(5)
After=network.target sshd-keygen.target #定义服务启动后还需要启动那些服务
Wants=sshd-keygen.target #定义弱依赖,启动的同时尽可能启动这个服务
[Service]
Type=notify #进程产生的方式
EnvironmentFile=-/etc/crypto-policies/back-ends/opensshserver.config #读取环境变量配置文件
EnvironmentFile=-/etc/sysconfig/sshd
ExecStart=/usr/sbin/sshd -D $OPTIONS $CRYPTO_POLICY #启动
ExecReload=/bin/kill -HUP $MAINPID #重载
KillMode=process
Restart=on-failure
RestartSec=42s
[Install]
WantedBy=multi-user.target #与多用户命令行模式关联
配置项 说明
type= 可以包含的值为simple、forking、oneshot、dbus、notify、idel其中之一。
simple:表示ExecStar=进程是该服务的主进程。如果它需要为其他进程提供服务,那么必须在该服务启动之前先建立好通信渠道,比如套接字,以加快后续单元的启动速度。
forking:表示ExecStar=进程将会在启动时使用fork()函数,这是传统Unix系统的做法,也就是这个进程将由systemd进程fork出来,然后当该进程都准备就绪时,systemd进程退出,而fork出来的进程作为服务的主进程继续运行,对于此类型的进程,建议设置PIDFile=选项,以帮助systemd准确定位该服务的主进程。
oneshot:该进程会在systemd启动后续单元之前退出,适用于仅需要执行一次的程序。比如清理磁盘,你只需要执行一次,不需要一直在后台运行这个程序。
dbus:该进程需要在D-Bus上获得一个由BusName=指定的名称,systemd将会在启动后续单元之前,首先确保该进程已经成功的获取了指定D-Bus名称。
notify:与simple类似,不同之处在于该进程会在启动完成之后通过sd_notify之类的接口发送一个通知消息。systemd在启动后续单元之前,必须确保该进程已经成功地发送了一个消息。
idel:与simple类似,不同之处在于该进程将会被延迟到所有操作都完成之后在执行。这样可以避免控制台上的状态信息与shell脚本的输出混在在一起。
ReaminAfterExit=
当该服务的所有进程都退出之后,是否依然将此无视为活动的,默认为no。
GuessMainPID=
在没有设置PIDFile=值的时候,systemd是否要猜测主进程的PID。默认是yes。
PIDFile=
守护进程的PID文件,必须是绝对路径,强烈建议在Type=forking的情况下明确设置此选项。这个路径也不是随便写的,而是你的进程实际的PID文件路径。这样systemd才能正确的读取该文件,但是它不会写入,只是会在服务停止后删除该文件,如果存在的话。
BusName=
设置与此服务通讯所使用的D-Bus名称,如果Type=dbus,则必须设置此项。
ExecStart=
设置启动服务是要执行的命令(命令+参数)。命令行必须是一个绝对路径表示可执行文件的位置,后面可以跟多个该命令支持的参数。如果在命令前面加上下面的标志,将会有不同含义:
@:表示后面的参数一次传递给被执行的程序
-:表示即使该进程以失败状态退出,也会被视为成功退出
+:表示该进程拥有超级用户特权
如果设置多个ExecStart=那么将依次运行,如果某个没有“-”前缀的命令执行失败,那么后续的ExecStart=将不会执行,同时该单元变为失败(failed)状态。
如果没有设置Type=forking时,这里的命令所启动的进程,将被视为该服务的主守护进程。
ExecStartPre=
在执行ExecStart之前或之后运行的命令。规则与ExecStart=相同。
ExecStartPost=
对于ExecStartPost= 命令仅在服务已经启动成功之后才会运行,判断的标准基于 Type= 选项。 具体说来,对于 Type=simple 或 Type=idle 就是主进程已经成功启动; 对于 Type=oneshot 来说就是主进程已经成功退出; 对于 Type=forking 来说就是初始进程已经成功退出; 对于 Type=notify 来说就是已经发送了 "READY=1" ; 对于 Type=dbus 来说就是已经取得了 BusName= 中设置的总线名称。注意一下2点:
不可将 ExecStartPre= 用于需要长时间执行的进程。 因为所有由 ExecStartPre= 派生的子进程 都会在启动 ExecStart= 服务进程之前被杀死。
如果在服务启动完成之前,任意一个 ExecStartPre=, ExecStart=, ExecStartPost= 中无 "-" 前缀的命令执行失败或超时, 那么,ExecStopPost= 将会被继续执行,而 ExecStop= 则会被跳过。
ExecReload=
这是一个可选的指令, 用于设置当该服务被要求重新载入配置时所执行的命令行。 语法规则与 ExecStart= 完全相同。
另外,还有一个特殊的环境变量 $MAINPID 可用于表示主进程的PID, 例如可以这样使用:/bin/kill -HUP $MAINPID
注意,像上例那样,通过向守护进程发送复位信号, 强制其重新加载配置文件,并不是一个好习惯。 因为这是一个异步操作, 所以不适用于需要按照特定顺序重新加载配置文件的服务。 我们强烈建议将 ExecReload= 设为一个 能够确保重新加载配置文件的操作同步完成的命令行
ExecStop=
这是一个可选的指令, 用于设置当该服务被要求停止时所执行的命令行。 语法规则与 ExecStart= 完全相同。 执行完此处设置的命令行之后, 该服务所有剩余的进程将会根据 KillMode= 的设置被杀死(参见 systemd.kill(5))。 如果未设置此选项,那么当此服务被停止时, 该服务的所有进程都将会根据 KillSignal= 的设置被立即全部杀死。 与 ExecReload= 一样, 也有一个特殊的环境变量 $MAINPID 可用于表示主进程的PID
一般来说, 仅仅设置一个结束服务的命令而不等待其完成, 是不够的。 因为当此处设置的命令执行完之后, 剩余的进程会被 SIGKILL 信号立即杀死, 这可能会导致数据丢失。 因此,这里设置的命令必须是同步操作, 而不能是异步操作。
注意,仅在服务确实启动成功的前提下,才会执行 ExecStop= 中设置的命令。 如果服务从未启动或启动失败(例如,任意一个 ExecStart=, ExecStartPre=, ExecStartPost= 中无 "-" 前缀的命令执行失败或超时), 那么 ExecStop= 将会被跳过。 如果想要无条件的在服务停止后执行特定的动作,那么应该使用 ExecStopPost= 选项。
应该将此选项用于那些必须在服务干净的退出之前执行的命令。 当此选项设置的命令被执行的时候,应该假定服务正处于完全正常的运行状态,可以正常的与其通信。 如果想要无条件的在服务停止后"清理尸体",那么应该使用 ExecStopPost= 选项。
KillMode=的值有如下几种:
control-group:表示杀死该单元的cgroup内的所有进程
process:表示仅杀死主进程
mixed:表示先向主进程发送SIGTERM信号,然后在向该单元的cgroup内的其他进程发送SIGKILL信号。
none:表示仅执行ExecStop=动作,而不杀死任何进程,这会导致进程单元停止了,但是该单元的cgroup还依然存在,直到其余进程全部死亡。
默认是control-group。
ExecStopPost=
这是一个可选的指令, 用于设置在该服务停止之后所执行的命令行。 语法规则与 ExecStart= 完全相同。 注意,与 ExecStop= 不同,无论服务是否启动成功, 此选项中设置的命令都会在服务停止后被无条件的执行。
应该将此选项用于设置那些无论服务是否启动成功都必须在服务停止后无条件执行的清理操作。 此选项设置的命令必须能够正确处理由于服务启动失败而造成的各种残缺不全以及数据不一致的场景。 由于此选项设置的命令在执行时,整个服务的所有进程都已经全部结束,所以无法与服务进行任何通信。
RestartSec=
设置在重启服务(Restart=)前暂停多长时间。 默认值是100毫秒(100ms)。 如果未指定时间单位,那么将视为以秒为单位。 例如设为"20"等价于设为"20s"
TimeoutStartSec=
设置该服务允许的最大启动时长。 如果守护进程未能在限定的时长内发出"启动完毕"的信号,那么该服务将被视为启动失败,并会被关闭。 如果未指定时间单位,那么将视为以秒为单位。
TimeoutStopSec=
设置该服务允许的最大停止时长。 如果该服务未能在限定的时长内成功停止, 那么将会被强制使用 SIGTERM 信号关闭, 如果依然未能在相同的时长内成功停止, 那么将会被强制使用 SIGKILL 信号关闭。如果未指定时间单位,那么将视为以秒为单位。 例如设为"20"等价于设为"20s"。 设为 "infinity" 则表示永不超时。
RuntimeMaxSec=
允许服务持续运行的最大时长。 如果服务持续运行超过了此处限制的时长,那么该服务将会被强制终止,同时将该服务变为失败(failed)状态。 注意,此选项对 Type=oneshot 类型的服务无效,因为它们会在启动完成后立即终止。 默认值为 "infinity" (不限时长)。
WatchdogSec=
设置该服务的看门狗(watchdog)的超时时长。 看门狗将在服务成功启动之后被启动。 该服务在运行过程中必须周期性的以 "WATCHDOG=1" ("keep-alive ping")调用 sd_notify(3) 函数。 如果在两次调用之间的时间间隔大于这里设定的值, 那么该服务将被视为失败(failed)状态, 并会被强制使用 SIGABRT 信号关闭。 通过将 Restart= 设为 on-failure, on-watchdog, on-abnormal, always 之一, 可以实现在失败状态下的自动重启该服务。 这里设置的值将会通过
WATCHDOG_USEC=
环境变量传递给守护进程, 这样就允许那些支持看门狗的服务自动启用"keep-alive ping"。 如果设置了此选项, 那么必须将 NotifyAccess= 设为 main(此种情况下的隐含默认值) 或 all 。 如果未指定时间单位,那么将视为以秒为单位。 例如设为"20"等价于设为"20s"。 默认值"0"表示禁用看门狗功能。 详见 sd_watchdog_enabled(3) 与 sd_event_set_watchdog(3) 手册。
Restart= 当服务进程正常退出、异常退出、被杀死、超时的时候,是否重启系统该服务。进程通过正常操作被停止则不会被执行重启。可选值为:
no:默认值,表示任何时候都不会被重启
always:表示会被无条件重启
no-success:表示仅在服务进程正常退出时重启
on-failure:表示仅在服务进程异常退出时重启
所谓正常退出是指,退出码为“0”,或者到IGHUP, SIGINT, SIGTERM, SIGPIPE 信号之一,并且退出码符合 SuccessExitStatus= 的设置。
所谓异常退出时指,退出码不为“0”,或者被强杀或者因为超时被杀死。
SuccessExitStatus= 额外定义附加的进程"正常退出"状态。 可以设为一系列以空格分隔的数字退出码或者信号名称
说明:如果在ExecStart=中设置多个命令,那么每个命令必须用“\;”隔开,且只有Type=oneshot时才可用。
另外在[Service]段中还可以使用:
配置项 说明
WorkingDirectory=
设置进程的工作目录。 既可以设为特殊值 "~" 表示 User= 用户的家目录, 也可以设为一个以 RootDirectory= 为基准的绝对路径。 例如当 RootDirectory=/sysroot 并且 WorkingDirectory=/work/dir 时, 实际的工作目录将是 /sysroot/work/dir 。 当 systemd 作为系统实例运行时,此选项的默认值是 / ; 当 systemd 作为用户实例运行时,此选项的默认值是对应用户的家目录。 如果给目录加上 "-" 前缀, 那么表示即使此目录不存在,也不算致命错误。 如果未设置
选项, 那么为 WorkingDirectory= 设置的绝对路径 将以主机(或容器)的根目录(也就是运行 systemd 的系统根目录)为基准。 注意,设置此选项将会导致自动添加额外的依赖关系(见上文)。
RootDirectory=
设置以 chroot(2) 方式执行进程时的根目录。 必须设为一个以主机(或容器)的根目录(也就是运行 systemd 的系统根目录)为基准的绝对路径。 如果设置了此选项, 必须确保进程及其辅助文件在 chroot() 监狱中确实可用。 注意,设置此选项将会导致自动添加额外的依赖关系(见上文)。
User=
设置进程在执行时使用的用户与组。 既可以设为数字形式的ID也可以设为字符串形式的名称。 如果没有明确设置
Group=
选项,则使用 User= 所属的默认组。 此选项不影响带有 "+" 前缀的命令。
Nice=
设置进程的默认谦让值。 可以设为 -20(最高优先级) 到 19(最低优先级) 之间的整数值。
Environment=
设置进程的环境变量, 值是一个空格分隔的 VAR=VALUE 列表。 可以多次使用此选项以增加新的变量或者修改已有的变量 (同一个变量以最后一次的设置为准)。 若设为空, 则表示清空先前所有已设置的变量。 注意: (1)不会在字符串内部进行变量展开(也就是"$"没有特殊含义); (2)如果值中包含空格, 那么必须在字符串两边使用双引号(")界定
Environment="VAR1=word1 word2"。
EnvironmentFile=
与 Environment= 类似, 不同之处在于此选项是从文本文件中读取环境变量的设置。 文件中的空行以及以分号(;)或井号(#)开头的行会被忽略, 其他行的格式必须符合 VAR=VALUE 的shell变量赋值语法。 行尾的反斜杠(\)将被视为续行符, 这与shell语法类似。 若想在变量值中包含空格, 则必须在值的两端加上双引号(")界定。
文件必须用绝对路径表示(可以包含通配符)。 但可在路径前加上"-"前缀表示忽略不存在的文件。 可以多次使用此选项, 以从多个不同的文件中读取设置。 若设为空, 则表示清空所有先前已经从文件中读取的环境变量。
这里列出的文件将在进程启动前的瞬间被读取, 因此可以由前一个单元生成配置文件, 再由后一个单元去读取它。
从文件中读取的环境变量会覆盖 Environment= 中设置的同名变量。 文件的读取顺序就是它们出现在单元文件中的顺序, 并且对于同一个变量,以最后读取的文件中的设置为准。
-----------------------------------
附上自建的两个service参考
[Unit]
Description=nginx - high performance web #描述服务
serverAfter=network.target remote-fs.target nss-lookup.target #描述服务类别
[Service] #服务运行参数的设置
Type=forking #是后台运行的形式
ExecStart=/usr/local/nginx/sbin/nginx -c /usr/local/nginx/conf/nginx.conf #为服务的具体运行命令
ExecReload=/usr/local/nginx/sbin/nginx -s reload #重启
ExecStop=/usr/local/nginx/sbin/nginx -s stop #停止
[Install] #服务安装的相关设置,可设置为多用户
WantedBy=multi-user.target
root@test:~# vim /lib/systemd/system/zabbix-proxy.service
[Unit]
Description=Zabbix Server
[Service]
EnvironmentFile=/usr/local/zabbix/etc/zabbix_server.conf
Type=forking
Restart=on-failure
PIDFile=/tmp/zabbix_server.pid #pid文件路径需要和proxy配置文件中的pid路径一致
KillMode=control-group
ExecStart=/usr/local/zabbix/sbin/zabbix_server
ExecStop=/bin/kill -SIGTERM $MAINPID
RestartSec=10s
[Install]
WantedBy=multi-user.target
vim /lib/systemd/system/zabbix-agent2.service
[Unit]
Description=Zabbix agent2
[Service]
EnvironmentFile=/usr/local/zabbix/etc/zabbix_agent2.conf
Type=simple
Restart=on-failure
PIDFile=/tmp/zabbix_agent2.pid #pid文件路径需要和proxy配置文件中的pid路径一致
KillMode=control-group
ExecStart=/usr/local/zabbix/sbin/zabbix_agent2
ExecStop=/bin/kill -SIGTERM $MAINPID
RestartSec=10s
[Install]
WantedBy=multi-user.target
更多推荐
已为社区贡献2条内容
所有评论(0)