# codo-publish

**Repository Path**: yingmingzongyu/codo-publish

## Basic Information

- **Project Name**: codo-publish
- **Description**: CODO项目 COS、OOS、S3、服务器发布脚本示例
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-10-29
- **Last Updated**: 2021-10-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


# codo-publish

> codo平台发布示例，支持服务器发布和Bucket发布，只有后端代码逻辑，所有的配置信息都是从前端传过来的。

## Server发布
- `get_publish_info.py`: 获取发布信息写文件
- `pull_code.py`: 构建主机拉取代码
- `bulid_code.py`: 编译代码，如：`npm install`
- `upload_code.py`: 处理exclude过滤后将代码并发到目标主机的`/tmp`目录
- `backup_code.py`: 备份目标主机的代码到：`/tmp/code_backup`，只保留最近一个版本
- `depoly_code.py`: 部署/下发代码到目标主机的代码目录，并发操作
- `custom_operation.py`: 自定义操作，比如下发完代码后需要重启xxx进程， `systemctl restart nginx`

## Bucket发布

- `upload_s3`：上传资源到AWS S3
- `upload_cos`: 上传资源到腾讯云COS
- `upload_oss`: 上传资源到阿里云OSS



## 开始使用

### 发布配置

> 预先配置你发布的应用信息，如：环境、主机、Git库等，


例举例一个简单发布示例：

- ①创建命令
- ②配置模板
- ③配置仓库
- ④新建应用
- ⑤提交发布

**创建命令**

> 我们提供了基于`服务器`和`Bucket`基础发布脚本示例供你使用.

克隆代码
```shell
##将代码放到/opt/ops_scripts目录下，后续平台要使用到
mkdir -p /opt/ops_scripts
cd /opt/ops_scripts && git clone https://github.com/opendevops-cn/codo-publish.git
cd codo-publish && pip3 install -r requirements.txt

##修改对应settings里面API网关地址，用户密码信息
vim settings.py
api_gw = 'gw.opendevops.cn'
```


接着到平台添加命令，点开`任务模块`-`命令管理`

![bash_list](https://raw.githubusercontent.com/opendevops-cn/opendevops/master/docs/source/_static/images/publish_cmd_list.png)

**配置模板**
点开`任务模块`-`模板管理`



> 这里需要你创建一个模板，如：Server发布示例，添加你的命令，自由排版，模板管理文档参考：[任务模板](http://docs.opendevops.cn/zh/latest/task_template.html#)

- 组：1的为第一组
- 优先级： 按数字顺序执行
- 参数：PUBLISH_NAME和FLOW_ID都是系统变量，不要修改
- 执行用户： 默认127.0.0.1可不选，保持默认即可
- 触发器：这里支持定时支持、人工干预、直接执行，默认是直接执行

![bash_list](https://raw.githubusercontent.com/opendevops-cn/opendevops/master/docs/source/_static/images/publish_server_temp.png)



**配置代码仓库**

点开`作业配置`-`代码仓库`

> 这里需要你配置一个git仓库地址，要发布的代码仓库。

![bash_list](https://raw.githubusercontent.com/opendevops-cn/opendevops/master/docs/source/_static/images/publish_code_repo.png)


**新建应用**
点开`作业配置`-`发布配置`
- 发布应用：建议一个有意义的名称
- 发布类型：选择发布类型，支持(服务器、存储桶)
- 构建主机：哪台主机执行操作，默认（127.0.0.1）
- 代码仓库：下拉选择你的代码库
- 关联模板：下拉选择你要关联的模板
- 排除文件：exclude排除，如图，多个按行隔开
- 发布类型：目前只支持简单发布
- 目标主机：ip port user password格式，多个按行隔开
- 目标主机组：CMDB里面API主机组的信息，可通过CMDB组里面点击获取API地址
- 发布目录: 服务器的代码目录如：/var/wwww/yanghongfei/

![](https://raw.githubusercontent.com/opendevops-cn/opendevops/master/docs/source/_static/images/publish_create_app.png)


**提交发布**
> 最后提交发布，发布是基于git tag的，需要你在要发布的版本库上打上tag

![](https://raw.githubusercontent.com/opendevops-cn/opendevops/master/docs/source/_static/images/publish_server_commit.png)

提交发布后会在订单列表里面显示出来你将要执行的任务，
当你点击到这个任务的时候，我们会把任务信息给展示出来方便你来确认，最后需要你进行审批，可选择时间执行。

![](https://raw.githubusercontent.com/opendevops-cn/opendevops/master/docs/source/_static/images/publish_audit.png)

如下图示例有一个手工干预的，需要你点击终止全部旁边的干预名称进行执行。

![](https://raw.githubusercontent.com/opendevops-cn/opendevops/master/docs/source/_static/images/publish_commit.png)

点击完审批后会进入等待执行，随后会按照你模板里面的顺序进行执行

![](https://raw.githubusercontent.com/opendevops-cn/opendevops/master/docs/source/_static/images/publish_wait.png)
最后执行完成后会显示状态OK，
- 若执行途中有报错，会暂停任务，可根据`日志`进行排错，进行`重做`
- 若执行途中有报错，且你不希望本组服务器进行执行了，可以点击`终止`
- 若整个任务都不想要了，可以点击`终止全部`

![](https://raw.githubusercontent.com/opendevops-cn/opendevops/master/docs/source/_static/images/publish_ok.png)


### 数据类型

- 接口数据类型如下

```json
{
	"id": 1,
	"publish_name": "yanghongfeitest",
	"publish_type": "service",
	"repository": "git@gitlab.domai.comn:ops/yanghongfei.git",
	"build_host": "172.16.0.101",
	"exclude_file": "flash\n.git/",
	"temp_name": "yanghongfeitest",
	"publish_type1": null,
	"publish_path": "/var/www/",
	"publish_hosts": "172.16.0.20 22 root password",
	"publish_hosts_api": "http://gw.domain.com/cmdb/api/cmdb/server_list/?group=xxxx",
	"bucket_type": "oss",
	"region": "",
	"bucket_name": "",
	"bucket_path": "",
	"SecretID": "",
	"SecretKey": "",
	"docker_registry": "",
	"k8s_api": "",
	"namespace": "",
	"create_time": "2018-12-04 16:29:21"
}
```

> PS: 代码写的有点搓，欢迎吐槽！