forked from projectcalico/libcalico-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
conversion.go
455 lines (407 loc) · 15 KB
/
conversion.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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
// Copyright (c) 2016-2017 Tigera, Inc. All rights reserved.
// 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 k8s
import (
"crypto/sha1"
"encoding/hex"
"fmt"
"sort"
"strings"
"github.com/projectcalico/libcalico-go/lib/backend/extensions"
log "github.com/sirupsen/logrus"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/util/intstr"
kapiv1 "k8s.io/client-go/pkg/api/v1"
"github.com/projectcalico/libcalico-go/lib/backend/model"
cnet "github.com/projectcalico/libcalico-go/lib/net"
"github.com/projectcalico/libcalico-go/lib/numorstring"
)
var (
protoTCP = extensions.ProtocolTCP
)
//TODO: make this private and expose a public conversion interface instead
type Converter struct {
}
// VethNameForWorkload returns a deterministic veth name
// for the given Kubernetes workload.
func VethNameForWorkload(workload string) string {
// A SHA1 is always 20 bytes long, and so is sufficient for generating the
// veth name and mac addr.
h := sha1.New()
h.Write([]byte(workload))
return fmt.Sprintf("cali%s", hex.EncodeToString(h.Sum(nil))[:11])
}
// parseWorkloadID extracts the Namespace and Pod name from the given workload ID.
func (c Converter) parseWorkloadID(workloadID string) (string, string) {
splits := strings.SplitN(workloadID, ".", 2)
return splits[0], splits[1]
}
// parsePolicyNameNetworkPolicy extracts the Kubernetes Namespace and NetworkPolicy that backs the given Policy.
func (c Converter) parsePolicyNameNetworkPolicy(name string) (string, string, error) {
// Policies backed by NetworkPolicies have form "knp.default.<ns_name>.<np_name>"
if !strings.HasPrefix(name, "knp.default.") {
// This is not backed by a Kubernetes NetworkPolicy.
return "", "", fmt.Errorf("Policy %s not backed by a NetworkPolicy", name)
}
splits := strings.SplitN(strings.TrimPrefix(name, "knp.default."), ".", 2)
if len(splits) != 2 {
return "", "", fmt.Errorf("Name does not include both Namespace and NetworkPolicy: %s", name)
}
// Return Namespace, NetworkPolicy name.
return splits[0], splits[1], nil
}
// parseProfileName extracts the Namespace name from the given Profile name.
func (c Converter) parseProfileName(profileName string) (string, error) {
// Profile objects backed by Namespaces have form "k8s_ns.<ns_name>"
if !strings.HasPrefix(profileName, "k8s_ns.") {
// This is not backed by a Kubernetes Namespace.
return "", fmt.Errorf("Profile %s not backed by a Namespace", profileName)
}
return strings.TrimPrefix(profileName, "k8s_ns."), nil
}
// NamespaceToProfile converts a Namespace to a Calico Profile. The Profile stores
// labels from the Namespace which are inherited by the WorkloadEndpoints within
// the Profile. This Profile also has the default ingress and egress rules, which are both 'allow'.
func (c Converter) NamespaceToProfile(ns *kapiv1.Namespace) (*model.KVPair, error) {
// Generate the labels to apply to the profile, using a special prefix
// to indicate that these are the labels from the parent Kubernetes Namespace.
labels := map[string]string{}
for k, v := range ns.ObjectMeta.Labels {
labels[fmt.Sprintf("pcns.%s", k)] = v
}
name := fmt.Sprintf("k8s_ns.%s", ns.ObjectMeta.Name)
kvp := model.KVPair{
Key: model.ProfileKey{Name: name},
Value: &model.Profile{
Labels: labels,
Rules: model.ProfileRules{
InboundRules: []model.Rule{model.Rule{Action: "allow"}},
OutboundRules: []model.Rule{model.Rule{Action: "allow"}},
},
},
Revision: ns.ObjectMeta.ResourceVersion,
}
return &kvp, nil
}
// isReadyCalicoPod returns true if the pod should be shown as a workloadEndpoint
// in the Calico API and false otherwise.
func (c Converter) isReadyCalicoPod(pod *kapiv1.Pod) bool {
if c.isHostNetworked(pod) {
log.WithField("pod", pod.Name).Debug("Pod is host networked.")
return false
} else if !c.hasIPAddress(pod) {
log.WithField("pod", pod.Name).Debug("Pod does not have an IP address.")
return false
} else if !c.isScheduled(pod) {
log.WithField("pod", pod.Name).Debug("Pod is not scheduled.")
return false
}
return true
}
func (c Converter) isScheduled(pod *kapiv1.Pod) bool {
return pod.Spec.NodeName != ""
}
func (c Converter) isHostNetworked(pod *kapiv1.Pod) bool {
return pod.Spec.HostNetwork
}
func (c Converter) hasIPAddress(pod *kapiv1.Pod) bool {
return pod.Status.PodIP != ""
}
// PodToWorkloadEndpoint converts a Pod to a WorkloadEndpoint. It assumes the calling code
// has verified that the provided Pod is valid to convert to a WorkloadEndpoint.
func (c Converter) PodToWorkloadEndpoint(pod *kapiv1.Pod) (*model.KVPair, error) {
// Pull out the profile and workload ID based on pod name and Namespace.
profile := fmt.Sprintf("k8s_ns.%s", pod.ObjectMeta.Namespace)
workload := fmt.Sprintf("%s.%s", pod.ObjectMeta.Namespace, pod.ObjectMeta.Name)
// We do, in some circumstances, want to parse Pods without an IP address. For example,
// a DELETE update will not include an IP.
ipNets := []cnet.IPNet{}
if c.hasIPAddress(pod) {
_, ipNet, err := cnet.ParseCIDR(fmt.Sprintf("%s/32", pod.Status.PodIP))
if err != nil {
log.WithFields(log.Fields{"ip": pod.Status.PodIP, "pod": pod.Name}).WithError(err).Error("Failed to parse pod IP")
return nil, err
}
ipNets = append(ipNets, *ipNet)
}
// Generate the interface name and MAC based on workload. This must match
// the host-side veth configured by the CNI plugin.
interfaceName := VethNameForWorkload(workload)
// Build the labels map.
labels := map[string]string{}
if pod.ObjectMeta.Labels != nil {
labels = pod.ObjectMeta.Labels
}
labels["calico/k8s_ns"] = pod.ObjectMeta.Namespace
// Create the key / value pair to return.
kvp := model.KVPair{
Key: model.WorkloadEndpointKey{
Hostname: pod.Spec.NodeName,
OrchestratorID: "k8s",
WorkloadID: workload,
EndpointID: "eth0",
},
Value: &model.WorkloadEndpoint{
State: "active",
Name: interfaceName,
ProfileIDs: []string{profile},
IPv4Nets: ipNets,
IPv6Nets: []cnet.IPNet{},
Labels: labels,
},
Revision: pod.ObjectMeta.ResourceVersion,
}
return &kvp, nil
}
// NetworkPolicyToPolicy converts a k8s NetworkPolicy to a model.KVPair.
func (c Converter) NetworkPolicyToPolicy(np *extensions.NetworkPolicy) (*model.KVPair, error) {
// Pull out important fields.
policyName := fmt.Sprintf("knp.default.%s.%s", np.ObjectMeta.Namespace, np.ObjectMeta.Name)
// We insert all the NetworkPolicy Policies at order 1000.0 after conversion.
// This order might change in future.
order := float64(1000.0)
// Generate the inbound rules list.
var inboundRules []model.Rule
for _, r := range np.Spec.Ingress {
inboundRules = append(inboundRules, c.k8sRuleToCalico(r.From, r.Ports, np.ObjectMeta.Namespace, true)...)
}
// Generate the outbound rules list.
var outboundRules []model.Rule
for _, r := range np.Spec.Egress {
outboundRules = append(outboundRules, c.k8sRuleToCalico(r.To, r.Ports, np.ObjectMeta.Namespace, false)...)
}
// Calculate Types setting.
ingress := false
egress := false
for _, policyType := range np.Spec.PolicyTypes {
switch policyType {
case extensions.PolicyTypeIngress:
ingress = true
case extensions.PolicyTypeEgress:
egress = true
}
}
types := []string{}
if ingress {
types = append(types, "ingress")
}
if egress {
types = append(types, "egress")
} else if len(outboundRules) > 0 {
// Egress was introduced at the same time as policyTypes. It shouldn't be possible to
// receive a NetworkPolicy with an egress rule but without "egress" specified in its types,
// but we'll warn about it anyway.
log.Warn("K8s PolicyTypes don't include 'egress', but NetworkPolicy has egress rules.")
}
// If no types were specified in the policy, then we're running on a cluster that doesn't
// include support for that field in the API. In that case, the correct behavior is for the policy
// to apply to only ingress traffic.
if len(types) == 0 {
types = append(types, "ingress")
}
// Build and return the KVPair.
return &model.KVPair{
Key: model.PolicyKey{
Name: policyName,
},
Value: &model.Policy{
Order: &order,
Selector: c.k8sSelectorToCalico(&np.Spec.PodSelector, &np.ObjectMeta.Namespace),
InboundRules: inboundRules,
OutboundRules: outboundRules,
Types: types,
},
Revision: np.ObjectMeta.ResourceVersion,
}, nil
}
// k8sSelectorToCalico takes a namespaced k8s label selector and returns the Calico
// equivalent.
func (c Converter) k8sSelectorToCalico(s *metav1.LabelSelector, ns *string) string {
// If this is a podSelector, it needs to be namespaced, and it
// uses a different prefix. Otherwise, treat this as a NamespaceSelector.
selectors := []string{}
prefix := "pcns."
if ns != nil {
prefix = ""
selectors = append(selectors, fmt.Sprintf("calico/k8s_ns == '%s'", *ns))
}
// matchLabels is a map key => value, it means match if (label[key] ==
// value) for all keys.
keys := make([]string, 0, len(s.MatchLabels))
for k := range s.MatchLabels {
keys = append(keys, k)
}
sort.Strings(keys)
for _, k := range keys {
v := s.MatchLabels[k]
selectors = append(selectors, fmt.Sprintf("%s%s == '%s'", prefix, k, v))
}
// matchExpressions is a list of in/notin/exists/doesnotexist tests.
for _, e := range s.MatchExpressions {
valueList := strings.Join(e.Values, "', '")
// Each selector is formatted differently based on the operator.
switch e.Operator {
case metav1.LabelSelectorOpIn:
selectors = append(selectors, fmt.Sprintf("%s%s in { '%s' }", prefix, e.Key, valueList))
case metav1.LabelSelectorOpNotIn:
selectors = append(selectors, fmt.Sprintf("%s%s not in { '%s' }", prefix, e.Key, valueList))
case metav1.LabelSelectorOpExists:
selectors = append(selectors, fmt.Sprintf("has(%s%s)", prefix, e.Key))
case metav1.LabelSelectorOpDoesNotExist:
selectors = append(selectors, fmt.Sprintf("! has(%s%s)", prefix, e.Key))
}
}
// If namespace selector is empty then we select all namespaces.
if len(selectors) == 0 && ns == nil {
selectors = []string{"has(calico/k8s_ns)"}
}
return strings.Join(selectors, " && ")
}
func (c Converter) k8sRuleToCalico(rPeers []extensions.NetworkPolicyPeer, rPorts []extensions.NetworkPolicyPort, ns string, ingress bool) []model.Rule {
rules := []model.Rule{}
peers := []*extensions.NetworkPolicyPeer{}
ports := []*extensions.NetworkPolicyPort{}
// Built up a list of the sources and a list of the destinations.
for _, f := range rPeers {
// We need to add a copy of the peer so all the rules don't
// point to the same location.
peers = append(peers, &extensions.NetworkPolicyPeer{
NamespaceSelector: f.NamespaceSelector,
PodSelector: f.PodSelector,
IPBlock: f.IPBlock,
})
}
for _, p := range rPorts {
// We need to add a copy of the port so all the rules don't
// point to the same location.
port := extensions.NetworkPolicyPort{}
if p.Port != nil {
portval := intstr.FromString(p.Port.String())
port.Port = &portval
// TCP is the implicit default (as per the definition of NetworkPolicyPort).
// Make the default explicit here because our data-model always requires
// the protocol to be specified if we're doing a port match.
port.Protocol = &protoTCP
}
if p.Protocol != nil {
protval := extensions.Protocol(fmt.Sprintf("%s", *p.Protocol))
port.Protocol = &protval
}
ports = append(ports, &port)
}
// If there no peers, or no ports, represent that as nil.
if len(peers) == 0 {
peers = []*extensions.NetworkPolicyPeer{nil}
}
if len(ports) == 0 {
ports = []*extensions.NetworkPolicyPort{nil}
}
// Combine desintations with sources to generate rules.
// TODO: This currently creates a lot of rules by making every combination of from / ports
// into a rule. We can combine these so that we don't need as many rules!
for _, port := range ports {
for _, peer := range peers {
protocol, dstPorts := c.k8sPortToCalicoFields(port)
selector, nets, notNets := c.k8sPeerToCalicoFields(peer, ns)
if ingress {
// Build inbound rule and append to list.
rules = append(rules, model.Rule{
Action: "allow",
Protocol: protocol,
DstPorts: dstPorts,
SrcSelector: selector,
SrcNets: nets,
NotSrcNets: notNets,
})
} else {
// Build outbound rule and append to list.
rules = append(rules, model.Rule{
Action: "allow",
Protocol: protocol,
DstPorts: dstPorts,
DstSelector: selector,
DstNets: nets,
NotDstNets: notNets,
})
}
}
}
return rules
}
func (c Converter) k8sPortToCalicoFields(port *extensions.NetworkPolicyPort) (protocol *numorstring.Protocol, dstPorts []numorstring.Port) {
// If no port info, return zero values for all fields (protocol, dstPorts).
if port == nil {
return
}
// Port information available.
protocol = c.k8sProtocolToCalico(port.Protocol)
dstPorts = c.k8sPortToCalico(*port)
return
}
func (c Converter) k8sProtocolToCalico(protocol *extensions.Protocol) *numorstring.Protocol {
if protocol != nil {
p := numorstring.ProtocolFromString(strings.ToLower(string(*protocol)))
return &p
}
return nil
}
func (c Converter) k8sPeerToCalicoFields(peer *extensions.NetworkPolicyPeer, ns string) (selector string, nets []*cnet.IPNet, notNets []*cnet.IPNet) {
// If no peer, return zero values for all fields (selector, nets and !nets).
if peer == nil {
return
}
// Peer information available.
// Determine the source selector for the rule.
// Only one of PodSelector / NamespaceSelector can be defined.
if peer.PodSelector != nil {
selector = c.k8sSelectorToCalico(peer.PodSelector, &ns)
return
}
if peer.NamespaceSelector != nil {
selector = c.k8sSelectorToCalico(peer.NamespaceSelector, nil)
return
}
if peer.IPBlock != nil {
// Convert the CIDR to include.
_, ipNet, err := cnet.ParseCIDR(peer.IPBlock.CIDR)
if err != nil {
log.WithField("cidr", peer.IPBlock.CIDR).WithError(err).Error("Failed to parse CIDR")
return
}
nets = []*cnet.IPNet{ipNet}
// Convert the CIDRs to exclude.
notNets = []*cnet.IPNet{}
for _, exception := range peer.IPBlock.Except {
_, ipNet, err = cnet.ParseCIDR(exception)
if err != nil {
log.WithField("cidr", exception).WithError(err).Error("Failed to parse CIDR")
return
}
notNets = append(notNets, ipNet)
}
return
}
return
}
func (c Converter) k8sPortToCalico(port extensions.NetworkPolicyPort) []numorstring.Port {
var portList []numorstring.Port
if port.Port != nil {
p, err := numorstring.PortFromString(port.Port.String())
if err != nil {
log.Panic("Invalid port %+v: %s", port.Port, err)
}
return append(portList, p)
}
// No ports - return empty list.
return portList
}