OpenDevOps任务平台最佳实践指南

前言

OpenDevOps是一个开源的自动化运维平台，提供了任务编排、配置管理、发布部署等功能。本文将详细介绍如何基于OpenDevOps平台实现多种场景下的任务自动化管理，包括基础任务提交、API调用、Git发布集成以及DNS配置管理等最佳实践。

基础任务提交示例

简单任务提交

最简单的任务提交方式是通过平台界面直接提交不带参数的任务。这种方式适合执行固定脚本或命令的场景。

1. 登录OpenDevOps平台
2. 进入任务管理界面
3. 选择对应模板
4. 填写任务基本信息
5. 直接提交执行

带参数任务提交

对于需要动态参数的场景，可以使用PARAMETER方式提交任务：

1. 在任务模板中预先定义参数变量
2. 提交任务时填写具体参数值
3. 平台会将参数传递给执行脚本

参数支持设置别名，提升可读性，例如将"VERSION"显示为"版本"。

JSON自定义任务提交

对于复杂任务，可以使用JSON格式提交：

{
  "task_name": "JSON提交的任务",
  "submitter": "user1",
  "temp_id": "1",
  "schedule": "ready",
  "exec_time": "2023-01-01 10:00:00",
  "args": "{'参数名':'参数值'}",
  "details": "任务描述",
  "hosts": "{1: '192.168.1.100'}"
}

API任务提交实践

通过API提交任务

在不登录平台的情况下，可以通过API提交任务，适合集成到其他系统中：

import requests
import datetime

def post_task(temp_id, schedule):
    auth_key = "your_auth_key_here"
    accept_task_url = 'https://your-domain.com/api/task/v2/task/accept/'
    
    args = {
        "TAG": "v1.0",
        "GIT_URL": "your_repo_url",
        "APP_NAME": "YourApp"
    }
    
    data = {
        "task_name": "API任务",
        "temp_id": temp_id,
        "args": str(args),
        "details": "通过API提交",
        "hosts": "{1: '192.168.1.100'}",
        "submitter": "api_user",
        "exec_time": datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S'),
        "schedule": schedule
    }
    
    # 获取CSRF token
    req1 = requests.get(accept_task_url, cookies={'auth_key': auth_key})
    csrf_key = req1.json()['csrf_key']
    
    # 提交任务
    req = requests.post(accept_task_url, 
                       data=json.dumps(data),
                       cookies={'auth_key': auth_key, 'csrf_key': csrf_key})
    
    if req.json()['code'] != 0:
        print("任务提交失败")
    else:
        print("任务提交成功")

Git集成发布实践

Git Tag触发自动发布

结合GitLab的Custom Hooks功能，可以实现基于Tag的自动化发布流程：

1. 在GitLab服务器上配置项目钩子
2. 创建update钩子脚本
3. 推送特定格式的Tag触发发布

钩子脚本示例：

#!/usr/bin/env python
import sys
import re

def get_tag():
    tag = sys.argv[1].split("/")[-1]
    # 测试环境Tag
    if re.match(r'\Aqa-[\w]*', tag):
        post_task(tag, '32', 'ready')
    # 生产环境Tag    
    elif re.match(r'\Arelease-[\w]*', tag):
        post_task(tag, '32', 'new')

发布流程优势：

• 可视化进度跟踪
• 完整的发布记录
• 快速回滚能力
• 灵活的权限控制
• 定时执行能力

DNS配置管理实践

基于配置中心管理dnsmasq

通过OpenDevOps配置中心管理DNS配置的优势：

1. 图形化配置管理
2. 配置版本对比
3. 一键回滚能力
4. 多环境支持

实现步骤：

1. 在配置中心创建DNS项目
2. 配置权限控制
3. 编写配置同步脚本
4. 创建发布模板

配置同步脚本示例：

class ConfApi:
    def __init__(self):
        self.auth_key = 'your_auth_key'
        self.conf_api = "https://your-domain.com/api/config/"
    
    def get_config(self, project, env, service, file):
        params = {
            'project_code': project,
            'environment': env,
            'service': service,
            'filename': file,
            'auth_key': self.auth_key
        }
        response = requests.get(self.conf_api, params=params)
        return response.json()['data']
    
    def sync_config(self, config_data, target_path):
        with open(target_path, 'w') as f:
            f.write(config_data)
        # 执行reload命令
        subprocess.run(['service', 'dnsmasq', 'reload'])

私有对象存储管理

基于CDN的私有存储访问控制

实现方案：

1. 创建私有读写OSS Bucket
2. 配置CDN私有回源
3. 设置远程鉴权
4. 通过网关进行访问控制

上传接口使用：

# 上传文件到私有存储
files = {'file': ('filename', open('local_file', 'rb'))}
headers = {'file-dir': 'custom_dir'}
response = requests.post(
    '/api/storage/file/private/',
    files=files,
    headers=headers
)

访问控制流程：

1. 用户请求CDN资源
2. CDN向网关发起鉴权请求
3. 网关验证JWT Token
4. 返回鉴权结果
5. CDN根据结果允许或拒绝访问

总结

本文详细介绍了OpenDevOps平台在各种场景下的最佳实践，包括：

1. 基础任务提交方式
2. API集成方案
3. Git自动化发布流程
4. DNS配置集中管理
5. 私有存储访问控制

通过这些实践案例，用户可以充分发挥OpenDevOps平台的自动化能力，提升运维效率和管理规范性。每个方案都可根据实际需求进行调整和扩展，满足不同场景下的自动化运维需求。