Skip to content

docs(storage): add LINSTOR GUI documentation#521

Open
myasnikovdaniil wants to merge 1 commit intomainfrom
daniil/linstor-gui-package
Open

docs(storage): add LINSTOR GUI documentation#521
myasnikovdaniil wants to merge 1 commit intomainfrom
daniil/linstor-gui-package

Conversation

@myasnikovdaniil
Copy link
Copy Markdown
Contributor

Summary

  • New page linstor-gui.md in both v1.3/storage/ and next/storage/
  • Covers: what linstor-gui is (LINBIT's web UI proxying the LINSTOR controller REST API over mTLS), how to enable it, and two access methods:
    • Ingress (requires OIDC enabled; restricted to cozystack-cluster-admin group)
    • Port-forward fallback (kubectl -n cozy-linstor port-forward svc/linstor-gui 3373:80)

Test plan

  • Netlify deploy preview renders linstor-gui.md correctly for both /docs/v1.3/ and /docs/next/
  • Page appears in storage section nav with correct weight (40)

🤖 Generated with Claude Code

Describes how to enable the opt-in linstor-gui system package via
bundles.enabledPackages and how to access the web console — either
through the Keycloak-protected Ingress (publishing.exposedServices)
or via kubectl port-forward.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Signed-off-by: Myasnikov Daniil <myasnikovdaniil2001@gmail.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 29, 2026

Warning

Rate limit exceeded

@myasnikovdaniil has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 59 minutes and 44 seconds before requesting another review.

To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 499e3e40-8fb7-454f-bb7c-c0faae8c4f2b

📥 Commits

Reviewing files that changed from the base of the PR and between bc2745e and 60deb84.

📒 Files selected for processing (2)
  • content/en/docs/next/storage/linstor-gui.md
  • content/en/docs/v1.3/storage/linstor-gui.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch daniil/linstor-gui-package

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
Review rate limit: 0/1 reviews remaining, refill in 59 minutes and 44 seconds.

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

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 29, 2026

Deploy Preview for cozystack ready!

Name Link
🔨 Latest commit 60deb84
🔍 Latest deploy log https://app.netlify.com/projects/cozystack/deploys/69f1e3be014df90008cceb6a
😎 Deploy Preview https://deploy-preview-521--cozystack.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces documentation for the LINSTOR GUI in both the next and v1.3 versions of the storage documentation. The new pages detail how to enable the package using kubectl patch and provide instructions for accessing the UI via a Keycloak-protected Ingress or a local port-forward. Feedback was provided to ensure consistent use of American English spelling for the word behavior across the new documentation files.

for browsing and managing LINSTOR nodes, resource definitions, volumes, storage pools, and snapshots.
The UI proxies the LINSTOR controller REST API in-cluster using mTLS, so no credentials are ever exposed in the browser.

The package is **opt-in**. The CLI workflow is unchanged — enabling the GUI does not affect any LINSTOR behaviour.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

Use American English spelling 'behavior' for consistency with technical documentation standards.

Suggested change
The package is **opt-in**. The CLI workflow is unchanged — enabling the GUI does not affect any LINSTOR behaviour.
The package is **opt-in**. The CLI workflow is unchanged — enabling the GUI does not affect any LINSTOR behavior.

for browsing and managing LINSTOR nodes, resource definitions, volumes, storage pools, and snapshots.
The UI proxies the LINSTOR controller REST API in-cluster using mTLS, so no credentials are ever exposed in the browser.

The package is **opt-in**. The CLI workflow is unchanged — enabling the GUI does not affect any LINSTOR behaviour.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

Use American English spelling 'behavior' for consistency with technical documentation standards.

Suggested change
The package is **opt-in**. The CLI workflow is unchanged — enabling the GUI does not affect any LINSTOR behaviour.
The package is **opt-in**. The CLI workflow is unchanged — enabling the GUI does not affect any LINSTOR behavior.

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