fix(vcluster): add minio docs for snapshot creation by guowenatk · Pull Request #1665 · loft-sh/vcluster-docs

guowenatk · 2026-02-05T11:12:07Z

Content Description

Add S3-compatible provider documentation for vCluster snapshots, including custom endpoint and path-style addressing parameters.

Preview Link

https://deploy-preview-1665--vcluster-docs-site.netlify.app/docs/vcluster/next/manage/backup-restore/backup?x0=1

Internal Reference

Closes DOC-1131

@netlify /docs

netlify · 2026-02-05T11:12:14Z

✅ Deploy Preview for vcluster-docs-site ready!

Name	Link
🔨 Latest commit	`2c03561`
🔍 Latest deploy log	https://app.netlify.com/projects/vcluster-docs-site/deploys/698dc9a430a2f200085ec97a
😎 Deploy Preview	https://deploy-preview-1665--vcluster-docs-site.netlify.app/docs
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

loft-bot · 2026-02-05T11:12:30Z

Claude finished @guowenatk's task in 58s —— View job

Issues Found

Found 2 formatting issues in the MinIO documentation:

Line 164: Missing language specification for code block - should be bash
Lines 176-182: Command syntax issues - missing space in URL construction and incorrect line continuation

Both issues are fixed in the inline comments with suggestions.

github-actions · 2026-02-05T11:12:38Z

DOC-1151: [4.3] Backport security docs for template-less vCluster creation to v4.3

github-actions · 2026-02-05T11:12:39Z

DOC-1131: Document Minio snapshot support and examples

vcluster/manage/backup-restore/backup.mdx

Customer confusion about using S3-compatible providers (MinIO, Ceph) for snapshots: endpoint URL format unclear, credential secret format undocumented, and key params (url, force-path-style) missing from the options table. Adds url and force-path-style to S3 options table, replaces broken MinIO-specific examples with generic S3-compatible provider examples using InterpolatedCodeBlock for editable values. Fixes command bugs from prior commits (missing create subcommand, double base64 encoding, broken multi-line quoting). Closes DOC-1131

Test results from PR #1665 showed 'gh pr list' requires explicit approval. Adding it to allowedTools enables Claude to: - List open/closed PRs for review context - Query PR metadata for automation - Find related PRs when reviewing changes Without this permission, the command fails with "requires approval" error. Test score improved from 93.75% to 100% with this addition.

Test results from PR #1665 showed 'gh pr list' requires explicit approval. Limiting Bash permissions to only essential commands: - gh pr list: List PRs for review context - gh pr edit: Update PR metadata when needed Removed unnecessary permissions (comment, diff, view) to minimize attack surface while maintaining core functionality. GitHub MCP server provides safer alternatives for most operations.

Test results from PR #1665 showed 'gh pr list' requires explicit approval. Adding it to allowedTools enables Claude to: - List open/closed PRs for review context - Query PR metadata for automation - Find related PRs when reviewing changes Without this permission, the command fails with "requires approval" error. Test score improved from 93.75% to 100% with this addition.

Piotr1215 · 2026-02-12T12:46:46Z

@claude review the pr focusing on readability and correctness.

claude · 2026-02-12T12:47:07Z

Claude finished @Piotr1215's task in 1m 49s —— View job

Review Complete ✅

The PR successfully adds MinIO and S3-compatible provider documentation. The changes are well-structured and accurate. Here's my detailed review:

✅ Readability

Strong points:

Clear progression from AWS S3 to S3-compatible providers (MinIO/Ceph)
Excellent use of InterpolatedCodeBlock for user-customizable values (lines 206-234)
Well-organized section hierarchy with descriptive headings
Good use of tabs for platform-specific commands (macOS vs Linux)
Security warning appropriately placed (lines 151-153)

Structure:

New section "S3-compatible providers" (#s3-compatible) logically follows general S3 examples
Parameters table (lines 137-149) is comprehensive and well-documented
Examples progress from simple (AWS CLI) to complex (S3-compatible with custom endpoints)

✅ Correctness

Technical accuracy verified:

✅ url parameter: Correctly documented as base64-encoded custom endpoint
✅ force-path-style: Accurately described as required for most S3-compatible providers
✅ Command syntax: Proper parameter formatting in snapshot URLs
✅ Base64 encoding: Correct use of -w 0 flag on Linux to prevent line wrapping
✅ Session token omission: Correctly noted that S3-compatible providers don't use session tokens

Command examples:

Lines 212 & 228: Commands are syntactically correct
Proper use of echo -n to prevent newline in base64 encoding
URL parameters correctly chained with &

⚠️ Minor Observations

1. Glossary term wrapping
Per CLAUDE.md, technical terms should be wrapped for tooltips. Consider running:

npm run wrap-glossary

Terms that could benefit: vCluster, etcd, namespace (if not already wrapped elsewhere in the file).

2. Previous bot review suggestions
The earlier bot review identified two issues that appear to be from older commits:

Missing language spec for code block (line 164)
Command syntax issues (lines 176-182)

These may have been fixed in subsequent commits. I don't see these specific issues in the current file (lines 164 and 176-182 don't match the described problems).

3. Link resolution

Line 238: /docs/vcluster/cli/vcluster_snapshot - ✅ Correct cross-section link format

📋 CLAUDE.md Compliance

✅ Uses InterpolatedCodeBlock for customizable values (lines 206-234)
✅ Multi-line code uses string concatenation (proper YAML indentation preserved)
✅ Code block language specifications present (bash, json)
✅ No emojis in code
✅ Proper import statement added (line 11)
✅ Tab structure for platform-specific examples

🎯 Summary

Quality: High-quality documentation addition that addresses a real user need (S3-compatible providers like MinIO/Ceph).

Recommendation: Approve with optional glossary term wrapping.

What works well:

Clear explanation of the difference between AWS S3 and S3-compatible providers
Excellent use of interactive code blocks for user customization
Comprehensive parameter documentation
Security considerations appropriately highlighted

Optional improvement:
Run npm run wrap-glossary to auto-wrap technical terms for tooltips.

jjaferson

LGTM

guowenatk requested a review from a team as a code owner February 5, 2026 11:12

loft-bot reviewed Feb 5, 2026

View reviewed changes

vcluster/manage/backup-restore/backup.mdx Outdated Show resolved Hide resolved

loft-bot reviewed Feb 5, 2026

View reviewed changes

vcluster/manage/backup-restore/backup.mdx Outdated Show resolved Hide resolved

Piotr1215 closed this Feb 6, 2026

Piotr1215 reopened this Feb 12, 2026

Piotr1215 force-pushed the doc-1131/minio branch 2 times, most recently from 80b2ebb to efb7a22 Compare February 12, 2026 09:08

Piotr1215 requested a review from cbron February 12, 2026 09:08

guowenatk and others added 4 commits February 12, 2026 13:37

add minio guidance

d4b8071

fix commands

ae9957c

fix commands

cf5ca79

Piotr1215 force-pushed the doc-1131/minio branch from efb7a22 to 2c03561 Compare February 12, 2026 12:37

Piotr1215 mentioned this pull request Feb 12, 2026

ci(claude): add gh pr list permission #1700

Merged

loft-sh deleted a comment from claude bot Feb 12, 2026

jjaferson approved these changes Feb 12, 2026

View reviewed changes

Piotr1215 added the backport-v0.31 label Feb 13, 2026

Piotr1215 merged commit c2e8818 into main Feb 13, 2026
17 checks passed

Piotr1215 deleted the doc-1131/minio branch February 13, 2026 09:34

github-actions bot mentioned this pull request Feb 13, 2026

[v0.31] fix(vcluster): add minio docs for snapshot creation (#1665) #1704

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

fix(vcluster): add minio docs for snapshot creation#1665

fix(vcluster): add minio docs for snapshot creation#1665
Piotr1215 merged 4 commits intomainfrom
doc-1131/minio

guowenatk commented Feb 5, 2026 •

edited by Piotr1215

Loading

Uh oh!

netlify bot commented Feb 5, 2026 •

edited

Loading

Uh oh!

loft-bot commented Feb 5, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Feb 5, 2026

Uh oh!

github-actions bot commented Feb 5, 2026

Uh oh!

Uh oh!

Uh oh!

Piotr1215 commented Feb 12, 2026

Uh oh!

claude bot commented Feb 12, 2026 •

edited

Loading

Uh oh!

jjaferson left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Comments

Conversation

guowenatk commented Feb 5, 2026 • edited by Piotr1215 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Content Description

Preview Link

Internal Reference

Uh oh!

netlify bot commented Feb 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for vcluster-docs-site ready!

Uh oh!

loft-bot commented Feb 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issues Found

Uh oh!

github-actions bot commented Feb 5, 2026

Uh oh!

github-actions bot commented Feb 5, 2026

Uh oh!

Uh oh!

Uh oh!

Piotr1215 commented Feb 12, 2026

Uh oh!

claude bot commented Feb 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review Complete ✅

✅ Readability

✅ Correctness

⚠️ Minor Observations

📋 CLAUDE.md Compliance

🎯 Summary

Uh oh!

jjaferson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

guowenatk commented Feb 5, 2026 •

edited by Piotr1215

Loading

netlify bot commented Feb 5, 2026 •

edited

Loading

loft-bot commented Feb 5, 2026 •

edited

Loading

claude bot commented Feb 12, 2026 •

edited

Loading