OCPBUGS-87521: Updating ose-openshift-apiserver-container image to be consistent with ART for 5.0 - #655
Conversation
7dadb2f to
277aa00
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/216 |
WalkthroughThis PR updates CI configuration and container build files to use OpenShift 5.0 and Golang 1.26 base images, replacing the previous OpenShift 4.22 and Golang 1.24 versions across both ChangesBase Image Versions Update
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 15✅ Passed checks (15 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
openshift-bot
changed the title
openshift-ci-robot
added
the
jira/valid-reference
openshift-ci-robot
added
the
jira/valid-bug
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: 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-bot: This pull request references Jira Issue OCPBUGS-87521, 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-87521, 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.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
images/Dockerfile.rhel (2)
1-14: 🛠️ Refactor suggestion | 🟠 Major | ⚡ Quick winAdd HEALTHCHECK directive for operational monitoring.
The Dockerfile lacks a HEALTHCHECK directive, which is required by container security guidelines. A health check enables container orchestration platforms to monitor the apiserver's availability and restart it if unhealthy.
🏥 Proposed HEALTHCHECK addition
FROM registry.ci.openshift.org/ocp/5.0:base-rhel9 COPY --from=builder /go/src/github.com/openshift/openshift-apiserver/openshift-apiserver /usr/bin/ COPY --from=builder /go/src/github.com/openshift/openshift-apiserver/openshift-apiserver-tests-ext.gz /usr/bin/ +HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \ + CMD ["/usr/bin/curl", "-f", "http://localhost:8080/healthz"] || exit 1 ENTRYPOINT ["/usr/bin/openshift-apiserver"]Note: Adjust the healthcheck endpoint URL and port to match your apiserver's actual health endpoint. The example assumes a
/healthzendpoint on port 8080. You may need to installcurlin the base image or use an alternative health check mechanism.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 1 - 14, The Dockerfile for the openshift-apiserver image is missing a HEALTHCHECK directive; add a HEALTHCHECK instruction after the ENTRYPOINT (or before LABEL) that probes the apiserver health endpoint (e.g., /healthz on the correct port) using a small runtime probe (curl or an available tool) and include sensible options (interval, timeout, start-period, retries); if the base image lacks curl, install a minimal probe tool in the builder or base image or use a shell builtin/netcat alternative so the HEALTHCHECK command can run; ensure the probe targets the binary started by ENTRYPOINT ("/usr/bin/openshift-apiserver") and document the chosen endpoint and timings in the Dockerfile comment.Source: Coding guidelines
1-14:⚠️ Potential issue | 🔴 Critical | 🏗️ Heavy liftAdd USER directive to run as non-root.
The Dockerfile runs as root by default. Per container security guidelines, you must specify a non-root user. Trivy correctly flagged this as DS-0002.
🔒 Proposed fix to add non-root user
Add a USER directive before the ENTRYPOINT in the runtime stage:
FROM registry.ci.openshift.org/ocp/5.0:base-rhel9 COPY --from=builder /go/src/github.com/openshift/openshift-apiserver/openshift-apiserver /usr/bin/ COPY --from=builder /go/src/github.com/openshift/openshift-apiserver/openshift-apiserver-tests-ext.gz /usr/bin/ +USER 1001 ENTRYPOINT ["/usr/bin/openshift-apiserver"]Note: Verify that UID 1001 (or another appropriate non-root UID) has the necessary permissions to execute the apiserver binary and access required resources. You may need to adjust file permissions in the builder stage or create a specific user in the base image.
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 1 - 14, The container currently runs as root; add a USER directive in the runtime stage before ENTRYPOINT to run as a non-root UID (e.g., 1001) and ensure the apiserver binary and tests archive are owned/readable by that user by adjusting ownership/permissions in the builder stage (or creating the user in the runtime image). Specifically, modify the runtime stage around the COPY lines and ENTRYPOINT so a non-root user is present and used, and update the builder stage to chown/chmod /go/src/.../openshift-apiserver and openshift-apiserver-tests-ext.gz so the chosen UID can execute/read them.Sources: Coding guidelines, Linters/SAST tools
🤖 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.
Outside diff comments:
In `@images/Dockerfile.rhel`:
- Around line 1-14: The Dockerfile for the openshift-apiserver image is missing
a HEALTHCHECK directive; add a HEALTHCHECK instruction after the ENTRYPOINT (or
before LABEL) that probes the apiserver health endpoint (e.g., /healthz on the
correct port) using a small runtime probe (curl or an available tool) and
include sensible options (interval, timeout, start-period, retries); if the base
image lacks curl, install a minimal probe tool in the builder or base image or
use a shell builtin/netcat alternative so the HEALTHCHECK command can run;
ensure the probe targets the binary started by ENTRYPOINT
("/usr/bin/openshift-apiserver") and document the chosen endpoint and timings in
the Dockerfile comment.
- Around line 1-14: The container currently runs as root; add a USER directive
in the runtime stage before ENTRYPOINT to run as a non-root UID (e.g., 1001) and
ensure the apiserver binary and tests archive are owned/readable by that user by
adjusting ownership/permissions in the builder stage (or creating the user in
the runtime image). Specifically, modify the runtime stage around the COPY lines
and ENTRYPOINT so a non-root user is present and used, and update the builder
stage to chown/chmod /go/src/.../openshift-apiserver and
openshift-apiserver-tests-ext.gz so the chosen UID can execute/read them.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository: openshift/coderabbit/.coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 8a2d48e2-6003-47e8-8b72-246d7d7b879b
📒 Files selected for processing (2)
.ci-operator.yamlimages/Dockerfile.rhel
|
@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-87774 to this PR, but found it is currently hooked up to ['OCPBUGS-87521']. Please consult with #forum-ocp-art if it is not clear what there is to do. |
openshift-bot
added
the
verified
openshift-ci
Bot
added
the
needs-rebase
|
PR needs rebase. 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. |
3 participants
Updating ose-openshift-apiserver-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:
ose-openshift-apiserver.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.