From 6f46b583308787f83345d0bc3be281d0479ee4fb Mon Sep 17 00:00:00 2001 From: Jianhai Luan Date: Sun, 13 Nov 2022 11:48:20 +0800 Subject: [PATCH] README: add detail information into syscare --- README.en.md | 23 ++++++++++++++--------- README.md | 37 ++++++++++++++++++++++++------------- 2 files changed, 38 insertions(+), 22 deletions(-) diff --git a/README.en.md b/README.en.md index fcf569cc..e1844db1 100644 --- a/README.en.md +++ b/README.en.md @@ -1,22 +1,27 @@ -# syscare +# SysCare: System Live Care Service #### Description -System Hot Services. We take care of the operating system. +    SysCare is a system-level hot-fix software that provides single-machine-level and cluster-level security patches and system error hot-fixes for the operating system. The host can fix the system problem without rebooting.
+    Currently, only the unified kernel-mode/user-mode hot patch technology is integrated. Users need to focus on their core business, and leave system repair problems to SysCare for processing. In the later stage, according to the different components to be repaired, a system hot upgrade technology will be provided to further liberate the operation and maintenance users and improve the operation and maintenance efficiency. #### Software Architecture -Software architecture description +    SysCare can use the source code of system components and the corresponding patch problems to produce RPMs for corresponding component patches (including patch files, dependency information and configuration information, etc.). The produced patch RPMs can be uploaded to the corresponding patch warehouses and clustered systems. Demond regularly queries the patch repository, and hot-fixes CVEs and software errors running in the system to ensure safe, stable, and efficient operation of the system. #### Installation -1. xxxx -2. xxxx -3. xxxx +1. syscare build .src.rpm xxxx.patch +2. syscare apply -patch.rpm +3. syscare active +4. syscare deactive +5. syscare remove #### Instructions -1. xxxx -2. xxxx -3. xxxx +1. Clone syscare $ git clone https://gitee.com/openeuler/syscare.git +2. Create develop branch $ cd syscare & git branch -b Feature_XXXX +3. Complete your feature $ vim src/upatch/xxxx & git commit -m "" +4. Push your code $ git push origin +5. Issue Pull Request #### Contribution diff --git a/README.md b/README.md index 8b9fc7e6..7d1029ab 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,41 @@ -# syscare +# SysCare: 系统热服务 #### 介绍 -System Hot Services. We take care of the operating system. +        SysCare 是一个系统级热修复软件，为操作系统提供单机级与集群级安全补丁和系统错误热修复，主机无需重新启动即可修复该系统问题。
+        当前仅融合统一内核态/用户态热补丁技术，用户需聚焦在自己核心业务中，系统修复问题交予SysCare进行处理。后期计划根据修复组件的不同，提供系统热升级技术，进一步解放运维用户提升运维效率。 #### 软件架构 -软件架构说明 +        SysCare 可以利用系统组件源代码与相应的patch问题，制作出相应组件补丁的RPM（包含补丁文件、依赖信息与配置信息等）. 制作的补丁RPM，可以上传到相应的补丁仓库中，集群的系统demond定时去查询补丁仓库, 对系统中运行的CVE与软件错误进行热修复，保证系统安全、稳定、高效运行。 #### 安装教程 -1. xxxx -2. xxxx -3. xxxx +源代码安装： +1. git clone https://gitee.com/openeuler/syscare.git +2. cd syscare & make rpm +3. rpm -ivh syscare-.rpm +4. enjoy the tool. + +二进制安装： +1. 正确配置dfn/yum仓库文件； +2. dnf update & dnf install syscare +3. enjoy the tool. #### 使用说明 -1. xxxx -2. xxxx -3. xxxx +1. syscare build .src.rpm xxxx.patch +2. syscare apply -patch.rpm +3. syscare active +4. syscare deactive +5. syscare remove #### 参与贡献 -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request +1. Fork 本仓库 $ git clone https://gitee.com/openeuler/syscare.git +2. 建立自己分支 $ cd syscare & git branch -b Feature_XXXX +3. 完善特性代码 $ vim src/upatch/xxxx & git commit -m "" +4. 提交代码 $ git push origin +5. 新建 Pull Request #### 特技 -- Gitee