Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

clean up openshift-sdn references in the API #1981

Merged
merged 3 commits into from
Aug 21, 2024

Conversation

danwinship
Copy link
Contributor

  • config.openshift.io:
    • Belatedly update a few places to now say that the default plugin is OVNKubernetes, not OpenShiftSDN.
    • Clarify the docs on NetworkMigration to make it clear that it is used for status, not spec.
  • operator.openshift.io:
    • Remove references to OpenShift SDN being a supported network type.
    • Mark OpenShiftSDNConfig as deprecated.
    • Belatedly remove the comment claiming that OVNKubernetes is not supported. 😬
    • Clarify that NetworkType migration is no longer supported by current versions of OpenShift, and so setting the associated fields will result in CNO rejecting the configuration.
  • network.openshift.io
    • Deprecate all the (OpenShift-SDN-only) types.

Note that all of the network.openshift.io types are now neither read from nor written to by any OCP component. In theory, users might be using them for their own purposes for unknown reasons not related to openshift-sdn, but other than that there's no reason to not just remove those types completely. (Though this PR does not do that.)

@openshift-ci-robot
Copy link

openshift-ci-robot commented Jul 31, 2024

@danwinship: This pull request references SDN-4900 which is a valid jira issue.

In response to this:

  • config.openshift.io:
  • Belatedly update a few places to now say that the default plugin is OVNKubernetes, not OpenShiftSDN.
  • Clarify the docs on NetworkMigration to make it clear that it is used for status, not spec.
  • operator.openshift.io:
  • Remove references to OpenShift SDN being a supported network type.
  • Mark OpenShiftSDNConfig as deprecated.
  • Belatedly remove the comment claiming that OVNKubernetes is not supported. 😬
  • Clarify that NetworkType migration is no longer supported by current versions of OpenShift, and so setting the associated fields will result in CNO rejecting the configuration.
  • network.openshift.io
  • Deprecate all the (OpenShift-SDN-only) types.

Note that all of the network.openshift.io types are now neither read from nor written to by any OCP component. In theory, users might be using them for their own purposes for unknown reasons not related to openshift-sdn, but other than that there's no reason to not just remove those types completely. (Though this PR does not do that.)

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-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jul 31, 2024
Copy link
Contributor

openshift-ci bot commented Jul 31, 2024

Hello @danwinship! 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.

@openshift-ci openshift-ci bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 31, 2024
@openshift-ci openshift-ci bot requested review from knobunc and sjenning July 31, 2024 16:58
@@ -91,8 +91,8 @@ type NetworkSpec struct {
// deployKubeProxy specifies whether or not a standalone kube-proxy should
// be deployed by the operator. Some network providers include kube-proxy
// or similar functionality. If unset, the plugin will attempt to select
// the correct value, which is false when OpenShift SDN and ovn-kubernetes are
// used and true otherwise.
// the correct value, which is false when ovn-kubernetes is used and true
Copy link
Contributor

Choose a reason for hiding this comment

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

While we are here should we change ovn-kubernetes to OVNKubernetes?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OVNKubernetes with no hyphen and no space is generally only used as a value in the API, whereas we're talking about the plugin itself here really, so ovn-kubernetes (or OVN-Kubernetes or OVN Kubernetes seems correct)

Copy link
Contributor

Choose a reason for hiding this comment

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

I think the name BU prefers in all documentation is OVN Kubernetes. cc @mcurry-rh.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The existing API documentation is inconsistent and this does not change it, so that can be fixed later.

@openshift-ci openshift-ci bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 5, 2024
@openshift-merge-robot openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 8, 2024
@openshift-merge-robot openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 9, 2024
@openshift-ci openshift-ci bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Aug 9, 2024
@danwinship
Copy link
Contributor Author

@kyrtapz can you re-review?

@kyrtapz
Copy link
Contributor

kyrtapz commented Aug 19, 2024

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Aug 19, 2024
@danwinship
Copy link
Contributor Author

/assign knobunc

@knobunc
Copy link
Contributor

knobunc commented Aug 19, 2024

/approve

Copy link
Contributor

openshift-ci bot commented Aug 19, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: danwinship, knobunc, kyrtapz

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:

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 Aug 19, 2024
@openshift-ci-robot
Copy link

/retest-required

Remaining retests: 0 against base HEAD 2c10e58 and 2 for PR HEAD 64e5a15 in total

@danwinship
Copy link
Contributor Author

/retest

1 similar comment
@danwinship
Copy link
Contributor Author

/retest

Copy link
Contributor

openshift-ci bot commented Aug 20, 2024

@danwinship: The following test 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-upgrade-minor 64e5a15 link true /test e2e-upgrade-minor

Full PR test history. Your PR dashboard.

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.

@danwinship danwinship changed the title SDN-4900: clean up openshift-sdn references in the API clean up openshift-sdn references in the API Aug 21, 2024
@openshift-ci-robot
Copy link

@danwinship: No Jira issue is referenced in the title of this pull request.
To reference a jira issue, add 'XYZ-NNN:' to the title of this pull request and request another refresh with /jira refresh.

In response to this:

  • config.openshift.io:
  • Belatedly update a few places to now say that the default plugin is OVNKubernetes, not OpenShiftSDN.
  • Clarify the docs on NetworkMigration to make it clear that it is used for status, not spec.
  • operator.openshift.io:
  • Remove references to OpenShift SDN being a supported network type.
  • Mark OpenShiftSDNConfig as deprecated.
  • Belatedly remove the comment claiming that OVNKubernetes is not supported. 😬
  • Clarify that NetworkType migration is no longer supported by current versions of OpenShift, and so setting the associated fields will result in CNO rejecting the configuration.
  • network.openshift.io
  • Deprecate all the (OpenShift-SDN-only) types.

Note that all of the network.openshift.io types are now neither read from nor written to by any OCP component. In theory, users might be using them for their own purposes for unknown reasons not related to openshift-sdn, but other than that there's no reason to not just remove those types completely. (Though this PR does not do that.)

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-ci-robot openshift-ci-robot removed the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Aug 21, 2024
@knobunc
Copy link
Contributor

knobunc commented Aug 21, 2024

/override ci/prow/minor-e2e-upgrade-minor

Copy link
Contributor

openshift-ci bot commented Aug 21, 2024

@knobunc: Overrode contexts on behalf of knobunc: ci/prow/minor-e2e-upgrade-minor

In response to this:

/override ci/prow/minor-e2e-upgrade-minor

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.

@openshift-merge-bot openshift-merge-bot bot merged commit 566edf3 into openshift:master Aug 21, 2024
20 checks passed
@danwinship danwinship deleted the drop-sdn branch August 21, 2024 16:20
@openshift-bot
Copy link

[ART PR BUILD NOTIFIER]

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

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. lgtm Indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants