Skip to content

Conversation

@danilo-gemoli
Copy link
Contributor

This is the preparatory work that ci-operator requires in order to run a small lease proxy server.

We are working on the intra-step leasing capability that will allow a step from the ci-operator step registry to acquire lease from boskos.
As of today, ci-operator acquire any leases required by a workflow and then run the test. With the new feature we are about to introduce, a step could also do that by sending requests to ci-operator that will, in turn, forward them to boskos.

A typical scenario looks like so:

  1. ci-operator is supposed to run the e2e-aws-ovn test:
- as: e2e-aws-ovn
  skip_if_only_changed: (^(docs|upi|hack)/)|((^|/)OWNERS(_ALIASES)?$)|((^|/)[A-Z]+\.md$)|(^images/(baremetal|libvirt|openstack))|(^cluster-api/providers/([^a]|a[^w]|aw[^s]).*/)|(/agent/)
  steps:
    cluster_profile: aws-4
    env:
      AWS_INSTALL_USE_MINIMAL_PERMISSIONS: "yes"
      USER_TAGS: |
        keyA valueA
        key2 value2
        keySpecial v@lu3-Special_.:/=+
        keyD valueD spaces
    workflow: openshift-e2e-aws
  1. The test uses a cluster_profile, therefore ci-operator runs a small HTTP server that acts as a lease proxy server, actually forwarding any requests to boskos.
  2. The workflow openshift-e2e-aws executes.
  3. Every step of the workflow has the CI_OPERATOR_POD_IP environment variable set, that it might uses to send requests to the proxy run by ci-operator.
  4. The ipi-install-install step runs and tries to acquire a lease from the proxy.
  5. ci-operator receives the request, forwards it to boskos and finally returns the result back to the ipi-install-install step.
ipi-install-install.sh step
|
HTTP POST `/acquire?type=aws-1-qe-quota-slice&count=1`
|
+----> lease-proxy-server run by `ci-operator`
          |
          HTTP POST `/acquire?type=aws-1-qe-quota-slice&count=1`
          |
          +----> `boskos`

@openshift-ci-robot
Copy link
Contributor

Pipeline controller notification
This repo is configured to use the pipeline controller. Second-stage tests will be triggered either automatically or after lgtm label is added, depending on the repository configuration. The pipeline controller will automatically detect which contexts are required and will utilize /test Prow commands to trigger the second stage.

For optional jobs, comment /test ? to see a list of all defined jobs. To trigger manually all jobs from second stage use /pipeline required command.

This repository is configured in: automatic mode

@coderabbitai
Copy link

coderabbitai bot commented Dec 22, 2025

Walkthrough

The changes introduce a lease-proxy server capability by adding a new constant for port 8082, a new PodSpecMutator function to configure the proxy in pod specifications, and updating the test builder and fixtures to include this configuration.

Changes

Cohort / File(s) Summary
Constants
pkg/api/constant.go
Added new exported constant LeaseProxyServerPort set to 8082
Pod Spec Configuration
pkg/prowgen/podspec.go
Added helper function addPort() for appending named ports to containers; introduced environment variable leaseProxyServerEnv for Pod IP propagation; defined new exported LeaseProxyServer() PodSpecMutator to configure lease-proxy endpoint and inject Pod IP environment variable
Test Builder
pkg/prowgen/jobbase.go
Updated NewProwJobBaseBuilderForTest to include LeaseProxyServer() call in PodSpec when cluster profile is present for multi-stage test configurations
Test Fixtures
pkg/prowgen/testdata/zz_fixture_...yaml
Updated fixture to include new CI_OPERATOR_POD_IP environment variable and port 8082 named lease-proxy in container spec

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Additional attention points:
    • Verify the port 8082 choice aligns with other infrastructure ports
    • Confirm CI_OPERATOR_POD_IP environment variable sourcing mechanism is correct
    • Validate test fixture updates match the expected PodSpec configuration
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

@openshift-ci openshift-ci bot requested review from jmguzik and liangxia December 22, 2025 13:27
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Dec 22, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: danilo-gemoli

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

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 22, 2025
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
pkg/prowgen/podspec.go (1)

184-189: Consider adding duplicate check for consistency.

The addPort helper always appends without checking for existing ports, unlike similar helpers (addEnvVar, addVolume, addVolumeMount) which prevent duplicates. While not an issue with current usage, adding a duplicate check would maintain consistency with the established pattern in this file.

🔎 Optional: Add duplicate port check
 func addPort(c *corev1.Container, name string, port int32) {
+	for _, p := range c.Ports {
+		if p.Name == name && p.ContainerPort == port {
+			return
+		}
+	}
 	c.Ports = append(c.Ports, corev1.ContainerPort{
 		Name:          name,
 		ContainerPort: port,
 	})
 }
📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Cache: Disabled due to data retention organization setting

Knowledge base: Disabled due to Reviews -> Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between 9dfdb9e and c12dd13.

📒 Files selected for processing (4)
  • pkg/api/constant.go
  • pkg/prowgen/jobbase.go
  • pkg/prowgen/podspec.go
  • pkg/prowgen/testdata/zz_fixture_TestNewProwJobBaseBuilderForTest_multi_stage_test_with_cluster_profile.yaml
🧰 Additional context used
📓 Path-based instructions (1)
**

⚙️ CodeRabbit configuration file

-Focus on major issues impacting performance, readability, maintainability and security. Avoid nitpicks and avoid verbosity.

Files:

  • pkg/api/constant.go
  • pkg/prowgen/jobbase.go
  • pkg/prowgen/podspec.go
  • pkg/prowgen/testdata/zz_fixture_TestNewProwJobBaseBuilderForTest_multi_stage_test_with_cluster_profile.yaml
🧬 Code graph analysis (2)
pkg/prowgen/jobbase.go (1)
pkg/prowgen/podspec.go (1)
  • LeaseProxyServer (498-504)
pkg/prowgen/podspec.go (1)
pkg/api/constant.go (1)
  • LeaseProxyServerPort (89-89)
🔇 Additional comments (7)
pkg/prowgen/testdata/zz_fixture_TestNewProwJobBaseBuilderForTest_multi_stage_test_with_cluster_profile.yaml (2)

19-23: LGTM!

The environment variable correctly uses the downward API to expose the Pod IP, which is necessary for test steps to locate the lease proxy server.


27-29: LGTM!

The container port configuration correctly exposes port 8082 as "lease-proxy", matching the constant defined in pkg/api/constant.go and used by the LeaseProxyServer() mutator.

pkg/api/constant.go (1)

88-89: LGTM!

The constant definition is clear, follows existing naming conventions, and centralizes the port configuration for the lease proxy server.

pkg/prowgen/jobbase.go (2)

149-149: LGTM!

The LeaseProxyServer() mutator is correctly added when a cluster profile is present, enabling ci-operator to run the lease proxy alongside the lease client configuration.


162-162: LGTM!

The LeaseProxyServer() mutator is consistently added for the MultiStageTestConfiguration case, ensuring both configuration paths have the same lease proxy functionality.

pkg/prowgen/podspec.go (2)

470-478: LGTM!

The environment variable correctly uses the Kubernetes downward API to expose the Pod's IP address, which test steps can use to connect to the lease proxy server.


498-504: LGTM!

The LeaseProxyServer mutator correctly configures the pod specification to expose the lease proxy port and inject the Pod IP environment variable, enabling intra-step leasing functionality.

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Dec 22, 2025

@danilo-gemoli: 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/integration c12dd13 link true /test integration
ci/prow/unit c12dd13 link true /test unit
ci/prow/breaking-changes c12dd13 link false /test breaking-changes
ci/prow/images c12dd13 link true /test images

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.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants