From df008d8cf4c837e077a50907a223a99fec76b4cd Mon Sep 17 00:00:00 2001 From: Takehana Date: Sat, 7 Oct 2023 19:27:23 +0800 Subject: [PATCH] feat: mirrors sysadmin docs --- docs/mirrors-sysadmin/common-workflows.md | 39 +++++++++++++++++++++++ docs/mirrors-sysadmin/mirrors-notes.md | 25 +++++++++++++++ mkdocs.yml | 4 ++- 3 files changed, 67 insertions(+), 1 deletion(-) create mode 100644 docs/mirrors-sysadmin/common-workflows.md create mode 100644 docs/mirrors-sysadmin/mirrors-notes.md diff --git a/docs/mirrors-sysadmin/common-workflows.md b/docs/mirrors-sysadmin/common-workflows.md new file mode 100644 index 0000000..b1a1c9e --- /dev/null +++ b/docs/mirrors-sysadmin/common-workflows.md @@ -0,0 +1,39 @@ +# 常见工作流程 + +## 排查同步问题 + +1. 发现有镜像同步状态为 failed +2. 进入镜像站，使用 `tail -30 tail -30 /var/tunasync/log//latest` 查看日志。其中 `` 为欲查看的镜像名 +3. 通过日志定位到问题，并尝试解决 +4. 使用 `tunasynctl` 重新同步对应的镜像，命令形如 `tunasynctl restart --worker main_worker `。其中 `` 为欲重新同步的镜像名 +5. 再次查看日志确认问题已解决 + +## 下架镜像 + +1. 在 `/etc/tunasync/worker.conf` 中删除对应的条目 +2. 使用 `tunasynctl` 重载配置文件，命令形如 `tunasynctl reload --config /etc/tunasync/worker.conf --worker main_worker` +3. 使用 `tunasynctl` 关闭对应的镜像同步，命令形如 `tunasynctl disable --worker main_worker `。其中 `` 为欲下架的镜像名 +4. 使用 `tunasynctl` 冲刷对应的镜像，命令形如 `tunasynctl flush` + +## 添加新闻 + +1. 确保能科学上网 +2. 进入 `hitszosa/mirrors-frontend` 仓库 +3. 确保 `main` 分支为最新 +4. 切换到 `prod` 分支 +5. 执行 `git rebase main`，可能需要自己处理冲突 +6. 在 `content/news` 目录下编写新闻，格式请参考该目录下的其他文件 +7. 执行 `yarn install` +8. 执行 `yarn generate`，生成后的网站位于 `.output/public/` +9. 使用 `rsync` 将网站部署到服务器，命令形如 `rsync -r ./.output/public/* @10.249.8.102:/var/www/public`。其中 `` 为您在服务器中的用户名 +10. 最后，确保网站正常后将修改推送到 GitHub。由于潜在的 rebase 操作，所有可能需要使用 `git push --force`。 + +## 更新镜像站帮助网站 + +1. 确保能科学上网 +2. 进入 `hitszosa/mirrorz-help` 仓库 +3. 打开 `reference/src/routes.json` 并找到想要添加到条目 +4. 将上一步找到的条目复制并粘贴到 `override/mirrorz-help/src/routes.json` 中的相应位置，最好按字典序放置，注意 JSON 格式规范（如列表末尾不能有多余的空格） +5. 执行 `make prod` +6. 使用 `rsync` 搬迁生成后的网站，生成后的网站位于 `mirrorz-help/out/`。形如：`rsync -r /path/to/osa-mirrorz-help/mirrorz-help/out/* yourname@10.249.8.102:/var/www/help` +7. 最后，确保网站正常后将修改推送到 GitHub \ No newline at end of file diff --git a/docs/mirrors-sysadmin/mirrors-notes.md b/docs/mirrors-sysadmin/mirrors-notes.md new file mode 100644 index 0000000..45ccf04 --- /dev/null +++ b/docs/mirrors-sysadmin/mirrors-notes.md @@ -0,0 +1,25 @@ +# 镜像站记载 + +## 目录清单 + +- `/usr/bin/tunasync*`：tunasync 本尊和 tunasynctl +- `/etc/tunasync/*`：工人和经理配置 +- `/var/tunasync/log/`：日志，failed 时可 debug +- `/var/tunasync/util/`：杂项工具 + - `gen_res_link`：按照 `gen_res_link.ini` 生成资源下载清单到 `/var/www/public/static/` + - `backup`：备份镜像站相关内容到 `/backups/backup-*.tar.gz` +- `/var/tunasync/script/`：自定义的同步脚本 +- `/etc/systemd/system/tunasync-*.service`：tunasync 需要的 systemd unit +- `/var/www/public/`：镜像站前端静态网站放置处 +- `/var/www/help/`：私有化 Mirrorz Help 静态网站放置处 +- `/etc/nginx/conf.d/mirrors.conf`：镜像站 Nginx 配置 +- `/etc/nginx/conf.d/mirrors-help.conf`：私有化 Mirrorz Help Nginx 配置 + +## 其他清单 + +- 工人名字是 main_worker +- tunasync 通信位于 localhost:14242 + +## imbuhui，怎么办 + +请 Google 搜索 tunasync 等获取特定的文档和教程。 diff --git a/mkdocs.yml b/mkdocs.yml index 72577ef..a101349 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -86,7 +86,9 @@ nav: - PyTorch on SLURM: hpc-doc/pytorch.md - 非官方实验环境指南: - 计算机组成原理lab1: unofficial-lab-env/comp-organ-lab1.md - + - 镜像站运维: + - 镜像站记载: mirrors-sysadmin/mirrors-notes.md + - 常见工作流程: mirrors-sysadmin/common-workflows.md plugins: - search: