Skip to content

chore: update occ remote capability token renewal related docs - #858

Merged
chathuranga95 merged 1 commit into
openchoreo:mainfrom
chathuranga95:capability-renewal
Sep 14, 2026
Merged

chathuranga95 merged 1 commit into
openchoreo:mainfrom
chathuranga95:capability-renewal

Conversation

@chathuranga95

Copy link
Copy Markdown
Contributor

Purpose

This PR updates the occ remote related docs wrt the capability renewal introduced by openchoreo/openchoreo#4723

Related Issues

openchoreo/openchoreo#4687

Checklist

  • Updated sidebars.ts if adding a new documentation page
  • Run npm run start to preview the changes locally
  • Run npm run build to ensure the build passes without errors
  • Verified all links are working (no broken links)

@coderabbitai

coderabbitai Bot commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

Warning

Review limit reached

Next included review available in 56 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

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

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 89471694-6b59-4f5e-8a5b-274ec7918c93

📥 Commits

Reviewing files that changed from the base of the PR and between 9fac994 and 9e3c734.

📒 Files selected for processing (1)
  • docs/platform-engineer-guide/local-development-setup.mdx

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 0c4ab130-b84c-45de-a331-613854c9e08e

📥 Commits

Reviewing files that changed from the base of the PR and between 02c9cdd and 9fac994.

📒 Files selected for processing (2)
  • docs/developer-guide/local-development.md
  • docs/platform-engineer-guide/local-development-setup.mdx

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated local development guidance to explain automatic session renewal and extended tunnel lifetimes.
    • Documented that permission changes are rechecked during renewal and take effect without restarting the session.
    • Clarified how newly available dependencies are reported and when local ports become available.
    • Added guidance on agent liveness refreshes, heartbeat timing, and configuring session lifetime limits.

Walkthrough

The documentation now describes self-renewing occ sessions, authorization checks on each renewal, liveness refresh behavior, dependency handling, and maxSessionSeconds configuration.

Changes

Session renewal documentation

Layer / File(s) Summary
Session renewal and authorization behavior
docs/developer-guide/local-development.md
The guide documents re-resolution before capability expiry, renewal-time permission checks, the 12-hour maximum session length, and the need to rerun occ remote for dependencies added during a session.
Liveness and lifetime configuration
docs/platform-engineer-guide/local-development-setup.mdx
The guide documents renewal-based liveness refreshes, 60-second heartbeats, reaperTtlSeconds guidance, repeated authorization checks, and the maxSessionSeconds setting.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 9fac9

The documentation accurately describes the reviewed session-renewal behavior, with no identified merge-blocking risk.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the documentation update for occ remote capability token renewal. It is concise and related to the main change.
Description check ✅ Passed The description includes the required Purpose, Related Issues, and Checklist sections. It identifies the related change and issue, and records local preview and build results. Link verification remain…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

Signed-off-by: chathuranga95 <siriwardhanachathuranga@gmail.com>
@chathuranga95
chathuranga95 merged commit 2b65f83 into openchoreo:main Sep 14, 2026
3 checks passed
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