Update README with OpenShift deployment documentation#243
Update README with OpenShift deployment documentation#243tpantelis merged 1 commit intosubmariner-io:develfrom
Conversation
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>
|
🤖 Created branch: z_pr243/tpantelis/trigger-rebuild |
WalkthroughDocumentation 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
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Caution Pre-merge checks failedPlease resolve all errors before merging. Addressing warnings is optional.
❌ Failed checks (1 error)
✅ Passed checks (2 passed)
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. Comment |
There was a problem hiding this comment.
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 whereimagePullPolicyis configured.The statement about
imagePullPolicy: Alwaysassumes 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.
|
@coderabbitai approve |
✅ Actions performedComments resolved and changes approved. |
|
🤖 Closed branches: [z_pr243/tpantelis/trigger-rebuild] |
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