-
Notifications
You must be signed in to change notification settings - Fork 192
/
clustermesh.go
1842 lines (1597 loc) · 59.5 KB
/
clustermesh.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
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Cilium
package clustermesh
import (
"bytes"
"cmp"
"context"
"crypto/x509"
"encoding/base64"
"encoding/json"
"encoding/pem"
"errors"
"fmt"
"io"
"net"
"os"
"sort"
"strconv"
"strings"
"text/tabwriter"
"time"
"github.com/cilium/cilium/api/v1/models"
ciliumv2 "github.com/cilium/cilium/pkg/k8s/apis/cilium.io/v2"
"golang.org/x/exp/maps"
"helm.sh/helm/v3/pkg/release"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
k8serrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"github.com/cilium/cilium-cli/defaults"
"github.com/cilium/cilium-cli/internal/helm"
"github.com/cilium/cilium-cli/k8s"
"github.com/cilium/cilium-cli/status"
"github.com/cilium/cilium-cli/utils/wait"
)
const (
configNameClusterID = "cluster-id"
configNameClusterName = "cluster-name"
configNameTunnelLegacy = "tunnel"
configNameTunnelProtocol = "tunnel-protocol"
configNameRoutingMode = "routing-mode"
configNameMaxConnectedClusters = "max-connected-clusters"
configNameIdentityAllocationMode = "identity-allocation-mode"
)
var (
// This can be replaced with cilium/pkg/defaults.MaxConnectedClusters once
// changes are merged there.
maxConnectedClusters = defaults.ClustermeshMaxConnectedClusters
errConfigRequiredNotRetrieved = errors.New("remote cluster configuration required but not found")
)
type k8sClusterMeshImplementation interface {
GetSecret(ctx context.Context, namespace, name string, opts metav1.GetOptions) (*corev1.Secret, error)
GetConfigMap(ctx context.Context, namespace, name string, opts metav1.GetOptions) (*corev1.ConfigMap, error)
GetDeployment(ctx context.Context, namespace, name string, opts metav1.GetOptions) (*appsv1.Deployment, error)
CheckDeploymentStatus(ctx context.Context, namespace, deployment string) error
GetService(ctx context.Context, namespace, name string, opts metav1.GetOptions) (*corev1.Service, error)
GetDaemonSet(ctx context.Context, namespace, name string, options metav1.GetOptions) (*appsv1.DaemonSet, error)
ListNodes(ctx context.Context, options metav1.ListOptions) (*corev1.NodeList, error)
ListPods(ctx context.Context, namespace string, options metav1.ListOptions) (*corev1.PodList, error)
AutodetectFlavor(ctx context.Context) k8s.Flavor
CiliumStatus(ctx context.Context, namespace, pod string) (*models.StatusResponse, error)
KVStoreMeshStatus(ctx context.Context, namespace, pod string) ([]*models.RemoteCluster, error)
CiliumDbgEndpoints(ctx context.Context, namespace, pod string) ([]*models.Endpoint, error)
ClusterName() string
ListCiliumExternalWorkloads(ctx context.Context, opts metav1.ListOptions) (*ciliumv2.CiliumExternalWorkloadList, error)
GetCiliumExternalWorkload(ctx context.Context, name string, opts metav1.GetOptions) (*ciliumv2.CiliumExternalWorkload, error)
CreateCiliumExternalWorkload(ctx context.Context, cew *ciliumv2.CiliumExternalWorkload, opts metav1.CreateOptions) (*ciliumv2.CiliumExternalWorkload, error)
DeleteCiliumExternalWorkload(ctx context.Context, name string, opts metav1.DeleteOptions) error
ListCiliumEndpoints(ctx context.Context, namespace string, options metav1.ListOptions) (*ciliumv2.CiliumEndpointList, error)
CiliumLogs(ctx context.Context, namespace, pod string, since time.Time) (string, error)
}
type K8sClusterMesh struct {
client k8sClusterMeshImplementation
statusCollector *status.K8sStatusCollector
flavor k8s.Flavor
params Parameters
clusterName string
clusterID string
externalKVStore bool
}
type Parameters struct {
Namespace string
ServiceType string
DestinationContext string
Wait bool
WaitDuration time.Duration
DestinationEndpoints []string
SourceEndpoints []string
Writer io.Writer
Labels map[string]string
IPv4AllocCIDR string
IPv6AllocCIDR string
All bool
ConfigOverwrites []string
Retries int
Output string
// EnableExternalWorkloads indicates whether externalWorkloads.enabled Helm value
// should be set to true. For Helm mode only.
EnableExternalWorkloads bool
// EnableKVStoreMesh indicates whether kvstoremesh should be enabled.
// For Helm mode only.
EnableKVStoreMesh bool
// HelmReleaseName specifies the Helm release name for the Cilium CLI.
// Useful for referencing Cilium installations installed directly through Helm
// or overriding the Cilium CLI for install/upgrade/enable.
HelmReleaseName string
}
type notConnectedError struct{ error }
func (p Parameters) waitTimeout() time.Duration {
if p.WaitDuration != time.Duration(0) {
return p.WaitDuration
}
return time.Minute * 15
}
func NewK8sClusterMesh(client k8sClusterMeshImplementation, p Parameters) *K8sClusterMesh {
return &K8sClusterMesh{
client: client,
params: p,
}
}
func (k *K8sClusterMesh) Log(format string, a ...interface{}) {
fmt.Fprintf(k.params.Writer, format+"\n", a...)
}
func (k *K8sClusterMesh) GetClusterConfig(ctx context.Context) error {
k.flavor = k.client.AutodetectFlavor(ctx)
cm, err := k.client.GetConfigMap(ctx, k.params.Namespace, defaults.ConfigMapName, metav1.GetOptions{})
if err != nil {
return fmt.Errorf("unable to retrieve ConfigMap %q: %w", defaults.ConfigMapName, err)
}
k.externalKVStore = cm.Data[configNameIdentityAllocationMode] != "crd"
clusterID := cm.Data[configNameClusterID]
if clusterID == "" {
clusterID = "0"
}
k.clusterID = clusterID
clusterName := cm.Data[configNameClusterName]
if clusterName == "" {
clusterName = "default"
}
k.clusterName = clusterName
if clusterID == "0" || clusterName == "default" {
k.Log("⚠️ Cluster not configured for clustermesh, use '--set cluster.id' and '--set cluster.name' with 'cilium install'. External workloads may still be configured.")
}
return nil
}
type accessInformation struct {
ServiceType corev1.ServiceType `json:"service_type,omitempty"`
ServiceIPs []string `json:"service_ips,omitempty"`
ServicePort int `json:"service_port,omitempty"`
ClusterID string `json:"cluster_id,omitempty"`
ClusterName string `json:"cluster_name,omitempty"`
CA []byte `json:"ca,omitempty"`
ClientCert []byte `json:"client_cert,omitempty"`
ClientKey []byte `json:"client_key,omitempty"`
ExternalWorkloadCert []byte `json:"external_workload_cert,omitempty"`
ExternalWorkloadKey []byte `json:"external_workload_key,omitempty"`
Tunnel string `json:"tunnel,omitempty"`
MaxConnectedClusters int `json:"max_connected_clusters,omitempty"`
}
func (ai *accessInformation) validate() bool {
return ai.ClusterName != "" &&
ai.ClusterName != "default" &&
ai.ClusterID != "" &&
ai.ClusterID != "0"
}
func getDeprecatedName(secretName string) string {
switch secretName {
case defaults.ClusterMeshRemoteSecretName:
return defaults.ClusterMeshClientSecretName
case defaults.ClusterMeshServerSecretName,
defaults.ClusterMeshAdminSecretName,
defaults.ClusterMeshClientSecretName,
defaults.ClusterMeshExternalWorkloadSecretName:
return secretName + "s"
default:
return ""
}
}
func getExternalWorkloadCertName() string {
return defaults.ClusterMeshClientSecretName
}
// getDeprecatedSecret attempts to retrieve a secret using one or more deprecated names
// There are now multiple "layers" of deprecated secret names, so we call this function recursively if needed
func (k *K8sClusterMesh) getDeprecatedSecret(ctx context.Context, client k8sClusterMeshImplementation, secretName string, defaultName string) (*corev1.Secret, error) {
deprecatedSecretName := getDeprecatedName(secretName)
if deprecatedSecretName == "" {
return nil, fmt.Errorf("unable to get secret %q and no deprecated names to try", secretName)
}
k.Log("Trying to get secret %s by deprecated name %s", secretName, deprecatedSecretName)
secret, err := client.GetSecret(ctx, k.params.Namespace, deprecatedSecretName, metav1.GetOptions{})
if err != nil {
return k.getDeprecatedSecret(ctx, client, deprecatedSecretName, defaultName)
}
k.Log("⚠️ Deprecated secret name %q, should be changed to %q", secret.Name, defaultName)
return secret, err
}
// We had inconsistency in naming clustermesh secrets between Helm installation and Cilium CLI installation
// Cilium CLI was naming clustermesh secrets with trailing 's'. eg. 'clustermesh-apiserver-client-certs' instead of `clustermesh-apiserver-client-cert`
// This caused Cilium CLI 'clustermesh status' command to fail when Cilium is installed using Helm
// getSecret handles both secret names and logs warning if deprecated secret name is found
func (k *K8sClusterMesh) getSecret(ctx context.Context, client k8sClusterMeshImplementation, secretName string) (*corev1.Secret, error) {
secret, err := client.GetSecret(ctx, k.params.Namespace, secretName, metav1.GetOptions{})
if err != nil {
return k.getDeprecatedSecret(ctx, client, secretName, secretName)
}
return secret, err
}
func (k *K8sClusterMesh) getCACert(ctx context.Context, client k8sClusterMeshImplementation) ([]byte, error) {
secret, err := client.GetSecret(ctx, k.params.Namespace, defaults.CASecretName, metav1.GetOptions{})
if err != nil {
return nil, fmt.Errorf("get secret %q to retrieve CA: %s", defaults.CASecretName, err)
}
// The helm and cronjob certificate generation methods currently store
// the certificate under the ca.crt key, while cert-manager requires it
// to be under the tls.crt key. Hence, let's attempt to retrieve it
// using both keys.
cert, ok := secret.Data[defaults.CASecretCertName]
if ok {
return cert, nil
}
cert, ok = secret.Data[corev1.TLSCertKey]
if ok {
return cert, nil
}
return nil, fmt.Errorf("secret %q does not contain the CA certificate", defaults.CASecretName)
}
func (k *K8sClusterMesh) extractAccessInformation(ctx context.Context, client k8sClusterMeshImplementation, endpoints []string, verbose bool, getExternalWorkLoadSecret bool) (*accessInformation, error) {
cm, err := client.GetConfigMap(ctx, k.params.Namespace, defaults.ConfigMapName, metav1.GetOptions{})
if err != nil {
return nil, fmt.Errorf("unable to retrieve ConfigMap %q: %w", defaults.ConfigMapName, err)
}
if _, ok := cm.Data[configNameClusterName]; !ok {
return nil, fmt.Errorf("%s is not set in ConfigMap %q", configNameClusterName, defaults.ConfigMapName)
}
clusterID := cm.Data[configNameClusterID]
clusterName := cm.Data[configNameClusterName]
if mcc, ok := cm.Data[configNameMaxConnectedClusters]; ok {
maxConnectedClusters, err = strconv.Atoi(mcc)
if err != nil {
return nil, fmt.Errorf("unable to parse %s: %w", configNameMaxConnectedClusters, err)
}
}
if verbose {
k.Log("✨ Extracting access information of cluster %s...", clusterName)
}
svc, err := client.GetService(ctx, k.params.Namespace, defaults.ClusterMeshServiceName, metav1.GetOptions{})
if err != nil {
return nil, fmt.Errorf("unable to get clustermesh service %q: %w", defaults.ClusterMeshServiceName, err)
}
if verbose {
k.Log("🔑 Extracting secrets from cluster %s...", clusterName)
}
meshSecret, err := k.getSecret(ctx, client, defaults.ClusterMeshRemoteSecretName)
if err != nil {
return nil, fmt.Errorf("unable to get client secret to access clustermesh service: %w", err)
}
clientKey, ok := meshSecret.Data[corev1.TLSPrivateKeyKey]
if !ok {
return nil, fmt.Errorf("secret %q does not contain key %q", meshSecret.Name, corev1.TLSPrivateKeyKey)
}
clientCert, ok := meshSecret.Data[corev1.TLSCertKey]
if !ok {
return nil, fmt.Errorf("secret %q does not contain key %q", meshSecret.Name, corev1.TLSCertKey)
}
caCert, err := k.getCACert(ctx, client)
// We failed to retrieve the CA from its own secret, let's fallback to the ca.crt certificate inside the mesh secret.
if err != nil {
caCert, ok = meshSecret.Data[defaults.CASecretCertName]
if !ok {
return nil, fmt.Errorf("unable to retrieve the CA certificate: %w", err)
}
}
// ExternalWorkload secret is created by 'clustermesh enable' command, but it isn't created by Helm. We should try to load this secret only when needed
var externalWorkloadKey, externalWorkloadCert []byte
if getExternalWorkLoadSecret {
externalWorkloadSecret, err := k.getSecret(ctx, client, getExternalWorkloadCertName())
if err != nil {
return nil, fmt.Errorf("unable to get external workload secret to access clustermesh service")
}
externalWorkloadKey, ok = externalWorkloadSecret.Data[corev1.TLSPrivateKeyKey]
if !ok {
return nil, fmt.Errorf("secret %q does not contain key %q", externalWorkloadSecret.Namespace, corev1.TLSPrivateKeyKey)
}
externalWorkloadCert, ok = externalWorkloadSecret.Data[corev1.TLSCertKey]
if !ok {
return nil, fmt.Errorf("secret %q does not contain key %q", externalWorkloadSecret.Namespace, corev1.TLSCertKey)
}
}
tunnelProtocol := ""
if cm.Data[configNameRoutingMode] == "tunnel" {
// Cilium v1.14 and newer
tunnelProtocol = "vxlan" // default for tunnel mode
if proto, ok := cm.Data[configNameTunnelProtocol]; ok {
tunnelProtocol = proto
}
} else if proto, ok := cm.Data[configNameTunnelLegacy]; ok {
// Cilium v1.13 and older (some v1.14 configurations might use it too)
// Can be removed once we drop support for v1.14
tunnelProtocol = proto
}
ai := &accessInformation{
ClusterID: clusterID,
ClusterName: clusterName,
CA: caCert,
ClientKey: clientKey,
ClientCert: clientCert,
ExternalWorkloadKey: externalWorkloadKey,
ExternalWorkloadCert: externalWorkloadCert,
ServiceType: svc.Spec.Type,
ServiceIPs: []string{},
Tunnel: tunnelProtocol,
MaxConnectedClusters: maxConnectedClusters,
}
switch {
case len(endpoints) > 0:
for _, endpoint := range endpoints {
ip, port, err := net.SplitHostPort(endpoint)
if err != nil {
return nil, fmt.Errorf("invalid endpoint %q, must be IP:PORT: %w", endpoint, err)
}
intPort, err := strconv.Atoi(port)
if err != nil {
return nil, fmt.Errorf("invalid port %q: %w", port, err)
}
if ai.ServicePort == 0 {
ai.ServicePort = intPort
} else if ai.ServicePort != intPort {
return nil, fmt.Errorf("port mismatch (%d != %d), all endpoints must use the same port number", ai.ServicePort, intPort)
}
ai.ServiceIPs = append(ai.ServiceIPs, ip)
}
case svc.Spec.Type == corev1.ServiceTypeClusterIP:
if len(svc.Spec.Ports) == 0 {
return nil, fmt.Errorf("port of service could not be derived, service has no ports")
}
if svc.Spec.Ports[0].Port == 0 {
return nil, fmt.Errorf("port is not set in service")
}
ai.ServicePort = int(svc.Spec.Ports[0].Port)
if svc.Spec.ClusterIP == "" {
return nil, fmt.Errorf("IP of service could not be derived, service has no ClusterIP")
}
ai.ServiceIPs = append(ai.ServiceIPs, svc.Spec.ClusterIP)
case svc.Spec.Type == corev1.ServiceTypeNodePort:
if len(svc.Spec.Ports) == 0 {
return nil, fmt.Errorf("port of service could not be derived, service has no ports")
}
if svc.Spec.Ports[0].NodePort == 0 {
return nil, fmt.Errorf("nodeport is not set in service")
}
ai.ServicePort = int(svc.Spec.Ports[0].NodePort)
nodes, err := client.ListNodes(ctx, metav1.ListOptions{})
if err != nil {
return nil, fmt.Errorf("unable to list nodes in cluster: %w", err)
}
for _, node := range nodes.Items {
nodeIP := ""
for _, address := range node.Status.Addresses {
switch address.Type {
case corev1.NodeExternalIP:
nodeIP = address.Address
case corev1.NodeInternalIP:
if nodeIP == "" {
nodeIP = address.Address
}
}
}
if nodeIP != "" {
ai.ServiceIPs = append(ai.ServiceIPs, nodeIP)
// We can't really support multiple nodes as
// the NodePort will be different and the
// current use of hostAliases will lead to
// DNS-style RR requiring all endpoints to use
// the same port
break
}
}
k.Log("⚠️ Service type NodePort detected! Service may fail when nodes are removed from the cluster!")
case svc.Spec.Type == corev1.ServiceTypeLoadBalancer:
if len(svc.Spec.Ports) == 0 {
return nil, fmt.Errorf("port of service could not be derived, service has no ports")
}
ai.ServicePort = int(svc.Spec.Ports[0].Port)
for _, ingressStatus := range svc.Status.LoadBalancer.Ingress {
if ingressStatus.Hostname == "" {
ai.ServiceIPs = append(ai.ServiceIPs, ingressStatus.IP)
} else {
k.Log("Hostname based ingress detected, trying to resolve it")
ips, err := net.LookupHost(ingressStatus.Hostname)
if err != nil {
k.Log(fmt.Sprintf("Could not resolve the hostname of the ingress, falling back to the static IP. Error: %v", err))
ai.ServiceIPs = append(ai.ServiceIPs, ingressStatus.IP)
} else {
k.Log("Hostname resolved, using the found ip(s)")
ai.ServiceIPs = append(ai.ServiceIPs, ips...)
}
}
}
}
switch {
case len(ai.ServiceIPs) > 0:
if verbose {
k.Log("ℹ️ Found ClusterMesh service IPs: %s", ai.ServiceIPs)
}
default:
return nil, fmt.Errorf("unable to derive service IPs automatically")
}
return ai, nil
}
// getClientsForConnect returns a k8s.Client for the local and remote cluster, respectively
func (k *K8sClusterMesh) getClientsForConnect() (*k8s.Client, *k8s.Client, error) {
remoteClient, err := k8s.NewClient(k.params.DestinationContext, "", k.params.Namespace)
if err != nil {
return nil, nil, fmt.Errorf(
"unable to create Kubernetes client to access remote cluster %q: %w",
k.params.DestinationContext, err)
}
return k.client.(*k8s.Client), remoteClient, nil
}
func (k *K8sClusterMesh) shallowExtractAccessInfo(ctx context.Context, c *k8s.Client) (*accessInformation, error) {
cm, err := c.GetConfigMap(ctx, k.params.Namespace, defaults.ConfigMapName, metav1.GetOptions{})
if err != nil {
return nil, fmt.Errorf("unable to retrieve ConfigMap %q: %w", defaults.ConfigMapName, err)
}
id, ok := cm.Data[configNameClusterID]
if !ok {
return nil, fmt.Errorf("unable to locate key: %q in ConfigMap %q", configNameClusterID, defaults.ConfigMapName)
}
name, ok := cm.Data[configNameClusterName]
if !ok {
return nil, fmt.Errorf("unable to locate key: %q in ConfigMap %q", configNameClusterName, defaults.ConfigMapName)
}
return &accessInformation{
ClusterID: id,
ClusterName: name,
}, nil
}
// connectAccessInit initializes a Kubernetes client for the local and remote cluster
// and performs some validation that the two clusters can be connected via clustermesh
func (k *K8sClusterMesh) getAccessInfoForConnect(
ctx context.Context, localClient, remoteClient *k8s.Client,
) (*accessInformation, *accessInformation, error) {
aiRemote, err := k.extractAccessInformation(ctx, remoteClient, k.params.DestinationEndpoints, true, false)
if err != nil {
k.Log("❌ Unable to retrieve access information of remote cluster %q: %s", remoteClient.ClusterName(), err)
return nil, nil, err
}
aiLocal, err := k.extractAccessInformation(ctx, localClient, k.params.SourceEndpoints, true, false)
if err != nil {
k.Log("❌ Unable to retrieve access information of local cluster %q: %s", k.client.ClusterName(), err)
return nil, nil, err
}
return aiLocal, aiRemote, nil
}
// connectAccessInit initializes a Kubernetes client for the local and remote cluster
// and performs some validation that the two clusters can be connected via clustermesh
func (k *K8sClusterMesh) validateInfoForConnect(aiLocal, aiRemote *accessInformation) error {
if !aiRemote.validate() {
return fmt.Errorf("remote cluster has non-unique name (%s) and/or ID (%s)",
aiRemote.ClusterName, aiRemote.ClusterID)
}
if !aiLocal.validate() {
return fmt.Errorf(
"local cluster has the default name (cluster name: %s) and/or ID 0 (cluster ID: %s)",
aiLocal.ClusterName, aiLocal.ClusterID)
}
cid, err := strconv.Atoi(aiRemote.ClusterID)
if err != nil {
return fmt.Errorf(
"remote cluster has non-numeric cluster ID %s. Only numeric values 1-255 are allowed",
aiRemote.ClusterID)
}
if cid < 1 || cid > aiLocal.MaxConnectedClusters {
return fmt.Errorf("remote cluster has cluster ID %d out of acceptable range (1-%d)", cid, aiLocal.MaxConnectedClusters)
}
if aiRemote.MaxConnectedClusters != aiLocal.MaxConnectedClusters {
return fmt.Errorf("remote and local clusters have different max connected clusters: %d != %d", aiRemote.MaxConnectedClusters, aiLocal.MaxConnectedClusters)
}
if aiRemote.ClusterName == aiLocal.ClusterName {
return fmt.Errorf("remote and local cluster have the same, non-unique name: %s", aiLocal.ClusterName)
}
if aiRemote.ClusterID == aiLocal.ClusterID {
return fmt.Errorf("remote and local cluster have the same, non-unique ID: %s", aiLocal.ClusterID)
}
return nil
}
type Status struct {
AccessInformation *accessInformation `json:"access_information,omitempty"`
Connectivity *ConnectivityStatus `json:"connectivity,omitempty"`
KVStoreMesh struct {
Enabled bool `json:"enabled"`
Status *ConnectivityStatus `json:"status,omitempty"`
} `json:"kvstoremesh,omitempty"`
}
func (k *K8sClusterMesh) statusAccessInformation(ctx context.Context, log bool, getExternalWorkloadSecret bool) (*accessInformation, error) {
w := wait.NewObserver(ctx, wait.Parameters{Log: func(err error, wait string) {
if log {
k.Log("⌛ Waiting (%s) for access information: %s", wait, err)
}
}})
defer w.Cancel()
for {
ai, err := k.extractAccessInformation(ctx, k.client, []string{}, false, getExternalWorkloadSecret)
if err != nil && k.params.Wait {
if err := w.Retry(err); err != nil {
return nil, err
}
continue
}
return ai, err
}
}
func (k *K8sClusterMesh) statusDeployment(ctx context.Context) (err error) {
w := wait.NewObserver(ctx, wait.Parameters{Log: func(err error, wait string) {
k.Log("⌛ Waiting (%s) for deployment %s to become ready: %s", wait, defaults.ClusterMeshDeploymentName, err)
}})
defer func() {
w.Cancel()
if err != nil {
err = fmt.Errorf("deployment %s is not ready: %w", defaults.ClusterMeshDeploymentName, err)
}
}()
for {
err := k.client.CheckDeploymentStatus(ctx, k.params.Namespace, defaults.ClusterMeshDeploymentName)
if err != nil && k.params.Wait {
if err := w.Retry(err); err != nil {
return err
}
continue
}
return err
}
}
func (k *K8sClusterMesh) kvstoremeshEnabled(ctx context.Context) (bool, error) {
deploy, err := k.client.GetDeployment(ctx, k.params.Namespace, defaults.ClusterMeshDeploymentName, metav1.GetOptions{})
if err != nil {
return false, fmt.Errorf("failed checking whether KVStoreMesh is enabled: %w", err)
}
for _, container := range deploy.Spec.Template.Spec.Containers {
if container.Name == defaults.ClusterMeshKVStoreMeshContainerName {
return true, nil
}
}
return false, nil
}
type StatisticalStatus struct {
Min int64 `json:"min,omitempty"`
Avg float64 `json:"avg,omitempty"`
Max int64 `json:"max,omitempty"`
}
type ClusterStats struct {
Configured int `json:"configured,omitempty"`
Connected int `json:"connected,omitempty"`
}
type ConnectivityStatus struct {
GlobalServices StatisticalStatus `json:"global_services,omitempty"`
Connected StatisticalStatus `json:"connected,omitempty"`
Clusters map[string]*ClusterStats `json:"clusters,omitempty"`
Total int64 `json:"total,omitempty"`
NotReady int64 `json:"not_ready,omitempty"`
Errors status.ErrorCountMapMap `json:"errors,omitempty"`
}
func (c *ConnectivityStatus) addError(pod, cluster string, err error) {
m := c.Errors[pod]
if m == nil {
m = status.ErrorCountMap{}
c.Errors[pod] = m
}
if m[cluster] == nil {
m[cluster] = &status.ErrorCount{}
}
m[cluster].Errors = append(m[cluster].Errors, err)
}
func remoteClusterStatusToError(status *models.RemoteCluster) error {
switch {
case status == nil:
return errors.New("unknown status")
case !status.Connected:
return notConnectedError{errors.New(status.Status)}
case status.Config == nil:
return errors.New("remote cluster configuration retrieval status unknown")
case status.Config.Required && !status.Config.Retrieved:
return errConfigRequiredNotRetrieved
case status.Synced == nil:
return errors.New("synchronization status unknown")
case !(status.Synced.Nodes && status.Synced.Endpoints && status.Synced.Identities && status.Synced.Services):
var toSync []string
appendNotSynced := func(name string, synced bool) {
if !synced {
toSync = append(toSync, name)
}
}
appendNotSynced("endpoints", status.Synced.Endpoints)
appendNotSynced("identities", status.Synced.Identities)
appendNotSynced("nodes", status.Synced.Nodes)
appendNotSynced("services", status.Synced.Services)
return fmt.Errorf("synchronization in progress for %s", strings.Join(toSync, ", "))
default:
return errors.New("not ready")
}
}
func (c *ConnectivityStatus) parseAgentStatus(name string, expected []string, s *status.ClusterMeshAgentConnectivityStatus) {
if c.GlobalServices.Min < 0 || c.GlobalServices.Min > s.GlobalServices {
c.GlobalServices.Min = s.GlobalServices
}
if c.GlobalServices.Max < s.GlobalServices {
c.GlobalServices.Max = s.GlobalServices
}
c.GlobalServices.Avg += float64(s.GlobalServices)
c.Total++
ready := int64(0)
for _, cluster := range s.Clusters {
stats, ok := c.Clusters[cluster.Name]
if !ok {
stats = &ClusterStats{}
c.Clusters[cluster.Name] = stats
}
stats.Configured++
if cluster.Ready {
ready++
stats.Connected++
} else {
c.addError(name, cluster.Name, remoteClusterStatusToError(cluster))
}
}
// Add an error for any cluster that was expected but not found
var missing bool
for _, exp := range expected {
if _, ok := s.Clusters[exp]; !ok {
missing = true
c.addError(name, exp, errors.New("unknown status"))
}
}
if missing || ready != int64(len(s.Clusters)) {
c.NotReady++
}
if c.Connected.Min < 0 || c.Connected.Min > ready {
c.Connected.Min = ready
}
if c.Connected.Max < ready {
c.Connected.Max = ready
}
c.Connected.Avg += float64(ready)
}
func (k *K8sClusterMesh) statusConnectivity(ctx context.Context, checkKVStoreMesh bool) (agents, kvstoremesh *ConnectivityStatus, err error) {
var err1, err2 error
var checkAgents = true
w := wait.NewObserver(ctx, wait.Parameters{Log: func(err error, wait string) {
k.Log("⌛ Waiting (%s) for clusters to be connected: %s", wait, err)
}})
defer w.Cancel()
for {
if checkAgents {
agents, err1 = k.determineStatusConnectivity(
ctx, defaults.ClusterMeshSecretName, defaults.AgentPodSelector, k.statusCollector.ClusterMeshConnectivity,
)
}
if checkKVStoreMesh {
kvstoremesh, err2 = k.determineStatusConnectivity(
ctx, defaults.ClusterMeshKVStoreMeshSecretName, defaults.ClusterMeshPodSelector, k.statusCollector.KVStoreMeshConnectivity,
)
if errors.Is(err2, k8s.ErrKVStoreMeshStatusNotImplemented) {
k.Log("⚠️ KVStoreMesh status retrieval is not supported by this Cilium version")
err2 = nil
}
}
if k.params.Wait {
notReadyCheck := func(status *ConnectivityStatus, err error, component string) error {
if err == nil && status != nil {
if status.NotReady > 0 {
err = fmt.Errorf("%d %s are not ready", status.NotReady, component)
}
}
return err
}
err1 = notReadyCheck(agents, err1, "nodes")
err2 = notReadyCheck(kvstoremesh, err2, "KVStoreMesh replicas")
checkAgents = checkAgents && err1 != nil
checkKVStoreMesh = checkKVStoreMesh && err2 != nil
if err := cmp.Or(err2, err1); err != nil {
if err := w.Retry(err); err != nil {
return agents, kvstoremesh, err
}
continue
}
}
// Return only one error rather than both, as joined errors are displayed poorly.
// And Prefer the KVStoreMesh one, given that it implies the agents one as well
// in most cases.
return agents, kvstoremesh, cmp.Or(err2, err1)
}
}
func (k *K8sClusterMesh) determineStatusConnectivity(ctx context.Context, secretName, selector string,
collector func(ctx context.Context, ciliumPod string) (*status.ClusterMeshAgentConnectivityStatus, error),
) (*ConnectivityStatus, error) {
stats := &ConnectivityStatus{
GlobalServices: StatisticalStatus{Min: -1},
Connected: StatisticalStatus{Min: -1},
Errors: status.ErrorCountMapMap{},
Clusters: map[string]*ClusterStats{},
}
// Retrieve the remote clusters to connect to from the clustermesh configuration,
// as there's no guarantee that the secret has already propagated into the agents.
// Don't fail in case the secret is not found, as it is legitimate if no cluster
// has been connected yet.
config, err := k.client.GetSecret(ctx, k.params.Namespace, secretName, metav1.GetOptions{})
if err != nil && !k8serrors.IsNotFound(err) {
return nil, fmt.Errorf("unable to retrieve configuration: %w", err)
}
var expected []string
for name, cfg := range config.Data {
// Same check as https://github.com/cilium/cilium/blob/538a18800206da0d33916f5f48853a3d4454dd81/pkg/clustermesh/internal/config.go#L68
// Additionally skip the configuration of the local cluster, if present
if name != k.clusterName && strings.Contains(string(cfg), "endpoints:") {
stats.Clusters[name] = &ClusterStats{}
expected = append(expected, name)
}
}
pods, err := k.client.ListPods(ctx, k.params.Namespace, metav1.ListOptions{LabelSelector: selector})
if err != nil {
return nil, fmt.Errorf("unable to list pods: %w", err)
}
for _, pod := range pods.Items {
s, err := collector(ctx, pod.Name)
if err != nil {
if len(expected) == 0 && errors.Is(err, status.ErrClusterMeshStatusNotAvailable) {
continue
}
return nil, fmt.Errorf("unable to determine status of pod %q: %w", pod.Name, err)
}
stats.parseAgentStatus(pod.Name, expected, s)
}
if len(pods.Items) > 0 {
stats.GlobalServices.Avg /= float64(len(pods.Items))
stats.Connected.Avg /= float64(len(pods.Items))
}
return stats, nil
}
func (k *K8sClusterMesh) Status(ctx context.Context) (*Status, error) {
err := k.GetClusterConfig(ctx)
if err != nil {
return nil, err
}
collector, err := status.NewK8sStatusCollector(k.client, status.K8sStatusParameters{
Namespace: k.params.Namespace,
})
if err != nil {
return nil, fmt.Errorf("unable to create client to collect status: %w", err)
}
k.statusCollector = collector
ctx, cancel := context.WithTimeout(ctx, k.params.waitTimeout())
defer cancel()
s := &Status{}
if k.externalKVStore {
k.Log("✅ Cilium is configured with an external kvstore")
} else {
s.AccessInformation, err = k.statusAccessInformation(ctx, true, false)
if err != nil {
return nil, err
}
k.Log("✅ Service %q of type %q found", defaults.ClusterMeshServiceName, s.AccessInformation.ServiceType)
k.Log("✅ Cluster access information is available:")
for _, ip := range s.AccessInformation.ServiceIPs {
k.Log(" - %s:%d", ip, s.AccessInformation.ServicePort)
}
err = k.statusDeployment(ctx)
if err != nil {
return nil, err
}
k.Log("✅ Deployment %s is ready", defaults.ClusterMeshDeploymentName)
s.KVStoreMesh.Enabled, err = k.kvstoremeshEnabled(ctx)
if err != nil {
return nil, err
}
status := "disabled"
if s.KVStoreMesh.Enabled {
status = "enabled"
}
k.Log("ℹ️ KVStoreMesh is %s", status)
}
s.Connectivity, s.KVStoreMesh.Status, err = k.statusConnectivity(ctx, s.KVStoreMesh.Enabled)
if k.params.Output == status.OutputJSON {
jsonStatus, err := json.MarshalIndent(s, "", " ")
if err != nil {
return nil, fmt.Errorf("failed to marshal status to JSON")
}
fmt.Println(string(jsonStatus))
return s, nil
}
if s.Connectivity != nil {
k.outputConnectivityStatus(s.Connectivity, s.KVStoreMesh.Status, s.KVStoreMesh.Enabled)
}
return s, err
}
func (k *K8sClusterMesh) outputConnectivityStatus(agents, kvstoremesh *ConnectivityStatus, kvstoremeshEnabled bool) {
outputStatusReady := func(status *ConnectivityStatus, component string) {
if status.NotReady > 0 {
k.Log("⚠️ %d/%d %s are not connected to all clusters [min:%d / avg:%.1f / max:%d]",
status.NotReady,
status.Total,
component,
status.Connected.Min,
status.Connected.Avg,
status.Connected.Max)
} else if len(status.Clusters) > 0 {
k.Log("✅ All %d %s are connected to all clusters [min:%d / avg:%.1f / max:%d]",
status.Total,
component,
status.Connected.Min,
status.Connected.Avg,
status.Connected.Max)
}
}
k.Log("")
outputStatusReady(agents, "nodes")
if kvstoremesh != nil {
outputStatusReady(kvstoremesh, "KVStoreMesh replicas")
}
k.Log("")
if len(agents.Clusters) > 0 {
k.Log("🔌 Cluster Connections:")
clusters := maps.Keys(agents.Clusters)
sort.Strings(clusters)
for _, cluster := range clusters {
stats := agents.Clusters[cluster]
line := fmt.Sprintf(" - %s: %d/%d configured, %d/%d connected",
cluster, stats.Configured, agents.Total,
stats.Connected, agents.Total)
if kvstoremesh != nil {
stats, ok := kvstoremesh.Clusters[cluster]
if !ok {
line += " - KVStoreMesh: status not available"
} else {
line += fmt.Sprintf(" - KVStoreMesh: %d/%d configured, %d/%d connected",
stats.Configured, kvstoremesh.Total,
stats.Connected, kvstoremesh.Total)
}
}
k.Log(line)
}
} else {
k.Log("🔌 No cluster connected")
}