Skip to content

Conversation

@bharathbrat
Copy link

@bharathbrat bharathbrat commented Dec 14, 2025

What type of PR is this?
/kind feature

What this PR does / why we need it:

This code provides a safe, automated mechanism to install and upgrade Gateway API Custom Resource Definitions (CRDs) using Kubernetes Jobs. It enforces a strict
"standard-channel-only" policy to prevent accidental downgrades or channel conflicts (e.g., Experimental vs. Standard).

The solution offers three modes of operation:

  1. List: Reports the version and channel of all currently installed Gateway API CRDs.
  2. Upgrade Existing: Scans the cluster for installed CRDs and upgrades them if a newer version is requested.
  3. Install/Upgrade Subset: Installs or upgrades a specific list of CRDs defined by the user.

More details and test log in this document: https://docs.google.com/document/d/1th_QTfO6I7t7l1EVe7yppwtwyDSVO34RSd9_FBsC9Z4/edit?usp=sharing.

Which issue(s) this PR fixes:

Fixes #2678

Does this PR introduce a user-facing change?:

Gateway API CRD Installer: Safe CRD Upgrade Job

This release introduces a dedicated Kubernetes Job to safely manage the lifecycle of Gateway API CRDs. This tool addresses issues where bundling CRDs with Helm charts or other
  add-ons can lead to conflicts, downgrades, or unintended channel switching.

Key Features:
   * Safe Upgrades: Automatically upgrades CRDs to a target version only if the new version is strictly newer than the installed version.
   * Standard Channel Enforcement: Strictly enforces the standard release channel. Operations targeting experimental channels are blocked to prevent stability regressions.
   * Conflict Prevention: Detects and skips upgrades if a channel mismatch is found (e.g., attempting to upgrade a standard CRD with an experimental manifest).
   * Flexible Modes: Supports listing installed CRDs, upgrading all existing CRDs, or targeting a specific subset of CRDs for installation.

Usage: Users can build the provided Docker image and deploy the appropriate Job manifest (job-all.yaml, job-subset.yaml, or job-list.yaml) to perform the desired operation. See README.md for detailed instructions.

@k8s-ci-robot k8s-ci-robot added kind/feature Categorizes issue or PR as related to a new feature. release-note Denotes a PR that will be considered when it comes time to generate release notes. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. labels Dec 14, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: bharathbrat
Once this PR has been reviewed and has the lgtm label, please assign aojea for approval. For more information see the Code Review Process.

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

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

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Dec 14, 2025
@k8s-ci-robot
Copy link
Contributor

Welcome @bharathbrat!

It looks like this is your first PR to kubernetes-sigs/gateway-api 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/gateway-api has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Dec 14, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @bharathbrat. Thanks for your PR.

I'm waiting for a github.com member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

@bharathbrat bharathbrat marked this pull request as ready for review December 14, 2025 23:53
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Dec 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/feature Categorizes issue or PR as related to a new feature. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create a simple k8s job that can install or upgrade Gateway API CRDs

2 participants