Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate from zhlint to autocorrect #777

Merged
merged 2 commits into from
Sep 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
121 changes: 121 additions & 0 deletions .autocorrectrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
# yaml-language-server: $schema=https://huacnlee.github.io/autocorrect/schema.json
rules:
# Default rules: https://github.com/huacnlee/autocorrect/raw/main/autocorrect/.autocorrectrc.default
spellcheck: 2
textRules:
# Config some special rule for some texts
# For example, if we wants to let "Hello你好" just warning, and "Hi你好" to ignore
# "Hello你好": 2
# "Hi你好": 0
fileTypes:
# Config the files associations, you config is higher priority than default.
# "rb": ruby
# "Rakefile": ruby
# "*.js": javascript
# ".mdx": markdown
spellcheck:
words:
# Please do not add a general English word (eg. apple, python) here.
# Users can add their special words to their .autocorrectrc file by their need.
- ActiveMQ
- AirPods
- Aliyun
- API
- App Store
- AppKit
- AppStore = App Store
- AWS
- CacheStorage
- CDN
- CentOS
- CloudFront
- CORS
- CPU
- DNS
- Elasticsearch
- ESLint
- Facebook
- GeForce
- GitHub
- Google
- GPU
- H5
- Hadoop
- HBase
- HDFS
- HKEX
- HTML
- HTTP
- HTTPS
- I10n
- I18n
- iMovie
- IndexedDB
- Intel
- iOS
- iPad
- iPadOS
- iPhone
- iTunes
- JavaScript
- jQuery
- JSON
- JWT
- Linux
- LocalStorage
- macOS
- Markdown
- MatrixOne
- MatrixOrigin
- Microsoft
- MongoDB
- Mozilla
- MVC
- MySQL
- Nasdaq
- Netflix
- NodeJS = Node.js
- NoSQL
- NVDIA
- NYSE
- OAuth
- Objective-C
- OLAP
- OSS
- P2P
- PaaS
- RabbitMQ
- Redis
- RESTful
- RSS
- RubyGem
- RubyGems
- SaaS
- Sass
- SDK
- Shopify
- SQL
- SQLite
- SQLServer
- SSL
- Tesla
- TikTok
- tvOS
- TypeScript
- Ubuntu
- UML
- URI
- URL
- VIM
- watchOS
- WebAssembly
- WebKit
- Webpack
- Wi-Fi
- Windows
- WWDC
- Xcode
- XML
- YAML
- YML
- YouTube
17 changes: 7 additions & 10 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,16 @@ jobs:
repository: ${{ github.event.pull_request.head.repo.full_name }}
ref: ${{ github.event.pull_request.head.ref }}

- name: Lint docs
uses: docker://avtodev/markdown-lint:v1 # fastest way
with:
config: './.markdownlint.yaml'
args: './docs/MatrixOne'

- name: Install NodeJS
uses: actions/setup-node@v3
with:
node-version: 18

- name: Install NodeJS Dependencies
run: npm ci
- name: Enable pnpm as package manager
run: corepack enable

- name: Install dependencies
run: pnpm i --frozen-lockfile

- name: Lint Chinese content
run: npm run lint
- name: Lint Markdown files
run: pnpm lint
6 changes: 1 addition & 5 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,2 @@
site
site/
node_modules/

# Configuration files of zhlint.
.zhlintrc
.zhlintignore
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@
- 尽量在写代码的同时就完成注释,减少事后返工
- 不要假设代码是不证自明的
- 对于简单代码尽量避免使用过多注释
- 有 “代入感” 地做注释(仿佛在进行对话一般)
- 有“代入感”地做注释(仿佛在进行对话一般)
- 确保及时更新注释
- 保证注释清楚易懂

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
- 不要在最后添加句号。

- 第二行请留白
- 第三行 “why” 部分,如果没有特定的原因,您可以使用以下表述,如 "Improve performance","Improve test coverage."
- 第三行“why”部分,如果没有特定的原因,您可以使用以下表述,如 "Improve performance","Improve test coverage."
- 其他行不超过 80 个字符。

### **良好的习惯**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
尊重每一个 PR 请求的发起人和其他审阅者。代码审阅是社区活动的重要部分,因此请遵循社区要求。

* **注意语气**
在与他人沟通交流时,我们鼓励您多使用 “建议” 或者 “提问” 的语气,而不要总是命令他人。换位思考,所有人都希望被温柔以待!
在与他人沟通交流时,我们鼓励您多使用“建议”或者“提问”的语气,而不要总是命令他人。换位思考,所有人都希望被温柔以待!

* **赞美**
不要吝啬对他人的赞美!一个好的想法或者好的成果值得我们夸赞。在很多情况下,鼓励、赞美他人往往比不留情面的批评更有价值!
Expand All @@ -27,7 +27,7 @@
请避免个人偏见和主观情绪。诚然,每个人的评论或多或少都会带有主观色彩,但是,作为一个成熟的审阅者,您应该注重技术和数据,而不是个人的喜好。

* **灵活而审慎**
当遇见一些复杂问题时,即使是在综合考量多方因素之后也很难抉择,“接受” 还是 “拒绝”,是个两难的问题———我们也无法给出一个明确、具体的标准,只能说 “具体情况,具体分析”。但是我们建议您在难以抉择时,寻求他人的帮助。
当遇见一些复杂问题时,即使是在综合考量多方因素之后也很难抉择,“接受”还是“拒绝”,是个两难的问题———我们也无法给出一个明确、具体的标准,只能说“具体情况,具体分析”。但是我们建议您在难以抉择时,寻求他人的帮助。

## **对 PR 分类**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

| 类型 | 说明 |
| ------------------------------------------------- | ------------------------------------------------------------ |
| 分享用例和解决方案 | 向用户展示如何在特定场景下使用 MatrixOne,可以将您的用例发送到 [email protected],我们将在社区中发布。 |
| 分享用例和解决方案 | 向用户展示如何在特定场景下使用 MatrixOne,可以将您的用例发送到 <[email protected]>,我们将在社区中发布。 |
| 撰写博文、故事墙、白皮书 | 撰写高质量的文章,清晰准确地解释有关 MatrixOne 的技术细节。|
| 做一场技术演讲或现场直播 | 发表演讲或现场直播可以帮助提高各界朋友对 MatrixOne 的认识。|
| 互相支持 | 帮助 GitHub 上的用户解决使用 MatrixOne 时遇到的问题。 |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ MatrixOne 社区欢迎所有开发者的加入和贡献!本章节旨在帮助

## **认领任务**

当您提出 Issue 之后或者是在浏览 `good-first-issue` 后决定上手解决,您需要认领这次 Issue。在相应 Issue 的评论中输入如 “I'd like to work on this issue”,社区人员会将任务分配给您,此时,您可以在右侧的 Assignees 板块看见自己,接下来便可以正式着手解决问题。
当您提出 Issue 之后或者是在浏览 `good-first-issue` 后决定上手解决,您需要认领这次 Issue。在相应 Issue 的评论中输入如“I'd like to work on this issue”,社区人员会将任务分配给您,此时,您可以在右侧的 Assignees 板块看见自己,接下来便可以正式着手解决问题。

## **前置准备**

Expand Down
6 changes: 3 additions & 3 deletions docs/MatrixOne/Deploy/MatrixOne-cluster-Scale.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,9 +132,9 @@ Kubernetes 可以通过 kuboard spray 图形化管理页面来完成节点的扩
2. 根据上述返回的结果和实际需求,你可以为节点打上标签,参见下面的代码示例:

```
NODE="[待打上标签的节点]" # 根据上述结果,有可能是ip、也可能是主机名、或者别名,例如10.0.0.1、host-10-0-0-1、node01,那么设置NODE="node0"
LABEL_K="mo-role" # 标签的key,可按需定义,也可以直接用示例
LABEL_V="mo-cn" # 标签的value,可按需定义,也可以直接用示例
NODE="[待打上标签的节点]" # 根据上述结果,有可能是 ip、也可能是主机名、或者别名,例如 10.0.0.1、host-10-0-0-1、node01,那么设置 NODE="node0"
LABEL_K="mo-role" # 标签的 key,可按需定义,也可以直接用示例
LABEL_V="mo-cn" # 标签的 value,可按需定义,也可以直接用示例

kubectl label node ${NODE} ${LABEL_K}=${LABEL_V}
```
Expand Down
20 changes: 10 additions & 10 deletions docs/MatrixOne/Deploy/deploy-MatrixOne-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@

- PersistentVolumeClaim

PersistentVolumeClaim,简称 **PVC**,作为用户对存储资源的需求申请, 主要包括存储空间请求、访问模式、PV 选择条件和存储类别等信息的设置。
PersistentVolumeClaim,简称 **PVC**,作为用户对存储资源的需求申请主要包括存储空间请求、访问模式、PV 选择条件和存储类别等信息的设置。

- Service

也叫做 **SVC**,通过标签选择的方式匹配一组 Pod 对外访问服务的一种机制, 每一个 svc 可以理解为一个微服务。
也叫做 **SVC**,通过标签选择的方式匹配一组 Pod 对外访问服务的一种机制每一个 svc 可以理解为一个微服务。

- Operator

Expand Down Expand Up @@ -512,17 +512,17 @@ __Note:__ 本章节均是在 master0 节点操作。
spec:
# 1. 配置 tn
tn:
cacheVolume: # tn的磁盘缓存
cacheVolume: # tn 的磁盘缓存
size: 5Gi # 根据实际磁盘大小和需求修改
storageClassName: local-path # 如果不写,会用系统默认的storage class
storageClassName: local-path # 如果不写,会用系统默认的 storage class
resources:
requests:
cpu: 100m #1000m=1c
memory: 500Mi # 1024Mi
limits: # 注意limits不能低于requests,也不能超过单节点的能力,一般根据实际情况来分配,一般设置limits和requests一致即可
limits: # 注意 limits 不能低于 requests,也不能超过单节点的能力,一般根据实际情况来分配,一般设置 limits 和 requests 一致即可
cpu: 200m
memory: 1Gi
config: | # tn的配置
config: | # tn 的配置
[dn.Txn.Storage]
backend = "TAE"
log-backend = "logservice"
Expand All @@ -536,15 +536,15 @@ __Note:__ 本章节均是在 master0 节点操作。
level = "error"
format = "json"
max-size = 512
replicas: 1 # tn的副本数,不可修改。当前版本仅支持设置为 1。
replicas: 1 # tn 的副本数,不可修改。当前版本仅支持设置为 1。
# 2. 配置 logservice
logService:
replicas: 3 # logservice的副本数
replicas: 3 # logservice 的副本数
resources:
requests:
cpu: 100m #1000m=1c
memory: 500Mi # 1024Mi
limits: # 注意limits不能低于requests,也不能超过单节点的能力,一般根据实际情况来分配,一般设置limits和requests一致即可
limits: # 注意 limits 不能低于 requests,也不能超过单节点的能力,一般根据实际情况来分配,一般设置 limits 和 requests 一致即可
cpu: 200m
memory: 1Gi
sharedStorage: # 配置 logservice 对接的 s3 存储
Expand All @@ -571,7 +571,7 @@ __Note:__ 本章节均是在 master0 节点操作。
requests:
cpu: 100m #1000m=1c
memory: 500Mi # 1024Mi
limits: # 注意limits不能低于requests,也不能超过单节点的能力,一般根据实际情况来分配,一般设置limits和requests一致即可
limits: # 注意 limits 不能低于 requests,也不能超过单节点的能力,一般根据实际情况来分配,一般设置 limits 和 requests 一致即可
cpu: 200m
memory: 2Gi
serviceType: NodePort # cn 需要对外提供访问入口,其 svc 设置为 NodePort
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
| 设备台数 | 3 台 |
| CPU 配置 | 8 核以上 |
| 内存配置 | 32GB 以上 |
| 磁盘配置 | 每节点1块系统盘 100G, 4-7块数据盘 100G, 均需要 PCIe NVME SSD 3.0 |
| 磁盘配置 | 每节点 1 块系统盘 100G, 4-7 块数据盘 100G, 均需要 PCIe NVME SSD 3.0 |
| 网卡配置 | 双万兆网口,万兆网卡及交换机 |

## 软件配置
Expand All @@ -28,6 +28,6 @@

| 节点名称 | 资源 | 节点角色 | 部署模块 | 磁盘部署 |
| -------- | ----- | -------------- | :----------------------------------------------------------- | ------------------------------------------------------------ |
| node0 | 8c32g | 管控/存储/计算 | 部署及运维工具 mo-ctl, Kubernetes master/node,Minio, MatrixOne Proxy,Logservice,TN,负载均衡 | Kubernetes 需要1块数据盘,Minio 需要 1 至 4 块数据盘(建议物理分盘,也可逻辑分盘), Logservice 需要1块数据盘,TN 需要 1 块数据盘 |
| node1 | 8c32g | 管控/存储/计算 | 部署及运维工具 mo-ctl, Kubernetes master/node,Minio,MatrixOne Proxy,Logservice,CN,负载均衡 | Kubernetes 需要1块数据盘,Minio 需要1-4块数据盘(建议物理分盘,也可逻辑分盘), Logservice 需要1块数据盘,CN需要1块数据盘 |
| node2 | 8c32g | 管控/存储/计算 | 部署及运维工具 mo-ctl, Kubernetes master/node,Minio,MatrixOne Proxy,Logservice,CN,负载均衡 | Kubernetes 需要 1 块数据盘,Minio需要1-4块数据盘(建议物理分盘,也可逻辑分盘), Logservice 需要 1 块数据盘,CN 需要 1 块数据盘 |
| node0 | 8c32g | 管控/存储/计算 | 部署及运维工具 mo-ctl, Kubernetes master/node,Minio,MatrixOne Proxy,Logservice,TN,负载均衡 | Kubernetes 需要 1 块数据盘,Minio 需要 1 至 4 块数据盘(建议物理分盘,也可逻辑分盘), Logservice 需要 1 块数据盘,TN 需要 1 块数据盘 |
| node1 | 8c32g | 管控/存储/计算 | 部署及运维工具 mo-ctl, Kubernetes master/node,Minio,MatrixOne Proxy,Logservice,CN,负载均衡 | Kubernetes 需要 1 块数据盘,Minio 需要 1-4 块数据盘(建议物理分盘,也可逻辑分盘), Logservice 需要 1 块数据盘,CN 需要 1 块数据盘 |
| node2 | 8c32g | 管控/存储/计算 | 部署及运维工具 mo-ctl, Kubernetes master/node,Minio,MatrixOne Proxy,Logservice,CN,负载均衡 | Kubernetes 需要 1 块数据盘,Minio 需要 1-4 块数据盘(建议物理分盘,也可逻辑分盘), Logservice 需要 1 块数据盘,CN 需要 1 块数据盘 |
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,22 @@

## 软件及硬件配置要求

| **模块** | Kubernetes master | Minio | LogService | TN(混部Proxy及负载均衡) | CN(混部Proxy及负载均衡) |
| **模块** | Kubernetes master | Minio | LogService | TN(混部 Proxy 及负载均衡) | CN(混部 Proxy 及负载均衡) |
| :-----------------------: | -------------------------- | ---------- | -------- | -------- | -------------------- |
| **台数(物理机、虚拟机均可)** | 3 台 | 4 台 | 3 台 | 1 台 | y 台 |
| **节点角色** | Kubernetes 管控 | 存储服务 | MatrixOne 工作节点 | MatrixOne 工作节点 | MatrixOne 工作节点 |
| **CPU 配置** | 4 核以上 | 4 核以上 | 4核以上 | 16 核以上 | 16 核以上 |
| **CPU 配置** | 4 核以上 | 4 核以上 | 4 核以上 | 16 核以上 | 16 核以上 |
| **内存配置** | 8GB 以上 | 8GB 以上 | 8GB 以上 | 64GB 以上 | 32GB 以上 |
| **网卡** | 双万兆网口,万兆网卡 | 同上 | 同上 | 同上 | 同上 |
| **系统盘配置** | 每节点 PCIe NVME SSD 3.0 × 1块 100GB,建议做 Raid 1 | 同上 | 同上 | 同上 | 同上 |
| **Kubernetes 盘配置** | 每节点 PCIe NVME SSD 3.0 × 1块 100GB,建议做 Raid 1 | 同上 | 同上 | 同上 | 同上 |
| **数据盘配置** | N/A | 每节点 PCIe NVME SSD 3.0 × 4块 × a G/块 ,raid无要求,建议物理分盘,可逻辑分盘。 | 每节点 NVME SSD 3.0/4.0 (1G/s以上读取速率) × 1块 × b G/块。 | NVME SSD 3.0/4.0 × 2 块 × c G/块 | 每节点 NVME SSD 3.0/4.0 × 2块 × d G/块 。 |
| **备注** | | a 与业务数据量相关,a = 业务数据量×2/16。 | b 与业务数据量相关,越接近越好。 | c 与业务数据量相关,越接近越好。其中一块给 TN/CN 故障恢复时备用。 | d 与业务数据量相关,越接近越好。其中一块给 TN/CN 故障恢复时备用。y与业务负载相关。 |
| **系统盘配置** | 每节点 PCIe NVME SSD 3.0 × 1 块 100GB,建议做 Raid 1 | 同上 | 同上 | 同上 | 同上 |
| **Kubernetes 盘配置** | 每节点 PCIe NVME SSD 3.0 × 1 块 100GB,建议做 Raid 1 | 同上 | 同上 | 同上 | 同上 |
| **数据盘配置** | N/A | 每节点 PCIe NVME SSD 3.0 × 4 块 × a G/块,raid 无要求,建议物理分盘,可逻辑分盘。 | 每节点 NVME SSD 3.0/4.0 (1G/s 以上读取速率) × 1 块 × b G/块。 | NVME SSD 3.0/4.0 × 2 块 × c G/块 | 每节点 NVME SSD 3.0/4.0 × 2 块 × d G/块。 |
| **备注** | | a 与业务数据量相关,a = 业务数据量×2/16。 | b 与业务数据量相关,越接近越好。 | c 与业务数据量相关,越接近越好。其中一块给 TN/CN 故障恢复时备用。 | d 与业务数据量相关,越接近越好。其中一块给 TN/CN 故障恢复时备用。y 与业务负载相关。 |

## 其他配置

| 操作系统 | 支持的 CPU 架构 |
| :----------------------------------------- | :-------------- |
| Debian 11 以上版本(Kernel内核要求 5.0 以上) | X86_64 |
| Debian 11 以上版本(Kernel 内核要求 5.0 以上) | X86_64 |

由于每个私有化生产环境部署场景均存在差异,有关具体部署方案及部署细节,请联系 MatrixOne 的客户支持团队。
4 changes: 2 additions & 2 deletions docs/MatrixOne/Deploy/health-check-resource-monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ MinIO 自带了一个管理界面,通过该界面我们可以以可视化的
2. 根据上述返回结果,使用以下命令来查看特定节点的资源使用情况。根据之前的部署方案,可以查看到 MatrixOne 集群位于名为 node0 的节点上:

```
NODE="[待监控节点]" # 根据上述结果,有可能是ip、也可能是主机名、或者别名,例如10.0.0.1、host-10-0-0-1、node01
NODE="[待监控节点]" # 根据上述结果,有可能是 ip、也可能是主机名、或者别名,例如 10.0.0.1、host-10-0-0-1、node01
kubectl top node ${NODE}
```

Expand Down Expand Up @@ -251,7 +251,7 @@ Events: <none>
2. 根据上述返回结果,使用以下命令来查看特定 Pod 的资源使用情况:

```
POD="[待监控pod名称]" # 根据上述结果,例如:tn为mo-tn-0,cn为mo-tp-cn-0、mo-tp-cn-1、...,logservice为mo-log-0、mo-log-1、...
POD="[待监控 pod 名称]" # 根据上述结果,例如:tn 为 mo-tn-0,cn 为 mo-tp-cn-0、mo-tp-cn-1、...,logservice 为 mo-log-0、mo-log-1、...
kubectl top pod ${POD} -n${NS}
```

Expand Down
2 changes: 1 addition & 1 deletion docs/MatrixOne/Deploy/mgmt-cn-group-using-proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Proxy 在 CN 缩容时通过以上行为处理会话的迁移和关闭,以确
namespace: mo-hn
spec:
+ proxy:
+ replicas: 2 #为了高可用,proxy的replicas需要至少2个
+ replicas: 2 #为了高可用,proxy 的 replicas 需要至少 2 个
```

2. 修改完成后,使用下面的命令行运行 `mo.yaml` 文件:
Expand Down
Loading
Loading