Skip to content

Commit 96d8bbd

Browse files
gbonnefillegbonnefille
committed
feat: allow to configure specific annotations
1 parent e882eea commit 96d8bbd

File tree

4 files changed

+163
-20
lines changed

4 files changed

+163
-20
lines changed

‎apis/controller/v1alpha1/devworkspaceoperatorconfig_types.go

+5
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,11 @@ type RoutingConfig struct {
5757
// DevWorkspaces. However, changing the proxy configuration for the DevWorkspace Operator itself
5858
// requires restarting the controller deployment.
5959
ProxyConfig *Proxy `json:"proxyConfig,omitempty"`
60+
// Annotations defines the collection of annotations to add on the routing object.
61+
//
62+
// Use this property to set the annotations expected by the routing framework used
63+
// in your cluster (nginx, traefik, ...)
64+
Annotations map[string]string `json:"annotations,omitempty"`
6065
}
6166

6267
type Proxy struct {

‎controllers/controller/devworkspacerouting/solvers/basic_solver.go

+25-12
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,33 @@ import (
2222
"github.com/devfile/devworkspace-operator/pkg/infrastructure"
2323
)
2424

25-
var routeAnnotations = func(endpointName string) map[string]string {
26-
return map[string]string{
27-
"haproxy.router.openshift.io/rewrite-target": "/",
28-
constants.DevWorkspaceEndpointNameAnnotation: endpointName,
25+
func appendMap[K, V comparable](dst map[K]V, m map[K]V) {
26+
for k, v := range m {
27+
dst[k] = v
2928
}
3029
}
3130

32-
var nginxIngressAnnotations = func(endpointName string) map[string]string {
33-
return map[string]string{
34-
"kubernetes.io/ingress.class": "nginx",
35-
"nginx.ingress.kubernetes.io/rewrite-target": "/",
36-
"nginx.ingress.kubernetes.io/ssl-redirect": "false",
31+
var routeAnnotations = map[string]string{
32+
"haproxy.router.openshift.io/rewrite-target": "/",
33+
}
34+
35+
var nginxIngressAnnotations = map[string]string{
36+
"kubernetes.io/ingress.class": "nginx",
37+
"nginx.ingress.kubernetes.io/rewrite-target": "/",
38+
"nginx.ingress.kubernetes.io/ssl-redirect": "false",
39+
}
40+
41+
func createAnnotations(endpointName string, routingAnnotations map[string]string, defaultAnnotations map[string]string) map[string]string {
42+
annotations := map[string]string{
3743
constants.DevWorkspaceEndpointNameAnnotation: endpointName,
3844
}
45+
46+
if routingAnnotations == nil || len(routingAnnotations) == 0 {
47+
appendMap(annotations, defaultAnnotations)
48+
} else {
49+
appendMap(annotations, routingAnnotations)
50+
}
51+
return annotations
3952
}
4053

4154
// Basic solver exposes endpoints without any authentication
@@ -67,12 +80,12 @@ func (s *BasicSolver) GetSpecObjects(routing *controllerv1alpha1.DevWorkspaceRou
6780
services := getServicesForEndpoints(spec.Endpoints, workspaceMeta)
6881
services = append(services, GetDiscoverableServicesForEndpoints(spec.Endpoints, workspaceMeta)...)
6982
routingObjects.Services = services
83+
routingAnnotations := config.GetGlobalConfig().Routing.Annotations
7084
if infrastructure.IsOpenShift() {
71-
routingObjects.Routes = getRoutesForSpec(routingSuffix, spec.Endpoints, workspaceMeta)
85+
routingObjects.Routes = getRoutesForSpec(routingSuffix, spec.Endpoints, workspaceMeta, routingAnnotations)
7286
} else {
73-
routingObjects.Ingresses = getIngressesForSpec(routingSuffix, spec.Endpoints, workspaceMeta)
87+
routingObjects.Ingresses = getIngressesForSpec(routingSuffix, spec.Endpoints, workspaceMeta, routingAnnotations)
7488
}
75-
7689
return routingObjects, nil
7790
}
7891

‎controllers/controller/devworkspacerouting/solvers/common.go

+8-8
Original file line numberDiff line numberDiff line change
@@ -153,33 +153,33 @@ func getServicesForEndpoints(endpoints map[string]controllerv1alpha1.EndpointLis
153153
}
154154
}
155155

156-
func getRoutesForSpec(routingSuffix string, endpoints map[string]controllerv1alpha1.EndpointList, meta DevWorkspaceMetadata) []routeV1.Route {
156+
func getRoutesForSpec(routingSuffix string, endpoints map[string]controllerv1alpha1.EndpointList, meta DevWorkspaceMetadata, annotations map[string]string) []routeV1.Route {
157157
var routes []routeV1.Route
158158
for _, machineEndpoints := range endpoints {
159159
for _, endpoint := range machineEndpoints {
160160
if endpoint.Exposure != controllerv1alpha1.PublicEndpointExposure {
161161
continue
162162
}
163-
routes = append(routes, getRouteForEndpoint(routingSuffix, endpoint, meta))
163+
routes = append(routes, getRouteForEndpoint(routingSuffix, endpoint, meta, annotations))
164164
}
165165
}
166166
return routes
167167
}
168168

169-
func getIngressesForSpec(routingSuffix string, endpoints map[string]controllerv1alpha1.EndpointList, meta DevWorkspaceMetadata) []networkingv1.Ingress {
169+
func getIngressesForSpec(routingSuffix string, endpoints map[string]controllerv1alpha1.EndpointList, meta DevWorkspaceMetadata, annotations map[string]string) []networkingv1.Ingress {
170170
var ingresses []networkingv1.Ingress
171171
for _, machineEndpoints := range endpoints {
172172
for _, endpoint := range machineEndpoints {
173173
if endpoint.Exposure != controllerv1alpha1.PublicEndpointExposure {
174174
continue
175175
}
176-
ingresses = append(ingresses, getIngressForEndpoint(routingSuffix, endpoint, meta))
176+
ingresses = append(ingresses, getIngressForEndpoint(routingSuffix, endpoint, meta, annotations))
177177
}
178178
}
179179
return ingresses
180180
}
181181

182-
func getRouteForEndpoint(routingSuffix string, endpoint controllerv1alpha1.Endpoint, meta DevWorkspaceMetadata) routeV1.Route {
182+
func getRouteForEndpoint(routingSuffix string, endpoint controllerv1alpha1.Endpoint, meta DevWorkspaceMetadata, annotations map[string]string) routeV1.Route {
183183
targetEndpoint := intstr.FromInt(endpoint.TargetPort)
184184
endpointName := common.EndpointName(endpoint.Name)
185185
return routeV1.Route{
@@ -189,7 +189,7 @@ func getRouteForEndpoint(routingSuffix string, endpoint controllerv1alpha1.Endpo
189189
Labels: map[string]string{
190190
constants.DevWorkspaceIDLabel: meta.DevWorkspaceId,
191191
},
192-
Annotations: routeAnnotations(endpointName),
192+
Annotations: createAnnotations(endpoint.Name, annotations, routeAnnotations),
193193
},
194194
Spec: routeV1.RouteSpec{
195195
Host: common.WorkspaceHostname(routingSuffix, meta.DevWorkspaceId),
@@ -209,7 +209,7 @@ func getRouteForEndpoint(routingSuffix string, endpoint controllerv1alpha1.Endpo
209209
}
210210
}
211211

212-
func getIngressForEndpoint(routingSuffix string, endpoint controllerv1alpha1.Endpoint, meta DevWorkspaceMetadata) networkingv1.Ingress {
212+
func getIngressForEndpoint(routingSuffix string, endpoint controllerv1alpha1.Endpoint, meta DevWorkspaceMetadata, annotations map[string]string) networkingv1.Ingress {
213213
endpointName := common.EndpointName(endpoint.Name)
214214
hostname := common.EndpointHostname(routingSuffix, meta.DevWorkspaceId, endpointName, endpoint.TargetPort)
215215
ingressPathType := networkingv1.PathTypeImplementationSpecific
@@ -220,7 +220,7 @@ func getIngressForEndpoint(routingSuffix string, endpoint controllerv1alpha1.End
220220
Labels: map[string]string{
221221
constants.DevWorkspaceIDLabel: meta.DevWorkspaceId,
222222
},
223-
Annotations: nginxIngressAnnotations(endpoint.Name),
223+
Annotations: createAnnotations(endpoint.Name, annotations, nginxIngressAnnotations),
224224
},
225225
Spec: networkingv1.IngressSpec{
226226
Rules: []networkingv1.IngressRule{

‎controllers/controller/devworkspacerouting/solvers/common_test.go

+125
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
package solvers
2+
3+
import (
4+
"testing"
5+
6+
"github.com/devfile/devworkspace-operator/apis/controller/v1alpha1"
7+
"github.com/stretchr/testify/assert"
8+
)
9+
10+
func TestGetRouteForEndpointAnnotations(t *testing.T) {
11+
tests := []struct {
12+
name string
13+
14+
routingSuffix string
15+
endpoint v1alpha1.Endpoint
16+
meta DevWorkspaceMetadata
17+
annotations map[string]string
18+
19+
expectedAnnotationsKeys []string
20+
}{
21+
{
22+
name: "nil",
23+
24+
annotations: nil,
25+
26+
expectedAnnotationsKeys: []string{
27+
"controller.devfile.io/endpoint_name",
28+
"haproxy.router.openshift.io/rewrite-target",
29+
},
30+
},
31+
{
32+
name: "empty",
33+
34+
annotations: map[string]string{},
35+
36+
expectedAnnotationsKeys: []string{
37+
"controller.devfile.io/endpoint_name",
38+
"haproxy.router.openshift.io/rewrite-target",
39+
},
40+
},
41+
{
42+
name: "defined",
43+
44+
annotations: map[string]string{
45+
"example.com/extra": "val",
46+
},
47+
48+
expectedAnnotationsKeys: []string{
49+
"controller.devfile.io/endpoint_name",
50+
"example.com/extra"},
51+
},
52+
}
53+
54+
for _, tt := range tests {
55+
t.Run(tt.name, func(t *testing.T) {
56+
route := getRouteForEndpoint("routingSuffix", v1alpha1.Endpoint{Name: "Endpoint"}, DevWorkspaceMetadata{DevWorkspaceId: "WorkspaceTest"}, tt.annotations)
57+
for _, expected := range tt.expectedAnnotationsKeys {
58+
_, ok := route.Annotations[expected]
59+
assert.True(t, ok, "Key %s does not exist", expected)
60+
assert.Equal(t, len(tt.expectedAnnotationsKeys), len(route.Annotations))
61+
}
62+
})
63+
}
64+
}
65+
66+
func TestGetIngressForEndpointAnnotations(t *testing.T) {
67+
tests := []struct {
68+
name string
69+
70+
routingSuffix string
71+
endpoint v1alpha1.Endpoint
72+
meta DevWorkspaceMetadata
73+
annotations map[string]string
74+
75+
expectedAnnotationsKeys []string
76+
}{
77+
{
78+
name: "nil",
79+
80+
annotations: nil,
81+
82+
expectedAnnotationsKeys: []string{
83+
"controller.devfile.io/endpoint_name",
84+
"kubernetes.io/ingress.class",
85+
"nginx.ingress.kubernetes.io/rewrite-target",
86+
"nginx.ingress.kubernetes.io/ssl-redirect",
87+
},
88+
},
89+
{
90+
name: "empty",
91+
92+
annotations: map[string]string{},
93+
94+
expectedAnnotationsKeys: []string{
95+
"controller.devfile.io/endpoint_name",
96+
"kubernetes.io/ingress.class",
97+
"nginx.ingress.kubernetes.io/rewrite-target",
98+
"nginx.ingress.kubernetes.io/ssl-redirect",
99+
},
100+
},
101+
{
102+
name: "defined",
103+
104+
annotations: map[string]string{
105+
"kubernetes.io/ingress.class": "traefik",
106+
},
107+
108+
expectedAnnotationsKeys: []string{
109+
"controller.devfile.io/endpoint_name",
110+
"kubernetes.io/ingress.class",
111+
},
112+
},
113+
}
114+
115+
for _, tt := range tests {
116+
t.Run(tt.name, func(t *testing.T) {
117+
ingress := getIngressForEndpoint("routingSuffix", v1alpha1.Endpoint{Name: "Endpoint"}, DevWorkspaceMetadata{DevWorkspaceId: "WorkspaceTest"}, tt.annotations)
118+
for _, expected := range tt.expectedAnnotationsKeys {
119+
_, ok := ingress.Annotations[expected]
120+
assert.True(t, ok, "Key %s does not exist", expected)
121+
assert.Equal(t, len(tt.expectedAnnotationsKeys), len(ingress.Annotations))
122+
}
123+
})
124+
}
125+
}

0 commit comments

Comments
 (0)