Skip to content

docs: complete deployment guide for v0.0.2 - #5

Merged
igun997 merged 1 commit into
masterfrom
docs/deployment-guide-v0.0.2
Aug 4, 2026
Merged

docs: complete deployment guide for v0.0.2#5
igun997 merged 1 commit into
masterfrom
docs/deployment-guide-v0.0.2

Conversation

@igun997

@igun997 igun997 commented Aug 4, 2026

Copy link
Copy Markdown
Owner

Guide

Adds docs/deployment-guide.md, a copy-paste operations guide for release v0.0.2.

Covers:

  • gRPC server deployment via Docker, Docker Compose, and local binary
  • plaintext gRPC/TLS guidance, panel-wide token scope, project prerequisite
  • grpcurl helper and all 16 RPC operations
  • prebuilt image deployment with env/resources/custom domain
  • explicit gRPC Dockerfile limitation and recommended paths
  • single/multi-service Compose, WordPress+MySQL, private Adminer
  • CLI image, inline Dockerfile, Git, GitHub, inline Compose, Compose Git
  • env, domains, logs, resources, scaling, deploy settings, lifecycle, cleanup
  • automatic post-mutation redeploy matrix
  • troubleshooting content/path/ref/rootPath, ports, 502, timeout, logs, auth

Security details:

  • token grants panel-wide access; no false tenant-isolation claim
  • gRPC plaintext warning and private/TLS proxy recommendation
  • secrets read without shell arguments; temp files use umask 077
  • Adminer stays private and uses pinned major tag
  • Compose host ports/host networking constraints documented

README corrections

  • link deployment guide from Quick Start
  • Go prerequisite 1.25+, not 1.21+
  • 16 RPCs, not 15; add UpdateDeploy
  • replace misleading “multi-tenant” wording with panel-wide access model
  • examples aligned to 0.0.2
  • remove unused CUSTOM_DOMAIN configuration claim

Verification

  • go test ./... -count=1 passes in clean/no-live-env mode
  • all documented Cobra flags checked against live --help
  • all gRPC request fields checked against proto/paas.proto
  • Markdown fences/local README link validated
  • independent final docs review: no release-blocking or materially misleading issues

After merge, tag v0.0.2 to publish images and release archives containing this guide through README linkage.

Add copy-paste setup and operations guide covering:
- gRPC server via Docker, Compose, and local binary
- panel-wide token/security constraints and project prerequisite
- image deployments with env/resources/custom domains
- single and multi-service Compose deployments
- CLI image, Dockerfile, Git/GitHub, and Compose workflows
- domains, logs, scaling, resources, lifecycle, cleanup
- automatic redeploy semantics and troubleshooting

Update README RPC count, Go requirement, access model, UpdateDeploy docs,
and release examples to v0.0.2.
@coderabbitai

coderabbitai Bot commented Aug 4, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@igun997, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 35 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

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 reviews.

How do review 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 refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 3cb0c6fe-fec5-46fb-8850-6199e2861258

📥 Commits

Reviewing files that changed from the base of the PR and between 2703c81 and 2c8d040.

📒 Files selected for processing (2)
  • README.md
  • docs/deployment-guide.md

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.

@igun997
igun997 merged commit 42be694 into master Aug 4, 2026
4 checks passed
@igun997
igun997 deleted the docs/deployment-guide-v0.0.2 branch August 4, 2026 11:45
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