OCPBUGS-87407: Updating oauth-server-container image to be consistent with ART for 5.0#235
Conversation
openshift-bot
force-pushed
the
art-consistency-openshift-5.0-oauth-server
branch
from
d01dbd8 to
d6559c9
Compare
|
Created by ART pipeline job run https://art-jenkins.apps.prod-stable-spoke1-dc-iad2.itup.redhat.com/job/aos-cd-builds/job/build%252Fsync-ci-images/201 |
WalkthroughThis PR upgrades the build infrastructure for the OAuth server project from OpenShift 4.21 with Go 1.24 to OpenShift 5.0 with Go 1.26. The CI operator configuration and multi-stage Dockerfile are updated to reference the newer base images, while build and runtime workflows remain unchanged. ChangesBuild Infrastructure Upgrade
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Important Pre-merge checks failedPlease resolve all errors before merging. Addressing warnings is optional. ❌ Failed checks (1 error)
✅ Passed checks (14 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
openshift-bot
changed the title
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: openshift-bot The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
openshift-ci-robot
added
jira/valid-reference
|
@openshift-bot: This pull request references Jira Issue OCPBUGS-87407, which is valid. The bug has been moved to the POST state. 3 validation(s) were run on this bug
The bug has been updated to refer to the pull request using the external bug tracker. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
|
@openshift-bot: This pull request references Jira Issue OCPBUGS-87407, which is valid. 3 validation(s) were run on this bug
DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
images/Dockerfile.rhel (1)
8-14:⚠️ Potential issue | 🟠 Major | ⚡ Quick winAdd a non-root USER directive.
The final stage does not specify a USER, so the container runs as root. Per the container security guidelines, you must run as non-root. This is especially critical for the OAuth server, which handles authentication and is a high-value security target.
🔒 Suggested fix
Add a USER directive before the ENTRYPOINT:
FROM registry.ci.openshift.org/ocp/5.0:base-rhel9 COPY --from=builder /go/src/github.com/openshift/oauth-server/oauth-server /usr/bin/ +USER 1001 ENTRYPOINT ["/usr/bin/oauth-server"]Ensure the base image provides a non-root user (UID 1001 is conventional for OpenShift) or create one explicitly if needed.
As per coding guidelines: "USER non-root; never run as root".
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@images/Dockerfile.rhel` around lines 8 - 14, The final image currently has no USER set so it runs as root; update the final stage of this Dockerfile by adding a non-root USER directive prior to ENTRYPOINT (e.g., use an existing non-root user/UID 1001 or create one in the image) so that the oauth-server binary copied by COPY --from=builder /go/src/github.com/openshift/oauth-server/oauth-server /usr/bin/ runs as non-root; ensure the chosen user exists in the base image or add user creation steps earlier in the Dockerfile and then set USER before ENTRYPOINT ["/usr/bin/oauth-server"].Sources: Coding guidelines, Linters/SAST tools
🧹 Nitpick comments (1)
images/Dockerfile.rhel (1)
8-14: ⚡ Quick winDefine a HEALTHCHECK.
The Dockerfile does not include a HEALTHCHECK instruction. Health checks enable orchestrators to detect and restart unhealthy containers, improving reliability.
🏥 Suggested addition
Add a HEALTHCHECK before the ENTRYPOINT that validates the OAuth server endpoint:
COPY --from=builder /go/src/github.com/openshift/oauth-server/oauth-server /usr/bin/ +HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \ + CMD ["/usr/bin/oauth-server", "healthz"] || exit 1 ENTRYPOINT ["/usr/bin/oauth-server"]Adjust the command/endpoint based on the actual health check interface exposed by the oauth-server binary.
As per coding guidelines: "HEALTHCHECK defined".
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@images/Dockerfile.rhel` around lines 8 - 14, Add a HEALTHCHECK instruction to the Dockerfile before the ENTRYPOINT to probe the oauth-server process (the binary referenced by ENTRYPOINT ["/usr/bin/oauth-server"]) — implement a short command that queries the server's health endpoint (e.g., via curl or wget against localhost:<port>/health or the appropriate oauth-server health path), set sensible --interval/--timeout/--retries, and ensure the HEALTHCHECK exits 0 for healthy and non‑zero for unhealthy so orchestrators can detect and restart the container.Source: Coding guidelines
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@images/Dockerfile.rhel`:
- Line 3: The Dockerfile currently uses a broad COPY . . which pulls the entire
build context into the image; replace that with explicit COPY lines listing only
required artifacts (e.g., COPY <build-output> <dest>, COPY package.json
package-lock.json ./) or otherwise restrict included files and patterns, and
add/update a .dockerignore to exclude secrets, config, .git, node_modules, and
other unnecessary paths; update the Dockerfile COPY commands (the COPY
instruction) to reference those specific files/directories instead of "." to
minimize attack surface.
---
Outside diff comments:
In `@images/Dockerfile.rhel`:
- Around line 8-14: The final image currently has no USER set so it runs as
root; update the final stage of this Dockerfile by adding a non-root USER
directive prior to ENTRYPOINT (e.g., use an existing non-root user/UID 1001 or
create one in the image) so that the oauth-server binary copied by COPY
--from=builder /go/src/github.com/openshift/oauth-server/oauth-server /usr/bin/
runs as non-root; ensure the chosen user exists in the base image or add user
creation steps earlier in the Dockerfile and then set USER before ENTRYPOINT
["/usr/bin/oauth-server"].
---
Nitpick comments:
In `@images/Dockerfile.rhel`:
- Around line 8-14: Add a HEALTHCHECK instruction to the Dockerfile before the
ENTRYPOINT to probe the oauth-server process (the binary referenced by
ENTRYPOINT ["/usr/bin/oauth-server"]) — implement a short command that queries
the server's health endpoint (e.g., via curl or wget against
localhost:<port>/health or the appropriate oauth-server health path), set
sensible --interval/--timeout/--retries, and ensure the HEALTHCHECK exits 0 for
healthy and non‑zero for unhealthy so orchestrators can detect and restart the
container.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository: openshift/coderabbit/.coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 2a0ecdb5-5a32-4274-b469-bf5c08689eaa
📒 Files selected for processing (2)
.ci-operator.yamlimages/Dockerfile.rhel
| FROM registry.ci.openshift.org/ocp/builder:rhel-9-golang-1.24-openshift-4.21 AS builder | ||
| FROM registry.ci.openshift.org/ocp/builder:rhel-9-golang-1.26-openshift-5.0 AS builder | ||
| WORKDIR /go/src/github.com/openshift/oauth-server | ||
| COPY . . |
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major | ⚡ Quick win
Avoid copying the entire build context.
Line 3 copies the entire repository context (. .) into the builder image. Per the container security guidelines, you should copy only specific required files to minimize the attack surface and prevent accidental inclusion of secrets or unnecessary files.
📦 Suggested approach
Replace the broad context copy with explicit file/directory patterns:
-COPY . .
+COPY go.mod go.sum ./
+COPY vendor/ vendor/
+COPY cmd/ cmd/
+COPY pkg/ pkg/
+# Add other required source directoriesAlternatively, use a .dockerignore file to exclude sensitive or unnecessary paths if the full context is genuinely required.
As per coding guidelines: "COPY specific files, not entire context".
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| COPY . . | |
| COPY go.mod go.sum ./ | |
| COPY vendor/ vendor/ | |
| COPY cmd/ cmd/ | |
| COPY pkg/ pkg/ | |
| # Add other required source directories |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@images/Dockerfile.rhel` at line 3, The Dockerfile currently uses a broad COPY
. . which pulls the entire build context into the image; replace that with
explicit COPY lines listing only required artifacts (e.g., COPY <build-output>
<dest>, COPY package.json package-lock.json ./) or otherwise restrict included
files and patterns, and add/update a .dockerignore to exclude secrets, config,
.git, node_modules, and other unnecessary paths; update the Dockerfile COPY
commands (the COPY instruction) to reference those specific files/directories
instead of "." to minimize attack surface.
Source: Coding guidelines
|
@openshift-bot: The following test failed, say
Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
|
ART wants to connect issue OCPBUGS-87692 to this PR, but found it is currently hooked up to ['OCPBUGS-87407']. Please consult with #forum-ocp-art if it is not clear what there is to do. |
openshift-bot
added
the
verified
3 participants
Updating oauth-server-container image to be consistent with ART for 5.0
TLDR:
Product builds by ART can be configured for different base and builder images than corresponding CI
builds. This automated PR requests a change to CI configuration to align with ART's configuration;
please take steps to merge it quickly or contact ART to coordinate changes.
The configuration in the following ART component metadata is driving this alignment request:
oauth-server.yml.
Detail:
This repository is out of sync with the downstream product builds for this component. The CI
configuration for at least one image differs from ART's expected product configuration. This should
be addressed to ensure that the component's CI testing accurate reflects what customers will
experience.
Most of these PRs are opened as an ART-driven proposal to migrate base image or builder(s) to a
different version, usually prior to GA. The intent is to effect changes in both configurations
simultaneously without breaking either CI or ART builds, so usually ART builds are configured to
consider CI as canonical and attempt to match CI config until the PR merges to align both. ART may
also configure changes in GA releases with CI remaining canonical for a brief grace period to enable
CI to succeed and the alignment PR to merge. In either case, ART configuration will be made
canonical at some point (typically at branch-cut before GA or release dev-cut after GA), so it is
important to align CI configuration as soon as possible.
PRs are also triggered when CI configuration changes without ART coordination, for instance to
change the number of builder images or to use a different golang version. These changes should be
coordinated with ART; whether ART configuration is canonical or not, preferably it would be updated
first to enable the changes to occur simultaneously in both CI and ART at the same time. This also
gives ART a chance to validate the intended changes first. For instance, ART compiles most
components with the Golang version being used by the control plane for a given OpenShift release.
Exceptions to this convention (i.e. you believe your component must be compiled with a Golang
version independent from the control plane) must be granted by the OpenShift staff engineers and
communicated to the ART team.
Roles & Responsibilities:
tests OR that necessary metadata changes are reported to the ART team
in
#forum-ocp-arton Slack. If necessary, the changes required by this pull request can beintroduced with a separate PR opened by the component team. Once the repository is aligned,
this PR will be closed automatically.
verify-depsis complaining. In that case, please opena new PR with the dependency issues addressed (and base images bumped). ART-9595 for reference.
any required labels to ensure the PR merges once tests are passing. In cases where ART config is
canonical, downstream builds are already being built with these changes, and merging this PR
only improves the fidelity of our CI. In cases where ART config is not canonical, this provides
a grace period for the component team to align their CI with ART's configuration before it becomes
canonical in product builds.
ART has been configured to reconcile your CI build root image (see https://docs.ci.openshift.org/docs/architecture/ci-operator/#build-root-image).
In order for your upstream .ci-operator.yaml configuration to be honored, you must set the following in your openshift/release ci-operator configuration file:
Change behavior of future PRs:
set up automatically. This means that such a PR would merge without human intervention (and awareness!) in the future.
To do so, open a PR to set the
auto_labelattribute in the image configuration. ExampleUPSTREAM: <carry>:. An example.If you have any questions about this pull request, please reach out in the
#forum-ocp-artSlack channel.