Skip to content

[docs] update OpenShell guide - #1302

Merged
artberger merged 4 commits into
mainfrom
docs/openshell-followup
Oct 19, 2026
Merged

artberger merged 4 commits into
mainfrom
docs/openshell-followup

Conversation

@artberger

Copy link
Copy Markdown
Collaborator

Follow-up to #1282.

  • Add descriptions: the architecture walkthrough, a kernel prerequisite, the OIDC login behavior, and a production smoke test.
  • Reformat descriptions into field tables to follow the style guide.
  • Reuse the OpenShell and Agent Sandbox versions through snippets.
  • Add troubleshooting steps for failures hit while running the guide: sandbox launch without Landlock support, and the OpenShell pod crash-loop when the OIDC issuer is unreachable.

Signed-off-by: Art Berger <art.berger@solo.io>
Signed-off-by: Art Berger <art.berger@solo.io>
@artberger artberger self-assigned this Oct 16, 2026
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

Deploying agentproxy with  Cloudflare Pages  Cloudflare Pages

Latest commit: aa70267
Status:⚡️  Build in progress...

View logs

@danehans
danehans self-requested a review October 16, 2026 23:21

@danehans danehans left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I have 2 non-blocking review comments:

  • Make the crash-loop diagnosis conditional. Line 259 says a timeout plus crash loop means the issuer is unreachable. Those symptoms have other causes. Suggest checking logs first, then applying the OIDC fix when discovery errors confirm it. The pod-deletion workaround is valid for a stalled StatefulSet rollout, but its explanation should describe that specific condition. Kubernetes documents this recovery case.
  • Clarify when manual login is needed. Line 302 suggests logging in again after token expiry. OpenShell v0.1.3 already attempts automatic refresh. Better: “If token refresh fails or reauthentication is required, run openshell gateway login production.” Refresh implementation.

artberger and others added 2 commits October 19, 2026 08:21
Signed-off-by: Art Berger <art.berger@solo.io>
@artberger
artberger merged commit bc07265 into main Oct 19, 2026
3 of 4 checks passed
@artberger
artberger deleted the docs/openshell-followup branch October 19, 2026 12:22
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