From 285e673438cd0d9f6b9f86f0fe288aee6e2b794b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=96=87=E6=95=8F=E5=A8=9F?= Date: Mon, 8 Jul 2024 07:39:09 +0000 Subject: [PATCH] =?UTF-8?q?=E8=A7=84=E8=8C=83=E5=92=8C=E4=BD=8E=E9=94=99?= =?UTF-8?q?=E7=B1=BB:=E9=93=BE=E6=8E=A5=E9=94=99=E8=AF=AF=E3=80=81?= =?UTF-8?q?=E7=A9=BA=E5=8D=95=E5=85=83=E6=A0=BC=E3=80=81=E6=A0=BC=E5=BC=8F?= =?UTF-8?q?=E9=94=99=E8=AF=AF=EF=BC=9B?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: 文敏娟 --- docs/zh/docs/userguide/pkgship.md | 49 +++++++++++++++---------------- 1 file changed, 23 insertions(+), 26 deletions(-) diff --git a/docs/zh/docs/userguide/pkgship.md b/docs/zh/docs/userguide/pkgship.md index 0eb22bfbe..03a900091 100644 --- a/docs/zh/docs/userguide/pkgship.md +++ b/docs/zh/docs/userguide/pkgship.md @@ -18,21 +18,20 @@ ## 介绍 -pkgship是一款管理OS软件包依赖关系，提供依赖和被依赖关系完整图谱的查询工具，pkgship提供软件包依赖查询、生命周期管理等功能。 +pkgship 是一款管理OS软件包依赖关系，提供依赖和被依赖关系完整图谱的查询工具，pkgship 提供软件包依赖查询、生命周期管理等功能。 1. 软件包基本信息查询：方便社区人员快速获取软件包的名称，版本，描述等基本信息。 2. 软件包依赖查询：方便社区人员在软件包引入、更新和删除的时候了解软件的影响范围。 ## 架构 -系统采用flask-restful开发，架构如下图所示。 +系统采用 flask-restful 开发，架构如下图所示。 ![avatar](./images/packagemanagement.png) ## 在线使用 -pkgship提供了公网地址 - +pkgship提供了公网地址。若无定制化需求，可直接使用在线查询。\ 若需要定制查询数据源，可按照文档进行本地安装、配置、使用。 ## 软件下载 @@ -43,7 +42,7 @@ pkgship提供了公网地址 使用场景：服务启动后，为了能查询对应的数据库（比如oe{version}）中的包信息及包依赖关系，需要将这些数据库通过createrepo生成的sqlite（分为源码库和二进制库）导入进服务内，生成对应的包信息json体然后插入Elasticsearch对应的数据库中。数据库名为根据conf.yaml中配置的dbname生成的dbname-source/binary。 + 使用场景：服务启动后，为了能查询对应的数据库（比如oe{version}）中的包信息及包依赖关系，需要将这些数据库通过createrepo生成的sqlite（分为源码库和二进制库）导入进服务内，生成对应的包信息json体然后插入Elasticsearch对应的数据库中。数据库名为根据conf.yaml中配置的dbname生成的dbname-source/binary。 ```bash pkgship init [-filepath path] @@ -252,7 +251,7 @@ pkgshipd stop 停止服务 用户可查询源码包或者二进制包(packagename)在指定数据库表（database）中的具体信息。 - > 使用场景：用户可查询源码包或者二进制包在指定数据库中的具体信息。 + 使用场景：用户可查询源码包或者二进制包在指定数据库中的具体信息。 ```bash pkgship pkginfo $packageName $database [-s] @@ -268,7 +267,7 @@ pkgshipd stop 停止服务 查询数据库下包含的所有包的信息。 - > 使用场景：用户可查询指定数据库下包含的所有软件包信息。 + 使用场景：用户可查询指定数据库下包含的所有软件包信息。 ```bash pkgship list $database [-s] @@ -282,7 +281,7 @@ pkgshipd stop 停止服务 查询二进制包(binaryName)的安装依赖。 - > 使用场景：用户需要安装某个二进制包A时，需要将该二进制包A的安装依赖B，及B的安装依赖C等等，直至所有的安装依赖全部安装到系统才能成功安装二进制包A。因此，在用户安装二进制包A之前，可能会需要查询二进制包A的所有安装依赖。该命令提供了此功能，允许用户根据平台默认的优先级在多个数据库之间进行查询；同时也支持用户自定义数据库查询优先级。 + 使用场景：用户需要安装某个二进制包A时，需要将该二进制包A的安装依赖B，及B的安装依赖C等等，直至所有的安装依赖全部安装到系统才能成功安装二进制包A。因此，在用户安装二进制包A之前，可能会需要查询二进制包A的所有安装依赖。该命令提供了此功能，允许用户根据平台默认的优先级在多个数据库之间进行查询；同时也支持用户自定义数据库查询优先级。 ```bash pkgship installdep [$binaryName $binaryName1 $binaryName2...] [-dbs] [db1 db2...] [-level] $level @@ -299,7 +298,7 @@ pkgshipd stop 停止服务 查询源码包(sourceName)的所有编译依赖。 - > 使用场景：用户要编译某个源码包A的时候，需要安装源码包A的编译依赖B，要成功安装编译依赖B需要获取B的所有安装依赖。因此，在用户编译源码包A之前，可能会需要查询源码包的编译依赖以及这些编译依赖的所有安装依赖。该命令提供了此功能，允许用户根据平台默认的优先级在多个数据库之间进行查询;同时也支持用户自定义数据库查询优先级。 + 使用场景：用户要编译某个源码包A的时候，需要安装源码包A的编译依赖B，要成功安装编译依赖B需要获取B的所有安装依赖。因此，在用户编译源码包A之前，可能会需要查询源码包的编译依赖以及这些编译依赖的所有安装依赖。该命令提供了此功能，允许用户根据平台默认的优先级在多个数据库之间进行查询;同时也支持用户自定义数据库查询优先级。 ```bash pkgship builddep [$sourceName $sourceName1 $sourceName2..] -dbs [db1 db2 ..] [-level] $level @@ -316,7 +315,7 @@ pkgshipd stop 停止服务 查询指定二进制包(binaryName)或源码包(sourceName )的安装及编译依赖，其中[pkgName]为查询的二进制包或者源码包的名称。当查询二进制包时，可以查询到该二进制包的所有安装依赖以及该二进制包对应的源码包的编译依赖，及这些编译依赖的所有安装依赖；当查询源码包时，可以查询该源码包的编译依赖，及这些编译依赖的所有安装依赖，并且查询该源码包生成的所有二进制包的所有安装依赖。同时，配合对应参数使用，该命令也支持查询软件包的自编译依赖查询，和包含子包的依赖查询。 - > 使用场景：如果开发者想在现有的版本库的基础上引入新的软件包，应同时引入该软件包的所有编译、安装依赖。该命令提供开发者一个同时查询这两种依赖关系的功能，能让开发者知晓该软件包会引入哪些其他的包，该命令支持查询二进制包和源码包。 + 使用场景：如果开发者想在现有的版本库的基础上引入新的软件包，应同时引入该软件包的所有编译、安装依赖。该命令提供开发者一个同时查询这两种依赖关系的功能，能让开发者知晓该软件包会引入哪些其他的包，该命令支持查询二进制包和源码包。 ```bash pkgship selfdepend [$pkgName1 $pkgName2 $pkgName3 ..] [-dbs] [db1 db2..] [-b] [-s] [-w] @@ -337,7 +336,7 @@ pkgshipd stop 停止服务 7. 被依赖查询。 查询软件包(pkgName)在某数据库(dbName)中被哪些包所依赖。 - > 使用场景：针对软件包A，在升级或删除的情况下会影响哪些软件包，可通过该命令查询。该命令会显示源码包A(若为源码包)生成的所有二进制包（若输入为二进制包，那此处即为输入的二进制包）被哪些源码包（比如B）编译依赖，被哪些二进制包（比如C1）安装依赖；以及B生成的二进制包及C1被哪些源码包（比如D）编译依赖，被哪些二进制包（比如E1）安装依赖，以此类推，遍历这些二进制包的被依赖。 + 使用场景：针对软件包A，在升级或删除的情况下会影响哪些软件包，可通过该命令查询。该命令会显示源码包A(若为源码包)生成的所有二进制包（若输入为二进制包，那此处即为输入的二进制包）被哪些源码包（比如B）编译依赖，被哪些二进制包（比如C1）安装依赖；以及B生成的二进制包及C1被哪些源码包（比如D）编译依赖，被哪些二进制包（比如E1）安装依赖，以此类推，遍历这些二进制包的被依赖。 ```bash pkgship bedepend dbName [$pkgName1 $pkgName2 $pkgName3] [-w] [-b] [-install/build] @@ -357,13 +356,13 @@ pkgshipd stop 停止服务 8. 数据库信息。 - > 使用场景，查看Elasticsearch中初始化了哪些数据库，该功能会按照优先级顺序返回已经初始化的数据库列表。 + 使用场景，查看Elasticsearch中初始化了哪些数据库，该功能会按照优先级顺序返回已经初始化的数据库列表。 `pkgship dbs` 9. 获取版本号。 - > 使用场景：获取pkgship软件的版本号。 + 使用场景：获取pkgship软件的版本号。 `pkgship -v` @@ -395,17 +394,15 @@ pkgshipd stop 停止服务 - 转储机制 - 使用python自带的logging内置函数的转储机制，按照日志大小来备份。 - -> 配置项，package.ini中配置每个日志的容量和备份数量 -> -> ```ini -> ; Maximum capacity of each file, the unit is byte, default is 30M -> max_bytes=31457280 -> -> ; Number of old logs to keep;default is 30 -> backup_count=30 -> ``` + 使用python自带的logging内置函数的转储机制，按照日志大小来备份。\ + 配置项，package.ini中配置每个日志的容量和备份数量 + > ```ini + > ; Maximum capacity of each file, the unit is byte, default is 30M + > max_bytes=31457280 + > + > ; Number of old logs to keep;default is 30 + > backup_count=30 + > ``` - 转储过程 -- Gitee