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

[doc] updated "prerequisites" with more detail #162

Closed
wants to merge 3 commits into from

Conversation

alexzhc
Copy link
Collaborator

@alexzhc alexzhc commented Aug 11, 2022

Responding to #155, we have updated the prerequisites for Quick Start with more information about os, software, and hardware.

Signed-off-by: alexzhc <alex.zheng@daocloud.io>
### Linux Distribution

1. CentOS `7.5+`
1. Kylin `V10`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we support Ubuntu, Rockey Linux ,RHEL .


### Package Dependencies

1. The latest `LVM2`
Copy link
Member

@yankay yankay Aug 11, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we change to " the LVM2 installed " ?


For test, a simple 1Giga TCP/IP network is adequate.

For production, and especially with HA features, it is recommended to have a redundant 10Giga TCP/IP network.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Recommended to have a redundant 10Giga TCP/IP network, if enable the HA features .

- Kubernetes version: `1.18+`
- LVM is installed
- Have at least one unused drive
1. Kubernetes version: `1.18+`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. Kubernetes version: `1.18+`
1. Kubernetes `1.18+`

Change for consistency


### Data Disk

HwameiStor supports `HDD`, `SSD` and `NVMe`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
HwameiStor supports `HDD`, `SSD` and `NVMe`.
HwameiStor supports `HDD`, `SSD`, and `NVMe`.


HwameiStor supports `HDD`, `SSD` and `NVMe`.

For test, each host must have at least one unused drive with a minimal size of 10GiB.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For test, each host must have at least one unused drive with a minimal size of 10GiB.
For test, each host must have at least one unused disk with a minimal size of 10GiB.

disk or drive, not sure, same issue below


### Network

For test, a simple 1Giga TCP/IP network is adequate.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For test, a simple 1Giga TCP/IP network is adequate.
For test, a 1Giga TCP/IP network bandwidth is adequate.


For test, a simple 1Giga TCP/IP network is adequate.

For production, and especially with HA features, it is recommended to have a redundant 10Giga TCP/IP network.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For production, and especially with HA features, it is recommended to have a redundant 10Giga TCP/IP network.
For production, and especially with HA features, it is recommended to have a redundant 10Giga TCP/IP network bandwidth.

@@ -5,8 +5,44 @@ sidebar_label: "准备工作"

# 准备工作

HwameiStor 必须部署在 Kubernetes 平台上。而且该平台必须满足以下条件:
## Kubernetes 平台

1. Kubernetes 版本: `1.18+`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. Kubernetes 版本: `1.18+`
1. Kubernetes `1.18+`


## 主机配置

### Linux 发行本
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Linux 发行本
### Linux 发行版

2. 高可用功能需要安装和当前运行的 kernel 版本一致的 `kernel-devel`

```bash
# CentOS and Kylin
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# CentOS and Kylin
# CentOS Kylin


### 数据盘

HwameiStor 支持物理硬盘(HDD), 固态硬盘(SSD) 和 NVMe 闪存盘.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
HwameiStor 支持物理硬盘(HDD), 固态硬盘(SSD) 和 NVMe 闪存盘.
HwameiStor 支持物理硬盘HDD)、固态硬盘SSD和 NVMe 闪存盘.


测试环境里,普通的千兆网络即可。

生产环境里,尤其是开启高可用模式后,须要有冗余保护的万兆网络。
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
生产环境里,尤其是开启高可用模式后,须要有冗余保护的万兆网络
生产环境里,尤其是开启高可用模式后,须有冗余保护的万兆网络

Signed-off-by: alexzhc <alex.zheng@daocloud.io>
Signed-off-by: alexzhc <alex.zheng@daocloud.io>
@alexzhc
Copy link
Collaborator Author

alexzhc commented Aug 11, 2022

closed for complicated conflicts.

@alexzhc alexzhc closed this Aug 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs] Prerequisites is too simple
3 participants