docs's People
docs's Issues
增加推荐 cni 说明
按照文档升级失败
按照https://docs.iomesh.com 的文档部署iomesh成功
但是pod绑定pvc过程中csi-driver一直卡在mkfs /dev/sda
DESCRIBE POD出现错误信息:“mke2fs is apparently in use by the system will not make a filesystem here”
chart版本:iomesh-v0.10.1.tgz operator-v0.10.1.tgz csi-driver-2.1.1.tgz
添加在同一个 k8s 集群部署多个 zbs-csi-driver 接入不同 zbs 集群的部署步骤
安装需求中增加最小 cpu/mem 相关描述
增加 FAQs
可参考 openebs https://openebs.io/docs/faqs/general ,不过他们的总体比较乱,我们需要做 FAQ 分类
文档: Markdown 列表中的缩进问题
大部分 flavor 的 Markdown 语法中都会描述列表条目下的内容应如何缩进,举个栗子:
To add another element in a list while preserving the continuity of the list, indent the element four spaces or one tab.
https://www.markdownguide.org/basic-syntax/#adding-elements-in-lists
以 IOMesh 文档为例,截图中红色箭头所指处当前没有缩进:
添加缩进后(four spaces),在 Github Preview 的效果如下,在 Docusaurus 中会有类似效果:
Setup Open-ISCSI
-
Install open-iscsi:
sudo yum install iscsi-initiator-utils -y
sudo apt-get install open-iscsi -y
-
Edit
/etc/iscsi/iscsid.conf
by settingnode.startup
tomanual
:sudo sed -i 's/^node.startup = automatic$/node.startup = manual/' /etc/iscsi/iscsid.conf
-
Disable SELinux:
sudo setenforce 0 sudo sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/' /etc/selinux/config
-
Start
iscsid
service:sudo systemctl enable --now iscsid
I hope this is of a little help. ;-)
Introduce zbs-csi-driver and how to deploy
需要强调 cacheWithJournal 必须配置并且磁盘必须大于 60GB
CSI Driver Deployment 增加对不同发行版的支持。
增加对 Ubuntu,Centos8 等平台的支持。
dm: 修改挂盘文档
relate: iomesh/zbs-operator#101
增加如何触发 ndm 重新扫描 bd 的操作说明
externa-snapshotter-controller 的 namespace 应该建议配置成 kube-system
per pvc 的鉴权文档中第一个样例 namespace 调整
add ci workflow
- trigger ci when pull request
- release to github page when merged
补充磁盘卸载步骤
先 cachewithjournal,后 datastore
external-snapshotter 文件名有误
external-lun: 提示用户关闭 selinux 后再使用 iscsiadm
提供离线部署方式
增加license相关的文档
需要明确 IOMESH_DATA_CIDR 的含义,是物理网络而非 CNI 网络
监控部分需要补充细节
目前监控部分比较简略,需要补充如下内容:
需要罗列具体操作步骤
- 如何部署到集群
- 如何监控iomesh,怎么配置
- 有哪些指标可监控
- 在哪查看监控结果
安装章节必须主动提示用户先完成前置准备章节
文档中的运维操作统一使用 kubectl edit 而非修改 helm values
更新 IOMesh 集群升级部分的内容
现有文档大量的升级操作已过期
csi: update Kubernetes Version Compatibility Matrix
- csi version should be updated to 2.0
- add a new matrix for openshift 3.11 and openshift 4.5
Add docs for cooperating with Prometheus
集群升级描述文档滞后
文档中描述修改iomesh.yaml的version字段,但是yaml文件中没有version字段。需要重新写一下这块
升级 docusaurus 版本 v1 => v2
v1.xxx 官方早已不推荐使用
IMPORTANT: this is the documentation of Docusaurus v1.
We now recommend using Docusaurus 2 instead!
增加详细的监控配置步骤
优化磁盘挂载方式的描述
目前的磁盘配置文档只有一些粗略的例子,对不熟悉 K8s Selector + Label 机制的用户会造成困惑导致无法灵活使用。
待改进
需要明确的让用户知道 IOMesh 磁盘挂载方式的原理,以及 selector 中配置的 label 应该是从 blockDevice 的 label 中查找。
operator 升级操作文档缺失
目前只有 iomesh 升级文档,没有 operator 升级文档
鉴权StorageClass,PVC创建需要添加描述与具体步骤
补充 RWO/RWX 等读写模式的支持情况
补充详细的 IOMesh 卸载方式
kubernetes feature gate 需要根据不同版本选择性开启
补充在不关闭 SELiunx 场景下部署 IOMesh 的对应配置方式
per pvc 鉴权样例调整
将鉴权使用的 secret 和认证使用的 secret 做明显区分
快速安装部分不再需要区分操作系统版本而使用不同的安装脚本
补充 open-iscsi 版本要求
dm: 补充挂载详细描述
需要补充:
- 磁盘规划
- 挂载详细指南
- 增加更多示例
- 全闪挂载
创建 pvc 章节中需要增加创建 block 类型 pvc 的示例
增加默认的资源限制说明
- meta pod: 0.6 Core / 2G RAM
- zookeeper pod: 0.4 Core / 2G RAM
- chunk pod: 3 Core / 5G RAM
- 其他 pod 合集:1 Core / 1G RAM
Use IOMesh as iSCSI Target->Delete PVC->提示字段要设置引号
目前:iomesh.com/iscsi-lun-iqn-allow-list field is "",
我以为是把值删除就可以,麻烦再强调一下要设置上引号,光删除后报错不会生效。
Fixes edit url, link to iomesh-docs
Add version control function
安装部署章节应该将 license 激活提示放到更加醒目的位置
避免 30 天到期导致集群问题造成用户疑惑和 oncall 事项,官方应该建议用户安装完毕尽快申请 license
install: 补充网络规划详细
需要补充:
- 网络规划及拓扑
- 更多示例
zbs-operator deployment doc helm install command error
helm install --namespace iomesh-system --create-namespace iomesh-system my-zbs-operator iomesh/zbs-operator --version 0.1.0
改为
helm install --namespace iomesh-system --create-namespace my-zbs-operator iomesh/zbs-operator --version 0.1.0
去掉 --create-namespace 后面的参数
Add docs for zbsctl
Add docs for upgrading zbs
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.