# wecube-plugins-saltstack

**Repository Path**: WeBankPartners/wecube-plugins-saltstack

## Basic Information

- **Project Name**: wecube-plugins-saltstack
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-08-30
- **Last Updated**: 2025-08-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SaltStack插件
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
![](https://img.shields.io/badge/language-golang-orang.svg)
 
中文 / [English](README.md)

## 简介

SaltStack 是一个服务器基础架构集中化管理平台，具备配置管理、远程执行、监控等功能。SaltStack 基于Python语言实现，结合轻量级消息队列（ZeroMQ）与Python第三方模块（Pyzmq、PyCrypto、Pyjinjia2、python-msgpack和PyYAML等）构建。

SaltStack插件根据不同场景的具体需求，对salt-api进行封装以及组合封装，降低了使用SaltStack的难度，并提供了更贴近业务使用场景的API接口。

SaltStack插件作为WeCube插件群里重要的一员，为WeCube提供了管理主机集群的能力。同时，SaltStack插件可以独立于WeCube为第三方应用提供可插拔式的服务。

## 主要功能

SaltStack插件依赖salt-master,salt-api和httpd等服务，基于这些服务封装了一层对主机进行系统管理和应用部署的API。

用户可通过该插件提供的API执行如下操作:

- salt-minion安装：主机安装salt-minion后,后续所有对该主机的操作都可从salt-master发起；
- 文件分发：从S3对象存储中下载文件并部署到指定主机的指定目录，如果是压缩包还提供解压能力；
- 变量替换操作：将安装包指定目录下的配置文件进行变量替换，并重新生成替换后的安装包放到S3对象存储；
- 脚本执行：可指定用户在指定主机上执行主机本地或者S3对象存储上的bash和python脚本；
- 用户管理操作：可在指定主机上新增用户、删除用户；
- 数据库操作：在指定的mysql数据库实例上执行S3对象存储上的sql文件；
- 数据盘操作：检查指定主机是否有未格式化的数据盘，可对指定主机上的数据盘进行格式化并设置自动挂在到某个主机目录；
- 应用部署：可指定主机下发S3上对象存储上的应用安装包，并执行安装包内的指定脚本用来启动或者停止应用。

架构及API见下图：

<img src="./docs/images/architecture.png" />

## 开发环境搭建

详情请查看 [SaltStack插件开发环境搭建指引](docs/compile/wecube-plugins-saltstack_build_dev_env.md)

**注意**: SaltStack插件编译完毕后，运行二进制前必须确认本机已安装salt-master、salt-api、mysql client等组件，建议在linux主机上使用docker镜像的方式运行SaltStack插件，因为docker镜像中已默认安装salt-api等组件。

## docker镜像和插件包制作

详情请查看 [SaltStack插件docker镜像包和插件包制作指引](docs/compile/wecube-plugins-saltstack_compile_guide.md)

## 运行插件

执行以下命令运行SaltStack插件容器,其中变量`{$HOST_IP}`需要替换为容器所在主机ip，该ip在执行主机安装salt-minion时使用，变量`{$TAG_NUM}`对应代码最后一次提交的commit号。

插件运行需要占用主机9099、4505、4606和4507四个端口，请使用netstat或者ss命令确认这4个端口未被其他程序占用。  
| 端口 | 说明                          |
| ---- | ----------------------------- |
| 9099 | salt-minion安装请求的端口     |
| 4505 | salt-master任务订阅端口       |
| 4506 | salt-master认证、结果收集端口 |
| 4507 | 双实例salt插件通信端口        |

```
docker run -d  --restart=unless-stopped -v /etc/localtime:/etc/localtime -e minion_master_ip={$HOST_IP} -e minion_port=22 -p 9099:80 -p 9090:8080 -p 4505:4505 -p 4506:4506 -p 8082:8082 --privileged=true  -v /home/app/data/minions_pki:/etc/salt/pki/master/minions -v /home/app/wecube-plugins-saltstack/logs:/home/app/wecube-plugins-saltstack/logs -v /home/app/data:/home/app/data wecube-plugins-saltstack:{$TAG_NUM}
```

**插件日志路径**:/home/app/wecube-plugins-saltstack/logs/wecube-plugins-saltstack.log

使用容器的方式运行插件后，在另外一台linux主机上安装salt-minion来测试。

在SaltStack插件所在的机器上运行如下curl命令，其中json参数host为需要安装salt-minion的主机ip，password为加密后的密码，本例中对应的原始密码为qq123456，插件会根据seed和guid生成一个key来解密输入的password获取原始密码。

```
curl -X POST  http://127.0.0.1:8082/v1/deploy/agent/install -H "cache-control: no-cache"  -H "content-type: application/json" -d "{\"inputs\":[{\"guid\":\"1234\",\"seed\":\"abc12345\",\"host\":\"127.0.0.1\",\"password\": \"251f54c3f5be75e171ae1eb516dbacd9\"}]}"
```

如看到以下返回，表示salt-minion安装成功

```
{
    "resultCode": "0",
    "resultMessage": "success",
    "results": {
        "outputs": [
            {
                "guid": "1234"
            }
        ]
    }
}
```

## API使用说明

关于SaltStack插件的API说明，请查看以下文档
[SaltStack插件API手册](docs/api/wecube_plugins_saltstack_api_guide.md)

## License

SaltStack插件是基于 Apache License 2.0 协议，详情请参考[license](http://www.apache.org/licenses/LICENSE-2.0)

## 社区

- 如果您想得到最快的响应，请给我们提[Issue](https://github.com/WeBankPartners/wecube-plugins-saltstack/issues/new/choose)或扫描下面的二维码，我们会第一时间反馈。

	<div align="left">
	<img src="docs/images/wecube_qr_code.png"  height="200" width="200">
	</div>

- 联系我们：fintech@webank.com