feat: Add grpc timeouts annotations (#11258)
* ✨ feat: add grpc timeouts with proxy settings if backend is grpc * 📝 docs: Documentation only changes * 🐛 fix: uppercase for protocol * 📝 docs: grpc timeouts example * 📝 docs: add links and default values for proxy timeout * 🧪 test: add e2e test for timeout * 🐛 fix: upgrade to 1.0.6 to fix nil pointer * 🐛 fix: lint * 🧪 test: trigger ci
This commit is contained in:
Anddd7
GitHub
parent
3b1908e206
commit
d0e9934789
8 changed files with 224 additions and 7 deletions
|
|
@ -22,11 +22,13 @@ import (
|
|||
"fmt"
|
||||
"strings"
|
||||
|
||||
delaypb "github.com/Anddd7/pb/grpcbin"
|
||||
pb "github.com/moul/pb/grpcbin/go-grpc"
|
||||
"github.com/onsi/ginkgo/v2"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"google.golang.org/grpc"
|
||||
"google.golang.org/grpc/credentials"
|
||||
"google.golang.org/grpc/credentials/insecure"
|
||||
"google.golang.org/grpc/metadata"
|
||||
corev1 "k8s.io/api/core/v1"
|
||||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||
|
|
@ -35,7 +37,10 @@ import (
|
|||
"k8s.io/ingress-nginx/test/e2e/framework"
|
||||
)
|
||||
|
||||
const echoHost = "echo"
|
||||
const (
|
||||
echoHost = "echo"
|
||||
host = "grpc"
|
||||
)
|
||||
|
||||
var _ = framework.DescribeAnnotation("backend-protocol - GRPC", func() {
|
||||
f := framework.NewDefaultFramework("grpc", framework.WithHTTPBunEnabled())
|
||||
|
|
@ -43,8 +48,6 @@ var _ = framework.DescribeAnnotation("backend-protocol - GRPC", func() {
|
|||
ginkgo.It("should use grpc_pass in the configuration file", func() {
|
||||
f.NewGRPCFortuneTellerDeployment()
|
||||
|
||||
host := "grpc"
|
||||
|
||||
annotations := map[string]string{
|
||||
"nginx.ingress.kubernetes.io/backend-protocol": "GRPC",
|
||||
}
|
||||
|
|
@ -259,4 +262,89 @@ var _ = framework.DescribeAnnotation("backend-protocol - GRPC", func() {
|
|||
metadata := res.GetMetadata()
|
||||
assert.Equal(ginkgo.GinkgoT(), metadata["content-type"].Values[0], "application/grpc")
|
||||
})
|
||||
|
||||
ginkgo.It("should return OK when request not exceed timeout", func() {
|
||||
f.NewGRPCBinDelayDeployment()
|
||||
|
||||
proxyTimeout := "10"
|
||||
ingressName := "grpcbin-delay"
|
||||
|
||||
annotations := make(map[string]string)
|
||||
annotations["nginx.ingress.kubernetes.io/backend-protocol"] = "GRPC"
|
||||
annotations["nginx.ingress.kubernetes.io/proxy-connect-timeout"] = proxyTimeout
|
||||
annotations["nginx.ingress.kubernetes.io/proxy-send-timeout"] = proxyTimeout
|
||||
annotations["nginx.ingress.kubernetes.io/proxy-read-timeout"] = proxyTimeout
|
||||
|
||||
ing := framework.NewSingleIngress(host, "/", host, f.Namespace, ingressName, 50051, annotations)
|
||||
|
||||
f.EnsureIngress(ing)
|
||||
|
||||
f.WaitForNginxServer(host,
|
||||
func(server string) bool {
|
||||
return strings.Contains(server, fmt.Sprintf("grpc_connect_timeout %ss;", proxyTimeout)) &&
|
||||
strings.Contains(server, fmt.Sprintf("grpc_send_timeout %ss;", proxyTimeout)) &&
|
||||
strings.Contains(server, fmt.Sprintf("grpc_read_timeout %ss;", proxyTimeout))
|
||||
})
|
||||
|
||||
conn, err := grpc.Dial(
|
||||
f.GetNginxIP()+":80",
|
||||
grpc.WithTransportCredentials(insecure.NewCredentials()),
|
||||
grpc.WithAuthority(host),
|
||||
)
|
||||
assert.Nil(ginkgo.GinkgoT(), err, "error creating a connection")
|
||||
defer conn.Close()
|
||||
|
||||
client := delaypb.NewGrpcbinServiceClient(conn)
|
||||
|
||||
res, err := client.Unary(context.Background(), &delaypb.UnaryRequest{
|
||||
Data: "hello",
|
||||
})
|
||||
assert.Nil(ginkgo.GinkgoT(), err)
|
||||
|
||||
metadata := res.GetResponseAttributes().RequestHeaders
|
||||
assert.Equal(ginkgo.GinkgoT(), metadata["content-type"], "application/grpc")
|
||||
assert.Equal(ginkgo.GinkgoT(), metadata[":authority"], host)
|
||||
})
|
||||
|
||||
ginkgo.It("should return Error when request exceed timeout", func() {
|
||||
f.NewGRPCBinDelayDeployment()
|
||||
|
||||
proxyTimeout := "10"
|
||||
ingressName := "grpcbin-delay"
|
||||
|
||||
annotations := make(map[string]string)
|
||||
annotations["nginx.ingress.kubernetes.io/backend-protocol"] = "GRPC"
|
||||
annotations["nginx.ingress.kubernetes.io/proxy-connect-timeout"] = proxyTimeout
|
||||
annotations["nginx.ingress.kubernetes.io/proxy-send-timeout"] = proxyTimeout
|
||||
annotations["nginx.ingress.kubernetes.io/proxy-read-timeout"] = proxyTimeout
|
||||
|
||||
ing := framework.NewSingleIngress(host, "/", host, f.Namespace, ingressName, 50051, annotations)
|
||||
|
||||
f.EnsureIngress(ing)
|
||||
|
||||
f.WaitForNginxServer(host,
|
||||
func(server string) bool {
|
||||
return strings.Contains(server, fmt.Sprintf("grpc_connect_timeout %ss;", proxyTimeout)) &&
|
||||
strings.Contains(server, fmt.Sprintf("grpc_send_timeout %ss;", proxyTimeout)) &&
|
||||
strings.Contains(server, fmt.Sprintf("grpc_read_timeout %ss;", proxyTimeout))
|
||||
})
|
||||
|
||||
conn, err := grpc.Dial(
|
||||
f.GetNginxIP()+":80",
|
||||
grpc.WithTransportCredentials(insecure.NewCredentials()),
|
||||
grpc.WithAuthority(host),
|
||||
)
|
||||
assert.Nil(ginkgo.GinkgoT(), err, "error creating a connection")
|
||||
defer conn.Close()
|
||||
|
||||
client := delaypb.NewGrpcbinServiceClient(conn)
|
||||
|
||||
_, err = client.Unary(context.Background(), &delaypb.UnaryRequest{
|
||||
Data: "hello",
|
||||
RequestAttributes: &delaypb.RequestAttributes{
|
||||
Delay: 15,
|
||||
},
|
||||
})
|
||||
assert.Error(ginkgo.GinkgoT(), err)
|
||||
})
|
||||
})
|
||||
|
|
|
|||
109
test/e2e/framework/grpc_delay.go
Normal file
109
test/e2e/framework/grpc_delay.go
Normal file
|
|
@ -0,0 +1,109 @@
|
|||
/*
|
||||
Copyright 2024 The Kubernetes Authors.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
*/
|
||||
|
||||
package framework
|
||||
|
||||
import (
|
||||
"github.com/onsi/ginkgo/v2"
|
||||
"github.com/stretchr/testify/assert"
|
||||
appsv1 "k8s.io/api/apps/v1"
|
||||
corev1 "k8s.io/api/core/v1"
|
||||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||
"k8s.io/apimachinery/pkg/fields"
|
||||
"k8s.io/apimachinery/pkg/util/intstr"
|
||||
)
|
||||
|
||||
// NewGRPCBinDelayDeployment creates a new single replica
|
||||
// deployment of the grpcbin image in a particular namespace
|
||||
func (f *Framework) NewGRPCBinDelayDeployment() {
|
||||
f.NewNewGRPCBinDelayDeploymentWithReplicas(1)
|
||||
}
|
||||
|
||||
// NewNewGRPCBinDelayDeploymentWithReplicas creates a new deployment of the
|
||||
// grpcbin image in a particular namespace. Number of replicas is configurable
|
||||
func (f *Framework) NewNewGRPCBinDelayDeploymentWithReplicas(replicas int32) {
|
||||
name := "grpcbin-delay"
|
||||
|
||||
deployment := &appsv1.Deployment{
|
||||
ObjectMeta: metav1.ObjectMeta{
|
||||
Name: name,
|
||||
Namespace: f.Namespace,
|
||||
},
|
||||
Spec: appsv1.DeploymentSpec{
|
||||
Replicas: NewInt32(replicas),
|
||||
Selector: &metav1.LabelSelector{
|
||||
MatchLabels: map[string]string{
|
||||
"app": name,
|
||||
},
|
||||
},
|
||||
Template: corev1.PodTemplateSpec{
|
||||
ObjectMeta: metav1.ObjectMeta{
|
||||
Labels: map[string]string{
|
||||
"app": name,
|
||||
},
|
||||
},
|
||||
Spec: corev1.PodSpec{
|
||||
TerminationGracePeriodSeconds: NewInt64(0),
|
||||
Containers: []corev1.Container{
|
||||
{
|
||||
Name: name,
|
||||
Image: "ghcr.io/anddd7/grpcbin:v1.0.6",
|
||||
Env: []corev1.EnvVar{},
|
||||
Ports: []corev1.ContainerPort{
|
||||
{
|
||||
Name: "grpc",
|
||||
ContainerPort: 50051,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
d := f.EnsureDeployment(deployment)
|
||||
|
||||
err := waitForPodsReady(f.KubeClientSet, DefaultTimeout, int(replicas), f.Namespace, &metav1.ListOptions{
|
||||
LabelSelector: fields.SelectorFromSet(fields.Set(d.Spec.Template.ObjectMeta.Labels)).String(),
|
||||
})
|
||||
assert.Nil(ginkgo.GinkgoT(), err, "failed to wait for to become ready")
|
||||
|
||||
service := &corev1.Service{
|
||||
ObjectMeta: metav1.ObjectMeta{
|
||||
Name: name,
|
||||
Namespace: f.Namespace,
|
||||
},
|
||||
Spec: corev1.ServiceSpec{
|
||||
Ports: []corev1.ServicePort{
|
||||
{
|
||||
Name: "grpc",
|
||||
Port: 50051,
|
||||
TargetPort: intstr.FromInt(50051),
|
||||
Protocol: "TCP",
|
||||
},
|
||||
},
|
||||
Selector: map[string]string{
|
||||
"app": name,
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
f.EnsureService(service)
|
||||
|
||||
err = WaitForEndpoints(f.KubeClientSet, DefaultTimeout, name, f.Namespace, int(replicas))
|
||||
assert.Nil(ginkgo.GinkgoT(), err, "waiting for endpoints to become ready")
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue