后台增加自动部署更新功能
This commit is contained in:
+82
-1
@@ -1,7 +1,12 @@
|
||||
from django.contrib import admin
|
||||
from django.db import models
|
||||
from django.shortcuts import redirect, render
|
||||
from django.urls import path, reverse
|
||||
from django.utils.html import format_html
|
||||
from django.contrib import messages
|
||||
from ckeditor_uploader.widgets import CKEditorUploadingWidget
|
||||
from .models import SiteSettings, Banner
|
||||
from .models import SiteSettings, Banner, DeployLog
|
||||
from .deploy import start_deploy
|
||||
|
||||
|
||||
@admin.register(SiteSettings)
|
||||
@@ -64,3 +69,79 @@ class BannerAdmin(admin.ModelAdmin):
|
||||
'fields': ('link_url', 'sort_order', 'is_active')
|
||||
}),
|
||||
)
|
||||
|
||||
|
||||
@admin.register(DeployLog)
|
||||
class DeployLogAdmin(admin.ModelAdmin):
|
||||
list_display = ('started_at', 'status', 'triggered_by', 'duration', 'view_output_link')
|
||||
list_filter = ('status',)
|
||||
readonly_fields = ('id', 'triggered_by', 'started_at', 'finished_at', 'status', 'output')
|
||||
ordering = ('-started_at',)
|
||||
list_per_page = 20
|
||||
|
||||
def has_add_permission(self, request):
|
||||
return False
|
||||
|
||||
def has_change_permission(self, request, obj=None):
|
||||
return False
|
||||
|
||||
def has_delete_permission(self, request, obj=None):
|
||||
return request.user.is_superuser
|
||||
|
||||
def view_output_link(self, obj):
|
||||
if not obj.id:
|
||||
return '-'
|
||||
url = reverse('admin:core_deploylog_detail', args=[obj.id])
|
||||
return format_html('<a href="{}" target="_blank">查看日志</a>', url)
|
||||
view_output_link.short_description = '输出日志'
|
||||
|
||||
def get_urls(self):
|
||||
urls = super().get_urls()
|
||||
custom_urls = [
|
||||
path(
|
||||
'deploy/',
|
||||
self.admin_site.admin_view(self.deploy_view),
|
||||
name='core_deploy_trigger',
|
||||
),
|
||||
path(
|
||||
'<path:log_id>/detail/',
|
||||
self.admin_site.admin_view(self.detail_view),
|
||||
name='core_deploylog_detail',
|
||||
),
|
||||
]
|
||||
return custom_urls + urls
|
||||
|
||||
def deploy_view(self, request):
|
||||
"""触发一次部署。"""
|
||||
# 防止并发部署:检查是否有正在执行的任务
|
||||
if DeployLog.objects.filter(status='running').exists():
|
||||
messages.error(request, '已有部署任务正在执行,请等待其完成后再试。')
|
||||
return redirect('admin:core_deploylog_changelist')
|
||||
|
||||
log = start_deploy(user=request.user)
|
||||
messages.success(request, f'部署已启动(日志 ID: {str(log.id)[:8]}),请刷新页面查看进度。')
|
||||
return redirect('admin:core_deploylog_detail', log_id=str(log.id))
|
||||
|
||||
def detail_view(self, request, log_id):
|
||||
"""展示单条部署日志的实时输出。"""
|
||||
try:
|
||||
log = DeployLog.objects.get(id=log_id)
|
||||
except (DeployLog.DoesNotExist, ValueError):
|
||||
messages.error(request, '部署日志不存在。')
|
||||
return redirect('admin:core_deploylog_changelist')
|
||||
|
||||
context = {
|
||||
**self.admin_site.each_context(request),
|
||||
'opts': self.model._meta,
|
||||
'log': log,
|
||||
'title': f'部署日志 - {log.started_at:%Y-%m-%d %H:%M:%S}',
|
||||
'is_running': log.status == 'running',
|
||||
}
|
||||
return render(request, 'admin/core/deploylog/detail.html', context)
|
||||
|
||||
def changelist_view(self, request, extra_context=None):
|
||||
"""在列表页顶部插入"一键部署"按钮。"""
|
||||
extra_context = extra_context or {}
|
||||
extra_context['deploy_url'] = reverse('admin:core_deploy_trigger')
|
||||
extra_context['has_running'] = DeployLog.objects.filter(status='running').exists()
|
||||
return super().changelist_view(request, extra_context)
|
||||
|
||||
@@ -0,0 +1,167 @@
|
||||
"""在线部署模块:从 Git 拉取最新代码并完成更新。
|
||||
|
||||
执行流程:
|
||||
1. git pull origin <branch>
|
||||
2. pip install -r requirements.txt
|
||||
3. python manage.py migrate
|
||||
4. python manage.py collectstatic --noinput
|
||||
5. sudo supervisorctl restart tgoim(可选,需配置 sudoers)
|
||||
|
||||
为避免 supervisor 重启时中断当前请求,部署在后台线程中执行,
|
||||
用户可在后台管理界面查看实时日志。
|
||||
"""
|
||||
import os
|
||||
import sys
|
||||
import subprocess
|
||||
import threading
|
||||
from pathlib import Path
|
||||
from django.conf import settings
|
||||
from django.utils import timezone
|
||||
|
||||
BASE_DIR = settings.BASE_DIR
|
||||
|
||||
# 单步命令超时(秒)
|
||||
STEP_TIMEOUT = 180
|
||||
# 拉取的远程分支,可通过 settings.GIT_DEPLOY_BRANCH 覆盖
|
||||
GIT_BRANCH = getattr(settings, 'GIT_DEPLOY_BRANCH', 'main')
|
||||
# Supervisor 服务名,可通过 settings.SUPERVISOR_SERVICE_NAME 覆盖
|
||||
SUPERVISOR_SERVICE = getattr(settings, 'SUPERVISOR_SERVICE_NAME', 'tgoim')
|
||||
|
||||
|
||||
def _venv_python():
|
||||
"""返回虚拟环境中的 python 可执行文件路径。"""
|
||||
if os.name == 'nt':
|
||||
candidate = BASE_DIR / 'venv' / 'Scripts' / 'python.exe'
|
||||
else:
|
||||
candidate = BASE_DIR / 'venv' / 'bin' / 'python'
|
||||
if candidate.exists():
|
||||
return str(candidate)
|
||||
return sys.executable
|
||||
|
||||
|
||||
def _venv_pip():
|
||||
"""返回虚拟环境中的 pip 可执行文件路径。"""
|
||||
if os.name == 'nt':
|
||||
candidate = BASE_DIR / 'venv' / 'Scripts' / 'pip.exe'
|
||||
else:
|
||||
candidate = BASE_DIR / 'venv' / 'bin' / 'pip'
|
||||
if candidate.exists():
|
||||
return str(candidate)
|
||||
return [sys.executable, '-m', 'pip']
|
||||
|
||||
|
||||
def _run_step(log_lines, cmd, timeout=STEP_TIMEOUT):
|
||||
"""执行一条命令,将输出追加到 log_lines,返回是否成功。"""
|
||||
if isinstance(cmd, str):
|
||||
display = cmd
|
||||
args = cmd.split()
|
||||
else:
|
||||
display = ' '.join(str(c) for c in cmd)
|
||||
args = [str(c) for c in cmd]
|
||||
|
||||
log_lines.append(f'\n$ {display}')
|
||||
try:
|
||||
result = subprocess.run(
|
||||
args, cwd=str(BASE_DIR),
|
||||
capture_output=True, text=True, timeout=timeout,
|
||||
)
|
||||
if result.stdout:
|
||||
log_lines.append(result.stdout.rstrip())
|
||||
if result.stderr:
|
||||
log_lines.append(result.stderr.rstrip())
|
||||
if result.returncode != 0:
|
||||
log_lines.append(f'命令失败,退出码: {result.returncode}')
|
||||
return False
|
||||
return True
|
||||
except subprocess.TimeoutExpired:
|
||||
log_lines.append(f'命令超时({timeout}s)')
|
||||
return False
|
||||
except FileNotFoundError as e:
|
||||
log_lines.append(f'命令未找到: {e}')
|
||||
return False
|
||||
except Exception as e:
|
||||
log_lines.append(f'执行异常: {e}')
|
||||
return False
|
||||
|
||||
|
||||
def _run_deploy(log_id):
|
||||
"""后台线程执行部署流程。"""
|
||||
from .models import DeployLog
|
||||
|
||||
log = DeployLog.objects.get(id=log_id)
|
||||
log_lines = []
|
||||
venv_python = _venv_python()
|
||||
venv_pip = _venv_pip()
|
||||
pip_cmd = venv_pip if isinstance(venv_pip, list) else [venv_pip]
|
||||
|
||||
try:
|
||||
log_lines.append(f'开始部署,分支: {GIT_BRANCH}')
|
||||
log_lines.append(f'工作目录: {BASE_DIR}')
|
||||
log_lines.append(f'Python: {venv_python}')
|
||||
log.output = '\n'.join(log_lines)
|
||||
log.save()
|
||||
|
||||
# 1. 拉取代码
|
||||
log_lines.append('\n========== [1/5] 拉取最新代码 ==========')
|
||||
log.output = '\n'.join(log_lines)
|
||||
log.save()
|
||||
if not _run_step(log_lines, ['git', 'pull', 'origin', GIT_BRANCH]):
|
||||
raise RuntimeError('git pull 失败')
|
||||
|
||||
# 2. 安装依赖
|
||||
log_lines.append('\n========== [2/5] 安装 Python 依赖 ==========')
|
||||
log.output = '\n'.join(log_lines)
|
||||
log.save()
|
||||
if not _run_step(log_lines, pip_cmd + ['install', '-r', 'requirements.txt']):
|
||||
raise RuntimeError('pip install 失败')
|
||||
|
||||
# 3. 数据库迁移
|
||||
log_lines.append('\n========== [3/5] 执行数据库迁移 ==========')
|
||||
log.output = '\n'.join(log_lines)
|
||||
log.save()
|
||||
if not _run_step(log_lines, [venv_python, 'manage.py', 'migrate']):
|
||||
raise RuntimeError('migrate 失败')
|
||||
|
||||
# 4. 收集静态文件
|
||||
log_lines.append('\n========== [4/5] 收集静态文件 ==========')
|
||||
log.output = '\n'.join(log_lines)
|
||||
log.save()
|
||||
if not _run_step(log_lines, [venv_python, 'manage.py', 'collectstatic', '--noinput']):
|
||||
raise RuntimeError('collectstatic 失败')
|
||||
|
||||
# 5. 重启服务
|
||||
log_lines.append('\n========== [5/5] 重启应用服务 ==========')
|
||||
# 先把成功状态写入数据库,因为 supervisorctl restart 可能会终止当前进程
|
||||
log.status = 'success'
|
||||
log_lines.append(f'代码更新成功,正在重启服务 {SUPERVISOR_SERVICE} ...')
|
||||
log.output = '\n'.join(log_lines)
|
||||
log.finished_at = timezone.now()
|
||||
log.save()
|
||||
|
||||
restart_ok = _run_step(log_lines, ['sudo', '-n', 'supervisorctl', 'restart', SUPERVISOR_SERVICE])
|
||||
if not restart_ok:
|
||||
log_lines.append(
|
||||
f'提示: 自动重启失败。请在服务器手动执行: '
|
||||
f'sudo supervisorctl restart {SUPERVISOR_SERVICE}'
|
||||
)
|
||||
# 状态仍记为 success,因为代码已更新成功,仅重启未生效
|
||||
log_lines.append('\n部署流程结束。')
|
||||
log.output = '\n'.join(log_lines)
|
||||
log.save()
|
||||
|
||||
except Exception as e:
|
||||
log.status = 'failed'
|
||||
log_lines.append(f'\n部署失败: {e}')
|
||||
log.output = '\n'.join(log_lines)
|
||||
log.finished_at = timezone.now()
|
||||
log.save()
|
||||
|
||||
|
||||
def start_deploy(user=None):
|
||||
"""启动一次部署(后台线程执行),返回 DeployLog 对象。"""
|
||||
from .models import DeployLog
|
||||
|
||||
log = DeployLog.objects.create(triggered_by=user, status='running')
|
||||
thread = threading.Thread(target=_run_deploy, args=(str(log.id),), daemon=True)
|
||||
thread.start()
|
||||
return log
|
||||
@@ -0,0 +1,32 @@
|
||||
# Generated manually for DeployLog model
|
||||
|
||||
import uuid
|
||||
from django.conf import settings
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
('auth', '0012_alter_user_first_name_max_length'),
|
||||
('core', '0002_sitesettings_about_content_en_and_more'),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.CreateModel(
|
||||
name='DeployLog',
|
||||
fields=[
|
||||
('id', models.UUIDField(default=uuid.uuid4, editable=False, primary_key=True, serialize=False)),
|
||||
('started_at', models.DateTimeField(auto_now_add=True, verbose_name='开始时间')),
|
||||
('finished_at', models.DateTimeField(blank=True, null=True, verbose_name='结束时间')),
|
||||
('status', models.CharField(choices=[('running', '执行中'), ('success', '成功'), ('failed', '失败')], default='running', max_length=20, verbose_name='状态')),
|
||||
('output', models.TextField(blank=True, default='', verbose_name='输出日志')),
|
||||
('triggered_by', models.ForeignKey(null=True, on_delete=models.SET_NULL, related_name='deploy_logs', to=settings.AUTH_USER_MODEL, verbose_name='触发者')),
|
||||
],
|
||||
options={
|
||||
'verbose_name': '部署日志',
|
||||
'verbose_name_plural': '部署日志',
|
||||
'ordering': ['-started_at'],
|
||||
},
|
||||
),
|
||||
]
|
||||
@@ -1,3 +1,4 @@
|
||||
import uuid
|
||||
from django.db import models
|
||||
|
||||
|
||||
@@ -63,3 +64,36 @@ class Banner(models.Model):
|
||||
|
||||
def __str__(self):
|
||||
return self.title_zh or f'Banner #{self.id}'
|
||||
|
||||
|
||||
class DeployLog(models.Model):
|
||||
STATUS_CHOICES = [
|
||||
('running', '执行中'),
|
||||
('success', '成功'),
|
||||
('failed', '失败'),
|
||||
]
|
||||
|
||||
id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
|
||||
triggered_by = models.ForeignKey(
|
||||
'auth.User', on_delete=models.SET_NULL, null=True,
|
||||
verbose_name='触发者', related_name='deploy_logs'
|
||||
)
|
||||
started_at = models.DateTimeField('开始时间', auto_now_add=True)
|
||||
finished_at = models.DateTimeField('结束时间', null=True, blank=True)
|
||||
status = models.CharField('状态', max_length=20, choices=STATUS_CHOICES, default='running')
|
||||
output = models.TextField('输出日志', blank=True, default='')
|
||||
|
||||
class Meta:
|
||||
ordering = ['-started_at']
|
||||
verbose_name = '部署日志'
|
||||
verbose_name_plural = verbose_name
|
||||
|
||||
def __str__(self):
|
||||
return f'{self.started_at:%Y-%m-%d %H:%M:%S} - {self.get_status_display()}'
|
||||
|
||||
@property
|
||||
def duration(self):
|
||||
if self.finished_at:
|
||||
delta = self.finished_at - self.started_at
|
||||
return f'{delta.total_seconds():.1f}s'
|
||||
return '-'
|
||||
|
||||
Reference in New Issue
Block a user