Skip to content

Commit 0fa3461

Browse files
authored
Merge pull request #59 from majinghe/helm-chart
add helm chart docs.
2 parents 830156b + 2872b11 commit 0fa3461

File tree

2 files changed

+76
-6
lines changed

2 files changed

+76
-6
lines changed

docs/zh/installation/cloud-native/index.md

Lines changed: 72 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,75 @@ title: "RustFS 的云原生安装指南"
33
description: "使用 Helm Chart 或 Operator 在 Kubernetes 上安装部署 RustFS.​"
44
---
55

6-
# RustFS 的云原生安装指南
6+
# RustFS 的云原生安装指南
7+
8+
RustFS 提供了官方和 [Helm Chart](https://github.com/rustfs/rustfs/tree/main/helm)来在 Kubernetes 集群上安装 RustFS([多机多盘模式,即 MNMD](../../installation/index.md))。
9+
10+
## 参数介绍
11+
12+
13+
| 参数 | 描述 | 默认值 |
14+
|--|--|--|
15+
| `replicaCount` | 集群的节点数量 | `4`(目前 16 节点正在测试中) |
16+
| `image.repository` | 镜像仓库 | `rustfs/rustfs` |
17+
| `image.tag` | 镜像 tag | `latest` |
18+
| `secret.rustfs.access_key` | RustFS access key | `rustfsadmin` |
19+
| `secret.rustfs.secret_key` | RustFS secret key | `rustfsadmin` |
20+
| `storageclass.name` | StorageClass 的名称 | `local-path` |
21+
| `storageclass.size` | PVC 大小 | `256Mi`**一定根据自身需求设置好大小**|
22+
| `requests.cpu` | 请求的 CPU 大小 | `100m`**一定根据自身需求设置好大小**|
23+
| `requests.memory` | 请求的 Memory 大小 | `128Mi`**一定根据自身需求设置好大小**|
24+
| `limits.cpu` | 限制的 CPU 大小 | `100m`**一定根据自身需求设置好大小**|
25+
| `limits.cpu` | 限制的 Memory 大小 | `100m`**一定根据自身需求设置好大小**|
26+
| `config.rustfs.volume` | RustFS 的 VOLUME 设置 | `/data/rustfs0,/data/rustfs1,/data/rustfs2,/data/rustfs3`**4 个 node 下必须这么配置**|
27+
| `config.rustfs.address` | RustFS 的 API 端点地址 | `0.0.0.0:9000` |
28+
| `config.rustfs.console_address` | RustFS 的控制台地址 | `0.0.0.0:9001` |
29+
| `ingress.className` | ingress class 的类型,`traefik``nginx` | `nginx` |
30+
31+
## 安装命令
32+
33+
如果以 `traefik` 为 ingress class,执行如下安装命令:
34+
35+
```
36+
helm install rustfs -n rustfs --create-namespace ./ --set ingress.className="traefik"
37+
```
38+
39+
如果以 `nginx` 为 ingress class,执行如下安装命令:
40+
41+
42+
```
43+
helm install rustfs -n rustfs --create-namespace ./ --set ingress.className="nginx"
44+
```
45+
46+
查看 pod 和 ingress:
47+
48+
```
49+
# 查看 Pod
50+
kubectl -n rustfs get pods -w
51+
NAME READY STATUS RESTARTS AGE
52+
rustfs-0 1/1 Running 0 2m27s
53+
rustfs-1 1/1 Running 0 2m27s
54+
rustfs-2 1/1 Running 0 2m27s
55+
rustfs-3 1/1 Running 0 2m27s
56+
57+
# 查看 ing
58+
kubectl -n rustfs get ing
59+
NAME CLASS HOSTS ADDRESS PORTS AGE
60+
rustfs nginx your.rustfs.com 10.43.237.152 80, 443 29m
61+
```
62+
63+
使用 `https://your.rustfs.com` 并用默认用户名和密码(均为 `rustfsadmin/rustfsadmin`)登陆安装好的 RustFS 实例。
64+
65+
66+
## 卸载
67+
68+
如果您想卸载 RustFS 实例,执行命令:
69+
70+
```
71+
helm uninstall rustfs -n rustfs
72+
```
73+
74+
75+
## 反馈
76+
77+
目前,该 Helm Chart 还在持续改进中,您在使用过程中有任何问题,可以在 [GitHub 上提 Issue 反馈](https://github.com/rustfs/rustfs/issues)

docs/zh/sidebar.ts

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,10 @@ export const sidebar = [
3838
text: 'Docker 安装',
3939
link: '/zh/installation/docker/index'
4040
},
41-
// {
42-
// text: '云原生安装',
43-
// link: '/zh/installation/cloud-native/index'
44-
// },
45-
41+
{
42+
text: '云原生安装',
43+
link: '/zh/installation/cloud-native/index'
44+
},
4645
]
4746
},
4847
{

0 commit comments

Comments
 (0)