From 62a26e340922407279824d60a7f9e059e1691e8d Mon Sep 17 00:00:00 2001 From: blue-troy <12729455+blue-troy@users.noreply.github.com> Date: Tue, 21 Jun 2022 10:05:32 +0800 Subject: [PATCH] Update README.md misuse of punctuation --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b3139da..63f1457 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,13 @@ ## 项目介绍 -Kindling 是一款基于标准化错误定界和定位理念设计的开源监控工具，其设计和核心思路是，对于云上环境和容器环境中，应用程序可能出现的各种故障，能够以标准化的步骤，定位故障出现的位置和原因，而不依赖于用户对应用的了解或对k8s,linux知识的积累。 +Kindling 是一款基于标准化错误定界和定位理念设计的开源监控工具，其设计和核心思路是，对于云上环境和容器环境中，应用程序可能出现的各种故障，能够以标准化的步骤，定位故障出现的位置和原因，而不依赖于用户对应用的了解或对k8s、linux知识的积累。 太空舱计划设计的目的是检验监控工具的标准化故障排查能力，推动Kindling项目的不断演进，以实现对各类故障的覆盖。 项目中总结了一些常见的应用异常场景，这些异常场景由项目组的开发和运维经验整理而来，覆盖了云上项目各类异常场景，包括网络设备，运行资源，应用程序缺陷等多种原因。 -这些场景通过预设置的Demo应用和故障注入程序进行封装，可以在各种k8s环境和云主机环境中复现. +这些场景通过预设置的Demo应用和故障注入程序进行封装，可以在各种k8s环境和云主机环境中复现。 用户可以快捷的将自己的测试环境改造成太空舱环境，并部署演示应用，来自行注入故障以验证监控工具的错误检测和定界定位能力。 @@ -19,11 +19,11 @@ Kindling 是一款基于标准化错误定界和定位理念设计的开源监 ## How to start on K8s ### k8s版本支持 v1.18.1 -> 1.23.1 已验证 - 其他版本如不适配，请提issues,提pr更加欢迎 + 其他版本如不适配，请提issues，提pr更加欢迎 ### k8s开始 1. 下载release到master节点(保证能执行kubectl命令即可)之后解压 2. 创建演示namespace -> kubectl create namespace practice -3. cd space-capsule目录,执行./install.sh安装 [chaosblade-operator](https://github.com/chaosblade-io/chaosblade-operator) 和 示例应用 +3. cd space-capsule目录，执行./install.sh安装 [chaosblade-operator](https://github.com/chaosblade-io/chaosblade-operator) 和 示例应用 - 执行 kubectl get po -n chaosblade 可查看chaosblade-operator是否安装成功 ``` @@ -108,7 +108,7 @@ example history install.sh space-capsule ## 流量发送 ### k8s jemter脚本及使用 1. 位于/space-capsule/jemter文件夹下面 -2. 修改用户定义的变量中ngIp,ngport为nginx暴露的端口或者nodeport方式暴露的端口 +2. 修改用户定义的变量中ngIp，ngport为nginx暴露的端口或者nodeport方式暴露的端口 3. 下发配置 - 禁用start线程组，启用init线程组，执行。查看结果树，每个请求项data不为空表示配置下发成功。 ``` @@ -226,7 +226,7 @@ graph LR; ## 缺陷注入 -- 支持出网和入网流量延迟和丢包场景，支持以下粒度: node,workload,pod,containers -- 支持资源抢占场景，包括 cpu，mem和disk资源, 支持以下粒度: node,workload,pod,containers +- 支持出网和入网流量延迟和丢包场景，支持以下粒度: node、workload、pod、containers +- 支持资源抢占场景，包括 cpu，mem和disk资源，支持以下粒度: node、workload、pod、containers - 支持k8s资源限制场景，包括cpu，memory和ephemeral storage的requests，limit限制 -- 支持Java应用程序异常场景，包括死锁，资源异常使用，RuntimeError, 外部资源阻塞等情况 +- 支持Java应用程序异常场景，包括死锁，资源异常使用，RuntimeError，外部资源阻塞等情况