Skip to content

CONSOLE-5293: Use console-downloads image instead of cli-artifacts - #1158

Open
jhadvig wants to merge 2 commits into
openshift:mainfrom
jhadvig:CONSOLE-5293
Open

CONSOLE-5293: Use console-downloads image instead of cli-artifacts#1158
jhadvig wants to merge 2 commits into
openshift:mainfrom
jhadvig:CONSOLE-5293

Conversation

@jhadvig

@jhadvig jhadvig commented May 15, 2026

Copy link
Copy Markdown
Member

Analysis / Root cause:

The downloads deployment currently uses the cli-artifacts image and runs an inline Python HTTP server script to serve CLI binaries. This approach is being replaced by a dedicated console-downloads image
(openshift/console Dockerfile.downloads) that contains a purpose-built Golang HTTP server with its own entrypoint, making the inline Python
script unnecessary.

Jira: https://redhat.atlassian.net/browse/CONSOLE-5293

Solution description:

  1. manifests/07-operator.yaml and manifests/07-operator-ibm-cloud-managed.yaml — Updated the DOWNLOADS_IMAGE env var from registry.svc.ci.openshift.org/openshift:cli-artifacts to
    registry.svc.ci.openshift.org/openshift:console-downloads.
  2. bindata/assets/deployments/downloads-deployment.yaml — Removed the inline Python HTTP server script (command, args), the /tmp volumeMount, and the tmp emptyDir volume. The new
    console-downloads image has its own entrypoint (/opt/downloads/downloads --config-path=/opt/downloads/defaultArtifactsConfig.yaml), so no custom command/args are needed.

No Go code changes were required — the operator reads the deployment YAML from bindata and sets the image from the DOWNLOADS_IMAGE env var, which continues to work as before.

Test setup:

The console-downloads image must be present in the release payload. Ensure the image is built and available via the CI config in openshift/release.

Test cases:

  • Verify the downloads deployment starts successfully with the new console-downloads image
  • Verify the downloads page at https://downloads-openshift-console.apps.<cluster>/ serves CLI binaries correctly
  • Verify oc download links for all architectures (amd64, arm64, ppc64le, s390x) and platforms (linux, mac, windows) are functional
  • Verify the liveness and readiness probes pass on port 8080
  • Verify the operator reconciles correctly after a fresh install
  • Verify the operator reconciles correctly on upgrade from a version using cli-artifacts

Needs to be tested with openshift/console#16455

Depends on: openshift/release#79355

Browser conformance:

  • Chrome
  • Firefox
  • Safari (or Epiphany on Linux)

N/A — this is a backend/operator change with no UI modifications. Downloads page was verified accessible via Chrome.

Additional info:

This is a net deletion of ~200 lines of inline Python. The new Golang-based downloads server in the console-downloads image provides the same functionality with better performance and maintainability.

Summary by CodeRabbit

  • Chores
    • Simplified the downloads deployment startup to run the download-server binary directly with the default artifacts configuration.
    • Updated the downloads-related image reference used by the operator to the console-downloads image for more consistent runtime assets.
  • Tests
    • Adjusted downloads deployment test expectations to match the new command and arguments.

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label May 15, 2026
@openshift-ci-robot

openshift-ci-robot commented May 15, 2026

Copy link
Copy Markdown
Contributor

@jhadvig: This pull request references CONSOLE-5293 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "5.0.0" version, but no target version was set.

Details

In response to this:

Analysis / Root cause:

The downloads deployment currently uses the cli-artifacts image and runs an inline Python HTTP server script to serve CLI binaries. This approach is being replaced by a dedicated console-downloads image
(openshift/console Dockerfile.downloads) that contains a purpose-built Golang HTTP server with its own entrypoint, making the inline Python
script unnecessary.

Jira: https://redhat.atlassian.net/browse/CONSOLE-5293

Solution description:

  1. manifests/07-operator.yaml and manifests/07-operator-ibm-cloud-managed.yaml — Updated the DOWNLOADS_IMAGE env var from registry.svc.ci.openshift.org/openshift:cli-artifacts to
    registry.svc.ci.openshift.org/openshift:console-downloads.
  2. bindata/assets/deployments/downloads-deployment.yaml — Removed the inline Python HTTP server script (command, args), the /tmp volumeMount, and the tmp emptyDir volume. The new
    console-downloads image has its own entrypoint (/opt/downloads/downloads --config-path=/opt/downloads/defaultArtifactsConfig.yaml), so no custom command/args are needed.

No Go code changes were required — the operator reads the deployment YAML from bindata and sets the image from the DOWNLOADS_IMAGE env var, which continues to work as before.

Test setup:

The console-downloads image must be present in the release payload. Ensure the image is built and available via the CI config in openshift/release.

Test cases:

  • Verify the downloads deployment starts successfully with the new console-downloads image
  • Verify the downloads page at https://downloads-openshift-console.apps.<cluster>/ serves CLI binaries correctly
  • Verify oc download links for all architectures (amd64, arm64, ppc64le, s390x) and platforms (linux, mac, windows) are functional
  • Verify the liveness and readiness probes pass on port 8080
  • Verify the operator reconciles correctly after a fresh install
  • Verify the operator reconciles correctly on upgrade from a version using cli-artifacts

Needs to be tested with openshift/console#16455

Browser conformance:

  • Chrome
  • Firefox
  • Safari (or Epiphany on Linux)

N/A — this is a backend/operator change with no UI modifications. Downloads page was verified accessible via Chrome.

Additional info:

This is a net deletion of ~200 lines of inline Python. The new Golang-based downloads server in the console-downloads image provides the same functionality with better performance and maintainability.

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

coderabbitai Bot commented May 15, 2026

Copy link
Copy Markdown

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

Walkthrough

The pull request migrates the OpenShift console downloads service from a Python-based HTTP server (cli-artifacts image) to a compiled downloads binary (console-downloads image). The downloads Deployment is updated to directly invoke the binary with a config path, both operator manifests are updated to reference the new image, and test expectations are updated to match the new startup structure.

Changes

Downloads Service Migration

Layer / File(s) Summary
Downloads Deployment binary startup
bindata/assets/deployments/downloads-deployment.yaml
The downloads container startup is refactored to run /opt/downloads/downloads --config-path=/opt/downloads/defaultArtifactsConfig.yaml directly, removing the embedded shell script that previously generated /tmp/serve.py and ran a Python HTTP server. The /tmp emptyDir volume mount and security context remain unchanged.
Operator console-downloads image configuration
manifests/07-operator.yaml, manifests/07-operator-ibm-cloud-managed.yaml
Both operator manifests update the DOWNLOADS_IMAGE environment variable from openshift:cli-artifacts to openshift:console-downloads, aligning with the new binary-based service image.
Test expectations for deployment startup
pkg/console/subresource/deployment/deployment_test.go
TestDefaultDownloadsDeployment expectations are updated to match the new container Command and Args for the downloads binary invocation, with resource requests remaining unchanged.

🎯 2 (Simple) | ⏱️ ~8 minutes

🚥 Pre-merge checks | ✅ 14 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (14 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: replacing the cli-artifacts image with console-downloads image, which is the primary objective of this pull request.
Description check ✅ Passed The description provides comprehensive coverage including analysis, solution details, test setup, test cases, browser conformance, and additional context. All required sections are completed with relevant information.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Stable And Deterministic Test Names ✅ Passed This repository uses standard Go testing (func Test* with t.Run), not Ginkgo. The PR modifies test expectations in deployment_test.go with stable subtest names like "Test Downloads Deployment for S...
Test Structure And Quality ✅ Passed PR contains no Ginkgo tests; all tests use standard Go testing (func TestXXX(t *testing.T) pattern). Custom check is specifically for Ginkgo tests and is not applicable.
Microshift Test Compatibility ✅ Passed This PR does not add new Ginkgo e2e tests. All test files use standard Go testing package, not Ginkgo framework. The custom check for MicroShift compatibility is designed for Ginkgo e2e tests and i...
Single Node Openshift (Sno) Test Compatibility ✅ Passed No new Ginkgo e2e tests added. The new test/e2e/downloads_test.go is a standard Go test (func TestDownloadsEndpoint) that only verifies HTTP endpoints are accessible via routes/services; it makes n...
Topology-Aware Scheduling Compatibility ✅ Passed The PR only updates the downloads image and removes inline Python scripts; it does not introduce any new scheduling constraints. The existing topology-aware scheduling logic (replicas, anti-affinit...
Ote Binary Stdout Contract ✅ Passed PR contains only YAML configuration changes and test expectation updates; no process-level code modifications that could violate the OTE Binary Stdout Contract.
Ipv6 And Disconnected Network Test Compatibility ✅ Passed No new Ginkgo e2e tests were added in this PR. Changes are limited to Kubernetes manifests and updating unit test expectations in a standard Go test file (using testing.T, not Ginkgo).
No-Weak-Crypto ✅ Passed PR contains only YAML configuration and test updates; no weak crypto (MD5, SHA1, DES, RC4, 3DES, Blowfish, ECB), custom crypto, or insecure secret comparisons are present.
Container-Privileges ✅ Passed All Kubernetes manifests maintain restrictive security contexts: allowPrivilegeEscalation is false, readOnlyRootFilesystem is true, capabilities only drop (no adds), runAsNonRoot is enabled, and no...
No-Sensitive-Data-In-Logs ✅ Passed No sensitive data (passwords, tokens, API keys, PII, session IDs, or credentials) is exposed in logs or commands. The new args field contains only a configuration file path, and environment variabl...

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@openshift-ci
openshift-ci Bot requested review from TheRealJon and spadgett May 15, 2026 17:38
@openshift-ci openshift-ci Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 15, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 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 `@bindata/assets/deployments/Untitled`:
- Line 1: Delete the stray asset file named "Untitled" that contains only the
token "readOnlyRootFilesystem" from the assets/deployments bundle; remove it
from the repository and any asset-generation lists so it won't be packaged into
bindata, and if the readOnlyRootFilesystem setting was intended for a real
deployment manifest, move that key into the proper deployment YAML (not the
"Untitled" stub).
🪄 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: 07e1b599-077b-438b-adb5-324ed8e45c96

📥 Commits

Reviewing files that changed from the base of the PR and between ee0e804 and 2e562b9.

📒 Files selected for processing (4)
  • bindata/assets/deployments/Untitled
  • bindata/assets/deployments/downloads-deployment.yaml
  • manifests/07-operator-ibm-cloud-managed.yaml
  • manifests/07-operator.yaml
📜 Review details
🧰 Additional context used
📓 Path-based instructions (2)
manifests/**/*.yaml

⚙️ CodeRabbit configuration file

manifests/**/*.yaml: Review CVO manifests carefully.
These are deployed to clusters and changes have wide impact.

Files:

  • manifests/07-operator-ibm-cloud-managed.yaml
  • manifests/07-operator.yaml
bindata/assets/**/*.yaml

⚙️ CodeRabbit configuration file

bindata/assets/**/*.yaml: Review YAML assets for Kubernetes resource correctness.
Ensure proper annotations for cluster profiles.

Files:

  • bindata/assets/deployments/downloads-deployment.yaml
🔀 Multi-repo context openshift/console

[::openshift/console::] README.md — references the origin-cli-artifacts image and oc binaries from quay.io/repository/openshift/origin-cli-artifacts (match at README.md:443 and README.md:463).

[::openshift/console::] Dockerfile.downloads — builds FROM quay.io/openshift/origin-cli-artifacts:4.18 and labels image as "openshift,cli-artifacts" (matches at Dockerfile.downloads:1 and Dockerfile.downloads:36).

Note: manifests/ and bindata/ were not present in this checkout (shell reported "No such file or directory"), so I could not locate the exact deployment YAML files changed in the PR within this repository.

🔇 Additional comments (1)
bindata/assets/deployments/downloads-deployment.yaml (1)

51-54: LGTM!

Comment thread bindata/assets/deployments/Untitled Outdated
@@ -0,0 +1 @@
readOnlyRootFilesystem No newline at end of file

@coderabbitai coderabbitai Bot May 15, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Remove this stray file.

bindata/assets/deployments/Untitled is not valid deployment YAML and looks like an accidental editor artifact. Leaving it under the assets tree risks confusing future maintainers or being swept into asset generation by mistake.

🤖 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 `@bindata/assets/deployments/Untitled` at line 1, Delete the stray asset file
named "Untitled" that contains only the token "readOnlyRootFilesystem" from the
assets/deployments bundle; remove it from the repository and any
asset-generation lists so it won't be packaged into bindata, and if the
readOnlyRootFilesystem setting was intended for a real deployment manifest, move
that key into the proper deployment YAML (not the "Untitled" stub).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

+1

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

@TheRealJon, glad we're on the same page! Once the bindata/assets/deployments/Untitled file is removed from the PR, feel free to let me know and I'll mark this resolved.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 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 `@bindata/assets/deployments/downloads-deployment.yaml`:
- Around line 51-54: The deployment currently runs the downloads binary
(command: /opt/downloads/downloads) with a readOnlyRootFilesystem but lacks a
writable /tmp, causing the Go server's os.MkdirTemp("", "artifacts") to fail;
update the Downloads Deployment to add a volumeMount for /tmp (mountPath: /tmp)
in the container spec and add a corresponding emptyDir volume (name like tmp or
downloads-tmp) in the pod spec so the container has a writable /tmp when
readOnlyRootFilesystem is true.
🪄 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: 023cf83e-cb7f-47c2-b8e2-1271d4209157

📥 Commits

Reviewing files that changed from the base of the PR and between 2e562b9 and b427ee2.

⛔ Files ignored due to path filters (1)
  • pkg/console/subresource/deployment/deployment_test.go is excluded by !**/*_test.go
📒 Files selected for processing (4)
  • bindata/assets/deployments/Untitled
  • bindata/assets/deployments/downloads-deployment.yaml
  • manifests/07-operator-ibm-cloud-managed.yaml
  • manifests/07-operator.yaml
✅ Files skipped from review due to trivial changes (1)
  • manifests/07-operator-ibm-cloud-managed.yaml
🚧 Files skipped from review as they are similar to previous changes (1)
  • bindata/assets/deployments/Untitled
📜 Review details
🧰 Additional context used
📓 Path-based instructions (2)
manifests/**/*.yaml

⚙️ CodeRabbit configuration file

manifests/**/*.yaml: Review CVO manifests carefully.
These are deployed to clusters and changes have wide impact.

Files:

  • manifests/07-operator.yaml
bindata/assets/**/*.yaml

⚙️ CodeRabbit configuration file

bindata/assets/**/*.yaml: Review YAML assets for Kubernetes resource correctness.
Ensure proper annotations for cluster profiles.

Files:

  • bindata/assets/deployments/downloads-deployment.yaml
🔀 Multi-repo context openshift/console

[::openshift/console::] Dockerfile.downloads:1 — FROM quay.io/openshift/origin-cli-artifacts:4.18 (file shows image built-from still references origin-cli-artifacts).
[::openshift/console::] Dockerfile.downloads:36 — image label io.openshift.tags="openshift,cli-artifacts".
[::openshift/console::] README.md:443,463 — README documents that the server provides oc binaries from quay.io/repository/openshift/origin-cli-artifacts and notes origin-cli-artifacts usage for local builds.
[::openshift/console::] Dockerfile.downloads:20-21,28 — the repo already builds and bundles the Go downloads server binary (/opt/downloads/downloads) and defaultArtifactsConfig.yaml; Dockerfile.downloads CMD is "/opt/downloads/downloads --config-path=/opt/downloads/defaultArtifactsConfig.yaml".
[::openshift/console::] cmd/downloads/main.go & cmd/downloads/config/* — implementation of the Go downloads server and config generation present in-tree (server listens on configured port and serves the generated TempDir).

Summary: repository contains the Go downloads server and Dockerfile that builds an image from origin-cli-artifacts base; README also references origin-cli-artifacts. The PR switching operator manifests to use registry.svc.ci.openshift.org/openshift:console-downloads will require the console-downloads image to be produced/pushed (openshift/release) and reconciled with the existing Dockerfile.downloads / README references that still mention origin-cli-artifacts.

🔇 Additional comments (1)
manifests/07-operator.yaml (1)

72-73: LGTM!

Comment thread bindata/assets/deployments/downloads-deployment.yaml
@jhadvig

jhadvig commented May 18, 2026

Copy link
Copy Markdown
Member Author

/retest

@TheRealJon TheRealJon left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Just the stray file to remove, other than that it looks good!

Comment thread bindata/assets/deployments/Untitled Outdated
@@ -0,0 +1 @@
readOnlyRootFilesystem No newline at end of file

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

+1

@TheRealJon TheRealJon left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label May 27, 2026
@openshift-ci

openshift-ci Bot commented May 27, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jhadvig, TheRealJon

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@jhadvig

jhadvig commented Jun 17, 2026

Copy link
Copy Markdown
Member Author

/retest

@openshift-ci openshift-ci Bot removed the lgtm Indicates that a PR is ready to be merged. label Jun 18, 2026
@openshift-ci

openshift-ci Bot commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

New changes are detected. LGTM label has been removed.

Replace the cli-artifacts image with the new console-downloads image
for the downloads deployment. The new image contains a Golang HTTP
server with its own entrypoint, so the inline Python server script
and associated command/args/volumes are removed from the deployment
template.
The Go downloads server writes to /tmp/artifacts at startup
(readOnlyRootFilesystem is true), so a writable tmpfs is required.
@jhadvig

jhadvig commented Jun 23, 2026

Copy link
Copy Markdown
Member Author

/retest

1 similar comment
@TheRealJon

Copy link
Copy Markdown
Member

/retest

@jhadvig

jhadvig commented Aug 10, 2026

Copy link
Copy Markdown
Member Author

/retest

@openshift-ci

openshift-ci Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

@jhadvig: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/e2e-azure-ovn-upgrade 582d25b link true /test e2e-azure-ovn-upgrade
ci/prow/e2e-gcp-ovn 582d25b link true /test e2e-gcp-ovn

Full PR test history. Your PR dashboard.

Details

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 kubernetes-sigs/prow repository. I understand the commands that are listed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants