api: Introduce a v1alpha1 DirectResponseRoute CRD #9951
Conversation
This commit introduces a new v1alpha1 CRD that allows users to configure direct response functionality within the K8S Gateway API integration. Signed-off-by: timflannagan <timflannagan@gmail.com>
|
Issues linked to changelog: |
| @@ -0,0 +1,8 @@ | |||
| changelog: | |||
| - type: NON_USER_FACING | |||
There was a problem hiding this comment.
NON_USER_FACING since I was planning on implementing this functionality in a separate PR. I can implement this in the same PR if folks have a strong opinion.
| // | ||
| // +kubebuilder:validation:Optional | ||
| // | ||
| // TODO(tim): Make required? Add validation on length of body? |
There was a problem hiding this comment.
This is still an open question I'd like to get consensus on. I thought it was reasonable to make it optional via cel expressions when status code is a 403/404/etc.
There was a problem hiding this comment.
I also tested this locally:
$ kubectl apply -f - <<EOF
apiVersion: gateway.gloo.solo.io/v1alpha1
kind: DirectResponseRoute
metadata:
name: test
namespace: gloo-system
spec:
code: 200
EOF
The DirectResponseRoute "test" is invalid: spec: Invalid value: "object": The 'body' field is required when 'code' is a 2xx status code
$ kubectl apply -f - <<EOF
apiVersion: gateway.gloo.solo.io/v1alpha1
kind: DirectResponseRoute
metadata:
name: test
namespace: gloo-system
spec:
code: 403
EOF
directresponseroute.gateway.gloo.solo.io/test configured
| // TODO(tim): Do we need to add any status fields? If so, investigate how | ||
| // other APIs define status fields with the same pattern. | ||
| LastUpdated *metav1.Time `json:"lastUpdated,omitempty"` |
There was a problem hiding this comment.
TODO: still relevant that I wanted to crowd source on whether folks with more historical context can answer.
| // DirectResponseRouteSpec describes the desired state of a DirectResponseRoute. | ||
| // | ||
| // +kubebuilder:validation:XValidation:message="The 'body' field is required when 'code' is a 2xx status code",rule="self.code < 200 || self.code >= 300 || has(self.body)" | ||
| type DirectResponseRouteSpec struct { |
There was a problem hiding this comment.
I'm looking at the implementation and I'm wondering whether we should have an HTTPRoute targetRef field to make lookup easier? I was initially looking at implementing this as a route plugin.
|
Closing - I'll open a full feature PR since the implementation doesn't look too rough. |
Description
This commit introduces a new v1alpha1 CRD that allows users to configure direct response functionality within the K8S Gateway API integration.
Checklist: