Skip to content

Update README with OpenShift deployment documentation#243

Merged
tpantelis merged 1 commit intosubmariner-io:develfrom
tpantelis:trigger-rebuild
Feb 6, 2026
Merged

Update README with OpenShift deployment documentation#243
tpantelis merged 1 commit intosubmariner-io:develfrom
tpantelis:trigger-rebuild

Conversation

@tpantelis
Copy link
Contributor

@tpantelis tpantelis commented Feb 6, 2026

Add documentation about the OpenShift BuildConfig-based deployment, including how builds are automatically triggered via GitHub webhook and how to manually trigger rebuilds.

Summary by CodeRabbit

  • Documentation
    • Updated deployment documentation with revised procedures and automation guidance.

Add documentation about the OpenShift BuildConfig-based deployment,
including how builds are automatically triggered via GitHub webhook
and how to manually trigger rebuilds.

Signed-off-by: Tom Pantelis <tompantelis@gmail.com>
@submariner-bot
Copy link

🤖 Created branch: z_pr243/tpantelis/trigger-rebuild

@coderabbitai
Copy link

coderabbitai bot commented Feb 6, 2026

Walkthrough

Documentation update that replaces kubectl-based image update instructions with OpenShift-specific deployment details, including BuildConfig builds triggered by GitHub webhooks and manual rebuild procedures using OpenShift tooling.

Changes

Cohort / File(s) Summary
Documentation
README.md
Updated deployment section to reflect OpenShift-based approach instead of kubectl. Introduced BuildConfig-based builds triggered by GitHub webhooks, replaced manual rebuild command with OpenShift CLI (oc start-build), and added imagePullPolicy: Always for automatic image updates.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes


Caution

Pre-merge checks failed

Please resolve all errors before merging. Addressing warnings is optional.

  • Ignore
❌ Failed checks (1 error)
Check name Status Explanation Resolution
Actionable Comments Resolved ❌ Error Namespace inconsistency between setup section (pr-brancher-webhook) and deployment section (submariner-bot) remains unresolved, and BuildConfig/webhook setup instructions are missing. Fix namespace inconsistency and add BuildConfig setup documentation with webhook configuration details and YAML file location.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and specifically summarizes the main change: updating README documentation with OpenShift deployment details, which aligns with the changeset that replaces the old deployment section with OpenShift-focused documentation.

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 and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Fix all issues with AI agents
In `@README.md`:
- Around line 73-89: Update the README to remove the namespace mismatch: decide
on a single namespace (either keep pr-brancher-webhook or standardize to
submariner-bot) and make both the setup section and the Deployment section
consistent; specifically update the setup resource creation to use
submariner-bot if you choose that namespace, or change the deployment build
command (oc start-build submariner-bot-git -n submariner-bot --follow) to
reference the $NS variable used in the setup or to use pr-brancher-webhook if
that is the intended target, and add a short note explaining if these are
distinct deployment methods when applicable.
- Around line 75-85: Add a new subsection under "Triggering a Rebuild" that
documents how to create and configure the BuildConfig named submariner-bot-git
and the GitHub webhook: state where the BuildConfig YAML lives (e.g.,
deployment/submariner-bot-buildconfig.yaml) and show the oc command to apply it
(reference submariner-bot-git), explain how to generate/record the webhook
secret token, the webhook URL format (OpenShift build webhook endpoint for the
submariner-bot-git BuildConfig), and step-by-step instructions for adding the
webhook in the GitHub repo settings so pushes trigger builds; include a note
about permissions required to run oc start-build and reference the
submariner-bot-git BuildConfig name throughout.
🧹 Nitpick comments (1)
README.md (1)

87-89: Clarify where imagePullPolicy is configured.

The statement about imagePullPolicy: Always assumes users know where this setting is configured. Consider adding a brief note that this is set in the deployment YAML (e.g., deployment/deployment.yaml) or verify that the existing deployment already has this setting.

@tpantelis
Copy link
Contributor Author

@coderabbitai approve

@coderabbitai
Copy link

coderabbitai bot commented Feb 6, 2026

✅ Actions performed

Comments resolved and changes approved.

@tpantelis tpantelis merged commit 4a531c5 into submariner-io:devel Feb 6, 2026
8 checks passed
@submariner-bot
Copy link

🤖 Closed branches: [z_pr243/tpantelis/trigger-rebuild]

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