operator/ingress: Delete +optional marker on type #440
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Make the "type" field of the endpoint publishing strategy for an IngressController resource a required field. The "type" field is a union discriminator field, and the KEP for union types states that a union discriminator field "CAN be optional"[1]. The IngressController resource's "spec.endpointPublishingStrategy" field is optional, so if it is specified, then it is reasonable to expect an explicit value be specified for "spec.endpointPublishingStrategy.type", and the ingress operator will always set an explicit value for the "status.endpointPublishingStrategy.type" field. The ingress operator currently has a CRD that was generated using controller-tools v0.2.0-beta.1, which ignores the "+optional" marker, with the result that "spec.endpointPublishingStrategy.type" is required[2]. controller-tools v0.2.0-beta.3 and newer respects the "+optional" marker[3], with the result that regenerating the CRD with the current API would cause the field to become no longer required. Because the current CRD specifies the field to be required, it is safe to remove the "+optional" marker now so that the field will continue to be required when the CRD is regenerated using newer controller-tools. 1. https://github.com/kubernetes/enhancements/blob/master/keps/sig-api-machinery/20190325-unions.md#go-tags 2. openshift/cluster-ingress-operator@b32cee9#diff-1b0497d8867a90088e4614b2e61dc496R40 3. kubernetes-sigs/controller-tools@fcf4205 * operator/v1/types_ingress.go (EndpointPublishingStrategy): Remove the "+optional" marker on the "type" field.
openshift-ci-robot
added
the
size/XS
1 task
Contributor
|
/approve @sttts PTAL, thanks for your help with these. |
Contributor
|
/lgtm |
Contributor
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: ironcladlou, Miciah, sttts The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci-robot
added
the
approved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Make the
typefield of the endpoint publishing strategy for an IngressController resource a required field.The
typefield is a union discriminator field, and the KEP for union types states that a union discriminator field "CAN be optional". The IngressController resource'sspec.endpointPublishingStrategyfield is optional, so if it is specified, then it is reasonable to expect an explicit value be specified forspec.endpointPublishingStrategy.type, and the ingress operator will always set an explicit value for thestatus.endpointPublishingStrategy.typefield.The ingress operator currently has a CRD that was generated using controller-tools v0.2.0-beta.1, which ignores the
+optionalmarker, with the result thatspec.endpointPublishingStrategy.typeis required. controller-tools v0.2.0-beta.3 and newer respects the+optionalmarker (kubernetes-sigs/controller-tools@fcf4205), with the result that regenerating the CRD with the current API would cause the field to become no longer required. Because the current CRD specifies the field to be required, it is safe to remove the+optionalmarker now so that the field will continue to be required when the CRD is regenerated using newer controller-tools.operator/v1/types_ingress.go(EndpointPublishingStrategy): Remove the+optionalmarker on thetypefield.