Word SSH key management and the control node as optional in the docs
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 75/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
調査の方向性
Start with the control-node and SSH passages in docs/Blueprint.md (line 3 and section 3.11), docs/design/00-Module-Contract-and-Layout.md (section 5), docs/design/04-Credentials-and-SSH-Keys.md (section 4) and docs/design/07-Backup-and-Recovery.md (section 4), then run grep -rn "control node" docs --include=*.md excluding docs/archive. Done means each hit is worded as optional with a stated local-mode fallback, the backup copy is skipped with a message when no peer is named, and the from= restriction is said to apply only when a control node exists.
索引モデルが issue の本文から書いたものです。
説明
Read first
- docs/design/00-Module-Contract-and-Layout.md, section 5 "Execution model"
- docs/design/04-Credentials-and-SSH-Keys.md, section 4 "SSH key design"
- docs/design/07-Backup-and-Recovery.md, section 4 "When"
- docs/Blueprint.md, sections 3.11 and 6.1
Read these before starting. If this issue and the spec disagree, the spec wins; say so in the pull request.
Summary
Local mode, Labyrinth run on each host by itself, is the standard. Some design text still reads as if a control node and SSH key management are always there: keys restricted to the control node, backups copied to it, scans run from it. Both are useful but optional. Reword these places so they read as options, and say what happens without them.
Depends on
Nothing.
Location & Context
At main 1b0cb6c:
docs/Blueprint.mdline 3: "a rapid, idempotent, multi-OS hardening and deception deployment system".docs/Blueprint.mdsection 3.11 (line 276): off-host copies go "to the control node, or another team host named as the backup peer".docs/design/00-Module-Contract-and-Layout.mdsection 5 (line 208 on): remote mode is "built after local mode", but nothing says it is optional.docs/design/02-Packages-and-Third-Party-Tools.mdsection 6 (line 72): nmap runs "from the control node".docs/design/04-Credentials-and-SSH-Keys.mdsection 4 (lines 102 and 105):from="<control node>"restrictions, and private keys kept on the control node.docs/design/07-Backup-and-Recovery.mdsection 4 (lines 50, 62 and 70): the copy off the host goes to the control node or the backup peer, and is "required".
Current Behavior
A reader takes the control node and SSH key setup as part of every install, so the docs seem to require a central machine that local mode does not need. Where a feature depends on one (an off-host backup copy, a key restricted to a source), the docs do not say what Labyrinth does when there is none.
Plan
- In each place listed, word the control node and SSH key management as optional ("where a control node is used").
- For each feature that relies on them, state the local-mode behavior. For example, the backup copy goes to the backup peer when one is named; otherwise it is skipped and the run says so. The
from=restriction is added only when a control node is configured. - Reword the Blueprint's opening line so it does not call Labyrinth a deployment system.
- Search
docs/(notdocs/archive/) for other "control node" and SSH wording that assumes them, and fix it the same way. - Rebuild the site locally only if needed to check links. Change wording only, and keep the meaning otherwise.
Acceptance tests
grep -rn "control node" docs --include=*.md(outsidedocs/archive/): every hit is either in remote-mode text or worded as optional.- Every feature that names the control node also says what happens without one.
- The site build and CI's link checks pass.
Done when
The design docs read as local mode first. Remote mode and SSH key management are options with a stated fallback, and the pull request lists each place changed.
Out of scope
- Changing code or behavior. This is wording only.
- Designing remote mode itself (milestone "2. Remote mode").
- 主要言語
- PowerShell
- スター
- 0
- フォーク
- 0
- 平均マージ
- 2時間 7分
- マージ済み PR(30日)
- 53
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
似ている issue
-
area: web priority: P1 story
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
nfiasco/Quant-Time-Machine#151 ·
メンテナーはふだん 1 日以内に返信
-
documentation
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
andromarces/agent-loops#1735 ·
メンテナーはふだん 1 日以内に返信
-
docs pydanty:is-working
難易度 1/5 1〜3時間 初心者へのやさしさ 85/100
pydantic/pydantic-ai#12892 ·
メンテナーはふだん 1 日以内に返信
-
needs-triage
難易度 1/5 1〜3時間 初心者へのやさしさ 72/100
Azure/azure-sdk-for-python#49886 · コメント 1 件 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
:watch: Not Triaged dotnet/svc
難易度 1/5 1時間未満 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信