OS install documentation - #123
Conversation
WalkthroughThe changes introduce new documentation and update existing scripts in the repository. A new runbook has been added detailing a procedure to reinstall a Docker host by deploying a new VM with a fresh OS and then reassigning the system disk to the old VM. Additionally, two new markdown files provide introductory guides for running Haiku OS and macOS VMs on Proxmox, including resource links. The shell scripts for creating OpenWRT and Ubuntu Server VMs on Proxmox are updated to reference newer OS versions. No changes to code logic or exported entities were made, except for version constant updates. Changes
Sequence Diagram(s)sequenceDiagram
participant Admin
participant ProxmoxVE as PVE Host
participant OldVM as OLD (Old Docker Host)
participant NewVM as NEW (New VM with fresh OS)
Admin->>ProxmoxVE: Deploy new VM (NEW) with fresh OS
Admin->>NewVM: Apply Ansible configuration
Admin->>NewVM: (Optional) Transfer container images and server host key
Admin->>NewVM: Create and mount storage directory
Admin->>NewVM: Shutdown NEW VM
Admin->>ProxmoxVE: Reassign disk ownership from NEW to OLD
Admin->>ProxmoxVE: Adjust boot order to prioritize new disk
Admin->>OldVM: Start OLD VM with new system disk
Admin->>OldVM: Create symlink to repositories
Admin->>OldVM: Start Docker services
Admin->>ProxmoxVE: Delete NEW VM after verification
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
proxmox/macos.md (1)
5-5: Convert bare URL to markdown link. Wrap the repository URL in link syntax for better readability:- https://github.com/luchina-gabriel/OSX-PROXMOX + [OSX-PROXMOX GitHub Repository](https://github.com/luchina-gabriel/OSX-PROXMOX)proxmox/haiku-os.md (3)
3-3: Refine adjective usage. Consider removing or replacing "very" to strengthen the description (e.g., use "powerful" or "extremely powerful").🧰 Tools
🪛 LanguageTool
[style] ~3-~3: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...t, simple to use, easy to learn and yet very powerful. Download: https://www.haiku-os.org/ge...(EN_WEAK_ADJECTIVE)
5-5: Convert bare URL to markdown link. Use link syntax for consistency:- Download: https://www.haiku-os.org/get-haiku/r1beta5/release-notes/ + Download: [Haiku R1 Beta 5 Release Notes](https://www.haiku-os.org/get-haiku/r1beta5/release-notes/)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
5-5: Bare URL used
null(MD034, no-bare-urls)
7-7: Convert bare URL to markdown link. Use link syntax for consistency:- Use with Proxmox: https://www.haiku-os.org/guides/virtualizing/proxmox/ + Use with Proxmox: [Haiku Proxmox Virtualization Guide](https://www.haiku-os.org/guides/virtualizing/proxmox/)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
7-7: Bare URL used
null(MD034, no-bare-urls)
docs/runbooks.md (1)
33-33: Add missing comma for clarity. Insert a comma after "After verification":- - PVE: After verification delete the temporary VM + - PVE: After verification, delete the temporary VM🧰 Tools
🪛 LanguageTool
[uncategorized] ~33-~33: A comma might be missing here.
Context: ...usingtask docker:apply- PVE: After verification delete the temporary VM(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
docs/runbooks.md(1 hunks)proxmox/create-openwrt-vm.sh(1 hunks)proxmox/create-ubuntu-server-vm.sh(1 hunks)proxmox/haiku-os.md(1 hunks)proxmox/macos.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
proxmox/haiku-os.md
[style] ~3-~3: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...t, simple to use, easy to learn and yet very powerful. Download: https://www.haiku-os.org/ge...
(EN_WEAK_ADJECTIVE)
docs/runbooks.md
[uncategorized] ~33-~33: A comma might be missing here.
Context: ...using task docker:apply - PVE: After verification delete the temporary VM
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
🪛 markdownlint-cli2 (0.17.2)
proxmox/haiku-os.md
5-5: Bare URL used
null
(MD034, no-bare-urls)
7-7: Bare URL used
null
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: check
- GitHub Check: build
🔇 Additional comments (9)
proxmox/create-openwrt-vm.sh (1)
6-6:Details
❓ Verification inconclusive
Confirm OpenWRT version bump. The
OPENWRT_VERSIONhas been updated to24.10.1. Ensure this version exists and the download URL is valid.You can verify with:
🏁 Script executed:
#!/bin/bash curl -I https://downloads.openwrt.org/releases/${OPENWRT_VERSION}/targets/x86/64/openwrt-${OPENWRT_VERSION}-x86-64-generic-ext4-combined.img.gzLength of output: 831
Confirm OpenWRT version bump
I attempted to verify the download URL for
24.10.1but received a 404. Please ensure this version is published and the URL is valid before merging.• Test with:
curl -I https://downloads.openwrt.org/releases/24.10.1/targets/x86/64/openwrt-24.10.1-x86-64-generic-ext4-combined.img.gzproxmox/create-ubuntu-server-vm.sh (1)
6-8:Details
✅ Verification successful
Confirm Ubuntu LTS version bump. Updated
UBUNTU_VERSIONto"24.04.2"and clarified the comment to reference the LTS releases site. Verify that the ISO exists and the download URL is correct.
🏁 Script executed:
#!/bin/bash curl -I https://releases.ubuntu.com/${UBUNTU_VERSION}/${INSTALL_ISO}Length of output: 561
Let’s verify the actual ISO URL directly:
🏁 Script executed:
#!/bin/bash curl -I https://releases.ubuntu.com/24.04.2/ubuntu-24.04.2-live-server-amd64.isoLength of output: 657
Ubuntu 24.04.2 ISO URL Validated
The URL
https://releases.ubuntu.com/24.04.2/ubuntu-24.04.2-live-server-amd64.isoreturns HTTP 200 OK, confirming the ISO exists and the download path is correct.proxmox/macos.md (3)
1-2: Header is clear. No changes required.
3-3: Section heading is descriptive. No changes required.
7-7: Introductory text is clear. No changes required.proxmox/haiku-os.md (2)
1-2: Header is clear. No changes needed.
9-14: List items appear accurate. No changes required.docs/runbooks.md (2)
1-32: General structure is sound. No specific remarks for these lines.
34-34: Final step is clear. No changes required.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
proxmox/haiku-os.md (3)
3-3: Remove redundant intensifier “very”.Consider removing the word “very” to improve conciseness:
- easy to learn and yet very powerful. + easy to learn and yet powerful.🧰 Tools
🪛 LanguageTool
[style] ~3-~3: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...t, simple to use, easy to learn and yet very powerful. - [Download R1 version](https://www.h...(EN_WEAK_ADJECTIVE)
5-6: Enhance link text for clarity.The text “[Download R1 version]” may be ambiguous; consider specifying the exact release:
- [Download R1 version](https://www.haiku-os.org/get-haiku/r1beta5/release-notes/) + [Download Haiku R1 Beta 5 release notes](https://www.haiku-os.org/get-haiku/r1beta5/release-notes/)
13-13: Ensure file ends with a newline.Add a trailing newline to comply with POSIX file standards and improve diffs.
proxmox/macos.md (3)
3-3: Normalize emphasis on “any”.Avoid using all-caps for “ANY” in the subheading to improve readability and tone:
- ## OSX-PROXMOX - Run macOS on ANY Computer - AMD & Intel + ## OSX-PROXMOX – Run macOS on any computer (AMD & Intel)
5-5: Convert bare URL to a markdown link.Use descriptive link text instead of a bare URL to improve accessibility and style:
- https://github.com/luchina-gabriel/OSX-PROXMOX + [OSX-PROXMOX GitHub repository](https://github.com/luchina-gabriel/OSX-PROXMOX)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
5-5: Bare URL used
null(MD034, no-bare-urls)
8-8: Ensure file ends with a newline.Add a trailing newline so tools and editors handle the file correctly.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/runbooks.md(1 hunks)proxmox/haiku-os.md(1 hunks)proxmox/macos.md(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/runbooks.md
🧰 Additional context used
🪛 LanguageTool
proxmox/haiku-os.md
[style] ~3-~3: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...t, simple to use, easy to learn and yet very powerful. - [Download R1 version](https://www.h...
(EN_WEAK_ADJECTIVE)
🪛 markdownlint-cli2 (0.17.2)
proxmox/macos.md
5-5: Bare URL used
null
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: build
- GitHub Check: check
Summary by CodeRabbit