-
Notifications
You must be signed in to change notification settings - Fork 156
/
provider.go
406 lines (358 loc) · 12.9 KB
/
provider.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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
/*
Copyright 2020 The Kubermatic Kubernetes Platform contributors.
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 gcp
import (
"context"
"encoding/base64"
"encoding/json"
"errors"
"fmt"
"net"
"net/http"
"net/url"
"path"
"strings"
"go.uber.org/zap"
"golang.org/x/oauth2/google"
"google.golang.org/api/compute/v1"
"google.golang.org/api/googleapi"
"google.golang.org/api/option"
kubermaticv1 "k8c.io/kubermatic/v2/pkg/crd/kubermatic/v1"
kuberneteshelper "k8c.io/kubermatic/v2/pkg/kubernetes"
"k8c.io/kubermatic/v2/pkg/log"
"k8c.io/kubermatic/v2/pkg/provider"
"k8c.io/kubermatic/v2/pkg/resources"
)
const (
DefaultNetwork = "global/networks/default"
computeAPIEndpoint = "https://www.googleapis.com/compute/v1/"
firewallSelfCleanupFinalizer = "kubermatic.io/cleanup-gcp-firewall-self"
firewallICMPCleanupFinalizer = "kubermatic.io/cleanup-gcp-firewall-icmp"
routesCleanupFinalizer = "kubermatic.io/cleanup-gcp-routes"
k8sNodeRouteTag = "k8s-node-route"
k8sNodeRoutePrefixRegexp = "kubernetes-.*"
)
type gcp struct {
secretKeySelector provider.SecretKeySelectorValueFunc
log *zap.SugaredLogger
}
// NewCloudProvider creates a new gcp provider.
func NewCloudProvider(secretKeyGetter provider.SecretKeySelectorValueFunc) provider.CloudProvider {
return &gcp{
secretKeySelector: secretKeyGetter,
log: log.Logger,
}
}
// TODO: update behaviour of all these methods
// InitializeCloudProvider initializes a cluster.
func (g *gcp) InitializeCloudProvider(cluster *kubermaticv1.Cluster, update provider.ClusterUpdater) (*kubermaticv1.Cluster, error) {
var err error
if cluster.Spec.Cloud.GCP.Network == "" && cluster.Spec.Cloud.GCP.Subnetwork == "" {
cluster, err = update(cluster.Name, func(cluster *kubermaticv1.Cluster) {
cluster.Spec.Cloud.GCP.Network = DefaultNetwork
})
if err != nil {
return nil, err
}
}
if err := g.ensureFirewallRules(cluster, update); err != nil {
return nil, err
}
// add the routes cleanup finalizer
if !kuberneteshelper.HasFinalizer(cluster, routesCleanupFinalizer) {
cluster, err = update(cluster.Name, func(cluster *kubermaticv1.Cluster) {
kuberneteshelper.AddFinalizer(cluster, routesCleanupFinalizer)
})
if err != nil {
return nil, fmt.Errorf("failed to add %s finalizer: %v", routesCleanupFinalizer, err)
}
}
return cluster, nil
}
// DefaultCloudSpec adds defaults to the cloud spec.
func (g *gcp) DefaultCloudSpec(spec *kubermaticv1.CloudSpec) error {
return nil
}
// ValidateCloudSpec validates the given CloudSpec.
func (g *gcp) ValidateCloudSpec(spec kubermaticv1.CloudSpec) error {
sa, err := GetCredentialsForCluster(spec, g.secretKeySelector)
if err != nil {
return err
}
if sa == "" {
return fmt.Errorf("serviceAccount cannot be empty")
}
return nil
}
// CleanUpCloudProvider removes firewall rules and related finalizer.
func (g *gcp) CleanUpCloudProvider(cluster *kubermaticv1.Cluster, update provider.ClusterUpdater) (*kubermaticv1.Cluster, error) {
serviceAccount, err := GetCredentialsForCluster(cluster.Spec.Cloud, g.secretKeySelector)
if err != nil {
return nil, err
}
svc, projectID, err := ConnectToComputeService(serviceAccount)
if err != nil {
return nil, err
}
firewallService := compute.NewFirewallsService(svc)
selfRuleName := fmt.Sprintf("firewall-%s-self", cluster.Name)
icmpRuleName := fmt.Sprintf("firewall-%s-icmp", cluster.Name)
if kuberneteshelper.HasFinalizer(cluster, firewallSelfCleanupFinalizer) {
_, err = firewallService.Delete(projectID, selfRuleName).Do()
// we ignore a Google API "not found" error
if err != nil && !isHTTPError(err, http.StatusNotFound) {
return nil, fmt.Errorf("failed to delete firewall rule %s: %v", selfRuleName, err)
}
cluster, err = update(cluster.Name, func(cluster *kubermaticv1.Cluster) {
kuberneteshelper.RemoveFinalizer(cluster, firewallSelfCleanupFinalizer)
})
if err != nil {
return nil, fmt.Errorf("failed to remove %s finalizer: %v", firewallSelfCleanupFinalizer, err)
}
}
if kuberneteshelper.HasFinalizer(cluster, firewallICMPCleanupFinalizer) {
_, err = firewallService.Delete(projectID, icmpRuleName).Do()
// we ignore a Google API "not found" error
if err != nil && !isHTTPError(err, http.StatusNotFound) {
return nil, fmt.Errorf("failed to delete firewall rule %s: %v", selfRuleName, err)
}
cluster, err = update(cluster.Name, func(cluster *kubermaticv1.Cluster) {
kuberneteshelper.RemoveFinalizer(cluster, firewallICMPCleanupFinalizer)
})
if err != nil {
return nil, fmt.Errorf("failed to remove %s finalizer: %v", firewallICMPCleanupFinalizer, err)
}
}
if kuberneteshelper.HasFinalizer(cluster, routesCleanupFinalizer) {
if err := g.cleanUnusedRoutes(cluster); err != nil {
return nil, err
}
cluster, err = update(cluster.Name, func(cluster *kubermaticv1.Cluster) {
kuberneteshelper.RemoveFinalizer(cluster, routesCleanupFinalizer)
})
if err != nil {
return nil, fmt.Errorf("failed to remove %s finalizer: %v", routesCleanupFinalizer, err)
}
}
return cluster, nil
}
// ConnectToComputeService establishes a service connection to the Compute Engine.
func ConnectToComputeService(serviceAccount string) (*compute.Service, string, error) {
b, err := base64.StdEncoding.DecodeString(serviceAccount)
if err != nil {
return nil, "", fmt.Errorf("error decoding service account: %v", err)
}
sam := map[string]string{}
err = json.Unmarshal(b, &sam)
if err != nil {
return nil, "", fmt.Errorf("failed unmarshaling service account: %v", err)
}
projectID := sam["project_id"]
if projectID == "" {
return nil, "", errors.New("empty project_id")
}
conf, err := google.JWTConfigFromJSON(b, compute.ComputeScope)
if err != nil {
return nil, "", err
}
ctx := context.Background()
client := conf.Client(ctx)
svc, err := compute.NewService(ctx, option.WithHTTPClient(client))
if err != nil {
return nil, "", fmt.Errorf("cannot connect to Google Cloud: %v", err)
}
return svc, projectID, nil
}
func (g *gcp) ensureFirewallRules(cluster *kubermaticv1.Cluster, update provider.ClusterUpdater) error {
serviceAccount, err := GetCredentialsForCluster(cluster.Spec.Cloud, g.secretKeySelector)
if err != nil {
return err
}
svc, projectID, err := ConnectToComputeService(serviceAccount)
if err != nil {
return err
}
firewallService := compute.NewFirewallsService(svc)
tag := fmt.Sprintf("kubernetes-cluster-%s", cluster.Name)
selfRuleName := fmt.Sprintf("firewall-%s-self", cluster.Name)
icmpRuleName := fmt.Sprintf("firewall-%s-icmp", cluster.Name)
// allow traffic within the same cluster
if !kuberneteshelper.HasFinalizer(cluster, firewallSelfCleanupFinalizer) {
_, err = firewallService.Insert(projectID, &compute.Firewall{
Name: selfRuleName,
Network: cluster.Spec.Cloud.GCP.Network,
Allowed: []*compute.FirewallAllowed{
{
IPProtocol: "tcp",
},
{
IPProtocol: "udp",
},
{
IPProtocol: "icmp",
},
{
IPProtocol: "esp",
},
{
IPProtocol: "ah",
},
{
IPProtocol: "sctp",
},
{
IPProtocol: "ipip",
},
},
TargetTags: []string{tag},
SourceTags: []string{tag},
}).Do()
// we ignore a Google API "already exists" error
if err != nil && !isHTTPError(err, http.StatusConflict) {
return fmt.Errorf("failed to create firewall rule %s: %v", selfRuleName, err)
}
cluster, err = update(cluster.Name, func(cluster *kubermaticv1.Cluster) {
kuberneteshelper.AddFinalizer(cluster, firewallSelfCleanupFinalizer)
})
if err != nil {
return fmt.Errorf("failed to add %s finalizer: %v", firewallSelfCleanupFinalizer, err)
}
}
// allow ICMP from everywhere
if !kuberneteshelper.HasFinalizer(cluster, firewallICMPCleanupFinalizer) {
_, err = firewallService.Insert(projectID, &compute.Firewall{
Name: icmpRuleName,
Network: cluster.Spec.Cloud.GCP.Network,
Allowed: []*compute.FirewallAllowed{
{
IPProtocol: "icmp",
},
},
TargetTags: []string{tag},
}).Do()
// we ignore a Google API "already exists" error
if err != nil && !isHTTPError(err, http.StatusConflict) {
return fmt.Errorf("failed to create firewall rule %s: %v", icmpRuleName, err)
}
newCluster, err := update(cluster.Name, func(cluster *kubermaticv1.Cluster) {
kuberneteshelper.AddFinalizer(cluster, firewallICMPCleanupFinalizer)
})
if err != nil {
return fmt.Errorf("failed to add %s finalizer: %v", firewallICMPCleanupFinalizer, err)
}
*cluster = *newCluster
}
return err
}
// ValidateCloudSpecUpdate verifies whether an update of cloud spec is valid and permitted
func (g *gcp) ValidateCloudSpecUpdate(oldSpec kubermaticv1.CloudSpec, newSpec kubermaticv1.CloudSpec) error {
return nil
}
// GetCredentialsForCluster returns the credentials for the passed in cloud spec or an error
func GetCredentialsForCluster(cloud kubermaticv1.CloudSpec, secretKeySelector provider.SecretKeySelectorValueFunc) (serviceAccount string, err error) {
serviceAccount = cloud.GCP.ServiceAccount
if serviceAccount == "" {
if cloud.GCP.CredentialsReference == nil {
return "", errors.New("no credentials provided")
}
serviceAccount, err = secretKeySelector(cloud.GCP.CredentialsReference, resources.GCPServiceAccount)
if err != nil {
return "", err
}
}
return serviceAccount, nil
}
// isHTTPError returns true if the given error is of a specific HTTP status code.
func isHTTPError(err error, status int) bool {
gerr, ok := err.(*googleapi.Error)
return ok && gerr.Code == status
}
// cleanUnusedRoutes finds and remove unused gcp routes
func (g *gcp) cleanUnusedRoutes(cluster *kubermaticv1.Cluster) error {
serviceAccount, err := GetCredentialsForCluster(cluster.Spec.Cloud, g.secretKeySelector)
if err != nil {
return fmt.Errorf("failed to get GCP service account: %v", err)
}
svc, projectID, err := ConnectToComputeService(serviceAccount)
if err != nil {
return fmt.Errorf("failed to connect to GCP comput service: %v", err)
}
// filter routes on:
// - name prefix for routes created by gcp cloud provider
// - default tag for routes created by gcp cloud provider
// - GCP network
filterStr := fmt.Sprintf("(name eq \"%s\")(description eq \"%s\")(network eq \".*%s.*\")",
k8sNodeRoutePrefixRegexp,
k8sNodeRouteTag,
g.networkURL(projectID, cluster.Spec.Cloud.GCP.Network))
routesList, err := svc.Routes.List(projectID).Filter(filterStr).Do()
if err != nil {
return fmt.Errorf("failed to list GCP routes: %v", err)
}
logger := g.log.With("cluster", cluster.Name)
for _, route := range routesList.Items {
if isMyRoute, err := isClusterRoute(cluster, route); err != nil || !isMyRoute {
if err != nil {
logger.Warnf("failed to determine route [%s] CIDR", route.Name)
}
continue
}
if isNextHopNotFound(route) {
logger.Infof("deleting unused GCP route [%s]", route.Name)
if _, err := svc.Routes.Delete(projectID, route.Name).Do(); err != nil && !isHTTPError(err, http.StatusNotFound) {
return fmt.Errorf("failed to delete GCP route %s: %v", route.Name, err)
}
}
}
return nil
}
// networkURL checks the network name and retuen the network URL based on it
func (g *gcp) networkURL(project, network string) string {
url, err := url.Parse(network)
if err == nil && url.Host != "" {
return network
}
return computeAPIEndpoint + strings.Join([]string{"projects", project, "global", "networks", path.Base(network)}, "/")
}
// isClusterRoute checks if the route CIDR is part of the Cluster CIDR
func isClusterRoute(cluster *kubermaticv1.Cluster, route *compute.Route) (bool, error) {
_, routeCIDR, err := net.ParseCIDR(route.DestRange)
if err != nil {
return false, fmt.Errorf("failed to parse route destination CIDR: %v", err)
}
// Not responsible if this route's CIDR is not within our clusterCIDR
lastIP := make([]byte, len(routeCIDR.IP))
for i := range lastIP {
lastIP[i] = routeCIDR.IP[i] | ^routeCIDR.Mask[i]
}
// check across all cluster cidrs
for _, clusterCIDRStr := range cluster.Spec.ClusterNetwork.Pods.CIDRBlocks {
_, clusterCIDR, err := net.ParseCIDR(clusterCIDRStr)
if err != nil {
return false, fmt.Errorf("failed to parse cluster CIDR: %v", err)
}
if clusterCIDR.Contains(routeCIDR.IP) || clusterCIDR.Contains(lastIP) {
return true, nil
}
}
return false, nil
}
// isNextHopNotFound checks if the route has a NEXT_HOP_INSTANCE_NOT_FOUND warning
func isNextHopNotFound(route *compute.Route) bool {
for _, w := range route.Warnings {
if w.Code == "NEXT_HOP_INSTANCE_NOT_FOUND" {
return true
}
}
return false
}