Skip to content

SBR docs: update sbdconfig-user-guide with Quick Start, Known Issues, etc#2

Open
maximunited wants to merge 2 commits intomedik8s:mainfrom
maximunited:fix/docs-sbdconfig-user-guide
Open

SBR docs: update sbdconfig-user-guide with Quick Start, Known Issues, etc#2
maximunited wants to merge 2 commits intomedik8s:mainfrom
maximunited:fix/docs-sbdconfig-user-guide

Conversation

@maximunited
Copy link

Update SBDConfig User Guide Documentation

This PR updates the SBDConfig user guide with new sections and important improvements:

Key Changes

  • Quick Start Section: Added a new quick setup guide with step-by-step instructions
  • Known Issues and Workarounds: Documented two critical issues:
    • Invalid default image path (requires explicit spec.image)
    • Missing SecurityContextConstraints on OpenShift (requires manual SCC creation)
  • Installation Section: Completely updated with:
    • OpenShift-first approach with OperatorHub instructions
    • Complete SCC YAML for OpenShift deployments
    • Updated standard Kubernetes installation notes
  • Configuration Reference: Updated to reflect:
    • image field is now required (not optional)
    • Namespace clarification (uses metadata.namespace, not spec.namespace)
    • Status fields updated to use Kubernetes Conditions pattern
  • Quick Reference: Updated sbdconfig-quick-reference.md to match user guide changes

@openshift-ci
Copy link

openshift-ci bot commented Jan 27, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: maximunited

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@maximunited
Copy link
Author

@mshitrit - FYI

@mshitrit
Copy link
Member

I think this PR captures and documents well some of SBR critial issues, which requires workarounds or additional attention.
However most of them should be fixed for the next release (here is the Jira epic capturing them).

I think it would be a good idea either to have a separate PR (in case there are here issues which aren't pending fix for GA), or to wait until GA with this PR - in which case it might be closed or significantly modified.

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

Comments