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

feat(#3097): propagate translation failures for missing service's referred client-cert #3137

Merged
merged 3 commits into from
Nov 7, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,8 @@ Adding a new version? You'll need three changes:
[#3125](https://github.com/Kong/kubernetes-ingress-controller/pull/3125)
- Warning events are recorded when annotations in services backing a single route do not match.
[#3130](https://github.com/Kong/kubernetes-ingress-controller/pull/3130)
- Warning events are recorded when a service's referred client-cert does not exist.
[#3137](https://github.com/Kong/kubernetes-ingress-controller/pull/3137)
- CRDs' validations improvements: `UDPIngressRule.Port`, `IngressRule.Port` and `IngressBackend.ServiceName`
instead of being validated in the Parser, are validated by the Kubernetes API now.
[#3136](https://github.com/Kong/kubernetes-ingress-controller/pull/3136)
Expand Down
20 changes: 10 additions & 10 deletions internal/dataplane/parser/ingressrules.go
Original file line number Diff line number Diff line change
Expand Up @@ -73,21 +73,21 @@ func (ir *ingressRules) populateServices(log logrus.FieldLogger, s store.Storer,
// extract client certificates intended for use by the service
secretName := annotations.ExtractClientCertificate(k8sService.Annotations)
if secretName != "" {
secret, err := s.GetSecret(k8sService.Namespace, secretName)
secretKey := k8sService.Namespace + "/" + secretName
secret, err := s.GetSecret(k8sService.Namespace, secretName)
if err != nil {
failuresCollector.PushTranslationFailure(
fmt.Sprintf("failed to fetch secret '%s': %v", secretKey, err), k8sService,
pmalek marked this conversation as resolved.
Show resolved Hide resolved
)
continue
}

// ensure that the cert is loaded into Kong
if _, ok := ir.SecretNameToSNIs[secretKey]; !ok {
ir.SecretNameToSNIs[secretKey] = []string{}
}
if err == nil {
service.ClientCertificate = &kong.Certificate{
ID: kong.String(string(secret.UID)),
}
} else {
log.WithFields(logrus.Fields{
"secret_name": secretName,
"secret_namespace": k8sService.Namespace,
}).Errorf("failed to fetch secret: %v", err)
service.ClientCertificate = &kong.Certificate{
ID: kong.String(string(secret.UID)),
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions internal/dataplane/parser/parser_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1142,7 +1142,7 @@ func TestServiceClientCertificate(t *testing.T) {
assert.Nil(err)
p := mustNewParser(t, store)
state, translationFailures := p.Build()
require.Empty(t, translationFailures)
require.Len(t, translationFailures, 1)
assert.NotNil(state)
assert.Equal(0, len(state.Certificates),
"expected no certificates to be rendered")
Expand Down Expand Up @@ -2856,7 +2856,7 @@ func TestDefaultBackend(t *testing.T) {
assert.Nil(err)
p := mustNewParser(t, store)
state, translationFailures := p.Build()
require.Empty(t, translationFailures)
require.Len(t, translationFailures, 1)
assert.NotNil(state)
assert.Equal(0, len(state.Certificates),
"expected no certificates to be rendered")
Expand Down
68 changes: 68 additions & 0 deletions test/integration/translation_failures_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import (
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
corev1 "k8s.io/api/core/v1"
netv1 "k8s.io/api/networking/v1"
v1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"sigs.k8s.io/controller-runtime/pkg/client"
Expand Down Expand Up @@ -115,6 +116,37 @@ func TestTranslationFailures(t *testing.T) {
return []client.Object{service2}
},
},
{
name: "missing client-cert for service",
translationFailureTrigger: func(t *testing.T, cleaner *clusters.Cleaner, ns string) []client.Object {
service := &corev1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: testutils.RandomName(testTranslationFailuresObjectsPrefix),
Annotations: map[string]string{
"konghq.com/client-cert": "not-existing-secret",
},
},
Spec: corev1.ServiceSpec{
Ports: []corev1.ServicePort{
{
Port: 80,
},
},
},
}
service, err := env.Cluster().Client().CoreV1().Services(ns).Create(ctx, service, metav1.CreateOptions{})
require.NoError(t, err)

_, err = env.Cluster().Client().NetworkingV1().Ingresses(ns).Create(
ctx,
ingressWithPathBackedByService(service),
metav1.CreateOptions{},
)
require.NoError(t, err)

return []client.Object{service}
},
},
}

for _, tt := range testCases {
Expand Down Expand Up @@ -265,3 +297,39 @@ func httpRouteWithBackends(gatewayName string, services ...*corev1.Service) *gat
},
}
}

func ingressWithPathBackedByService(service *corev1.Service) *netv1.Ingress {
pathType := netv1.PathTypePrefix
return &netv1.Ingress{
ObjectMeta: metav1.ObjectMeta{
Name: testutils.RandomName(testTranslationFailuresObjectsPrefix),
Annotations: map[string]string{
annotations.IngressClassKey: ingressClass,
},
},
Spec: netv1.IngressSpec{
Rules: []netv1.IngressRule{
{
IngressRuleValue: netv1.IngressRuleValue{
HTTP: &netv1.HTTPIngressRuleValue{
Paths: []netv1.HTTPIngressPath{
{
Path: "/",
PathType: &pathType,
Backend: netv1.IngressBackend{
Service: &netv1.IngressServiceBackend{
Name: service.Name,
Port: netv1.ServiceBackendPort{
Number: 80,
},
},
},
},
},
},
},
},
},
},
}
}