Skip to content

fix(docs): スナップショット対象を /work から /home/ubuntu 共通ボリュームに修正#8

Open
takemi-ohama wants to merge 1 commit intomainfrom
fix-snapshot-target-docs
Open

fix(docs): スナップショット対象を /work から /home/ubuntu 共通ボリュームに修正#8
takemi-ohama wants to merge 1 commit intomainfrom
fix-snapshot-target-docs

Conversation

@takemi-ohama
Copy link
Copy Markdown
Contributor

Pull Request

概要

実装と異なり、ドキュメントが「snapshot 対象 = `/work` ボリューム」と記載していたため整合性を失っていた問題の修正。実装は `devbase_home_ubuntu` ボリューム(`/home/ubuntu` にマウント)を対象にしており、これが正しい仕様。

PR #6 で README と snapshot-guide.md を「`/work`」に修正したのは私の誤り(元の「ホームボリューム」が正しかった)。今回正しい記述に統一する。

関連 Issue

変更点

`README.md` L16

  • スナップショット管理の機能説明:
    • 修正前: 「`/work` ボリュームの増分バックアップ・復元・世代管理」
    • 修正後: 「`/home/ubuntu` 共通ボリュームの増分バックアップ・復元・世代管理」

`docs/user/snapshot-guide.md`

  • L3 冒頭説明: 「`/work` ボリュームを増分バックアップ」→ 「`/home/ubuntu` 共通ボリューム (`devbase_home_ubuntu`) を増分バックアップ」+ `/work` 配下はバックアップ対象外である旨を追記
  • L23 フルバックアップ対象: `/work` → `/home/ubuntu` 共通ボリューム
  • L203 復元前自動バックアップ対象: `/work` → `/home/ubuntu` 共通ボリューム

`docs/user/troubleshooting.md`

  • L376 高速化ヒント説明: `/work` ボリューム → `/home/ubuntu` 共通ボリューム
  • L379 削除推奨ファイルの場所: `/work` から削除 → `/home/ubuntu` から削除

実装根拠

`lib/devbase/snapshot/manager.py`:
```python
VOLUME_NAME = 'devbase_home_ubuntu' # /home/ubuntu にマウントされる共通ボリューム
```

`SnapshotManager` はこのボリュームを対象に `docker run` で snapshot コンテナを立ててバックアップを行う。`/work` ボリュームには触らない。

ユーザ視点での意味

`/home/ubuntu` は以下を保存する場所であり、これらを保護することがスナップショットの目的:

  • 個人設定(`.bashrc`, `.vimrc`, シェル履歴)
  • SSH 鍵
  • AI CLI 認証キャッシュ
  • VS Code 拡張機能(`.vscode-server/`)

一方、プロジェクト作業ファイル(`/work` 配下)は Git で管理する前提であり、スナップショット対象外。

やらないこと

  • `docs/user/troubleshooting.md` L146 の「重要なデータは必ず `/work` に配置してください」は別観点(コンテナ FS との対比)なので今回は触らない
  • `docs/user/container-operations.md` L118 の `/work` ボリューム説明は snapshot とは無関係なので変更不要

動作確認

  • `grep -rn "/work.*ボリューム" docs/ README.md` で snapshot 文脈の `/work` 表記が残っていない
  • snapshot-guide.md の説明が `lib/devbase/snapshot/manager.py:17` の `VOLUME_NAME` 定義と一致
  • CI が green である

実装 (lib/devbase/snapshot/manager.py:17 VOLUME_NAME = 'devbase_home_ubuntu')
と異なり、ドキュメントが「/work ボリュームを増分バックアップ」と記載
していたため整合性を失っていた。

PR #6 で README と snapshot-guide.md を「/work」に修正したのは誤り
(元の「ホームボリューム」が正しかった)。今回正しい記述に統一する。

修正:
- README.md L16: スナップショット対象の表記
- docs/user/snapshot-guide.md L3, L23, L203: 同上 +
  「/work 配下はバックアップ対象外」の注記を追加
- docs/user/troubleshooting.md L376, L379: 高速化のヒントの対象パス

参考: スナップショット対象の実装

  lib/devbase/snapshot/manager.py:
    VOLUME_NAME = 'devbase_home_ubuntu'  # /home/ubuntu にマウントされる共通ボリューム

ユーザ視点では /home/ubuntu が個人設定 / シェル履歴 / SSH 鍵 /
AI CLI キャッシュ / VS Code 拡張機能の保存先で、スナップショットは
これらを保護する目的。プロジェクト作業ファイル (/work 配下) は
Git で管理する前提。

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant