长期支持版本

    社区创新版本

      sysmaster使用说明

      本章主要通过一些实例来带领用户初步使用 sysmaster,例如:

      • 如何创建 service服务单元配置文件。
      • 如何管理单元服务,例如启动、停止、查看服务。

      创建单元配置文件

      用户可以在 /usr/lib/sysmaster/system/目录下创建单元配置文件。

      单元配置文件的类型

      当前 sysmaster支持 targetsocketservice类型的单元配置文件。

      • target:封装了一个由 sysmaster管理的启动目标,用于将多个单元集中到一个同步点。sysmaster提供不同阶段的 target单元,例如 multi-user.target代表系统已完成启动,用户可以依赖此目标,启动自己的服务。
      • socket:封装了一个用于进程间通信的套接字 socket, 以支持基于套接字的启动。例如用户可以配置 service单元依赖此 socket,当此 socket有数据写入时,sysmaster会拉起对应的 service单元。
      • service:封装了一个被 sysmaster监视与控制的进程。

      单元配置文件的构成

      单元配置文件通常由3块组成:

      • Unit:单元的公共配置说明,如服务名称、描述、依赖关系等。
      • Install:描述如何安装和启动服务。
      • ServiceSocket:各个单元类型的配置。

      创建service单元配置

      sshd服务被用来远程登录到服务器,并在远程终端上执行命令和操作。 使用如下配置项来创建一个 sshd.service服务单元配置。

      [Unit]
      Description="OpenSSH server daemon"
      Documentation="man:sshd(8) man:sshd_config(5)"
      After="sshd-keygen.target"
      Wants="sshd-keygen.target"
      
      [Service]
      Type="notify"
      EnvironmentFile="-/etc/sysconfig/sshd"
      ExecStart="/usr/sbin/sshd -D $OPTIONS"
      ExecReload="/bin/kill -HUP $MAINPID"
      KillMode="process"
      Restart="on-failure"
      RestartSec=42
      
      [Install]
      WantedBy="multi-user.target"
      

      以下是对单元配置文件中选项配置的说明,更多可以查阅官方手册

      • Description:说明该 unit的主要功能。
      • Documentation:说明该 unit的文档链接。
      • After:配置同时启动的单元的先后顺序,sshd.service服务将在 sshd-keygen.target之后启动。
      • Wants:配置一个单元对另一个单元的依赖,启动 sshd.service服务,将会自动启动 sshd-keygen.target
      • Type:配置 sysmaster 如何启动此服务,notify表明需要主进程启动完成后发送通知消息。
      • EnvironmentFile:设置环境变量的文件读取路径。
      • ExecStart:配置服务启动时执行的命令,启动 sshd.service服务会执行 sshd命令。
      • ExecReload:配置重新加载 sshd.service的配置时执行的命令。
      • KillMode:配置当需要停止服务进程时,杀死服务进程的方法,process表示只杀死主进程。
      • Restart:配置服务不同情况下退出或终止,是否重新启动服务,on-failure表示当服务非正常退出时重新启动服务。
      • RestartSec:配置当服务退出时,重新拉起服务的间隔时间。
      • WantedBy:配置依赖当前 sshd.service服务的单元。

      管理单元服务

      sctlsysmaster的命令行工具,用于检查和控制 sysmaster服务端行为和各个服务的状态,它可以启动、停止、重启、检查系统服务。

      启动服务

      使用以下命令可以启动 sshd服务和运行 ExecStart所配置的命令。

      sctl start sshd.service
      

      停止服务

      使用以下命令可以停止 sshd服务,杀死 ExecStart所运行的进程。

      sctl stop sshd.service
      

      重启服务

      使用以下命令可以重启 sshd服务,该命令会先停止后启动服务。

      sctl restart sshd.service
      

      查看服务状态

      使用以下命令可以查看服务 sshd运行状态,用户可以查看服务的状态来获取服务是否正常运行。

      sctl status sshd.service
      

      文档捉虫

      “有虫”文档片段

      问题描述

      提交类型 issue

      有点复杂...

      找人问问吧。

      PR

      小问题,全程线上修改...

      一键搞定!

      问题类型
      规范和低错类

      ● 错别字或拼写错误;标点符号使用错误;

      ● 链接错误、空单元格、格式错误;

      ● 英文中包含中文字符;

      ● 界面和描述不一致,但不影响操作;

      ● 表述不通顺,但不影响理解;

      ● 版本号不匹配:如软件包名称、界面版本号;

      易用性

      ● 关键步骤错误或缺失,无法指导用户完成任务;

      ● 缺少必要的前提条件、注意事项等;

      ● 图形、表格、文字等晦涩难懂;

      ● 逻辑不清晰,该分类、分项、分步骤的没有给出;

      正确性

      ● 技术原理、功能、规格等描述和软件不一致,存在错误;

      ● 原理图、架构图等存在错误;

      ● 命令、命令参数等错误;

      ● 代码片段错误;

      ● 命令无法完成对应功能;

      ● 界面错误,无法指导操作;

      风险提示

      ● 对重要数据或系统存在风险的操作,缺少安全提示;

      内容合规

      ● 违反法律法规,涉及政治、领土主权等敏感词;

      ● 内容侵权;

      您对文档的总体满意度

      非常不满意
      非常满意
      提交
      根据您的反馈,会自动生成issue模板。您只需点击按钮,创建issue即可。
      文档捉虫
      编组 3备份