SuperAPI AI 工具集

deployment-documentation

部署与运维

查看项目

更新于 10-15 11:51

技能介绍

用途

该技能用于创建全面的部署文档,覆盖基础设施搭建、CI/CD 流水线、部署流程与回滚策略。适用于编写部署指南、基础设施文档、CI/CD 流水线配置说明、配置管理文档、容器编排说明、云基础设施文档、发布流程和回滚流程。

主要能力

文档内容围绕以下方面展开:

  • 部署方式说明:手动部署(仅限应急)、自动化 CI/CD(首选)、蓝绿部署、金丝雀部署。
  • 环境说明:开发、预发布、生产三类环境及其示例地址。
  • 前置条件:所需工具。
  • 参考指南:GitHub Actions 工作流、Dockerfile、docker-compose.yml、部署清单。
  • 最佳实践清单:应做与不应做事项。

使用方式

文档提供一个最小工作示例,结构如下:

# Deployment Guide

## Overview

This document describes the deployment process for [Application Name].

**Deployment Methods:**

- Manual deployment (emergency only)
- Automated CI/CD (preferred)
- Blue-green deployment
- Canary deployment

**Environments:**

- Development: https://dev.example.com
- Staging: https://staging.example.com
- Production: https://example.com

---

## Prerequisites

### Required Tools

// ... (see reference guides for full implementation)

参考指南位于 references/ 目录,包含:

指南 内容
GitHub Actions Workflow GitHub Actions Workflow
Dockerfile Dockerfile
docker-compose.yml docker-compose.yml
Deployment Manifest Deployment Manifest

适用场景

  • 需要为应用编写部署指南时。
  • 需要记录基础设施搭建过程时。
  • 需要说明 CI/CD 流水线配置时。
  • 需要编写配置管理、容器编排或云基础设施文档时。
  • 需要制定发布流程与回滚流程时。

最佳实践

应做:

  • 使用基础设施即代码
  • 实施 CI/CD 流水线
  • 使用容器编排
  • 实施健康检查
  • 使用滚动部署
  • 准备回滚方案
  • 监控部署
  • 记录应急流程
  • 使用密钥管理
  • 实施蓝绿或金丝雀部署

不应做:

  • 直接部署到生产
  • 跳过部署前测试
  • 迁移前忘记备份
  • 没有回滚计划就部署
  • 部署后跳过监控
  • 硬编码凭据
  • 在高峰时段部署(除非必要)

限制

资料未提供具体实现代码细节,参考指南的完整实现需查看对应文件。资料未说明收费、价格、平台支持范围或实际效果。