-
Notifications
You must be signed in to change notification settings - Fork 15
/
openfaas.go
348 lines (304 loc) · 10.8 KB
/
openfaas.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
/*
Copyright (C) GRyCAP - I3M - UPV
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 backends
import (
"context"
"encoding/json"
"errors"
"fmt"
"log"
"net/http"
"github.com/grycap/oscar/v2/pkg/types"
"github.com/grycap/oscar/v2/pkg/utils"
ofv1 "github.com/openfaas/faas-netes/pkg/apis/openfaas/v1"
ofclientset "github.com/openfaas/faas-netes/pkg/client/clientset/versioned"
appsv1 "k8s.io/api/apps/v1"
v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
k8stypes "k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/watch"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/rest"
)
var errOpenfaasOperator = errors.New("the OpenFaaS Operator is not creating the service deployment")
// OpenfaasBackend struct to represent an Openfaas client
type OpenfaasBackend struct {
kubeClientset kubernetes.Interface
ofClientset *ofclientset.Clientset
namespace string
gatewayEndpoint string
scaler *utils.OpenfaasScaler
config *types.Config
}
// MakeOpenfaasBackend makes a OpenfaasBackend from the provided k8S clientset and config
func MakeOpenfaasBackend(kubeClientset kubernetes.Interface, kubeConfig *rest.Config, cfg *types.Config) *OpenfaasBackend {
ofClientset, err := ofclientset.NewForConfig(kubeConfig)
if err != nil {
log.Fatal(err)
}
return &OpenfaasBackend{
kubeClientset: kubeClientset,
ofClientset: ofClientset,
namespace: cfg.ServicesNamespace,
gatewayEndpoint: fmt.Sprintf("gateway.%s:%d", cfg.OpenfaasNamespace, cfg.OpenfaasPort),
scaler: utils.NewOFScaler(kubeClientset, cfg),
config: cfg,
}
}
// GetInfo returns the ServerlessBackendInfo with the name and version
func (of *OpenfaasBackend) GetInfo() *types.ServerlessBackendInfo {
backInfo := &types.ServerlessBackendInfo{
Name: "OpenFaaS",
}
version, err := of.ofClientset.Discovery().ServerVersion()
if err == nil {
backInfo.Version = version.GitVersion
}
return backInfo
}
// ListServices returns a slice with all services registered in the provided namespace
func (of *OpenfaasBackend) ListServices() ([]*types.Service, error) {
// Get the list with all deployments
deployments, err := of.kubeClientset.AppsV1().Deployments(of.namespace).List(context.TODO(), metav1.ListOptions{})
if err != nil {
return nil, err
}
services := []*types.Service{}
for _, deployment := range deployments.Items {
// Get service from configMap's FDL
svc, err := getServiceFromFDL(deployment.Name, of.namespace, of.kubeClientset)
if err != nil {
log.Printf("WARNING: %v\n", err)
} else {
services = append(services, svc)
}
}
return services, nil
}
// CreateService creates a new service as a OpenFaaS function
func (of *OpenfaasBackend) CreateService(service types.Service) error {
// Create the configMap with FDL and user-script
err := createServiceConfigMap(&service, of.namespace, of.kubeClientset)
if err != nil {
return err
}
// Check if a deployment of the function was already created to get its ResourceVersion
var resourceVersion string
oldDeploy, err := of.kubeClientset.AppsV1().Deployments(of.namespace).Get(context.TODO(), service.Name, metav1.GetOptions{})
if err == nil {
resourceVersion = oldDeploy.ResourceVersion
}
// Create the Function through the OpenFaaS operator
function := of.createOFFunctionDefinition(&service)
_, err = of.ofClientset.OpenfaasV1().Functions(of.namespace).Create(context.TODO(), function, metav1.CreateOptions{})
if err != nil {
// Delete the previously created configMap
if delErr := deleteServiceConfigMap(service.Name, of.namespace, of.kubeClientset); delErr != nil {
log.Println(delErr.Error())
}
return err
}
// Watch for deployment changes in services namespace
var timeoutSeconds int64 = 30
var deploymentCreated = false
listOpts := metav1.ListOptions{
TimeoutSeconds: &timeoutSeconds,
Watch: true,
ResourceVersion: resourceVersion,
}
watcher, err := of.kubeClientset.AppsV1().Deployments(of.namespace).Watch(context.TODO(), listOpts)
if err != nil {
// Delete the function
delErr := of.ofClientset.OpenfaasV1().Functions(of.namespace).Delete(context.TODO(), service.Name, metav1.DeleteOptions{})
if delErr != nil {
log.Println(delErr.Error())
}
// Delete the previously created configMap
if delErr := deleteServiceConfigMap(service.Name, of.namespace, of.kubeClientset); delErr != nil {
log.Println(delErr.Error())
}
return err
}
ch := watcher.ResultChan()
for event := range ch {
deploy, ok := event.Object.(*appsv1.Deployment)
if ok {
if event.Type == watch.Added && deploy.Name == service.Name {
deploymentCreated = true
break
}
}
}
watcher.Stop()
// Return an error if the OpenFaaS Operator doesn't create the deployment
if !deploymentCreated {
// Delete the function
delErr := of.ofClientset.OpenfaasV1().Functions(of.namespace).Delete(context.TODO(), service.Name, metav1.DeleteOptions{})
if delErr != nil {
log.Println(delErr.Error())
}
// Delete the previously created configMap
if delErr := deleteServiceConfigMap(service.Name, of.namespace, of.kubeClientset); delErr != nil {
log.Println(delErr.Error())
}
return errOpenfaasOperator
}
// Create podSpec from the service
podSpec, err := service.ToPodSpec(of.config)
if err != nil {
// Delete the function
delErr := of.ofClientset.OpenfaasV1().Functions(of.namespace).Delete(context.TODO(), service.Name, metav1.DeleteOptions{})
if delErr != nil {
log.Println(delErr.Error())
}
// Delete the previously created configMap
if delErr := deleteServiceConfigMap(service.Name, of.namespace, of.kubeClientset); delErr != nil {
log.Println(delErr.Error())
}
return err
}
// Create JSON Patch
// https://tools.ietf.org/html/rfc6902
patch := []struct {
Op string `json:"op"`
Path string `json:"path"`
Value *v1.PodSpec `json:"value"`
}{
{
Op: "replace",
Path: "/spec/template/spec",
Value: podSpec,
},
}
jsonPatch, _ := json.Marshal(patch)
// Update the deployment
_, err = of.kubeClientset.AppsV1().Deployments(of.namespace).Patch(context.TODO(), service.Name, k8stypes.JSONPatchType, jsonPatch, metav1.PatchOptions{})
if err != nil {
// Delete the function
delErr := of.ofClientset.OpenfaasV1().Functions(of.namespace).Delete(context.TODO(), service.Name, metav1.DeleteOptions{})
if delErr != nil {
log.Println(delErr.Error())
}
// Delete the previously created configMap
if delErr := deleteServiceConfigMap(service.Name, of.namespace, of.kubeClientset); delErr != nil {
log.Println(delErr.Error())
}
return err
}
return nil
}
// ReadService returns a Service
func (of *OpenfaasBackend) ReadService(name string) (*types.Service, error) {
// Check if service exists
if _, err := of.kubeClientset.AppsV1().Deployments(of.namespace).Get(context.TODO(), name, metav1.GetOptions{}); err != nil {
return nil, err
}
// Get service from configMap's FDL
svc, err := getServiceFromFDL(name, of.namespace, of.kubeClientset)
if err != nil {
return nil, err
}
return svc, nil
}
// UpdateService updates an existent service
func (of *OpenfaasBackend) UpdateService(service types.Service) error {
// Get the old service's configMap
oldCm, err := of.kubeClientset.CoreV1().ConfigMaps(of.namespace).Get(context.TODO(), service.Name, metav1.GetOptions{})
if err != nil {
return fmt.Errorf("the service \"%s\" does not have a registered ConfigMap", service.Name)
}
// Update the configMap with FDL and user-script
if err := updateServiceConfigMap(&service, of.namespace, of.kubeClientset); err != nil {
return err
}
// Create podSpec from the service
podSpec, err := service.ToPodSpec(of.config)
if err != nil {
// Restore the old configMap
_, resErr := of.kubeClientset.CoreV1().ConfigMaps(of.namespace).Update(context.TODO(), oldCm, metav1.UpdateOptions{})
if resErr != nil {
log.Println(resErr.Error())
}
return err
}
// Get the service's deployment to update its podSpec
deployment, err := of.kubeClientset.AppsV1().Deployments(of.namespace).Get(context.TODO(), service.Name, metav1.GetOptions{})
if err != nil {
// Restore the old configMap
_, resErr := of.kubeClientset.CoreV1().ConfigMaps(of.namespace).Update(context.TODO(), oldCm, metav1.UpdateOptions{})
if resErr != nil {
log.Println(resErr.Error())
}
return err
}
// Update podSpec in the deployment
deployment.Spec.Template.Spec = *podSpec
// Update the deployment
_, err = of.kubeClientset.AppsV1().Deployments(of.namespace).Update(context.TODO(), deployment, metav1.UpdateOptions{})
if err != nil {
// Restore the old configMap
_, resErr := of.kubeClientset.CoreV1().ConfigMaps(of.namespace).Update(context.TODO(), oldCm, metav1.UpdateOptions{})
if resErr != nil {
log.Println(resErr.Error())
}
return err
}
return nil
}
// DeleteService deletes a service
func (of *OpenfaasBackend) DeleteService(name string) error {
if err := of.ofClientset.OpenfaasV1().Functions(of.namespace).Delete(context.TODO(), name, metav1.DeleteOptions{}); err != nil {
return err
}
// Delete the service's configMap
if delErr := deleteServiceConfigMap(name, of.namespace, of.kubeClientset); delErr != nil {
log.Println(delErr.Error())
}
// Delete all the service's jobs
if err := deleteServiceJobs(name, of.namespace, of.kubeClientset); err != nil {
log.Printf("Error deleting associated jobs for service \"%s\": %v\n", name, err)
}
return nil
}
// GetProxyDirector returns a director function to use in a httputil.ReverseProxy
func (of *OpenfaasBackend) GetProxyDirector(serviceName string) func(req *http.Request) {
return func(req *http.Request) {
req.URL.Scheme = "http"
req.URL.Host = of.gatewayEndpoint
req.URL.Path = fmt.Sprintf("/function/%s", serviceName)
}
}
func (of *OpenfaasBackend) createOFFunctionDefinition(service *types.Service) *ofv1.Function {
// Add label "com.openfaas.scale.zero=true" for scaling to zero
service.Labels[types.OpenfaasZeroScalingLabel] = "true"
return &ofv1.Function{
ObjectMeta: metav1.ObjectMeta{
Name: service.Name,
Namespace: of.namespace,
},
Spec: ofv1.FunctionSpec{
Image: service.Image,
Name: service.Name,
Annotations: &service.Annotations,
Labels: &service.Labels,
},
}
}
// StartScaler starts the OpenFaaS Scaler
func (of *OpenfaasBackend) StartScaler() {
of.scaler.Start()
}
// GetKubeClientset returns the Kubernetes Clientset
func (of *OpenfaasBackend) GetKubeClientset() kubernetes.Interface {
return of.kubeClientset
}