Skip to content

[INFRA-425] - Update community→commercial restore script and drop artifacts.plane.so registry prefix#296

Merged
danciaclara merged 2 commits into
masterfrom
chore-update-ce-migration-and-registry
Jun 24, 2026
Merged

[INFRA-425] - Update community→commercial restore script and drop artifacts.plane.so registry prefix#296
danciaclara merged 2 commits into
masterfrom
chore-update-ce-migration-and-registry

Conversation

@akshat5302

@akshat5302 akshat5302 commented Jun 24, 2026

Copy link
Copy Markdown
Member

Summary

Two documentation updates to the self-hosting guides:

  1. Community → Commercial restore script (upgrade-from-community.md) — the restore script now removes each destination directory (db, redis, minio/uploads) before mv, so restoring Community data onto an existing Commercial install no longer fails on pre-existing directories.

  2. Dropped the artifacts.plane.so/ registry prefix so image references point at the makeplane/ Docker Hub org. Affected files:

The two kubernetes.md table files were re-run through Prettier (column widths shifted after the prefix removal), which inflates the diff line counts.

Verification

  • pnpm check:format passes
  • pnpm build completes cleanly

Work item

INFRA-425

Summary by CodeRabbit

  • Documentation
    • Updated self-hosting guides to use the current Docker image names and registry paths.
    • Revised copy, pull, and run examples for image migration and AIO installation.
    • Improved the Community-to-Commercial upgrade restore steps to better handle existing destination folders before moving restored data.

…s.plane.so registry prefix

- Restore script now removes destination dirs (db, redis, minio/uploads) before mv to
  avoid failures when restoring onto an existing Commercial install
- Remove artifacts.plane.so/ prefix from image references so they point to the
  makeplane/ Docker Hub org
@vercel

vercel Bot commented Jun 24, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
developer-docs Ready Ready Preview, Comment Jun 24, 2026 2:09pm

Request Review

@makeplane

makeplane Bot commented Jun 24, 2026

Copy link
Copy Markdown

Linked to Plane Work Item(s)

This comment was auto-generated by Plane

@coderabbitai

coderabbitai Bot commented Jun 24, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@akshat5302, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 56 minutes and 27 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 985fcb2e-2334-486d-ab50-71ccc2d30875

📥 Commits

Reviewing files that changed from the base of the PR and between b0d20f2 and 90cefdf.

📒 Files selected for processing (8)
  • docs/self-hosting/govern/high-availability.md
  • docs/self-hosting/manage/update-plane/airgapped-edition/update-airgapped-docker.md
  • docs/self-hosting/manage/update-plane/airgapped-edition/update-airgapped-kubernetes.md
  • docs/self-hosting/methods/clone-docker-images.md
  • docs/self-hosting/methods/download-config.md
  • docs/self-hosting/methods/install-methods-commercial/kubernetes.md
  • docs/self-hosting/methods/kubernetes.md
  • docs/self-hosting/methods/podman-quadlets.md
📝 Walkthrough

Walkthrough

Two sets of documentation corrections for self-hosting: all commercial image references are updated from the artifacts.plane.so/makeplane registry to makeplane across clone-docker-images.md and docker-aio.md; the community-to-commercial restore script in upgrade-from-community.md is updated to remove existing destination directories with sudo rm -rf before executing mv operations.

Changes

Self-hosting docs: registry URL and restore script

Layer / File(s) Summary
Registry URL update across clone and AIO docs
docs/self-hosting/methods/clone-docker-images.md, docs/self-hosting/methods/docker-aio.md
All source image references change from artifacts.plane.so/makeplane/... to makeplane/..., including the image list, inline copy examples, batch script SOURCE_REGISTRY variable, troubleshooting crane ls command, and all docker pull/docker run examples.
Restore script: delete before move
docs/self-hosting/upgrade-from-community.md
The community-to-commercial restore script now runs sudo rm -rf on the db, redis, and minio/uploads destination paths before the mv operations; trailing slashes are removed from mv targets.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested reviewers

  • pratapalakshmi
  • sunder-ch
  • danciaclara

Poem

🐰 Hop hop, the registry moved today,
No more artifacts.plane.so in the way!
Just makeplane pure, short and bright,
And rm -rf clears the path just right.
This bunny approves — the docs look tight! 🎉

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the two main documentation changes: the restore script update and removal of the artifacts.plane.so registry prefix.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore-update-ce-migration-and-registry

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/self-hosting/upgrade-from-community.md`:
- Around line 70-75: The restore shell steps mix privileged and unprivileged
file operations, which can fail after the destination is removed; update the
migration commands in the upgrade guide so each remove/move/create action uses
consistent privileges. Specifically, in the restore sequence around the db,
redis, and minio paths, make sure the mv operations and the mkdir for minio are
executed with the same sudo context as the rm -rf calls so the restore stays
atomic on owned directories like /opt.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b6ae8735-87c0-4e01-93a0-56deada9b372

📥 Commits

Reviewing files that changed from the base of the PR and between f6749a7 and b0d20f2.

📒 Files selected for processing (5)
  • docs/self-hosting/methods/clone-docker-images.md
  • docs/self-hosting/methods/docker-aio.md
  • docs/self-hosting/methods/install-methods-commercial/kubernetes.md
  • docs/self-hosting/methods/kubernetes.md
  • docs/self-hosting/upgrade-from-community.md

Comment thread docs/self-hosting/upgrade-from-community.md
Update all Commercial Edition (v2.x) version examples to v2.6.3 across
self-hosting guides. Community Edition (v1.x), iframely image tag (v1.2.0),
and historical upgrade guides are intentionally left unchanged.

Co-Authored-By: WOZCODE <contact@withwoz.com>
@danciaclara danciaclara merged commit 706aacc into master Jun 24, 2026
8 checks passed
@danciaclara danciaclara deleted the chore-update-ce-migration-and-registry branch June 24, 2026 14:10
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.

2 participants