Skip to content

Commit 57d341e

Browse files
committed
fix:添加粗糙的节点录入说明和用户管理说明
1 parent ee34b67 commit 57d341e

3 files changed

Lines changed: 76 additions & 4 deletions

File tree

docs/en/guide/oneclickvirt/oneclickvirt_install.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ apt install -y vnstat
1818

1919
to download it. The same applies to other systems.
2020

21+
The controlled side only needs to install the virtualization environment, there is no need to install additional agent for control, just make sure that SSH can log in.
22+
2123
## Control Panel
2224

2325
Hardware requirements: at least 1GB of free memory and 2GB of free disk space. Installation can be completed through any of the following methods.

docs/guide/oneclickvirt/oneclickvirt_install.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ apt install -y vnstat
1818

1919
进行下载,其他系统同理。
2020

21+
受控端只需要安装好虚拟化环境即可,不必额外安装agent进行控制,只要确保SSH能登录即可。
22+
2123
## 面板端
2224

2325
硬件上需要至少1G空闲内存和2G空闲硬盘,通过下面任一方式安装完成即可。

docs/guide/oneclickvirt/oneclickvirt_usage.md

Lines changed: 72 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,88 @@ outline: deep
88

99
## 用户管理
1010

11-
占位待施工
11+
登录进入管理员界面后,打开用户管理页面后,必须点击重置密码,以确保admin账户的密码为强密码,确保不会被恶意爆破。如果初始化的时候,你使用了自行定义的密码,那么不重置密码也可以。
12+
13+
重置密码会自动生成强密码,仅展示一次,务必复制保存好,避免遗忘。
14+
15+
(如果忘记了密码,需要通过数据库操作强行更改密码,占位施工)
16+
17+
如果需要更改用户的类型,就需要点击对应用户进行编辑,编辑的弹窗支持更改用户类型。
18+
19+
管理员可以点击右上角头像,下拉栏目中有切换管理员和普通用户视图的按钮,如果需要测试任何功能,可以直接使用管理员用户测试。(普通用户没有这个视图切换按钮)
20+
21+
## 纳管节点
22+
23+
首先,需要确保要纳管的节点已经安装了四大虚拟化技术的其中之一。
24+
25+
部署了本面板的机器上ping对应的节点的IP,最好延迟在300ms以内且丢包率不要太高,否则可能出现无法连接导致控制中遗漏命令执行的情况。
26+
27+
以下是录入节点的设置步骤:
28+
29+
1. 录入节点基础信息(必须)
30+
31+
录入登录信息的下方,有一个测试按钮,一般来说不需要手动修改对应的连接参数,如果延迟过高或者丢包率很高,那么最好将参数按照提示调高一些,增加容错率。
32+
33+
2. 设置节点所在位置(可选)
34+
35+
直接输入具体国家进行勾选,主流国家都已经有预设了,有对应的旗帜图标。设置位置后,普通用户的申请领取界面将可以看到对应的旗帜和地区,还有自动匹配的所在大洲。
36+
37+
3. 设置节点支持开设的实例类型和对应实例类型的数量限制(必须)
38+
39+
对于docker类型的节点,只能开设容器,其他虚拟化类型都支持开设虚拟机和容器。如果不需要开设虚拟机,务必取消虚拟机的勾选。
40+
41+
数量限制如果保持默认的参数0,意味着不进行节点层面的这个类型的实例类型数量限制。对于容器,建议按照以下公式设置数量
42+
43+
节点空闲存储盘大小 / 将分发的实例的最小硬盘大小 = 实例最大数量
44+
45+
对于虚拟机,则
1246

13-
## 纳管服务器
47+
节点空闲内存大小(含虚拟内存) / 将分发的实例的最小内存大小 = 实例数量
1448

15-
占位待施工。
49+
这样计算的原因在于,容器一般不限制总的CPU数量和内存大小,但限制硬盘大小,虚拟机一般内存才是开设数量的瓶颈。
50+
51+
4. 设置实例类型对应的资源超配置(可选)
1652

1753
默认容器类型不限制CPU和内存预分配的总量,但限制预分配的硬盘总量,以达到最优化的资源共享和最大化的实例数量。
1854

1955
默认虚拟机类型限制所有资源,预分配的总量最大值不能超过实际资源大小。
2056

21-
这块的限制是限制在对应类型的实例在这个服务器上总的资源占用,这里的资源占用是预分配的,不是实际的实例占用,仅用于计算空闲资源限制开设。
57+
具体来说,如果你需要限制哪种资源不被超开,那么就点击限制,限制后将无法超开对应资源。
58+
59+
这块的限制是限制在对应类型的实例在这个节点上总的资源占用,这里的资源占用是预分配的,不是实际的实例占用,仅用于计算空闲资源限制开设。
2260

2361
不推荐进行修改,除非你知道这块的设置在干什么。
2462

63+
5. 设置节点层面的等级限制(必选)
64+
65+
这块预设了5个等级,用户申请领取的时候,将经过这个限制筛选配置。
66+
67+
在实际实例开设过程中,该 节点层面的等级限制 将与 全局的用户等级的资源限制 互相比对,取其中的最小值作为用户在当前节点可用的资源限制。
68+
69+
6. 设置带宽和流量(必选)
70+
71+
字面意思,设置节点的最大带宽和以自然月计算的流量可用值,默认自动启用流量监控和流量统计。
72+
73+
实例流量超过节点限制或用户限制时,将自动停止实例;节点总的流量超限时,将停止整个节点的所有实例。
74+
75+
月初会重置统计数据,并重新启动所有实例。
76+
77+
6. 高级设置(可选)
78+
79+
可以控制对于节点操作的详细参数:
80+
81+
默认单线程串联执行,同一时刻,只会存在一个增删改的任务(对应实例的开设删除重置操作)。
82+
83+
可以更改为多线程并发执行,同一时刻可以存在多个增删改任务,只有并发执行时,并发数量的设置才有意义。
84+
85+
串联执行适合节点本身性能弱或平台用户数量少的情况,并发操作适合节点本身性能强或用户数量多的情况,请自行选择模式。个人推荐使用默认设置,并发执行可能存在未完全测试出来的边界条件,可能有BUG。
86+
87+
节点操作模式支持 仅API,仅SSH,自动切换 ,默认使用自动模式,一般来说没必要修改,除非有特殊需求。
88+
89+
如果需要启用API操作模式,需要在录入节点成功后,在外面点击自动配置API按钮,将执行后台任务自动对接虚拟化平台的API,无需人工配置。等待一段时间大概15~20秒后,应该已经配置成功,点击按钮可见配置历史任务及对应的日志。配置成功后,再点击健康检测,确保API状态为绿色在线状态,就配置启用API成功了。
90+
91+
7. 进行健康检测(必选)
92+
2593
健康检测后普通用户才能看到对应的服务器,才能进行申请开设,若未进行健康检测,用户无法申请开设领取。
2694

2795
## 镜像管理

0 commit comments

Comments
 (0)