OCPBUGS-87517: Updating openshift-enterprise-console-operator-container image to be consistent with ART for 5.0#1171
Conversation
7701227 to
62b8719
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 upgrades the build infrastructure by updating the CI operator configuration and Dockerfile to use Go 1.26 with OpenShift 5.0, replacing the previous Go 1.25 with OpenShift 4.22 versions across both the builder stage and runtime base image. ChangesBuild and runtime image upgrade to Go 1.26 and OpenShift 5.0
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 15✅ Passed checks (15 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
[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-bot: This pull request references Jira Issue OCPBUGS-87517, 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-87517, 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. |
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
Dockerfile.ocp (1)
8-34:⚠️ Potential issue | 🟠 Major | ⚡ Quick winAdd a runtime HEALTHCHECK to satisfy container policy.
Final image does not define a health check. Add one appropriate for the operator process (or a lightweight binary probe endpoint check if exposed).
As per coding guidelines, "HEALTHCHECK defined."Example HEALTHCHECK stub
FROM registry.ci.openshift.org/ocp/5.0:base-rhel9 RUN useradd console-operator USER console-operator COPY --from=builder /go/src/github.com/openshift/console-operator/console /usr/bin/console +HEALTHCHECK --interval=30s --timeout=5s --start-period=20s --retries=3 \ + CMD ["/usr/bin/console", "version"]🤖 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 `@Dockerfile.ocp` around lines 8 - 34, Add a Docker HEALTHCHECK to the image so the operator runtime is validated: in Dockerfile.ocp add a HEALTHCHECK that either probes the operator's HTTP health endpoint (if the operator exposes one) or runs a lightweight process check for the console operator binary (e.g. verifying /usr/bin/console with the "operator" subcommand is running). Place the HEALTHCHECK after the final COPY/LABEL blocks and before any CMD, reference the runtime binary "/usr/bin/console" and the "operator" invocation so the check targets the correct process or endpoint, and configure sensible interval/retries/start-period values per container policy.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 `@Dockerfile.ocp`:
- Line 1: The Dockerfile uses an unapproved base image "FROM
registry.ci.openshift.org/ocp/builder:rhel-9-golang-1.26-openshift-5.0 AS
builder"; update this (and any other FROM lines, e.g., the runtime image) to use
an approved catalog.redhat.com base (UBI minimal or approved distroless) to
comply with container policy. Replace the builder FROM line and the runtime FROM
line(s) with the corresponding catalog.redhat.com UBI minimal or distroless
image tags that match the required runtime (e.g., UBI for Go builds or a
distroless runtime), ensuring the AS builder alias and any subsequent stages
still reference the renamed base.
- Line 4: The Dockerfile currently uses a broad COPY . . in the builder stage
which brings the entire build context (and secrets) into the image; replace that
with explicit COPY commands for only required build inputs (e.g., COPY go.mod
go.sum ./, COPY cmd/ ./cmd/, COPY pkg/ ./pkg/, and any required assets) and
ensure these COPY lines are placed in the same stage referenced by the builder
stage name (the existing COPY . . symbol in the builder stage). This reduces
attack surface and build noise while preserving the same build output.
---
Outside diff comments:
In `@Dockerfile.ocp`:
- Around line 8-34: Add a Docker HEALTHCHECK to the image so the operator
runtime is validated: in Dockerfile.ocp add a HEALTHCHECK that either probes the
operator's HTTP health endpoint (if the operator exposes one) or runs a
lightweight process check for the console operator binary (e.g. verifying
/usr/bin/console with the "operator" subcommand is running). Place the
HEALTHCHECK after the final COPY/LABEL blocks and before any CMD, reference the
runtime binary "/usr/bin/console" and the "operator" invocation so the check
targets the correct process or endpoint, and configure sensible
interval/retries/start-period values per container policy.
🪄 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 YAML (base), Central YAML (inherited)
Review profile: CHILL
Plan: Enterprise
Run ID: 573a8127-20b5-4a2f-a5b9-24e5cdffdbff
📒 Files selected for processing (2)
.ci-operator.yamlDockerfile.ocp
📜 Review details
🧰 Additional context used
📓 Path-based instructions (3)
Dockerfile.ocp
📄 CodeRabbit inference engine (TESTING.md)
Build container images using Dockerfile.ocp for OpenShift deployment
Files:
Dockerfile.ocp
**/{Dockerfile,Containerfile}*
⚙️ CodeRabbit configuration file
**/{Dockerfile,Containerfile}*: Container security (prodsec-skills):
- Base image: UBI minimal or distroless from catalog.redhat.com
- Red Hat images: use floating tags (Red Hat manages updates);
non-RH images: pin by digest- Multi-stage builds; no build tools in final image
- USER non-root; never run as root
- COPY specific files, not entire context
- No secrets in ENV, ARG, or COPY
- Read-only rootfs where possible
- No package manager cache in final layer
- HEALTHCHECK defined
Files:
Dockerfile.ocp
**
⚙️ CodeRabbit configuration file
**: # OpenShift Console Operator - AI Context HubThis file serves as the central AI documentation hub for the OpenShift Console Operator project. AI assistants (Claude, Cursor, Copilot, CodeRabbit, etc.) use this and the linked documents to understand project context.
Go Version and Dependencies
Go Version and Dependencies
- Go version: 1.24.0 (toolchain: go1.24.4)
- Dependency management: Uses
go.modwith vendoring- Build flags: Use
GOFLAGS="-mod=vendor"for builds and tests to ensure vendored dependencies are used- Key dependencies: openshift/api, openshift/library-go, k8s.io client libraries
- Go version: 1.24.0 (toolchain: go1.24.4)
- Dependency management: Uses
go.modwith vendoring- Build flags: Use
GOFLAGS="-mod=vendor"for builds and tests to ensure vendored dependencies are used- Key dependencies: openshift/api, openshift/library-go, k8s.io client libraries
Quick Reference
This Repository
Document Purpose ARCHITECTURE.md System architecture, components, repository structure CONVENTIONS.md Go coding standards, patterns, import organization TESTING.md Testing patterns, commands, debugging README.md Project README with setup instructions Console Repository (openshift/console)
For frontend-related guidelines, see the openshift/console repository:
Document Purpose STYLEGUIDE.md Frontend code style guidelines INTERNATIONALIZATION.md i18n patterns and translation guidelines CONTRIBUTING.md Contribution guidelines for the console project Project Summary
The **console-operator...
Files:
Dockerfile.ocp
🔀 Multi-repo context openshift/console
[::openshift/console::] .ci-operator.yaml
- file exists at repo root and contains build_root_image configuration (search hit). This is the CI file the PR updates.
[::openshift/console::] Dockerfile
- FROM registry.ci.openshift.org/ocp/builder:rhel-9-golang-1.25-openshift-4.22 AS gobuilder (line shown by search)
- FROM registry.ci.openshift.org/ocp/builder:rhel-9-base-nodejs-openshift-4.22 AS nodebuilder
- FROM registry.ci.openshift.org/ocp/4.22:base-rhel9
[::openshift/console::] Dockerfile.downloads
- FROM registry.ci.openshift.org/ocp/builder:rhel-9-golang-1.25-openshift-4.22 AS gobuilder
[::openshift/console::] Dockerfile.dev
- FROM registry.ci.openshift.org/ocp/builder:rhel-9-golang-1.25-openshift-4.22 AS gobuilder
- FROM registry.ci.openshift.org/ocp/4.22:base-rhel9
Notes:
- The repository contains multiple Dockerfiles and a .ci-operator.yaml that reference rhel-9-golang-1.25-openshift-4.22 / ocp 4.22 images — these are the locations the PR updates to rhel-9-golang-1.26-openshift-5.0 / ocp 5.0. No other repositories were available to search.
🔇 Additional comments (1)
.ci-operator.yaml (1)
4-4: LGTM!
| @@ -1,11 +1,11 @@ | |||
| FROM registry.ci.openshift.org/ocp/builder:rhel-9-golang-1.25-openshift-4.22 AS builder | |||
| FROM registry.ci.openshift.org/ocp/builder:rhel-9-golang-1.26-openshift-5.0 AS builder | |||
There was a problem hiding this comment.
Use approved Red Hat base image source per container policy.
Both updated FROM images are pulled from registry.ci.openshift.org, but this policy requires base images from catalog.redhat.com (UBI minimal or distroless). Please switch both builder/runtime bases to approved catalog sources for production image compliance.
As per coding guidelines, "Base image: UBI minimal or distroless from catalog.redhat.com."
Also applies to: 8-8
🤖 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 `@Dockerfile.ocp` at line 1, The Dockerfile uses an unapproved base image "FROM
registry.ci.openshift.org/ocp/builder:rhel-9-golang-1.26-openshift-5.0 AS
builder"; update this (and any other FROM lines, e.g., the runtime image) to use
an approved catalog.redhat.com base (UBI minimal or approved distroless) to
comply with container policy. Replace the builder FROM line and the runtime FROM
line(s) with the corresponding catalog.redhat.com UBI minimal or distroless
image tags that match the required runtime (e.g., UBI for Go builds or a
distroless runtime), ensuring the AS builder alias and any subsequent stages
still reference the renamed base.
Source: Coding guidelines
| FROM registry.ci.openshift.org/ocp/builder:rhel-9-golang-1.26-openshift-5.0 AS builder | ||
| ARG TAGS=ocp | ||
| WORKDIR /go/src/github.com/openshift/console-operator | ||
| COPY . . |
There was a problem hiding this comment.
Avoid copying full build context into the builder stage.
COPY . . imports unnecessary files and increases secret/supply-chain exposure risk. Copy only required paths (go.mod, go.sum, cmd/, pkg/, and needed assets).
As per coding guidelines, "COPY specific files, not entire context."
Proposed tightening
-COPY . .
+COPY go.mod go.sum ./
+COPY cmd ./cmd
+COPY pkg ./pkg
+COPY manifests ./manifests
+COPY quickstarts ./quickstarts
+COPY vendor ./vendor📝 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 cmd ./cmd | |
| COPY pkg ./pkg | |
| COPY manifests ./manifests | |
| COPY quickstarts ./quickstarts | |
| COPY vendor ./vendor |
🤖 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 `@Dockerfile.ocp` at line 4, The Dockerfile currently uses a broad COPY . . in
the builder stage which brings the entire build context (and secrets) into the
image; replace that with explicit COPY commands for only required build inputs
(e.g., COPY go.mod go.sum ./, COPY cmd/ ./cmd/, COPY pkg/ ./pkg/, and any
required assets) and ensure these COPY lines are placed in the same stage
referenced by the builder stage name (the existing COPY . . symbol in the
builder stage). This reduces attack surface and build noise while preserving the
same build output.
Source: Coding guidelines
|
@openshift-bot: all tests passed! 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-87770 to this PR, but found it is currently hooked up to ['OCPBUGS-87517']. Please consult with #forum-ocp-art if it is not clear what there is to do. |
Updating openshift-enterprise-console-operator-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:
openshift-enterprise-console-operator.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.