# compose_update

**Repository Path**: yunwe/compose_update

## Basic Information

- **Project Name**: compose_update
- **Description**: 通过post请求更新docker-compose
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-06-12
- **Last Updated**: 2025-05-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Go语言, Docker, docker-compose, devops, cicd

## README

# ComposeUpdate

## 介绍
通过接口请求compose_update服务更新docker-compose文件镜像版本，建议搭配Jenkins使用。

## 构建(可选)
```shell
# 下载源码
git clone https://gitee.com/yunwe/compose_update.git
cd compose_update/

# 设置国内代理（七牛云）
go env -w GOPROXY=https://goproxy.cn,direct

# 构建x86_64版本
GOOS=linux GOARCH=amd64 go build -o compose_update_amd64_linux ./app

# 构建arm64版本
GOOS=linux GOARCH=arm64 go build -o compose_update_arm64_linux ./app
```

## 安装教程

### 环境要求

- Docker
- Docker Compose

## 使用说明

选择对应架构下载后添加执行权限`chmod +x compose_update_amd64_linux`


### 启动参数
```bash
[root@master-test test]# ./compose_update_amd64_linux -h
WARN[2025-04-15 05:36:08] 无效日志级别 ''，默认使用'info'                         
Usage of ./compose_update_amd64_linux:
  -filePath string
        The path of the docker-compose.yml file needs to be provided when the program is running or the interface is called.
  -listen string
        Port to listen on (default 5001) (default "5001")
  -loglevel string
        Log level (debug, info, warn, error, fatal, panic) (default "debug")
  -token string
        Authentication token.
```

### 启动示例：
```bash
./compose_update_for_linux -token 123456 -filePath /data/deploy.yaml
```
> 启动时如果不指定filePath参数，则在请求接口时必须携带filePath参数

更新示例：

```bash
curl -X POST 'http://127.0.0.1:5001/update-service' \
  -H 'Authorization: Bearer 123456' \
  -H 'Content-Type: application/json' \
  -d '{
      "image": "reg.abc.com:1880/front:17",
      "service": "volunteer-h5-front",
      "filePath": "/data/deploy.yaml"
}'
```
回滚示例
```bash
curl -X POST 'http://127.0.0.1:5001/rollback-service' \
  -H 'Authorization: Bearer 123456' \
  -H 'Content-Type: application/json' \
  -d '{
      "service": "nginx",
      "filePath": "/data/test/docker-compose.yml"
}'
```
### Systemd管理
```shell
# 添加执行权限
chmod +x compose_update_amd64_linux && mv compose_update_for_linux /usr/local/bin/compose_update
# service文件
cat >/etc/systemd/system/compose_update.service <<EOF
[Unit]
Description=Compose Update Service

[Service]
ExecStart=compose_update -token diKWZbDxFfYc3r51 -listen 5000
ExecStop=/bin/true
Restart=always

[Install]
WantedBy=multi-user.target
EOF
# 启动
systemctl daemon-reload && systemctl restart compose_update.service
systemctl enable compose_update.service && systemctl status compose_update.service
```

## 集成Jenkins

### 自由风格

```bash
#!/bin/bash

set -e  # 任何命令失败时立即退出

# 定义API端点
API_URL="http://127.0.0.1:5001"
AUTH_TOKEN="123456"



# 执行更新
update() {
  response=$(curl -X POST 'http://127.0.0.1:5001/update-service' \
  -H 'Authorization: Bearer 123456' \
  -H 'Content-Type: application/json' \
  -d '{
      "image": "reg.abc.com:1880/front:17",
      "service": "volunteer-h5-front",
      "filePath": "/data/deploy.yaml"
   }')

  http_code=$(echo "$response" | tail -n 1)
  response_body=$(echo "$response" | sed '$d')

  echo "API响应内容: $response_body"
  echo "HTTP状态码: $http_code"

  if [ $http_code -ne 200 ]; then
    echo "[ERROR] API返回异常状态码: $http_code"
    exit 1
  fi
  exit 0
}

# 回滚服务
rollback_service() {
  response=$(curl -X POST 'http://127.0.0.1:5001/rollback-service' \
  -H 'Authorization: Bearer 123456' \
  -H 'Content-Type: application/json' \
  -d '{
      "service": "nginx",
      "filePath": "/data/test/docker-compose.yml"
	}')
  http_code=$(echo "$response" | tail -n 1)
  response_body=$(echo "$response" | sed '$d')

  echo "API响应内容: $response_body"
  echo "HTTP状态码: $http_code"

  if [ $http_code -ne 200 ]; then
    echo "[ERROR] API返回异常状态码: $http_code"
    exit 1
  fi
  exit 0
}

$status
```

### 流水线风格

```bash
pipeline {
    agent any
    environment {
        API_URL = 'http://127.0.0.1:5001'
        AUTH_TOKEN = '123456'
    }
    stages {
        stage('Update or Rollback Service') {
            steps {
                script {
                    // 定义请求参数（可以从参数化构建传入）
                    def serviceName = 'volunteer-h5-front'
                    def filePath = '/data/deploy.yaml'
                    def imageTag = 'reg.abc.com:1880/front:17'
                    def operation = params.OPERATION ?: 'update' // 可以通过参数化构建选择操作

                    try {
                        // 根据操作类型构建不同的请求
                        def endpoint = (operation == 'update') ? 'update-service' : 'rollback-service'
                        def jsonPayload = (operation == 'update') ? 
                            """
                            {
                                "image": "${imageTag}",
                                "service": "${serviceName}",
                                "filePath": "${filePath}"
                            }
                            """ : 
                            """
                            {
                                "service": "${serviceName}",
                                "filePath": "${filePath}"
                            }
                            """

                        echo "正在执行${operation == 'update' ? '更新' : '回滚'}操作..."
                        
                        // 执行API请求
                        def response = sh(returnStdout: true, script: """
                            curl -s -w "\\n%{http_code}" -X POST '${API_URL}/${endpoint}' \\
                              -H 'Authorization: Bearer ${AUTH_TOKEN}' \\
                              -H 'Content-Type: application/json' \\
                              -d '${jsonPayload}'
                        """).trim()

                        // 处理响应
                        def http_code = response.split('\n')[-1]
                        def response_body = response.replace("\n${http_code}", "")

                        echo "API响应内容: ${response_body}"
                        echo "HTTP状态码: ${http_code}"

                        if (http_code != '200') {
                            error("${operation == 'update' ? '更新' : '回滚'}服务失败，状态码: ${http_code}")
                        }
                        
                        echo "SUCCESS: 服务${operation == 'update' ? '更新' : '回滚'}成功！"

                    } catch (Exception e) {
                        echo "ERROR: 操作执行失败 - ${e.getMessage()}"
                        
                        // 如果是更新失败，可以在这里添加自动回滚逻辑
                        if (operation == 'update') {
                            echo "尝试自动回滚服务..."
                            try {
                                def rollbackResponse = sh(returnStdout: true, script: """
                                    curl -s -w "\\n%{http_code}" -X POST '${API_URL}/rollback-service' \\
                                      -H 'Authorization: Bearer ${AUTH_TOKEN}' \\
                                      -H 'Content-Type: application/json' \\
                                      -d '{
                                          "service": "${serviceName}",
                                          "filePath": "${filePath}"
                                    }'
                                """).trim()
                                
                                def rb_http_code = rollbackResponse.split('\n')[-1]
                                if (rb_http_code == '200') {
                                    echo "SUCCESS: 服务回滚成功"
                                } else {
                                    error("回滚失败，状态码: ${rb_http_code}")
                                }
                            } catch (rollbackException) {
                                error("自动回滚失败: ${rollbackException.getMessage()}")
                            }
                        }
                        
                        // 最终抛出异常使构建失败
                        error("${operation == 'update' ? '更新' : '回滚'}流程失败")
                    }
                }
            }
        }
    }
    // 可选：添加参数化构建支持
    parameters {
        choice(
            name: 'OPERATION',
            choices: ['update', 'rollback'],
            description: '选择要执行的操作'
        )
        string(
            name: 'SERVICE_NAME',
            defaultValue: 'volunteer-h5-front',
            description: '要操作的服务名称'
        )
        string(
            name: 'FILE_PATH',
            defaultValue: '/data/deploy.yaml',
            description: '配置文件路径'
        )
        string(
            name: 'IMAGE_TAG',
            defaultValue: 'reg.abc.com:1880/front:17',
            description: '镜像标签（仅更新时需要）'
        )
    }
}
```