/
kubernetes_control_plane.py
3755 lines (3221 loc) · 138 KB
/
kubernetes_control_plane.py
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
#!/usr/local/sbin/charm-env python3
# Copyright 2015 The Kubernetes Authors.
#
# 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.
import base64
import json
import os
import re
import socket
import traceback
import yaml
from itertools import filterfalse
from shutil import move, copyfile
from pathlib import Path
from subprocess import check_call, call
from subprocess import check_output
from subprocess import CalledProcessError
from urllib.request import Request, urlopen
import charms.coordinator
from charms.layer import snap
from charms.leadership import leader_get, leader_set
from charms.reactive import hook
from charms.reactive import remove_state, clear_flag
from charms.reactive import get_flags, set_state, set_flag
from charms.reactive import is_state, is_flag_set, get_unset_flags
from charms.reactive import endpoint_from_flag, endpoint_from_name
from charms.reactive import when, when_any, when_not, when_none
from charms.reactive import register_trigger
from charms.reactive import data_changed, any_file_changed
from charms.layer import tls_client
from charms.layer import vaultlocker
from charms.layer import vault_kv
from charmhelpers.core import hookenv
from charmhelpers.core import host
from charmhelpers.core import unitdata
from charmhelpers.core.host import restart_on_change
from charmhelpers.core.host import (
service_pause,
service_resume,
service_running,
service_stop,
)
from charmhelpers.core.templating import render
from charmhelpers.contrib.charmsupport import nrpe
from charmhelpers.contrib.storage.linux.ceph import CephBrokerRq
from charms.layer import kubernetes_control_plane
from charms.layer import kubernetes_common
from charms.layer.kubernetes_common import kubeclientconfig_path
from charms.layer.kubernetes_common import migrate_resource_checksums
from charms.layer.kubernetes_common import check_resources_for_upgrade_needed
from charms.layer.kubernetes_common import (
calculate_and_store_resource_checksums,
) # noqa
from charms.layer.kubernetes_common import arch
from charms.layer.kubernetes_common import service_restart
from charms.layer.kubernetes_common import get_ingress_address
from charms.layer.kubernetes_common import get_ingress_address6
from charms.layer.kubernetes_common import create_kubeconfig
from charms.layer.kubernetes_common import get_service_ip
from charms.layer.kubernetes_common import configure_kubernetes_service
from charms.layer.kubernetes_common import cloud_config_path
from charms.layer.kubernetes_common import encryption_config_path
from charms.layer.kubernetes_common import write_gcp_snap_config
from charms.layer.kubernetes_common import generate_openstack_cloud_config
from charms.layer.kubernetes_common import write_azure_snap_config
from charms.layer.kubernetes_common import configure_kube_proxy
from charms.layer.kubernetes_common import kubeproxyconfig_path
from charms.layer.kubernetes_common import get_version
from charms.layer.kubernetes_common import retry
from charms.layer.kubernetes_common import ca_crt_path
from charms.layer.kubernetes_common import server_crt_path
from charms.layer.kubernetes_common import server_key_path
from charms.layer.kubernetes_common import client_crt_path
from charms.layer.kubernetes_common import client_key_path
from charms.layer.kubernetes_common import kubectl, kubectl_manifest, kubectl_success
from charms.layer.kubernetes_common import _get_vmware_uuid
from charms.layer.kubernetes_common import get_node_name
from charms.layer.kubernetes_common import get_sandbox_image_uri
from charms.layer.kubernetes_common import kubelet_kubeconfig_path
from charms.layer.kubernetes_common import add_systemd_restart_always
from charms.layer.kubernetes_common import cni_config_exists
from charms.layer.kubernetes_node_base import LabelMaker
from charms.layer.nagios import install_nagios_plugin_from_file
from charms.layer.nagios import remove_nagios_plugin
# Override the default nagios shortname regex to allow periods, which we
# need because our bin names contain them (e.g. 'snap.foo.daemon'). The
# default regex in charmhelpers doesn't allow periods, but nagios itself does.
nrpe.Check.shortname_re = r"[\.A-Za-z0-9-_]+$"
snap_resources = [
"kubectl",
"kube-apiserver",
"kube-controller-manager",
"kube-scheduler",
"cdk-addons",
"kube-proxy",
"kubelet",
]
control_plane_services = [
"kube-apiserver",
"kube-controller-manager",
"kube-scheduler",
"kube-proxy",
"kubelet",
]
cohort_snaps = snap_resources
os.environ["PATH"] += os.pathsep + os.path.join(os.sep, "snap", "bin")
db = unitdata.kv()
checksum_prefix = "kubernetes-master.resource-checksums."
configure_prefix = "kubernetes-master.prev_args."
keystone_root = "/root/cdk/keystone"
keystone_policy_path = os.path.join(keystone_root, "keystone-policy.yaml")
kubecontrollermanagerconfig_path = "/root/cdk/kubecontrollermanagerconfig"
kubeschedulerconfig_path = "/root/cdk/kubeschedulerconfig"
cdk_addons_kubectl_config_path = "/root/cdk/cdk_addons_kubectl_config"
kubernetes_logs = "/var/log/kubernetes/"
aws_iam_webhook = "/root/cdk/aws-iam-webhook.yaml"
auth_webhook_root = "/root/cdk/auth-webhook"
auth_webhook_conf = os.path.join(auth_webhook_root, "auth-webhook-conf.yaml")
auth_webhook_exe = os.path.join(auth_webhook_root, "auth-webhook.py")
auth_webhook_svc_name = "cdk.master.auth-webhook"
auth_webhook_svc = "/etc/systemd/system/{}.service".format(auth_webhook_svc_name)
tls_ciphers_intermediate = [
# https://wiki.mozilla.org/Security/Server_Side_TLS
# https://ssl-config.mozilla.org/#server=go&config=intermediate
"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256",
"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384",
"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384",
"TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305",
"TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305",
]
register_trigger(
when="endpoint.aws.ready",
set_flag="kubernetes-control-plane.aws.changed", # when set
)
register_trigger(
when_not="endpoint.aws.ready", # when cleared
set_flag="kubernetes-control-plane.aws.changed",
)
register_trigger(
when="endpoint.azure.ready",
set_flag="kubernetes-control-plane.azure.changed", # when set
)
register_trigger(
when_not="endpoint.azure.ready", # when cleared
set_flag="kubernetes-control-plane.azure.changed",
)
register_trigger(
when="endpoint.gcp.ready",
set_flag="kubernetes-control-plane.gcp.changed", # when set
)
register_trigger(
when_not="endpoint.gcp.ready", # when cleared
set_flag="kubernetes-control-plane.gcp.changed",
)
register_trigger(
when="keystone-credentials.available", set_flag="cdk-addons.reconfigure"
)
register_trigger(
when_not="keystone-credentials.available", set_flag="cdk-addons.reconfigure"
)
register_trigger(
when="kubernetes-control-plane.aws.changed", set_flag="cdk-addons.reconfigure"
)
register_trigger(
when="kubernetes-control-plane.azure.changed", set_flag="cdk-addons.reconfigure"
)
register_trigger(
when="kubernetes-control-plane.gcp.changed", set_flag="cdk-addons.reconfigure"
)
register_trigger(
when="kubernetes-control-plane.openstack.changed", set_flag="cdk-addons.reconfigure"
)
register_trigger(
when_not="cni.available", clear_flag="kubernetes-control-plane.components.started"
)
register_trigger(
when="kube-control.requests.changed", clear_flag="authentication.setup"
)
register_trigger(
when_not="kubernetes-control-plane.apiserver.configured",
clear_flag="kubernetes-control-plane.apiserver.running",
)
register_trigger(
when="config.changed.image-registry",
clear_flag="kubernetes-control-plane.kubelet.configured",
)
register_trigger(
when="config.changed.image-registry",
clear_flag="kubernetes-control-plane.sent-registry",
)
register_trigger(
when="config.changed.default-cni",
clear_flag="kubernetes-control-plane.default-cni.configured",
)
register_trigger(
when_not="ceph-client.connected",
clear_flag="kubernetes-control-plane.ceph.pools.created",
)
register_trigger(
when_not="ceph-client.connected",
clear_flag="kubernetes-control-plane.ceph.permissions.requested",
)
register_trigger(
when="ceph-client.available",
clear_flag="kubernetes-control-plane.apiserver.configured",
)
register_trigger(
when_not="ceph-client.available",
clear_flag="kubernetes-control-plane.apiserver.configured",
)
# when CNI becomes available, reconfigure k8s services with the cluster-cidr
register_trigger(
when="cni.available", clear_flag="kubernetes-control-plane.components.started"
)
def set_upgrade_needed(forced=False):
set_state("kubernetes-control-plane.upgrade-needed")
config = hookenv.config()
previous_channel = config.previous("channel")
require_manual = config.get("require-manual-upgrade")
hookenv.log("set upgrade needed")
if previous_channel is None or not require_manual or forced:
hookenv.log("forcing upgrade")
set_state("kubernetes-control-plane.upgrade-specified")
@when("config.changed.channel")
def channel_changed():
set_upgrade_needed()
def maybe_install_kubelet():
if not snap.is_installed("kubelet"):
channel = hookenv.config("channel")
hookenv.status_set("maintenance", "Installing kubelet snap")
snap.install("kubelet", channel=channel, classic=True)
calculate_and_store_resource_checksums(checksum_prefix, snap_resources)
def maybe_install_kube_proxy():
if not snap.is_installed("kube-proxy"):
channel = hookenv.config("channel")
hookenv.status_set("maintenance", "Installing kube-proxy snap")
snap.install("kube-proxy", channel=channel, classic=True)
calculate_and_store_resource_checksums(checksum_prefix, snap_resources)
@hook("install")
def fresh_install():
# fresh installs should always send the unique cluster tag to cdk-addons
set_state("kubernetes-control-plane.cdk-addons.unique-cluster-tag")
@hook("upgrade-charm")
def check_for_upgrade_needed():
"""An upgrade charm event was triggered by Juju, react to that here."""
hookenv.status_set("maintenance", "Checking resources")
is_leader = is_state("leadership.is_leader")
# migrate to inclusive flags
old, new = "kubernetes-master", "kubernetes-control-plane" # wokeignore:rule=master
for flag in get_flags():
if flag.startswith(old):
new_flag = flag.replace(old, new, 1)
clear_flag(flag)
set_flag(new_flag)
# migrate to new flags
if is_state("kubernetes-control-plane.restarted-for-cloud"):
remove_state("kubernetes-control-plane.restarted-for-cloud")
set_state("kubernetes-control-plane.cloud.ready")
if is_state("kubernetes-control-plane.cloud-request-sent"):
# minor change, just for consistency
remove_state("kubernetes-control-plane.cloud-request-sent")
set_state("kubernetes-control-plane.cloud.request-sent")
if is_flag_set("kubernetes-control-plane.snaps.installed"):
# consistent with layer-kubernetes-node-base
remove_state("kubernetes-control-plane.snaps.installed")
set_state("kubernetes-node.snaps.installed")
# ceph-storage.configured flag no longer exists
remove_state("ceph-storage.configured")
# kubernetes-control-plane.ceph.configured flag no longer exists
remove_state("kubernetes-control-plane.ceph.configured")
maybe_install_kubelet()
maybe_install_kube_proxy()
update_certificates()
switch_auth_mode(forced=True)
# File-based auth is gone in 1.19; ensure any entries in basic_auth.csv are
# added to known_tokens.csv, and any known_tokens entries are created as secrets.
if not is_flag_set("kubernetes-control-plane.basic-auth.migrated"):
if kubernetes_control_plane.migrate_auth_file(
kubernetes_control_plane.AUTH_BASIC_FILE
):
set_flag("kubernetes-control-plane.basic-auth.migrated")
else:
hookenv.log(
"Unable to migrate {} to {}".format(
kubernetes_control_plane.AUTH_BASIC_FILE,
kubernetes_control_plane.AUTH_TOKENS_FILE,
)
)
if not is_flag_set("kubernetes-control-plane.token-auth.migrated"):
register_auth_webhook()
add_rbac_roles()
if kubernetes_control_plane.migrate_auth_file(
kubernetes_control_plane.AUTH_TOKENS_FILE
):
set_flag("kubernetes-control-plane.token-auth.migrated")
else:
hookenv.log(
"Unable to migrate {} to Kubernetes secrets".format(
kubernetes_control_plane.AUTH_TOKENS_FILE
)
)
set_state("reconfigure.authentication.setup")
remove_state("authentication.setup")
if not db.get("snap.resources.fingerprint.initialised"):
# We are here on an upgrade from non-rolling control plane
# Since this upgrade might also include resource updates eg
# juju upgrade-charm kubernetes-control-plane --resource kube-any=my.snap
# we take no risk and forcibly upgrade the snaps.
# Forcibly means we do not prompt the user to call the upgrade action.
set_upgrade_needed(forced=True)
migrate_resource_checksums(checksum_prefix, snap_resources)
if check_resources_for_upgrade_needed(checksum_prefix, snap_resources):
set_upgrade_needed()
# Set the auto storage backend to etcd2.
auto_storage_backend = leader_get("auto_storage_backend")
if not auto_storage_backend and is_leader:
leader_set(auto_storage_backend="etcd2")
if is_leader and not leader_get("auto_dns_provider"):
leader_set(auto_dns_provider="core-dns")
if is_flag_set("nrpe-external-master.available"):
update_nrpe_config()
remove_state("kubernetes-control-plane.system-monitoring-rbac-role.applied")
remove_state("kubernetes-control-plane.kubelet.configured")
remove_state("kubernetes-control-plane.default-cni.configured")
remove_state("kubernetes-control-plane.sent-registry")
remove_state("kubernetes-control-plane.ceph.permissions.requested")
# Remove services from hacluster and leave to systemd while
# hacluster is not ready to accept order and colocation constraints
if is_flag_set("ha.connected"):
hacluster = endpoint_from_flag("ha.connected")
for service in control_plane_services:
daemon = "snap.{}.daemon".format(service)
hacluster.remove_systemd_service(service, daemon)
@hook("pre-series-upgrade")
def pre_series_upgrade():
"""Stop the kubernetes control plane services"""
for service in control_plane_services:
service_pause("snap.%s.daemon" % service)
@hook("post-series-upgrade")
def post_series_upgrade():
for service in control_plane_services:
service_resume("snap.%s.daemon" % service)
# set ourselves up to restart
remove_state("kubernetes-control-plane.components.started")
@hook("leader-elected")
def leader_elected():
clear_flag("authentication.setup")
def add_rbac_roles():
"""Update the known_tokens file with proper groups.
DEPRECATED: Once known_tokens are migrated, group data will be stored in K8s
secrets. Do not use this function after migrating to authn with secrets.
"""
if is_flag_set("kubernetes-control-plane.token-auth.migrated"):
hookenv.log("Known tokens have migrated to secrets. Skipping group changes")
return
tokens_fname = "/root/cdk/known_tokens.csv"
tokens_backup_fname = "/root/cdk/known_tokens.csv.backup"
move(tokens_fname, tokens_backup_fname)
with open(tokens_fname, "w") as ftokens:
with open(tokens_backup_fname, "r") as stream:
for line in stream:
if line.startswith("#"):
continue
record = line.strip().split(",")
try:
# valid line looks like: token,username,user,groups
if record[2] == "admin" and len(record) == 3:
towrite = '{0},{1},{2},"{3}"\n'.format(
record[0], record[1], record[2], "system:masters"
)
ftokens.write(towrite)
continue
if record[2] == "kube_proxy":
towrite = "{0},{1},{2}\n".format(
record[0], "system:kube-proxy", "kube-proxy"
)
ftokens.write(towrite)
continue
if record[2] == "kube_controller_manager":
towrite = "{0},{1},{2}\n".format(
record[0],
"system:kube-controller-manager",
"kube-controller-manager",
)
ftokens.write(towrite)
continue
if record[2] == "kubelet" and record[1] == "kubelet":
continue
except IndexError:
msg = "Skipping invalid line from {}: {}".format(
tokens_backup_fname, line
)
hookenv.log(msg, level=hookenv.DEBUG)
continue
else:
ftokens.write("{}".format(line))
@when("kubernetes-control-plane.upgrade-specified")
def do_upgrade():
install_snaps()
remove_state("kubernetes-control-plane.upgrade-needed")
remove_state("kubernetes-control-plane.upgrade-specified")
def install_snaps():
channel = hookenv.config("channel")
hookenv.status_set("maintenance", "Installing core snap")
snap.install("core")
hookenv.status_set("maintenance", "Installing kubectl snap")
snap.install("kubectl", channel=channel, classic=True)
hookenv.status_set("maintenance", "Installing kube-apiserver snap")
snap.install("kube-apiserver", channel=channel)
hookenv.status_set("maintenance", "Installing kube-controller-manager snap")
snap.install("kube-controller-manager", channel=channel)
hookenv.status_set("maintenance", "Installing kube-scheduler snap")
snap.install("kube-scheduler", channel=channel)
hookenv.status_set("maintenance", "Installing cdk-addons snap")
snap.install("cdk-addons", channel=channel)
hookenv.status_set("maintenance", "Installing kubelet snap")
snap.install("kubelet", channel=channel, classic=True)
hookenv.status_set("maintenance", "Installing kube-proxy snap")
snap.install("kube-proxy", channel=channel, classic=True)
calculate_and_store_resource_checksums(checksum_prefix, snap_resources)
db.set("snap.resources.fingerprint.initialised", True)
set_state("kubernetes-node.snaps.installed")
remove_state("kubernetes-control-plane.components.started")
@when("kubernetes-node.snaps.installed", "leadership.is_leader")
@when_not("leadership.set.cohort_keys")
def create_or_update_cohort_keys():
cohort_keys = {}
for snapname in cohort_snaps:
try:
cohort_key = snap.create_cohort_snapshot(snapname)
except CalledProcessError:
# Snap store outages prevent keys from being created; log it
# and retry later. LP:1956608
hookenv.log(
"Failed to create cohort for {}; will retry".format(snapname),
level=hookenv.INFO,
)
return
cohort_keys[snapname] = cohort_key
leader_set(cohort_keys=json.dumps(cohort_keys))
hookenv.log("Snap cohort keys have been created.", level=hookenv.INFO)
# Prime revision info so we can detect changes later
cohort_revs = kubernetes_control_plane.get_snap_revs(cohort_snaps)
data_changed("leader-cohort-revs", cohort_revs)
hookenv.log(
"Tracking cohort revisions: {}".format(cohort_revs), level=hookenv.DEBUG
)
@when(
"kubernetes-node.snaps.installed",
"leadership.is_leader",
"leadership.set.cohort_keys",
)
def check_cohort_updates():
cohort_revs = kubernetes_control_plane.get_snap_revs(cohort_snaps)
if cohort_revs and data_changed("leader-cohort-revs", cohort_revs):
leader_set(cohort_keys=None)
hookenv.log("Snap cohort revisions have changed.", level=hookenv.INFO)
@when("kubernetes-node.snaps.installed", "leadership.set.cohort_keys")
@when_none("coordinator.granted.cohort", "coordinator.requested.cohort")
def safely_join_cohort():
"""Coordinate the rollout of snap refreshes.
When cohort keys change, grab a lock so that only 1 unit in the
application joins the new cohort at a time. This allows us to roll out
snap refreshes without risking all units going down at once.
"""
cohort_keys = leader_get("cohort_keys")
# NB: initial data-changed is always true
if data_changed("leader-cohorts", cohort_keys):
clear_flag("kubernetes-control-plane.cohorts.joined")
clear_flag("kubernetes-control-plane.cohorts.sent")
charms.coordinator.acquire("cohort")
@when(
"kubernetes-node.snaps.installed",
"leadership.set.cohort_keys",
"coordinator.granted.cohort",
)
@when_not("kubernetes-control-plane.cohorts.joined")
def join_or_update_cohorts():
"""Join or update a cohort snapshot.
All units of this application (leader and followers) need to refresh their
installed snaps to the current cohort snapshot.
"""
cohort_keys = json.loads(leader_get("cohort_keys"))
for snapname in cohort_snaps:
cohort_key = cohort_keys[snapname]
if snap.is_installed(snapname): # we also manage workers' cohorts
hookenv.status_set("maintenance", "Joining snap cohort.")
snap.join_cohort_snapshot(snapname, cohort_key)
set_flag("kubernetes-control-plane.cohorts.joined")
hookenv.log("{} has joined the snap cohort".format(hookenv.local_unit()))
@when(
"kubernetes-node.snaps.installed",
"leadership.set.cohort_keys",
"kubernetes-control-plane.cohorts.joined",
"kube-control.connected",
)
@when_not("kubernetes-control-plane.cohorts.sent")
def send_cohorts():
"""Send cohort information to workers.
If we have peers, wait until all peers are updated before sending.
Otherwise, we're a single unit k8s-cp and can fire when connected.
"""
cohort_keys = json.loads(leader_get("cohort_keys"))
kube_control = endpoint_from_flag("kube-control.connected")
kube_cps = endpoint_from_flag("kube-masters.connected") # wokeignore:rule=master
# If we have peers, tell them we've joined the cohort. This is needed so
# we don't tell workers about cohorts until all control planes are in-sync.
goal_peers = len(list(hookenv.expected_peer_units()))
if goal_peers > 0:
if kube_cps:
# tell peers about the cohort keys
kube_cps.set_cohort_keys(cohort_keys)
else:
msg = "Waiting for {} peers before setting the cohort.".format(goal_peers)
hookenv.log(msg, level=hookenv.DEBUG)
return
if is_flag_set("kube-masters.cohorts.ready"):
# tell workers about the cohort keys
kube_control.set_cohort_keys(cohort_keys)
hookenv.log(
"{} (peer) sent cohort keys to workers".format(hookenv.local_unit())
)
else:
msg = "Waiting for k8s-cps to agree on cohorts."
hookenv.log(msg, level=hookenv.DEBUG)
return
else:
# tell workers about the cohort keys
kube_control.set_cohort_keys(cohort_keys)
hookenv.log(
"{} (single) sent cohort keys to workers".format(hookenv.local_unit())
)
set_flag("kubernetes-control-plane.cohorts.sent")
@when("config.changed.client_password", "leadership.is_leader")
def password_changed():
"""Handle password change by reconfiguring authentication."""
remove_state("authentication.setup")
@when("config.changed.storage-backend")
def storage_backend_changed():
remove_state("kubernetes-control-plane.components.started")
@when("leadership.is_leader")
@when_not("authentication.setup")
def setup_leader_authentication():
"""
Setup service accounts and tokens for the cluster.
As of 1.19 charms, this will also propogate a generic basic_auth.csv, which is
merged into known_tokens.csv, which are migrated to secrets during upgrade-charm.
"""
basic_auth = "/root/cdk/basic_auth.csv"
known_tokens = "/root/cdk/known_tokens.csv"
service_key = "/root/cdk/serviceaccount.key"
os.makedirs("/root/cdk", exist_ok=True)
hookenv.status_set("maintenance", "Rendering authentication templates.")
keys = [basic_auth, known_tokens, service_key]
# Try first to fetch data from an old leadership broadcast.
if not get_keys_from_leader(keys) or is_state("reconfigure.authentication.setup"):
kubernetes_control_plane.deprecate_auth_file(basic_auth)
set_flag("kubernetes-control-plane.basic-auth.migrated")
kubernetes_control_plane.deprecate_auth_file(known_tokens)
set_flag("kubernetes-control-plane.token-auth.migrated")
# Generate the default service account token key
if not os.path.isfile(service_key):
cmd = ["openssl", "genrsa", "-out", service_key, "2048"]
check_call(cmd)
remove_state("reconfigure.authentication.setup")
# Write the admin token every time we setup authn to ensure we honor a
# configured password.
client_pass = hookenv.config("client_password") or get_token("admin")
setup_tokens(client_pass, "admin", "admin", "system:masters")
create_tokens_and_sign_auth_requests()
# send auth files to followers via leadership data
leader_data = {}
for f in [basic_auth, known_tokens, service_key]:
try:
with open(f, "r") as fp:
leader_data[f] = fp.read()
except FileNotFoundError:
pass
# this is slightly opaque, but we are sending file contents under its file
# path as a key.
# eg:
# {'/root/cdk/serviceaccount.key': 'RSA:2471731...'}
leader_set(leader_data)
remove_state("kubernetes-control-plane.components.started")
remove_state("kube-control.requests.changed")
set_state("authentication.setup")
@when_not("leadership.is_leader")
def setup_non_leader_authentication():
basic_auth = "/root/cdk/basic_auth.csv"
known_tokens = "/root/cdk/known_tokens.csv"
service_key = "/root/cdk/serviceaccount.key"
# Starting with 1.19, we don't use csv auth files; handle changing secrets.
secrets = {
"admin": get_token("admin"),
"kube-controller-manager": get_token("system:kube-controller-manager"),
"kube-proxy": get_token("system:kube-proxy"),
"kube-scheduler": get_token("system:kube-scheduler"),
}
if data_changed("secrets-data", secrets):
set_flag("kubernetes-control-plane.token-auth.migrated")
build_kubeconfig()
remove_state("kubernetes-control-plane.components.started")
keys = [basic_auth, known_tokens, service_key]
# Pre-secrets, the source of truth for non-leaders is the leader.
# Therefore we overwrite_local with whatever the leader has.
if not get_keys_from_leader(keys, overwrite_local=True):
# the keys were not retrieved. Non-leaders have to retry.
return
if any_file_changed(keys):
remove_state("kubernetes-control-plane.components.started")
# Clear stale creds from the kube-control relation so that the leader can
# assume full control of them.
kube_control = endpoint_from_flag("kube-control.connected")
if kube_control:
kube_control.clear_creds()
remove_state("kube-control.requests.changed")
set_state("authentication.setup")
def get_keys_from_leader(keys, overwrite_local=False):
"""
Gets the broadcasted keys from the leader and stores them in
the corresponding files.
Args:
keys: list of keys. Keys are actually files on the FS.
Returns: True if all key were fetched, False if not.
"""
# This races with other codepaths, and seems to require being created first
# This block may be extracted later, but for now seems to work as intended
os.makedirs("/root/cdk", exist_ok=True)
for k in keys:
# If the path does not exist, assume we need it
if not os.path.exists(k) or overwrite_local:
# Fetch data from leadership broadcast
contents = leader_get(k)
# Default to logging the warning and wait for leader data to be set
if contents is None:
hookenv.log("Missing content for file {}".format(k))
return False
# Write out the file and move on to the next item
with open(k, "w+") as fp:
fp.write(contents)
fp.write("\n")
return True
@when("kubernetes-node.snaps.installed")
def set_app_version():
"""Declare the application version to juju"""
version = check_output(["kube-apiserver", "--version"])
hookenv.application_version_set(version.split(b" v")[-1].rstrip())
@hookenv.atstart
def check_vault_pending():
try:
goal_state = hookenv.goal_state()
except NotImplementedError:
goal_state = {}
vault_kv_goal = "vault-kv" in goal_state.get("relations", {})
vault_kv_connected = is_state("vault-kv.connected")
vault_kv_related = vault_kv_goal or vault_kv_connected
vault_kv_ready = is_state("layer.vault-kv.ready")
if vault_kv_related and not vault_kv_ready:
set_flag("kubernetes-control-plane.vault-kv.pending")
else:
clear_flag("kubernetes-control-plane.vault-kv.pending")
@hookenv.atexit
def set_final_status():
"""Set the final status of the charm as we leave hook execution"""
try:
goal_state = hookenv.goal_state()
except NotImplementedError:
goal_state = {}
if is_flag_set("upgrade.series.in-progress"):
hookenv.status_set("blocked", "Series upgrade in progress")
return
if not is_flag_set("certificates.available"):
if "certificates" in goal_state.get("relations", {}):
hookenv.status_set("waiting", "Waiting for certificates authority.")
else:
hookenv.status_set("blocked", "Missing relation to certificate authority.")
return
if is_flag_set("kubernetes-control-plane.secure-storage.failed"):
hookenv.status_set(
"blocked",
"Failed to configure encryption; "
"secrets are unencrypted or inaccessible",
)
return
elif is_flag_set("kubernetes-control-plane.secure-storage.created"):
if not encryption_config_path().exists():
hookenv.status_set(
"blocked", "VaultLocker containing encryption config unavailable"
)
return
vsphere_joined = is_state("endpoint.vsphere.joined")
azure_joined = is_state("endpoint.azure.joined")
cloud_blocked = is_state("kubernetes-control-plane.cloud.blocked")
if vsphere_joined and cloud_blocked:
hookenv.status_set(
"blocked", "vSphere integration requires K8s 1.12 or greater"
)
return
if azure_joined and cloud_blocked:
hookenv.status_set("blocked", "Azure integration requires K8s 1.11 or greater")
return
if not is_flag_set("kubernetes.cni-plugins.installed"):
hookenv.status_set("blocked", "Missing CNI resource")
return
if is_state("kubernetes-control-plane.cloud.pending"):
hookenv.status_set("waiting", "Waiting for cloud integration")
return
if "kube-api-endpoint" in goal_state.get("relations", {}):
if not is_state("kube-api-endpoint.available"):
hookenv.status_set("waiting", "Waiting for kube-api-endpoint relation")
return
for lb_endpoint in ("loadbalancer-internal", "loadbalancer-external"):
if lb_endpoint in goal_state.get("relations", {}):
lb_provider = endpoint_from_name(lb_endpoint)
if not lb_provider.has_response:
hookenv.status_set("waiting", "Waiting for " + lb_endpoint)
return
ks = endpoint_from_flag("keystone-credentials.available")
if ks and ks.api_version() == "2":
msg = "Keystone auth v2 detected. v3 is required."
hookenv.status_set("blocked", msg)
return
upgrade_needed = is_state("kubernetes-control-plane.upgrade-needed")
upgrade_specified = is_state("kubernetes-control-plane.upgrade-specified")
if upgrade_needed and not upgrade_specified:
msg = "Needs manual upgrade, run the upgrade action"
hookenv.status_set("blocked", msg)
return
try:
get_dns_provider()
except InvalidDnsProvider as e:
if e.value == "core-dns":
msg = "dns-provider=core-dns requires k8s 1.14+"
else:
msg = "dns-provider=%s is invalid" % e.value
hookenv.status_set("blocked", msg)
return
if is_state("kubernetes-control-plane.vault-kv.pending"):
hookenv.status_set(
"waiting", "Waiting for encryption info from Vault to secure secrets"
)
return
if is_state("kubernetes-control-plane.had-service-cidr-expanded"):
hookenv.status_set(
"waiting", "Waiting to retry updates for service-cidr expansion"
)
return
if not is_state("etcd.available"):
if "etcd" in goal_state.get("relations", {}):
status = "waiting"
else:
status = "blocked"
hookenv.status_set(status, "Waiting for etcd")
return
if not is_state("cni.available"):
if "cni" in goal_state.get("relations", {}):
hookenv.status_set("waiting", "Waiting for CNI plugins to become available")
return
elif not cni_config_exists():
hookenv.status_set("blocked", "Missing CNI relation or config")
return
if not is_state("tls_client.certs.saved"):
hookenv.status_set("waiting", "Waiting for certificates")
return
if not is_flag_set("kubernetes-control-plane.auth-webhook-service.started"):
hookenv.status_set("waiting", "Waiting for auth-webhook service to start")
return
if not is_flag_set("kubernetes-control-plane.apiserver.configured"):
hookenv.status_set("waiting", "Waiting for API server to be configured")
return
if not is_flag_set("kubernetes-control-plane.apiserver.running"):
hookenv.status_set("waiting", "Waiting for API server to start")
return
authentication_setup = is_state("authentication.setup")
if not authentication_setup:
hookenv.status_set("waiting", "Waiting for crypto keys.")
return
if not is_flag_set("kubernetes-control-plane.auth-webhook-tokens.setup"):
hookenv.status_set("waiting", "Waiting for auth-webhook tokens")
return
if is_state("kubernetes-control-plane.components.started"):
# All services should be up and running at this point. Double-check...
failing_services = control_plane_services_down()
if len(failing_services) != 0:
msg = "Stopped services: {}".format(",".join(failing_services))
hookenv.status_set("blocked", msg)
if is_flag_set("ha.connected"):
hookenv.log("Disabling node to pass resources to other nodes")
cmd = "crm -w -F node standby"
call(cmd.split())
for service in failing_services:
heal_handler = HEAL_HANDLER[service]
for flag in heal_handler["clear_flags"]:
clear_flag(flag)
heal_handler["run"]()
set_flag("kubernetes-control-plane.components.failed")
return
else:
if is_flag_set("kubernetes-control-plane.components.failed"):
if is_flag_set("ha.connected"):
hookenv.log("Enabling node again to receive resources")
cmd = "crm -w -F node online"
call(cmd.split())
clear_flag("kubernetes-control-plane.components.failed")
else:
# if we don't have components starting, we're waiting for that and
# shouldn't fall through to Kubernetes control plane running.
hookenv.status_set(
"maintenance", "Waiting for control plane components to start"
)
return
# Note that after this point, kubernetes-control-plane.components.started is
# always True.
is_leader = is_state("leadership.is_leader")
addons_configured = is_state("cdk-addons.configured")
if is_leader and not addons_configured:
hookenv.status_set("waiting", "Waiting to retry addon deployment")
return
if is_leader and not is_state(
"kubernetes-control-plane.system-monitoring-rbac-role.applied"
):
msg = "Waiting to retry applying system:monitoring RBAC role"
hookenv.status_set("waiting", msg)
return
try:
unready = get_kube_system_pods_not_running()
except FailedToGetPodStatus:
hookenv.status_set("waiting", "Waiting for kube-system pods to start")
return
if unready:
plural = "s" if len(unready) > 1 else ""
msg = "Waiting for {} kube-system pod{} to start"
msg = msg.format(len(unready), plural)
hookenv.status_set("waiting", msg)
return
service_cidr = kubernetes_control_plane.service_cidr()
if hookenv.config("service-cidr") != service_cidr:
msg = "WARN: cannot change service-cidr, still using " + service_cidr
hookenv.status_set("active", msg)
return
gpu_available = is_state("kube-control.gpu.available")
gpu_enabled = is_state("kubernetes-control-plane.gpu.enabled")
if gpu_available and not gpu_enabled:
msg = 'GPUs available. Set allow-privileged="auto" to enable.'
hookenv.status_set("active", msg)
return
if is_flag_set("ceph-storage.available"):
hookenv.status_set(
"blocked", "ceph-storage relation deprecated, use ceph-client instead"
)