GoMe

Tiếng Nhật IT · リリース作業手順書

Tài liệu quy trình release (kèm phương án rollback)

Nội dung mẫu tiếng Nhật

【リリース作業手順書】〔システム名〕ver〔〇.〇〕本番リリース

■作業概要
・作業日時：〔〇月〇日（〇） 22:00～24:00〕
・対象環境：本番環境
・作業内容：〔例：アプリケーションのデプロイ、DBマイグレーション（テーブル追加1件）〕
・サービス停止：〔あり（22:10～23:15予定）／なし〕
・体制：作業責任者 〔氏名〕／作業者 〔氏名〕／確認者 〔氏名〕
・緊急連絡先：〔氏名・電話番号〕

■事前準備（前日まで）
1. 利用者へのメンテナンス告知（〔〇月〇日〕掲載済み）
2. リリース対象（〔タグ名／ビルド番号〕）の確定
3. ステージング環境での切り戻し手順のリハーサル

■作業手順
1. 〔22:00〕作業開始を関係者へ連絡
2. 〔22:10〕メンテナンス画面へ切り替え
3. 〔22:15〕DBのバックアップを取得し、取得完了を確認
4. 〔22:30〕新バージョンをデプロイし、DBマイグレーションを実行
5. 〔22:50〕動作確認（ログイン、〔主要機能〕）
6. 〔23:15〕メンテナンス解除、作業完了を関係者へ連絡

■切り戻し判断基準
・〔例：23:30の時点で手順5の動作確認が完了していない場合〕
・〔例：手順5で重大な不具合が見つかり、その場で原因を特定できない場合〕
・判断者：〔作業責任者名〕

■切り戻し手順
1. メンテナンス画面へ切り替え（解除済みの場合）
2. 旧バージョン（〔タグ名〕）を再デプロイ
3. 〔例：手順3で取得したバックアップからDBを復元〕
4. 動作確認後、メンテナンス解除
5. 切り戻しの実施と理由を関係者へ報告

■作業後の監視
リリース後〔24時間〕は、エラーログと監視アラートを重点的に確認する。

以上

Cấu trúc từng phần

Tài liệu này viết và được duyệt TRƯỚC ngày release; đêm release mọi người làm đúng theo từng bước. Văn bản kỹ thuật nên viết thể ngắn, không cần kính ngữ.
Có dừng dịch vụ không, ai là người chịu trách nhiệm (作業責任者), gọi ai khi khẩn cấp: phải rõ trước khi bắt đầu.
Chạy thử cả phần rollback ở môi trường staging. Rollback chưa từng chạy thử thì lúc cần rất dễ hỏng.
Mỗi bước có giờ dự kiến và cách xác nhận đã xong. Bước sao lưu DB (3) luôn đứng trước migration (4).
Quyết trước: đến mốc giờ nào, hoặc gặp tình huống gì thì quay lại bản cũ, và ai là người quyết. Không để tới lúc đang rối mới bàn.
Khôi phục DB từ bản sao lưu chỉ an toàn vì dịch vụ đang dừng nên không có dữ liệu mới. Release không dừng dịch vụ (hoặc đã mở lại cho người dùng) thì phải dùng migration ngược hoặc thiết kế tương thích ngược, không được khôi phục mù làm mất dữ liệu mới.

Bản dịch tiếng Việt

[Tài liệu quy trình release] 〔tên hệ thống〕 ver〔〇.〇〕 lên production ■ Tóm tắt ・Thời gian: 〔ngày 〇/〇 (thứ 〇) 22:00～24:00〕 ・Môi trường: production ・Nội dung: 〔ví dụ: deploy ứng dụng, chạy migration DB (thêm 1 bảng)〕 ・Dừng dịch vụ: 〔có (dự kiến 22:10～23:15) / không〕 ・Nhân sự: người chịu trách nhiệm 〔họ tên〕 / người thao tác 〔họ tên〕 / người kiểm tra 〔họ tên〕 ・Liên lạc khẩn cấp: 〔họ tên, số điện thoại〕 ■ Chuẩn bị trước (chậm nhất ngày hôm trước) 1. Thông báo bảo trì cho người dùng (đã đăng ngày 〔〇/〇〕) 2. Chốt bản sẽ release (〔tên tag / số build〕) 3. Chạy thử quy trình rollback trên môi trường staging ■ Các bước thực hiện 1. 〔22:00〕 Báo các bên liên quan bắt đầu làm 2. 〔22:10〕 Chuyển sang màn hình bảo trì 3. 〔22:15〕 Sao lưu DB, xác nhận sao lưu xong 4. 〔22:30〕 Deploy bản mới, chạy migration DB 5. 〔22:50〕 Kiểm tra hoạt động (đăng nhập, 〔chức năng chính〕) 6. 〔23:15〕 Tắt màn hình bảo trì, báo các bên liên quan đã xong ■ Tiêu chí quyết định rollback ・〔Ví dụ: đến 23:30 vẫn chưa kiểm tra xong bước 5〕 ・〔Ví dụ: bước 5 phát hiện lỗi nghiêm trọng mà không tìm ra nguyên nhân ngay tại chỗ〕 ・Người quyết định: 〔tên người chịu trách nhiệm〕 ■ Các bước rollback 1. Chuyển sang màn hình bảo trì (nếu đã tắt) 2. Deploy lại bản cũ (〔tên tag〕) 3. 〔Ví dụ: khôi phục DB từ bản sao lưu ở bước 3〕 4. Kiểm tra hoạt động rồi tắt màn hình bảo trì 5. Báo các bên liên quan đã rollback và lý do ■ Giám sát sau release Trong 〔24 giờ〕 sau release, tập trung theo dõi log lỗi và cảnh báo giám sát. Hết.

Mẹo soạn thảo & lưu ý

Đêm release, ghi giờ thực tế bên cạnh từng bước; bước nào làm khác tài liệu thì ghi lại lý do. Bản ghi này là nguồn để viết email báo kết quả release cho khách ngày hôm sau.

Nguồn

Biên soạn bởi GoMe