search

openshift / api

Canonical location of the OpenShift API definition.
http://www.openshift.org
Apache License 2.0
94 stars 517 forks source link

RFE-6242: ingress: rename loadBalancerIP to floatingIP #2051

Closed EmilienM closed 1 month ago

EmilienM commented 1 month ago

This was poorly named and this hasn't been used anywhere so we can make the change while it's still time.

Also add CEL validation to make sure the field is only used for external LB (and add tests).

openshift-ci-robot commented 1 month ago

@EmilienM: This pull request references RFE-6242 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 feature request to target the "4.18.0" version, but no target version was set.

In response to [this](https://github.com/openshift/api/pull/2051): >This was poorly named and this hasn't been used anywhere so we can make >the change while it's still time. > Instructions for interacting with me using PR comments are available [here](https://prow.ci.openshift.org/command-help?repo=openshift%2Fapi). If you have questions or suggestions related to my behavior, please file an issue against the [openshift-eng/jira-lifecycle-plugin](https://github.com/openshift-eng/jira-lifecycle-plugin/issues/new) repository.
openshift-ci[bot] commented 1 month ago

Hello @EmilienM! Some important instructions when contributing to openshift/api: API design plays an important part in the user experience of OpenShift and as such API PRs are subject to a high level of scrutiny to ensure they follow our best practices. If you haven't already done so, please review the OpenShift API Conventions and ensure that your proposed changes are compliant. Following these conventions will help expedite the api review process for your PR.

EmilienM commented 1 month ago

/hold cc @Miciah for information. Feel free to tag your team. @mdbooth let me know if we want to make it explicit that it's for external scope LBs

CPO makes it explicit that it's for external LB:

https://github.com/kubernetes/cloud-provider-openstack/blob/333a126f63038d52fad1e306eff6ee4ef7f53948/pkg/openstack/loadbalancer.go#L624-L625

EmilienM commented 1 month ago

/test verify-crd-schema

Miciah commented 1 month ago

/assign

EmilienM commented 1 month ago

I need to run something like: /override verify-crd-schema

Because we are violating API validations since this change is not backward compatible. cc @JoelSpeed for review on that one.

openshift-ci[bot] commented 1 month ago

@EmilienM: EmilienM unauthorized: /override is restricted to Repo administrators, approvers in top level OWNERS file, and the following github teams:openshift: openshift-release-oversight openshift-staff-engineers.

In response to [this](https://github.com/openshift/api/pull/2051#issuecomment-2389107789): >I need to run something like: >/override verify-crd-schema > >Because we are violating API validations since this change is not backward compatible. >cc @JoelSpeed for review on that one. Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.
JoelSpeed commented 1 month ago

@EmilienM Is this the one that literally just merged?

Now that it's merged, renaming it means you have to create a tombstone, a marker that shows for ever what the field name was and what its type was, so that we never re-use it.

Out of interest, why is floatingIP a better name?

EmilienM commented 1 month ago

@EmilienM Is this the one that literally just merged?

Yes... :'(

Now that it's merged, renaming it means you have to create a tombstone, a marker that shows for ever what the field name was and what its type was, so that we never re-use it.

ok

Out of interest, why is floatingIP a better name?

Discussion: https://redhat-internal.slack.com/archives/CH98TDJUD/p1727796033056959

JoelSpeed commented 1 month ago

/approve /assign @Miciah

/override ci/prow/verify-crd-schema

Removing a field that is in a tech preview struct and never really saw the light of day, field is tombstoned to prevent us from re-introducing as a different serialisation in the future

openshift-ci[bot] commented 1 month ago

@JoelSpeed: Overrode contexts on behalf of JoelSpeed: ci/prow/verify-crd-schema

In response to [this](https://github.com/openshift/api/pull/2051#issuecomment-2390968240): >/approve >/assign @Miciah > >/override ci/prow/verify-crd-schema > >Removing a field that is in a tech preview struct and never really saw the light of day, field is tombstoned to prevent us from re-introducing as a different serialisation in the future Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.
JoelSpeed commented 1 month ago

/approve cancel

Some back and forth still happening about this it seems

EmilienM commented 1 month ago

/hold cancel

openshift-ci-robot commented 1 month ago

@EmilienM: This pull request references RFE-6242 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 feature request to target the "4.18.0" version, but no target version was set.

In response to [this](https://github.com/openshift/api/pull/2051): >This was poorly named and this hasn't been used anywhere so we can make >the change while it's still time. > >Also add CEL validation to make sure the field is only used for external >LB (and add tests). Instructions for interacting with me using PR comments are available [here](https://prow.ci.openshift.org/command-help?repo=openshift%2Fapi). If you have questions or suggestions related to my behavior, please file an issue against the [openshift-eng/jira-lifecycle-plugin](https://github.com/openshift-eng/jira-lifecycle-plugin/issues/new) repository.
EmilienM commented 1 month ago

@Miciah thanks for the quick review. I think I addressed everything.

Miciah commented 1 month ago

Thanks! /lgtm

Miciah commented 1 month ago

verify-crd-schema is failing with a bunch of loadBalancerIP may not be removed errors. I don't know if that's something @JoelSpeed would override since we have the tombstone, or whether something needs to be changed in the PR itself.

Miciah commented 1 month ago

Oh, sorry, I see https://github.com/openshift/api/pull/2051#issuecomment-2390968240 now. We just need the same /override again since you pushed changes.

JoelSpeed commented 1 month ago

/override ci/prow/verify-crd-schema /lgtm

openshift-ci[bot] commented 1 month ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: EmilienM, JoelSpeed, Miciah

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

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/openshift/api/blob/master/OWNERS)~~ [JoelSpeed] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
openshift-ci[bot] commented 1 month ago

@JoelSpeed: Overrode contexts on behalf of JoelSpeed: ci/prow/verify-crd-schema

In response to [this](https://github.com/openshift/api/pull/2051#issuecomment-2393255844): >/override ci/prow/verify-crd-schema >/lgtm Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.
openshift-ci[bot] commented 1 month ago

@EmilienM: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository. I understand the commands that are listed [here](https://go.k8s.io/bot-commands).
openshift-bot commented 1 month ago

[ART PR BUILD NOTIFIER]

Distgit: ose-cluster-config-api This PR has been included in build ose-cluster-config-api-container-v4.18.0-202410041311.p0.gb1f700b.assembly.stream.el9. All builds following this will include this PR.