Achelous 系统管理员命令 bioadm
bioadm 是 Achelous 平台的管理员工具,供系统管理员对平台进行配置、用户管理、后端管理及集群管理等操作。本文档将详细介绍 bioadm 各子命令的使用方法。
bioadm 基本说明
bioadm 命令的基本格式为:
bioadm <命令组> <子命令> [参数]
使用 bioadm --help 可以查看所有命令组,使用 bioadm <命令组> --help 可以查看该命令组下的子命令。
认证管理 bioadm auth
修改特权用户密码
bioadm auth passwd --old=OLD --new=NEW [-e ENDPOINTS]
--old/-o:当前密码(必填)--new/-n:新密码(必填)--endpoints/-e:ETCD 端点地址,格式 svr1,svr2,svr3
例如:
[root@Cc1Xtcls]$ bioadm auth passwd --old=oldpass --new=newpass
Successfully change password
生成用户 API-Key 和 Security-Key
bioadm auth keygen [<username>]
为非特权账户生成 API-Key 和 Security-Key。
例如:
[root@Cc1Xtcls]$ bioadm auth keygen demo
API-Key: a1b2c3d4-e5f6-7890-abcd-ef1234567890
Security-Key: x1y2z3w4-v5u6-t7s8-r9q0-po9876543210
获取用户 API-Key 和 Security-Key
bioadm auth keyget [<username>]
获取已有非特权账户的 API-Key 和 Security-Key。
例如:
[root@Cc1Xtcls]$ bioadm auth keyget demo
API-Key: a1b2c3d4-e5f6-7890-abcd-ef1234567890
Security-Key: x1y2z3w4-v5u6-t7s8-r9q0-po9876543210
配置管理 bioadm config
初始化配置
bioadm config init <file>
file:配置文件路径
使用 JSON 格式的配置文件初始化 bioflow 配置。
更新集群配置
bioadm config update-cluster <file>
file:集群配置文件路径
导出当前配置
bioadm config dump
将当前 bioflow 配置导出显示。
卷映射管理
映射卷
bioadm config mapvol [-k] <volmap>
-k/--scheduler:映射到调度器,不加此选项则映射到服务器volmap:卷映射格式为vol@cluster:mnt或vol:mnt
例如:
[root@Cc1Xtcls]$ bioadm config mapvol vol1@xtfs-cluster1:/mnt/vol1
[root@Cc1Xtcls]$ bioadm config mapvol -k vol1@xtfs-cluster1:/mnt/vol1
解除卷映射
bioadm config unmapvol [-k] <volmap>
-k/--scheduler:解除调度器上的卷映射,不加此选项则解除服务器上的卷映射
作业路径管理
设置作业根路径
bioadm config jobrootpath <path>
path:路径格式为vol@cluster:path/to/dir
删除作业根路径
bioadm config unjobrootpath
设置 Cromwell 根路径
bioadm config cromwellpath <path>
path:路径格式为vol@cluster:path/to/dir
邮件通知配置
bioadm config mailaccount --user=USER --password=PASSWORD --host=HOST
--user/-u:邮件账户用户名(必填)--password/-p:邮件账户密码(必填)--host/-s:邮件服务器地址(必填)
设置邮件账户后,系统可以通过邮件向用户发送事件通知。
文件下载资源配置
bioadm config filedownload --cpu=CPU --memory=MEMORY
--cpu/-u:CPU 资源(必填)--memory/-m:内存资源(必填)
前端通知配置
bioadm config frontend --url=URL <opt>
--url/-u:前端 API 地址(必填)opt:操作类型,add添加或del删除
流程存储配置
bioadm config pipelinestore [-p] <dir>
-p/--prefix:是否启用前缀dir:存储流程源文件的目录路径
实例状态管理
列出实例状态
bioadm config lsinst <queue>
queue:队列名称
删除实例状态
bioadm config rminst <queue> <seq>
queue:队列名称seq:实例序号
存储集群挂载配置
列出集群挂载配置
bioadm config lscluster
添加集群挂载配置
bioadm config addcluster [-o OPTS] [-p PATH] [-v VOL] <name> <fstype> <servers>
name:集群名称fstype:文件系统类型,支持nfs、alamo、anna、gluster、ceph、lustre、hdfs、mapservers:服务器地址,多个用逗号分隔,如 server1,server2-o/--opts:挂载选项-p/--path:NFS 服务器的目标挂载路径-v/--vol:挂载配置对应的卷
例如:
[root@Cc1Xtcls]$ bioadm config addcluster xtfs-cluster1 alamo server1,server2
删除集群挂载配置
bioadm config rmcluster [-v VOL] <name>
name:集群名称-v/--vol:指定要删除的卷
自动挂载管理
启用自动挂载
bioadm config automount
禁用自动挂载
bioadm config disablemount
安全参数配置
bioadm config tunesecurity <param> <value>
param:安全参数名称,支持以下选项:secmode:安全模式maxtasknum:最大任务数maxjobnum:最大作业数
value:参数值
调度器参数配置
设置调度器参数
bioadm config tunescheduler <param> <value>
param:调度器参数名称value:参数值
查看调度器参数
bioadm config showscheduler
日志级别配置
bioadm config loglevel [-q QUEUE] [-a] <level>
level:日志级别,0=info, 1=debug, 2=warn, 3=error-q/--queue:指定设置日志级别的队列-a/--achelous:设置 Achelous 的日志级别
物理调度器配置
bioadm config physical <param> <value>
param:物理调度器参数名称value:参数值
容器数据目录配置
bioadm config setcontainerdatadir <dir>
dir:容器数据目录路径
计算集群管理 bioadm computecluster
查看计算集群配置
bioadm computecluster showcluster
添加计算集群
bioadm computecluster addcluster [-s STORAGE] [-c CONSTRAINT] <clustername>
clustername:计算集群名称-s/--storage:关联的存储集群-c/--constraint:集群约束
例如:
[root@Cc1Xtcls]$ bioadm computecluster addcluster compute-cluster1 -s xtfs-cluster1
删除计算集群
bioadm computecluster deletecluster <clustername>
clustername:计算集群名称
管理集群存储
添加存储
bioadm computecluster addstorage <clustername> <storage>
删除存储
bioadm computecluster deletestorage <clustername> <storage>
管理集群约束
添加约束
bioadm computecluster addconstraint <clustername> <constraint>
删除约束
bioadm computecluster deleteconstraint <clustername> <constraint>
后端管理 bioadm backend
列出所有后端
bioadm backend list [--endpoints=ENDPOINTS]
--endpoints:ETCD 端点地址
添加后端
bioadm backend add [-t TYPE] [--cluster=CLUSTER] [--endpoints=ENDPOINTS] <server> <port>
server:后端服务器地址(必填)port:后端端口(必填)-t/--type:后端类型,支持paladin(默认)和kubernetes--cluster:关联的计算集群名称
例如:
[root@Cc1Xtcls]$ bioadm backend add paladin-backend.servicemgr.apc 1026
[root@Cc1Xtcls]$ bioadm backend add -t kubernetes --cluster compute-cluster1 k8s-backend.servicemgr.apc 8080
删除后端
bioadm backend delete [--endpoints=ENDPOINTS] <id>
id:后端 ID
禁用后端
bioadm backend disable <id> <inst>
id:后端 IDinst:实例标识,如 q10
禁用后端后,该后端不再接收新的任务调度,但已运行的任务不会受影响。
启用后端
bioadm backend enable <id> <inst>
id:后端 IDinst:实例标识
启用之前被禁用的后端,恢复任务调度。
实例管理 bioadm cluster
列出所有实例
bioadm cluster list
删除实例
bioadm cluster delete [--endpoints=ENDPOINTS] <inst>
inst:实例标识,如 q10--endpoints:ETCD 端点地址
用户管理 bioadm user
加载外部用户
bioadm user load
从外部系统加载用户信息到 Achelous 平台。
查看用户信息
bioadm user info <id>
id:用户 ID
例如:
[root@Cc1Xtcls]$ bioadm user info demo
User ID: demo
Name: demo
Groups: group1
Credit: 100
JobQuota: 50
TaskQuota: 200
CPUQuota: 100
MemQuota: 512
GPUQuota: 8
GPUMemQuota: 64
Mail: demo@example.com
列出所有用户
bioadm user list [-q]
-q/--quota:显示用户的配额信息
例如:
[root@Cc1Xtcls]$ bioadm user list -q
ID Name Credit JobQuota TaskQuota CPUQuota MemQuota
demo demo 100 50 200 100 512
user2 user2 200 100 500 200 1024
查看用户资源统计
bioadm user acct [-i NAME] [-S SPAN]
-i/--name:指定用户名称-S/--span:时间范围,格式[2017-06-01 12:00:00, 2017-07-01 12:00:00];使用横线(或空)设置单边条件
例如:
[root@Cc1Xtcls]$ bioadm user acct -i demo -S "[2025-01-01 00:00:00, -]"
User: demo
TotalCPU: 256.5
TotalMemory: 1024.0
TotalJobs: 150
TotalTasks: 1200
重置用户资源统计
bioadm user clracct [-i NAME] [-S SPAN]
-i/--name:指定用户名称-S/--span:时间范围
配置用户信息
bioadm user configure <id> [-c CREDIT] [-j JOBQUOTA] [-t TASKQUOTA] [-p CPUQUOTA] [-e MEMQUOTA] [-g GPUQUOTA] [-u GPUMEMQUOTA] [-m MAIL]
id:用户 ID(必填)-c/--credit:用户信用值,-1 表示不修改-j/--jobquota:作业配额,-1 表示不修改-t/--taskquota:任务配额,-1 表示不修改-p/--cpuquota:CPU 配额,-1 表示不修改-e/--memquota:内存配额,-1 表示不修改-g/--gpuquota:GPU 配额,-1 表示不修改-u/--gpumemquota:GPU 内存配额,-1 表示不修改-m/--mail:接收通知的邮件地址
例如:
[root@Cc1Xtcls]$ bioadm user configure demo -c 200 -j 100 -p 200 -m demo@example.com
Successfully configure user demo
组管理 bioadm group
配置组信息
bioadm group configure <id> [-c CREDIT] [-j JOBQUOTA] [-t TASKQUOTA] [-p CPUQUOTA] [-e MEMQUOTA] [-g GPUQUOTA] [-u GPUMEMQUOTA] [-m MAIL]
id:组 ID(必填)-c/--credit:组内用户信用值,-1 表示不修改-j/--jobquota:组内用户作业配额,-1 表示不修改-t/--taskquota:组内用户任务配额,-1 表示不修改-p/--cpuquota:组内用户 CPU 配额,-1 表示不修改-e/--memquota:组内用户内存配额,-1 表示不修改-g/--gpuquota:组内用户 GPU 配额,-1 表示不修改-u/--gpumemquota:组内用户 GPU 内存配额,-1 表示不修改-m/--mail:组内接收通知的邮件地址
例如:
[root@Cc1Xtcls]$ bioadm group configure group1 -c 500 -j 200
Successfully configure group group1