Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sjqzhang/ops_channel
命令通道是联接人与机器，人与业务的一座桥.它跟常用的开源运维工具(`ansible`,`saltstack`,`puppet`)有相似之处，但也有着本质的差异。
https://github.com/sjqzhang/ops_channel
aiops ansible channel devops puppet remote-control remote-shell saltstack ssh
Last synced: 4 days ago
JSON representation
命令通道是联接人与机器，人与业务的一座桥.它跟常用的开源运维工具(`ansible`,`saltstack`,`puppet`)有相似之处，但也有着本质的差异。
- Host: GitHub
- URL: https://github.com/sjqzhang/ops_channel
- Owner: sjqzhang
- Created: 2018-11-05T06:19:36.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-21T22:11:44.000Z (4 months ago)
- Last Synced: 2025-01-21T08:07:07.050Z (11 days ago)
- Topics: aiops, ansible, channel, devops, puppet, remote-control, remote-shell, saltstack, ssh
- Language: Go
- Homepage:
- Size: 9.75 MB
- Stars: 37
- Watchers: 3
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[视频教程](https://www.bilibili.com/video/av82624198?p=6)
[](https://asciinema.org/a/258501)
## 什么是命令通道？
命令通道是联接人与机器，人与业务的一座桥.它跟常用的开源工具(`ansible`,`saltstack`,`puppet`)有相似之处，但也有着本质的差异。
## 命令通道有那些特点？
命令通道简单，高效，安全，可靠，可扩展．
- 简单：只有一个可执行文件，无需第三方依赖，安装(服务端，客户端)只需一条命令．客户端零配置．
- 高效: 每秒可以操纵上千台服务器．
- 安全：每个
人员使用不同的token+ip的黑白名单．
- 可靠：自动修复，过载保护
- 可扩展：可以简单配置实现集群，支持10w+客户端
- 支持执行实时消息
## 稳定性如何？
本工具已经在线上稳定运行2年，管理机器超1Ｗ+,无出现重大问题．
## 硬件要求？
```
客户端千级别以下，4核8g
客户端万级别以下，8核16g
```
## 如何安装命令通道
### 安装服务端
```
mkdir -p /opt/channel
wget --no-check-certificate https://github.com/sjqzhang/ops_channel/releases/download/v1.0/CliServer -O /opt/channel/CliServer && cd /opt/channel/ && chmod +x CliServer && ./CliServer &
```
### Docker部署服务端(建议）
```
DIR=/mnt && mkdir -p $DIR/{cache,conf,doc,files,log} && docker run -d --net=host --name channel -v $DIR/files:/opt/channel/files -v $DIR/conf:/opt/channel/conf -v $DIR/cache:/opt/channel/cache -v $DIR/doc:/opt/channel/doc -v $DIR/log:/opt/channel/log sjqzhang/ops_channel
```
```
注意:DIR=/mnt 其中/mnt为宿主机的路径,将宿主机的目录挂载到容器
```
### 安装客户端
```
wget http://{serverip}:9160/cli/upgrade -O /bin/cli && chmod +x /bin/cli && cli daemon -s restart
```
### 单独安装cli命令行(无服务端)
```
wget https://raw.githubusercontent.com/sjqzhang/ops_channel/master/cli -O /bin/cli && chmod +x /bin/cli
```
### 简单使用(`服务端执行`)
```
cli cmd --token abc -u root --sudo 1 -c hostname -i ip{客户端ip}
```
## cli客户端命令
### 登陆相关
```
cli login -u username -p password #用户名密码登陆
cli logout #登出
cli register -u username -p password #注册用户
cli enableuser -u username #启用用户
cli disableuser -u username #禁用用户
```
### shell相关
```
echo hello | cli len ##字符串长度 数据长度等
echo hello | cli upper ##字符串转大写
echo HELLO | cli lower ##字符串转小写
echo 'hello,world' |cli split -s ',' ##字符串分隔
echo 'hello,world' |cli split -s ','|cli join -s ' ' ##数组并接
echo 'hello,world' |cli split -s ','|cli jq -k 0 |cli join ##数组并接
echo 'hello,world' |cli match -m '[\w+]+$' -o aim ##字符正则匹配 -o aim (i:ignoresencase,a:all,m:mutiline)
echo 'hello,world' |cli cut -p 5:-1 ##字符串截取
echo '{"name":"hello","date":"2018-11-09"}'|cli jq -k name ##json解析器
cli md5 -s 'hello' ##字符md5
cli md5 -f filename ##文件md5
cli uuid ##随机uuid
cli rand ##随机数
cli randint -r 100:1000 ##100-1000随机数
cli randstr -l 20 ##随机数字符串
cli machine_id ##客户端编号
```
### 状态相关
```
cli status
cli run_status
cli check_status
cli info
cli check -i ip(客户端ip)
cli repair -i ip(客户端ip)
```
### 文件相关
```
cli upload -f filename ##文件上传(需登陆)
cli delfile -f filename ##文件上传(需登陆)
cli listfile -d directory ##查看文件
```
### 执行命令
```
cli register -u username -p password #注册用户
cli addtoken -t token -u user -s sudo -b blackip -w whiteip #增加token认证
cli rshell -u username --sudo 0 --token token -i ip -d directory -f filename -a arguments -o json --async 1 -t timeout #远程执行
cli cmd -u username --sudo 0 --token token -c command -i ip -o json --async 1 -t timeout #执行命令
参数说明：
-i ip(在那个ip上运行指令，多个ip用英文逗号分隔)
-u username(执行的用户)
--sudo 0(0:普通用户，1:root执行)
-t timeout(超时时间,单位秒，默认：25S)
-o json/text(结果输出格式,默认：text)
--async 0(是否使用异步执行，1:异步,0:同步)
--token token(授权token)
```
### http api
```python
###远程执行命令
# -*- coding: utf-8 -*-
import requests
import json
import time
import threading
import random
def cmd(ip,cmd):
param={
'c':cmd, #command
'i':ip, #ip
'u':'root',# user
'o':'json',# return json or text
'sudo':'1', # sudo
}
headers={'token':'abc'}
data={'param':json.dumps(param)}
return requests.post('http://server ip:9160/cli/api',data=data,headers=headers).text
print cmd('client ip','hostname')
###远程执行脚本
# -*- coding: utf-8 -*-
import requests
import json
import time
import threading
import random
def cmd(ip,filename,args):
param={
'd':'apollo', #command
'f':filename, #filename (注意：这个文件先要登陆上传后才能使用）
'a':args,# user
'u':'root',# user
'o':'json',# return json or text
'sudo':'1', # sudo
}
headers={'token':'abc'}
data={'param':json.dumps(param)}
return requests.post('http://server ip:9160/cli/rshell',data=data,headers=headers).text
print cmd('client ip','test.sh','{"name":"test"}')
```
## Q&A
### cli 客户端可以单独使用么？
```
可以单独使用,可以当shell的一个命令来使用,通过组合功能非常强大！
```
[视频教程](https://www.bilibili.com/video/av82624198?p=6)