Source file client.ml
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
module Transport = struct
type request = {
cancel : Cancel.t option;
meth : Http.meth;
target : string;
headers : (string * string) list;
body : string option;
on_chunk : (string -> unit) option;
max_body_bytes : int option;
}
type websocket_request = {
cancel : Cancel.t option;
target : string;
headers : (string * string) list;
protocols : string list;
max_message_bytes : int option;
max_error_body_bytes : int option;
}
type sensitive_request = {
cancel : Cancel.t option;
meth : Http.meth;
target : string;
headers : (string * string) list;
secret_headers : (string * Secret.t) list;
body : Secret.t option;
max_body_bytes : int option;
hardened : bool;
}
type t = {
execute_fn : request -> (Http.response, string) result;
websocket_fn :
(websocket_request -> (Websocket.t, Websocket.connect_error) result)
option;
sensitive_fn :
(sensitive_request -> (Http.Sensitive.response, string) result) option;
close_fn : unit -> unit;
closed_error : string;
closed : bool Atomic.t;
}
let make_with_closed_error ?(close = fun () -> ()) ?websocket ?sensitive
~closed_error execute_fn =
{
execute_fn;
websocket_fn = websocket;
sensitive_fn = sensitive;
close_fn = close;
closed_error;
closed = Atomic.make false;
}
let make ?close ?websocket ?sensitive execute_fn =
make_with_closed_error ?close ?websocket ?sensitive
~closed_error:"client transport is closed" execute_fn
let execute transport (request : request) =
if Atomic.get transport.closed then Error transport.closed_error
else if Option.fold ~none:false ~some:Cancel.is_cancelled request.cancel
then Error "request cancelled"
else
let limit =
Option.value ~default:(32 * 1024 * 1024) request.max_body_bytes
in
if limit < 0 then Error "max_body_bytes must not be negative"
else
match
try transport.execute_fn request
with exn ->
Error ("client transport raised: " ^ Printexc.to_string exn)
with
| Ok response when String.length response.Http.body > limit ->
Error (Printf.sprintf "HTTP body exceeds %d bytes" limit)
| result -> result
let websocket transport (request : websocket_request) =
if Atomic.get transport.closed then
Error (Websocket.Transport transport.closed_error)
else if Option.fold ~none:false ~some:Cancel.is_cancelled request.cancel
then Error (Websocket.Transport "request cancelled")
else
match transport.websocket_fn with
| None ->
Error
(Websocket.Transport
"client transport does not support WebSocket upgrades")
| Some connect -> (
try connect request
with exn ->
Error
(Websocket.Transport
("client transport raised during WebSocket upgrade: "
^ Printexc.to_string exn)))
let execute_sensitive transport (request : sensitive_request) =
if Atomic.get transport.closed then Error transport.closed_error
else if Option.fold ~none:false ~some:Cancel.is_cancelled request.cancel
then Error "request cancelled"
else if Option.value ~default:(32 * 1024 * 1024) request.max_body_bytes < 0
then Error "max_body_bytes must not be negative"
else
match transport.sensitive_fn with
| None -> Error "client transport does not support protected requests"
| Some execute -> (
try execute request
with exn ->
Error
("client transport raised during protected request: "
^ Printexc.to_string exn))
let close transport =
if Atomic.compare_and_set transport.closed false true then
transport.close_fn ()
end
type t = {
config : Config.t;
transport : Transport.t;
rate_limiter : Rate_limiter.t;
logger : Log.t;
next_request_id : int Atomic.t;
}
type api_error = {
code : int;
reason : string option;
message : string;
retry_after_seconds : int option;
body : Yojson.Safe.t option;
}
type error =
| Transport of string
| Api of api_error
| Decode of string
| Invalid_request of string
module Error = struct
let status_code = function
| Api error -> Some error.code
| _ -> None
let reason = function
| Api error -> error.reason
| _ -> None
let known_reasons =
[
"Unauthorized";
"Forbidden";
"NotFound";
"AlreadyExists";
"Conflict";
"Gone";
"Invalid";
"ServerTimeout";
"Timeout";
"TooManyRequests";
"BadRequest";
"MethodNotAllowed";
"NotAcceptable";
"RequestEntityTooLarge";
"UnsupportedMediaType";
"InternalError";
"Expired";
"ServiceUnavailable";
"StoreReadError";
]
let reason_is_known reason = List.mem reason known_reasons
let matches ~reason ~code = function
| Api error -> (
match error.reason with
| Some candidate when candidate = reason -> true
| Some candidate when reason_is_known candidate -> false
| None | Some _ -> error.code = code)
| Transport _ | Decode _ | Invalid_request _ -> false
let is_unauthorized = matches ~reason:"Unauthorized" ~code:401
let is_forbidden = matches ~reason:"Forbidden" ~code:403
let is_not_found = matches ~reason:"NotFound" ~code:404
let is_already_exists = matches ~reason:"AlreadyExists" ~code:409
let is_conflict = matches ~reason:"Conflict" ~code:409
let is_gone = matches ~reason:"Gone" ~code:410
let is_resource_expired = matches ~reason:"Expired" ~code:410
let is_invalid = matches ~reason:"Invalid" ~code:422
let is_bad_request = matches ~reason:"BadRequest" ~code:400
let is_method_not_supported = matches ~reason:"MethodNotAllowed" ~code:405
let is_not_acceptable = matches ~reason:"NotAcceptable" ~code:406
let is_request_entity_too_large =
matches ~reason:"RequestEntityTooLarge" ~code:413
let is_unsupported_media_type =
matches ~reason:"UnsupportedMediaType" ~code:415
let is_timeout = matches ~reason:"Timeout" ~code:504
let is_server_timeout = function
| Api { reason = Some "ServerTimeout"; _ } -> true
| _ -> false
let is_too_many_requests = matches ~reason:"TooManyRequests" ~code:429
let is_internal_error = matches ~reason:"InternalError" ~code:500
let is_service_unavailable = matches ~reason:"ServiceUnavailable" ~code:503
let suggested_delay = function
| Api { retry_after_seconds = Some seconds; _ } ->
Some (float_of_int seconds)
| error when is_server_timeout error -> Some 0.
| Transport _ | Api _ | Decode _ | Invalid_request _ -> None
let is_transient = function
| Transport _ -> true
| Api _ as error -> (
is_timeout error || is_server_timeout error
|| is_too_many_requests error || is_internal_error error
|| is_service_unavailable error
||
match status_code error with
| Some (408 | 425 | 502 | 504) -> true
| Some code when code >= 500 && code <= 599 -> true
| Some _ | None -> false)
| Decode _ | Invalid_request _ -> false
end
type patch =
| Json_patch of Yojson.Safe.t
| Merge_patch of Yojson.Safe.t
| Apply of { value : Yojson.Safe.t; field_manager : string; force : bool }
type field_validation = [ `Ignore | `Warn | `Strict ]
type write_options = {
dry_run : string list;
field_manager : string option;
field_validation : field_validation option;
}
let default_write_options =
{ dry_run = []; field_manager = None; field_validation = None }
type propagation_policy = [ `Orphan | `Background | `Foreground ]
type delete_options = {
grace_period_seconds : int option;
propagation_policy : propagation_policy option;
precondition_uid : string option;
precondition_resource_version : Core.Resource_version.t option;
dry_run : string list;
}
let default_delete_options =
{
grace_period_seconds = None;
propagation_policy = None;
precondition_uid = None;
precondition_resource_version = None;
dry_run = [];
}
type scale_spec = { replicas : int32 }
type scale_status = { replicas : int32; selector : string option }
type scale = {
api_version : string;
kind : string;
metadata : Core.object_meta;
spec : scale_spec;
status : scale_status option;
}
type log_stream = [ `All | `Stdout | `Stderr ]
type log_options = {
container : string option;
follow : bool;
previous : bool;
since_seconds : int option;
since_time : string option;
timestamps : bool;
tail_lines : int64 option;
limit_bytes : int64 option;
insecure_skip_tls_verify_backend : bool;
stream : log_stream option;
}
let default_log_options =
{
container = None;
follow = false;
previous = false;
since_seconds = None;
since_time = None;
timestamps = false;
tail_lines = None;
limit_bytes = None;
insecure_skip_tls_verify_backend = false;
stream = None;
}
type 'a list_result = {
items : 'a list;
resource_version : Core.Resource_version.t;
continue_token : string option;
remaining_item_count : int option;
}
type 'a watch_event =
| Added of 'a
| Modified of 'a
| Deleted of 'a
| Bookmark of Core.Resource_version.t option
| Watch_error of api_error
type watch_outcome =
| Watch_ended of Core.Resource_version.t
| Resource_version_expired
let ( let* ) result fn =
match result with
| Ok value -> fn value
| Error _ as error -> error
let create_with_transport ?rate_limiter ?(logger = Log.null) ~transport config =
let rate_limiter =
match rate_limiter with
| Some rate_limiter -> rate_limiter
| None -> Rate_limiter.create ~qps:20.0 ~burst:30
in
{ config; transport; rate_limiter; logger; next_request_id = Atomic.make 0 }
let create ?max_idle_connections ?connect_timeout ?write_timeout
? ?rate_limiter ?(logger = Log.null) config =
let http =
Http.create ?max_idle_connections ?connect_timeout ?write_timeout
?response_header_timeout config
in
let websocket_lock = Mutex.create () in
let websocket_closed = ref false in
let websockets = ref [] in
let close_native_transport () =
Mutex.lock websocket_lock;
websocket_closed := true;
let active = !websockets in
websockets := [];
Mutex.unlock websocket_lock;
List.iter Websocket.close active;
Http.close http
in
let open_websocket (request : Transport.websocket_request) =
match
Websocket.connect ?cancel:request.Transport.cancel
~headers:request.headers ~protocols:request.protocols
?max_message_bytes:request.max_message_bytes
?max_error_body_bytes:request.max_error_body_bytes config request.target
with
| Error _ as error -> error
| Ok socket ->
Mutex.lock websocket_lock;
websockets :=
List.filter (fun value -> not (Websocket.is_closed value)) !websockets;
let closed = !websocket_closed in
if not closed then websockets := socket :: !websockets;
Mutex.unlock websocket_lock;
if closed then (
Websocket.close socket;
Error (Websocket.Transport "HTTP transport is closed"))
else Ok socket
in
let transport =
Transport.make_with_closed_error ~closed_error:"HTTP transport is closed"
~close:close_native_transport ~websocket:open_websocket
~sensitive:(fun request ->
Http.Sensitive.request ?cancel:request.Transport.cancel
~headers:request.headers ~secret_headers:request.secret_headers
?body:request.body ?max_body_bytes:request.max_body_bytes
~hardened:request.hardened http request.meth request.target)
(fun request ->
Http.request ?cancel:request.cancel ~headers:request.headers
?body:request.body ?on_chunk:request.on_chunk
?max_body_bytes:request.max_body_bytes http request.meth
request.target)
in
create_with_transport ?rate_limiter ~logger ~transport config
let close client = Transport.close client.transport
let config client = client.config
let logger client = client.logger
let pp_error formatter = function
| Transport message -> Format.fprintf formatter "transport error: %s" message
| Decode message -> Format.fprintf formatter "decode error: %s" message
| Invalid_request message ->
Format.fprintf formatter "invalid request: %s" message
| Api error ->
Format.fprintf formatter "Kubernetes API error %d%s%s: %s" error.code
(match error.reason with
| None -> ""
| Some reason -> " " ^ reason)
(match error.retry_after_seconds with
| None -> ""
| Some seconds -> Printf.sprintf " (retry after %ds)" seconds)
error.message
let json_member name = function
| `Assoc fields -> List.assoc_opt name fields
| _ -> None
let json_string = function
| `String value -> Some value
| _ -> None
let json_int = function
| `Int value -> Some value
| `Intlit value -> int_of_string_opt value
| _ -> None
let json_int64 = function
| `Int value -> Some (Int64.of_int value)
| `Intlit value -> Int64.of_string_opt value
| _ -> None
let int32_of_json context json =
match json_int64 json with
| Some value
when Int64.compare value (Int64.of_int32 Int32.min_int) >= 0
&& Int64.compare value (Int64.of_int32 Int32.max_int) <= 0 ->
Ok (Int64.to_int32 value)
| Some _ -> Error (context ^ " is outside the int32 range")
| None -> Error (context ^ " must be an integer")
let scale_of_json json =
let required_string context name =
match Option.bind (json_member name json) json_string with
| Some value -> Ok value
| None -> Error (context ^ " is required")
in
let* api_version = required_string "Scale.apiVersion" "apiVersion" in
let* () =
if api_version = "autoscaling/v1" then Ok ()
else Error ("unsupported Scale apiVersion " ^ api_version)
in
let* kind = required_string "Scale.kind" "kind" in
let* () =
if kind = "Scale" then Ok () else Error ("unexpected Scale kind " ^ kind)
in
let* metadata = Core.object_meta_of_json json in
let* spec =
match json_member "spec" json with
| Some (`Assoc _ as spec) -> (
match json_member "replicas" spec with
| Some value ->
let* replicas = int32_of_json "Scale.spec.replicas" value in
Ok { replicas }
| None -> Ok { replicas = 0l })
| Some _ -> Error "Scale.spec must be an object"
| None -> Error "Scale.spec is required"
in
let* status =
match json_member "status" json with
| None | Some `Null -> Ok None
| Some (`Assoc _ as status) -> (
match json_member "replicas" status with
| None -> Error "Scale.status.replicas is required"
| Some value ->
let* replicas = int32_of_json "Scale.status.replicas" value in
let* selector =
match json_member "selector" status with
| None | Some `Null -> Ok None
| Some (`String value) -> Ok (Some value)
| Some _ -> Error "Scale.status.selector must be a string"
in
Ok (Some { replicas; selector }))
| Some _ -> Error "Scale.status must be an object"
in
Ok { api_version; kind; metadata; spec; status }
let scale_to_json scale =
let status =
match scale.status with
| None -> []
| Some status ->
[
( "status",
`Assoc
([ ("replicas", `Int (Int32.to_int status.replicas)) ]
@
match status.selector with
| None -> []
| Some selector -> [ ("selector", `String selector) ]) );
]
in
`Assoc
([
("apiVersion", `String scale.api_version);
("kind", `String scale.kind);
("metadata", Core.object_meta_to_json scale.metadata);
("spec", `Assoc [ ("replicas", `Int (Int32.to_int scale.spec.replicas)) ]);
]
@ status)
let retry_after_of_status body =
Option.bind body (json_member "details") |> fun details ->
Option.bind details (json_member "retryAfterSeconds") |> fun value ->
Option.bind value json_int |> fun seconds ->
Option.bind seconds (fun seconds ->
if seconds < 0 then None else Some seconds)
let =
List.find_map
(fun (name, value) ->
if String.lowercase_ascii name <> "retry-after" then None
else
match int_of_string_opt (String.trim value) with
| Some seconds when seconds >= 0 -> Some seconds
| Some _ | None -> None)
headers
let api_error_of_response response =
let body =
try Some (Yojson.Safe.from_string response.Http.body)
with Yojson.Json_error _ -> None
in
let reason =
Option.bind (Option.bind body (json_member "reason")) json_string
in
let message =
Option.bind (Option.bind body (json_member "message")) json_string
|> Option.value
~default:
(if response.reason = "" then response.body else response.reason)
in
let code =
Option.bind (Option.bind body (json_member "code")) json_int
|> Option.value ~default:response.status
in
let retry_after_seconds =
match retry_after_of_headers response.headers with
| Some _ as value -> value
| None -> retry_after_of_status body
in
{ code; reason; message; retry_after_seconds; body }
let raw_unlogged ?cancel ?( = []) ?body ?on_chunk ?max_body_bytes client
meth path =
let* () =
if Rate_limiter.acquire ?cancel client.rate_limiter then Ok ()
else Error (Transport "request cancelled while waiting for rate limiter")
in
let authorization () =
match Config.authorization_header client.config with
| Ok value -> Ok value
| Error message -> Error (Transport message)
in
let =
if
List.exists
(fun (name, _) -> String.lowercase_ascii name = "impersonate-user")
headers
then headers
else Config.impersonation_headers client.config @ headers
in
let perform authorization =
let =
match authorization with
| None -> headers
| Some value -> ("Authorization", value) :: headers
in
match
Transport.execute client.transport
{ cancel; meth; target = path; headers; body; on_chunk; max_body_bytes }
with
| Error message -> Error (Transport message)
| Ok response -> Ok response
in
let* first_authorization = authorization () in
let* response = perform first_authorization in
let* response =
if response.status = 401 && Config.invalidate_credential client.config then
let* refreshed_authorization = authorization () in
perform refreshed_authorization
else Ok response
in
match response with
| response when response.status >= 200 && response.status < 300 -> Ok response
| response -> Error (Api (api_error_of_response response))
let websocket_unlogged ?cancel ?( = []) ?(protocols = [])
?max_message_bytes ?max_error_body_bytes client path =
let* () =
if Rate_limiter.acquire ?cancel client.rate_limiter then Ok ()
else Error (Transport "request cancelled while waiting for rate limiter")
in
let authorization () =
match Config.authorization_header client.config with
| Ok value -> Ok value
| Error message -> Error (Transport message)
in
let =
if
List.exists
(fun (name, _) -> String.lowercase_ascii name = "impersonate-user")
headers
then headers
else Config.impersonation_headers client.config @ headers
in
let perform authorization =
let =
match authorization with
| None -> headers
| Some value -> ("Authorization", value) :: headers
in
Transport.websocket client.transport
{
cancel;
target = path;
headers;
protocols;
max_message_bytes;
max_error_body_bytes;
}
in
let* first_authorization = authorization () in
let first = perform first_authorization in
let* result =
match first with
| Error (Websocket.Http_response response)
when response.status = 401 && Config.invalidate_credential client.config
->
let* refreshed_authorization = authorization () in
Ok (perform refreshed_authorization)
| result -> Ok result
in
match result with
| Ok connection -> Ok connection
| Error (Websocket.Http_response response) ->
Error (Api (api_error_of_response response))
| Error (Websocket.Transport message) -> Error (Transport message)
| Error (Websocket.Protocol message) ->
Error (Transport ("WebSocket protocol error: " ^ message))
let method_string = function
| `GET -> "GET"
| `POST -> "POST"
| `PUT -> "PUT"
| `PATCH -> "PATCH"
| `DELETE -> "DELETE"
let target_path value =
try Uri.path (Uri.of_string value) with _ -> "<invalid>"
let raw ?cancel ? ?body ?on_chunk ?max_body_bytes client meth path =
if not (Log.enabled client.logger Log.Debug) then
raw_unlogged ?cancel ?headers ?body ?on_chunk ?max_body_bytes client meth
path
else
let request_id = Atomic.fetch_and_add client.next_request_id 1 in
let started = Clock.now () in
let common =
[
("request_id", Log.Int request_id);
("method", Log.String (method_string meth));
("path", Log.String (target_path path));
]
in
Log.debug client.logger ~fields:common "Kubernetes API request started";
let result =
raw_unlogged ?cancel ?headers ?body ?on_chunk ?max_body_bytes client meth
path
in
let outcome_fields =
match result with
| Ok response ->
[
("result", Log.String "ok");
("status_code", Log.Int response.Http.status);
]
| Error (Api error) ->
[
("result", Log.String "api_error");
("status_code", Log.Int error.code);
]
| Error (Transport _) -> [ ("result", Log.String "transport_error") ]
| Error (Decode _) -> [ ("result", Log.String "decode_error") ]
| Error (Invalid_request _) ->
[ ("result", Log.String "invalid_request") ]
in
Log.debug client.logger
~fields:
(common
@ ("duration_seconds", Log.Float (Clock.elapsed started))
:: outcome_fields)
"Kubernetes API request completed";
result
module Sensitive = struct
type write_result = { resource_version : string option }
type secret_manifest = {
namespace : string;
name : string;
type_ : string option;
immutable : bool option;
labels : (string * string) list;
annotations : (string * string) list;
owner_references : Core.owner_reference list;
data : (string * Secret.t) list;
}
type segment = Public of string | Base64 of Secret.t
let base64_length length =
if length > (max_int - 2) / 4 * 3 then None else Some ((length + 2) / 3 * 4)
let segment_length = function
| Public value -> Some (String.length value)
| Base64 value -> base64_length (Secret.length value)
let total_length segments =
List.fold_left
(fun total segment ->
match (total, segment_length segment) with
| Some total, Some length when length <= max_int - total ->
Some (total + length)
| _ -> None)
(Some 0) segments
let base64_alphabet =
"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"
let write_base64 source output offset =
Secret.Unsafe.with_string_view source (fun input ->
let length = String.length input in
let rec loop input_offset output_offset =
if input_offset + 3 <= length then (
let a = Char.code input.[input_offset] in
let b = Char.code input.[input_offset + 1] in
let c = Char.code input.[input_offset + 2] in
Bytes.set output output_offset base64_alphabet.[a lsr 2];
Bytes.set output (output_offset + 1)
base64_alphabet.[((a land 0x03) lsl 4) lor (b lsr 4)];
Bytes.set output (output_offset + 2)
base64_alphabet.[((b land 0x0f) lsl 2) lor (c lsr 6)];
Bytes.set output (output_offset + 3) base64_alphabet.[c land 0x3f];
loop (input_offset + 3) (output_offset + 4))
else if input_offset < length then (
let a = Char.code input.[input_offset] in
Bytes.set output output_offset base64_alphabet.[a lsr 2];
if input_offset + 1 < length then (
let b = Char.code input.[input_offset + 1] in
Bytes.set output (output_offset + 1)
base64_alphabet.[((a land 0x03) lsl 4) lor (b lsr 4)];
Bytes.set output (output_offset + 2)
base64_alphabet.[(b land 0x0f) lsl 2];
Bytes.set output (output_offset + 3) '=')
else (
Bytes.set output (output_offset + 1)
base64_alphabet.[(a land 0x03) lsl 4];
Bytes.set output (output_offset + 2) '=';
Bytes.set output (output_offset + 3) '=');
output_offset + 4)
else output_offset
in
loop 0 offset)
let with_segments ?(hardened = false) segments fn =
match total_length segments with
| None -> Error (Invalid_request "protected JSON body is too large")
| Some length when length > 1024 * 1024 ->
Error
(Invalid_request
"protected Kubernetes Secret body exceeds the 1 MiB limit")
| Some length ->
Secret.with_secret ~hardened length (fun output ->
Secret.Unsafe.with_bytes_view output (fun bytes ->
ignore
(List.fold_left
(fun offset -> function
| Public value ->
Bytes.blit_string value 0 bytes offset
(String.length value);
offset + String.length value
| Base64 value -> write_base64 value bytes offset)
0 segments));
Ok (fn output))
let safe_reason meth status =
match (meth, status) with
| `POST, 409 -> Some "AlreadyExists"
| _, status -> (
match status with
| 400 -> Some "BadRequest"
| 401 -> Some "Unauthorized"
| 403 -> Some "Forbidden"
| 404 -> Some "NotFound"
| 409 -> Some "Conflict"
| 410 -> Some "Gone"
| 413 -> Some "RequestEntityTooLarge"
| 415 -> Some "UnsupportedMediaType"
| 422 -> Some "Invalid"
| 429 -> Some "TooManyRequests"
| 500 -> Some "InternalError"
| 503 -> Some "ServiceUnavailable"
| 504 -> Some "Timeout"
| _ -> None)
let api_error_of_sensitive_response meth response =
let retry_after_seconds =
retry_after_of_headers response.Http.Sensitive.headers
in
{
code = response.status;
reason = safe_reason meth response.status;
message =
(if response.reason = "" then
Printf.sprintf "Kubernetes API returned HTTP %d" response.status
else response.reason);
retry_after_seconds;
body = None;
}
let raw_unlogged ?cancel ?( = []) ?( = []) ?body
?max_body_bytes ?(hardened = false) ?(strict_credentials = true) client
meth path =
let* () =
if strict_credentials && client.config.tls.client_key_pem <> None then
Error
(Invalid_request
"strict protected transport rejects heap-originating client keys")
else if
strict_credentials
&& Option.fold ~none:false
~some:(fun proxy -> Uri.userinfo proxy <> None)
client.config.proxy_url
then
Error
(Invalid_request
"strict protected transport rejects heap-originating proxy \
credentials")
else if Rate_limiter.acquire ?cancel client.rate_limiter then Ok ()
else Error (Transport "request cancelled while waiting for rate limiter")
in
let =
if
List.exists
(fun (name, _) -> String.lowercase_ascii name = "impersonate-user")
headers
then headers
else Config.impersonation_headers client.config @ headers
in
let perform ~origin authorization =
if strict_credentials && origin = `Heap then
Error
(Invalid_request
"strict protected transport rejects heap-originating credentials")
else
let =
match authorization with
| None -> secret_headers
| Some value -> ("Authorization", value) :: secret_headers
in
match
Transport.execute_sensitive client.transport
{
cancel;
meth;
target = path;
headers;
secret_headers;
body;
max_body_bytes;
hardened;
}
with
| Error message -> Error (Transport message)
| Ok response when response.status >= 200 && response.status < 300 ->
Ok response
| Ok response ->
let error = api_error_of_sensitive_response meth response in
Secret.destroy response.body;
Error (Api error)
in
match
Config.with_authorization_secret ~hardened client.config (fun ~origin ->
perform ~origin)
with
| Error message -> Error (Transport message)
| Ok result -> result
let raw ?cancel ? ? ?body ?max_body_bytes ?hardened
?strict_credentials client meth path =
if not (Log.enabled client.logger Log.Debug) then
raw_unlogged ?cancel ?headers ?secret_headers ?body ?max_body_bytes
?hardened ?strict_credentials client meth path
else
let request_id = Atomic.fetch_and_add client.next_request_id 1 in
let started = Clock.now () in
let common =
[
("request_id", Log.Int request_id);
("method", Log.String (method_string meth));
("path", Log.String (target_path path));
]
in
Log.debug client.logger ~fields:common
"protected Kubernetes API request started";
let result =
raw_unlogged ?cancel ?headers ?secret_headers ?body ?max_body_bytes
?hardened ?strict_credentials client meth path
in
let fields =
match result with
| Ok response ->
[
("result", Log.String "ok");
("status_code", Log.Int response.Http.Sensitive.status);
]
| Error (Api error) ->
[
("result", Log.String "api_error");
("status_code", Log.Int error.code);
]
| Error (Transport _) -> [ ("result", Log.String "transport_error") ]
| Error (Decode _) -> [ ("result", Log.String "decode_error") ]
| Error (Invalid_request _) ->
[ ("result", Log.String "invalid_request") ]
in
Log.debug client.logger
~fields:
(common
@ (("duration_seconds", Log.Float (Clock.elapsed started)) :: fields)
)
"protected Kubernetes API request completed";
result
let quote value = Yojson.Safe.to_string (`String value)
let data_segments data =
let rec loop first accumulator = function
| [] -> List.rev (Public "}" :: accumulator)
| (key, value) :: rest ->
let prefix = (if first then "" else ",") ^ quote key ^ ":\"" in
loop false
(Public "\"" :: Base64 value :: Public prefix :: accumulator)
rest
in
loop true [ Public "{" ] data
let duplicate_key values =
let sorted = List.sort String.compare (List.map fst values) in
let rec loop = function
| first :: (second :: _ as rest) ->
if first = second then Some first else loop rest
| [] | [ _ ] -> None
in
loop sorted
let find_json_string_field body field =
Secret.Unsafe.with_string_view body (fun input ->
let length = String.length input in
let field_length = String.length field in
let is_space = function
| ' ' | '\t' | '\r' | '\n' -> true
| _ -> false
in
let rec skip_space offset =
if offset < length && is_space input.[offset] then
skip_space (offset + 1)
else offset
in
let field_at offset =
let rec equal index =
if index = field_length then true
else if input.[offset + index] <> field.[index] then false
else equal (index + 1)
in
offset + field_length < length
&& equal 0
&& input.[offset + field_length] = '"'
in
let rec value_end offset =
if offset >= length then None
else
match input.[offset] with
| '"' -> Some offset
| '\\' -> None
| _ -> value_end (offset + 1)
in
let rec scan offset =
if offset >= length then None
else if input.[offset] <> '"' then scan (offset + 1)
else
let key_start = offset + 1 in
if not (field_at key_start) then scan key_start
else
let after_key = skip_space (key_start + field_length + 1) in
if after_key >= length || input.[after_key] <> ':' then
scan key_start
else
let value_start = skip_space (after_key + 1) in
if value_start >= length || input.[value_start] <> '"' then
scan key_start
else
let start = value_start + 1 in
Option.map
(fun ending -> (start, ending - start))
(value_end start)
in
scan 0)
let consume_write_response response =
Fun.protect
~finally:(fun () -> Secret.destroy response.Http.Sensitive.body)
(fun () ->
let resource_version =
match find_json_string_field response.body "resourceVersion" with
| None -> None
| Some (offset, length) ->
Secret.Unsafe.with_string_view response.body (fun body ->
Some (String.sub body offset length))
in
Ok { resource_version })
let create_secret ?cancel ?(hardened = false) client manifest =
match duplicate_key manifest.data with
| Some key -> Error (Invalid_request ("duplicate Secret data key " ^ key))
| None ->
let metadata =
`Assoc
([ ("name", `String manifest.name) ]
@ (if manifest.labels = [] then []
else
[
( "labels",
`Assoc
(List.map
(fun (key, value) -> (key, `String value))
manifest.labels) );
])
@ (if manifest.annotations = [] then []
else
[
( "annotations",
`Assoc
(List.map
(fun (key, value) -> (key, `String value))
manifest.annotations) );
])
@
if manifest.owner_references = [] then []
else
[
( "ownerReferences",
`List
(List.map Core.owner_reference_to_json
manifest.owner_references) );
])
in
let prefix =
"{\"apiVersion\":\"v1\",\"kind\":\"Secret\",\"metadata\":"
^ Yojson.Safe.to_string metadata
^ Option.fold ~none:""
~some:(fun value -> ",\"type\":" ^ quote value)
manifest.type_
^ Option.fold ~none:""
~some:(fun value ->
",\"immutable\":" ^ if value then "true" else "false")
manifest.immutable
^ ",\"data\":"
in
let segments =
(Public prefix :: data_segments manifest.data) @ [ Public "}" ]
in
with_segments ~hardened segments (fun body ->
let path =
"/api/v1/namespaces/"
^ Uri.pct_encode ~component:`Path manifest.namespace
^ "/secrets"
in
raw ?cancel
~headers:[ ("Content-Type", "application/json") ]
~body
~max_body_bytes:(2 * 1024 * 1024)
~hardened client `POST path
|> fun result -> Result.bind result consume_write_response)
|> fun result -> Result.bind result Fun.id
let json_pointer_segment value =
let output = Buffer.create (String.length value) in
String.iter
(function
| '~' -> Buffer.add_string output "~0"
| '/' -> Buffer.add_string output "~1"
| character -> Buffer.add_char output character)
value;
Buffer.contents output
let patch_secret ?cancel ?(hardened = false) client ~namespace ~name
~source_annotation:(annotation, source_uid) ~data =
match duplicate_key data with
| Some key -> Error (Invalid_request ("duplicate Secret data key " ^ key))
| None ->
let prefix =
"[{\"op\":\"test\",\"path\":"
^ quote ("/metadata/annotations/" ^ json_pointer_segment annotation)
^ ",\"value\":" ^ quote source_uid
^ "},{\"op\":\"replace\",\"path\":\"/data\",\"value\":"
in
let segments =
(Public prefix :: data_segments data) @ [ Public "}]" ]
in
with_segments ~hardened segments (fun body ->
let path =
"/api/v1/namespaces/"
^ Uri.pct_encode ~component:`Path namespace
^ "/secrets/"
^ Uri.pct_encode ~component:`Path name
in
raw ?cancel
~headers:[ ("Content-Type", "application/json-patch+json") ]
~body
~max_body_bytes:(2 * 1024 * 1024)
~hardened client `PATCH path
|> fun result -> Result.bind result consume_write_response)
|> fun result -> Result.bind result Fun.id
let create_service_account_token ?cancel ?(hardened = false) ?(audiences = [])
?expiration_seconds client ~namespace ~service_account =
let spec =
`Assoc
((if audiences = [] then []
else
[
( "audiences",
`List (List.map (fun value -> `String value) audiences) );
])
@
match expiration_seconds with
| None -> []
| Some value ->
[ ("expirationSeconds", `Intlit (Int64.to_string value)) ])
in
let request =
`Assoc
[
("apiVersion", `String "authentication.k8s.io/v1");
("kind", `String "TokenRequest");
("spec", spec);
]
|> Yojson.Safe.to_string |> Secret.of_string ~hardened
in
Fun.protect
~finally:(fun () -> Secret.destroy request)
(fun () ->
let path =
"/api/v1/namespaces/"
^ Uri.pct_encode ~component:`Path namespace
^ "/serviceaccounts/"
^ Uri.pct_encode ~component:`Path service_account
^ "/token"
in
match
raw ?cancel
~headers:[ ("Content-Type", "application/json") ]
~body:request ~max_body_bytes:(1024 * 1024) ~hardened client `POST
path
with
| Error _ as error -> error
| Ok response ->
Fun.protect
~finally:(fun () -> Secret.destroy response.body)
(fun () ->
match find_json_string_field response.body "token" with
| Some (offset, length) when length > 0 ->
Ok
(Secret.sub ~hardened response.body ~off:offset
~len:length)
| Some _ | None ->
Error
(Decode
"TokenRequest response is missing an unescaped status \
token")))
end
let websocket ?cancel ? ?protocols ?max_message_bytes
?max_error_body_bytes client path =
if not (Log.enabled client.logger Log.Debug) then
websocket_unlogged ?cancel ?headers ?protocols ?max_message_bytes
?max_error_body_bytes client path
else
let request_id = Atomic.fetch_and_add client.next_request_id 1 in
let started = Clock.now () in
let common =
[
("request_id", Log.Int request_id);
("method", Log.String "GET");
("path", Log.String (target_path path));
]
in
Log.debug client.logger ~fields:common
"Kubernetes WebSocket upgrade started";
let result =
websocket_unlogged ?cancel ?headers ?protocols ?max_message_bytes
?max_error_body_bytes client path
in
let outcome =
match result with
| Ok _ -> "ok"
| Error (Api _) -> "api_error"
| Error (Transport _) -> "transport_error"
| Error (Decode _) -> "decode_error"
| Error (Invalid_request _) -> "invalid_request"
in
Log.debug client.logger
~fields:
(common
@ [
("duration_seconds", Log.Float (Clock.elapsed started));
("result", Log.String outcome);
])
"Kubernetes WebSocket upgrade completed";
result
let with_query path query =
Uri.of_string path |> fun uri -> Uri.with_query' uri query |> Uri.to_string
let encode_json value = Yojson.Safe.to_string value
module For (Resource : Core.Resource) = struct
let resource_version_match_string = function
| `Exact -> "Exact"
| `Not_older_than -> "NotOlderThan"
let decode body =
try
let json = Yojson.Safe.from_string body in
match Resource.of_json json with
| Ok value -> Ok value
| Error message -> Error (Decode message)
with Yojson.Json_error message -> Error (Decode message)
let path result =
match result with
| Ok value -> Ok value
| Error message -> Error (Invalid_request message)
let object_namespace client explicit =
match Resource.api.scope with
| Core.Cluster -> explicit
| Core.Namespaced ->
Some
(match (explicit, (config client).namespace) with
| Some value, _ -> value
| None, Some value -> value
| None, None -> "default")
let create_namespace client explicit value =
match Resource.api.scope with
| Core.Cluster -> explicit
| Core.Namespaced ->
let metadata = Resource.metadata value in
Some
(match (explicit, metadata.namespace, (config client).namespace) with
| Some value, _, _ -> value
| None, Some value, _ -> value
| None, None, Some value -> value
| None, None, None -> "default")
let field_validation_string = function
| `Ignore -> "Ignore"
| `Warn -> "Warn"
| `Strict -> "Strict"
let write_query (options : write_options) =
List.map (fun value -> ("dryRun", value)) options.dry_run
@ (match options.field_manager with
| None -> []
| Some value -> [ ("fieldManager", value) ])
@
match options.field_validation with
| None -> []
| Some value -> [ ("fieldValidation", field_validation_string value) ]
let with_write_options path options =
let query = write_query options in
if query = [] then path else with_query path query
let decode_json body =
try Ok (Yojson.Safe.from_string body)
with Yojson.Json_error message -> Error (Decode message)
let get ?cancel ?resource_version ?resource_version_match client ?namespace
name =
let namespace = object_namespace client namespace in
let* path = path (Core.object_path Resource.api ~namespace ~name) in
let query =
( [] |> fun values ->
match resource_version with
| None -> values
| Some value ->
("resourceVersion", Core.Resource_version.to_string value) :: values
)
|> fun values ->
match resource_version_match with
| None -> values
| Some value ->
("resourceVersionMatch", resource_version_match_string value)
:: values
in
let* response = raw ?cancel client `GET (with_query path query) in
decode response.body
let create ?cancel ?(options = default_write_options) client ?namespace value
=
let namespace = create_namespace client namespace value in
let* path = path (Core.collection_path Resource.api ~namespace) in
let* response =
raw ?cancel
~headers:[ ("Content-Type", "application/json") ]
~body:(encode_json (Resource.to_json value))
client `POST
(with_write_options path options)
in
decode response.body
let replace ?cancel ?(options = default_write_options) client ?namespace name
value =
let namespace = object_namespace client namespace in
let* path = path (Core.object_path Resource.api ~namespace ~name) in
let* response =
raw ?cancel
~headers:[ ("Content-Type", "application/json") ]
~body:(encode_json (Resource.to_json value))
client `PUT
(with_write_options path options)
in
decode response.body
let validate_delete_options (options : delete_options) =
match options.grace_period_seconds with
| Some value when value < 0 ->
Error
(Invalid_request "delete grace_period_seconds must not be negative")
| _ -> Ok ()
let propagation_policy_string = function
| `Orphan -> "Orphan"
| `Background -> "Background"
| `Foreground -> "Foreground"
let optional_json name fn = function
| None -> []
| Some value -> [ (name, fn value) ]
let delete_options_json (options : delete_options) =
let preconditions =
optional_json "uid" (fun value -> `String value) options.precondition_uid
@ optional_json "resourceVersion"
(fun value -> `String (Core.Resource_version.to_string value))
options.precondition_resource_version
in
`Assoc
([ ("apiVersion", `String "v1"); ("kind", `String "DeleteOptions") ]
@ optional_json "gracePeriodSeconds"
(fun value -> `Int value)
options.grace_period_seconds
@ optional_json "propagationPolicy"
(fun value -> `String (propagation_policy_string value))
options.propagation_policy
@ (if preconditions = [] then []
else [ ("preconditions", `Assoc preconditions) ])
@
if options.dry_run = [] then []
else
[
( "dryRun",
`List (List.map (fun value -> `String value) options.dry_run) );
])
let delete_request ?cancel client path options =
let* () = validate_delete_options options in
let* _response =
raw ?cancel
~headers:[ ("Content-Type", "application/json") ]
~body:(encode_json (delete_options_json options))
client `DELETE path
in
Ok ()
let delete ?cancel ?(options = default_delete_options) client ?namespace name
=
let namespace = object_namespace client namespace in
let* path = path (Core.object_path Resource.api ~namespace ~name) in
delete_request ?cancel client path options
let delete_collection ?cancel ?(options = default_delete_options) ?namespace
?(all_namespaces = false) ?label_selector ?field_selector
?resource_version ?resource_version_match ?limit ?continue
?timeout_seconds client =
let* () =
match limit with
| Some value when value < 0 ->
Error (Invalid_request "delete_collection limit must not be negative")
| _ -> Ok ()
in
let* () =
match timeout_seconds with
| Some value when value < 0 ->
Error
(Invalid_request
"delete_collection timeout_seconds must not be negative")
| _ -> Ok ()
in
let* namespace =
match (Resource.api.scope, all_namespaces, namespace) with
| Core.Namespaced, true, None -> Ok None
| Core.Namespaced, true, Some _ ->
Error
(Invalid_request
"delete_collection cannot combine namespace and all_namespaces")
| Core.Namespaced, false, namespace ->
Ok (object_namespace client namespace)
| Core.Cluster, true, _ ->
Error
(Invalid_request
"all_namespaces is invalid for a cluster-scoped resource")
| Core.Cluster, false, namespace -> Ok namespace
in
let* base_path = path (Core.collection_path Resource.api ~namespace) in
let query =
( ( ( ( ( ( [] |> fun values ->
match label_selector with
| None -> values
| Some value -> ("labelSelector", value) :: values )
|> fun values ->
match field_selector with
| None -> values
| Some value -> ("fieldSelector", value) :: values )
|> fun values ->
match resource_version with
| None -> values
| Some value ->
("resourceVersion", Core.Resource_version.to_string value)
:: values )
|> fun values ->
match resource_version_match with
| None -> values
| Some value ->
("resourceVersionMatch", resource_version_match_string value)
:: values )
|> fun values ->
match limit with
| None -> values
| Some value -> ("limit", string_of_int value) :: values )
|> fun values ->
match continue with
| None -> values
| Some value -> ("continue", value) :: values )
|> fun values ->
match timeout_seconds with
| None -> values
| Some value -> ("timeoutSeconds", string_of_int value) :: values
in
delete_request ?cancel client (with_query base_path query) options
let patch_request_json ?cancel ?(options = default_write_options) client
?namespace name ?subresource patch_value =
let namespace = object_namespace client namespace in
let* base_path =
match subresource with
| None -> path (Core.object_path Resource.api ~namespace ~name)
| Some subresource ->
path
(Core.subresource_path Resource.api ~namespace ~name ~subresource)
in
let content_type, json, patch_query =
match patch_value with
| Json_patch value -> ("application/json-patch+json", value, [])
| Merge_patch value -> ("application/merge-patch+json", value, [])
| Apply { value; field_manager = _; force } ->
( "application/apply-patch+yaml",
value,
[ ("force", string_of_bool force) ] )
in
let query =
match patch_value with
| Apply { field_manager; _ } ->
("fieldManager", field_manager)
:: (List.remove_assoc "fieldManager" (write_query options)
@ patch_query)
| _ -> write_query options @ patch_query
in
let request_path =
if query = [] then base_path else with_query base_path query
in
let* response =
raw ?cancel
~headers:[ ("Content-Type", content_type) ]
~body:(encode_json json) client `PATCH request_path
in
decode_json response.body
let decode_resource_json json =
match Resource.of_json json with
| Ok value -> Ok value
| Error message -> Error (Decode message)
let patch ?cancel ?options client ?namespace name value =
let* json =
patch_request_json ?cancel ?options client ?namespace name value
in
decode_resource_json json
let patch_status ?cancel ?options client ?namespace name value =
let* json =
patch_request_json ?cancel ?options client ?namespace name
~subresource:"status" value
in
decode_resource_json json
let replace_status ?cancel ?(options = default_write_options) client
?namespace name value =
let namespace = object_namespace client namespace in
let* path =
path
(Core.subresource_path Resource.api ~namespace ~name
~subresource:"status")
in
let* response =
raw ?cancel
~headers:[ ("Content-Type", "application/json") ]
~body:(encode_json (Resource.to_json value))
client `PUT
(with_write_options path options)
in
decode response.body
let subresource_request_path client namespace name subresource =
if String.trim subresource = "" then
Error (Invalid_request "subresource must not be empty")
else
let namespace = object_namespace client namespace in
path (Core.subresource_path Resource.api ~namespace ~name ~subresource)
let get_subresource ?cancel client ?namespace name subresource =
let* path = subresource_request_path client namespace name subresource in
let* response = raw ?cancel client `GET path in
decode_json response.body
let write_subresource_json ?cancel ?(options = default_write_options) client
?namespace ~name ~subresource meth value =
let* path = subresource_request_path client namespace name subresource in
let* response =
raw ?cancel
~headers:[ ("Content-Type", "application/json") ]
~body:(encode_json value) client meth
(with_write_options path options)
in
decode_json response.body
let create_subresource ?cancel ?options client ?namespace ~name ~subresource
value =
write_subresource_json ?cancel ?options client ?namespace ~name ~subresource
`POST value
let replace_subresource ?cancel ?options client ?namespace ~name ~subresource
value =
write_subresource_json ?cancel ?options client ?namespace ~name ~subresource
`PUT value
let patch_subresource ?cancel ?options client ?namespace ~name ~subresource
value =
if String.trim subresource = "" then
Error (Invalid_request "subresource must not be empty")
else
patch_request_json ?cancel ?options client ?namespace name ~subresource
value
let delete_subresource ?cancel ?(options = default_delete_options) client
?namespace name subresource =
let* path = subresource_request_path client namespace name subresource in
delete_request ?cancel client path options
let stream_subresource ?cancel ?(query = [])
?(max_error_body_bytes = 32 * 1024 * 1024) client ?namespace name
subresource ~on_chunk =
let* () =
if max_error_body_bytes < 0 then
Error (Invalid_request "max_error_body_bytes must not be negative")
else Ok ()
in
let* path = subresource_request_path client namespace name subresource in
let* _response =
raw ?cancel
~headers:[ ("Accept", "*/*") ]
~on_chunk ~max_body_bytes:max_error_body_bytes client `GET
(with_query path query)
in
Ok ()
let decode_scale_json json =
match scale_of_json json with
| Ok scale -> Ok scale
| Error message -> Error (Decode message)
let get_scale ?cancel client ?namespace name =
let* json = get_subresource ?cancel client ?namespace name "scale" in
decode_scale_json json
let replace_scale ?cancel ?options client ?namespace name scale =
let* json =
replace_subresource ?cancel ?options client ?namespace ~name
~subresource:"scale" (scale_to_json scale)
in
decode_scale_json json
let patch_scale ?cancel ?options client ?namespace name value =
let* json =
patch_subresource ?cancel ?options client ?namespace ~name
~subresource:"scale" value
in
decode_scale_json json
let log_stream_string = function
| `All -> "All"
| `Stdout -> "Stdout"
| `Stderr -> "Stderr"
let log_query (options : log_options) =
let* () =
match options.container with
| Some value when String.trim value = "" ->
Error (Invalid_request "log container must not be empty")
| _ -> Ok ()
in
let* () =
match (options.since_seconds, options.since_time) with
| Some _, Some _ ->
Error
(Invalid_request
"log since_seconds and since_time are mutually exclusive")
| Some value, None when value < 1 ->
Error (Invalid_request "log since_seconds must be positive")
| _ -> Ok ()
in
let* () =
match options.since_time with
| Some value when String.trim value = "" ->
Error (Invalid_request "log since_time must not be empty")
| _ -> Ok ()
in
let* () =
match options.tail_lines with
| Some value when Int64.compare value 0L < 0 ->
Error (Invalid_request "log tail_lines must not be negative")
| _ -> Ok ()
in
let* () =
match options.limit_bytes with
| Some value when Int64.compare value 0L <= 0 ->
Error (Invalid_request "log limit_bytes must be positive")
| _ -> Ok ()
in
let optional name fn = function
| None -> []
| Some value -> [ (name, fn value) ]
in
Ok
(optional "container" Fun.id options.container
@ (if options.follow then [ ("follow", "true") ] else [])
@ (if options.previous then [ ("previous", "true") ] else [])
@ optional "sinceSeconds" string_of_int options.since_seconds
@ optional "sinceTime" Fun.id options.since_time
@ (if options.timestamps then [ ("timestamps", "true") ] else [])
@ optional "tailLines" Int64.to_string options.tail_lines
@ optional "limitBytes" Int64.to_string options.limit_bytes
@ (if options.insecure_skip_tls_verify_backend then
[ ("insecureSkipTLSVerifyBackend", "true") ]
else [])
@ optional "stream" log_stream_string options.stream)
let logs ?cancel ?(options = default_log_options) ?max_body_bytes client
?namespace name =
let* query = log_query options in
let* path = subresource_request_path client namespace name "log" in
let* response =
raw ?cancel
~headers:[ ("Accept", "text/plain, */*") ]
?max_body_bytes client `GET (with_query path query)
in
Ok response.body
let stream_logs ?cancel ?(options = default_log_options) ?max_error_body_bytes
client ?namespace name ~on_chunk =
let* query = log_query options in
stream_subresource ?cancel ~query ?max_error_body_bytes client ?namespace
name "log" ~on_chunk
let list ?cancel ?namespace ?label_selector ?field_selector ?resource_version
?resource_version_match ?limit ?continue client =
let* () =
match limit with
| Some value when value < 0 ->
Error (Invalid_request "list limit must not be negative")
| _ -> Ok ()
in
let* base_path = path (Core.collection_path Resource.api ~namespace) in
let query =
( ( ( ( ( [] |> fun values ->
match label_selector with
| None -> values
| Some value -> ("labelSelector", value) :: values )
|> fun values ->
match field_selector with
| None -> values
| Some value -> ("fieldSelector", value) :: values )
|> fun values ->
match resource_version with
| None -> values
| Some value ->
("resourceVersion", Core.Resource_version.to_string value)
:: values )
|> fun values ->
match resource_version_match with
| None -> values
| Some value ->
("resourceVersionMatch", resource_version_match_string value)
:: values )
|> fun values ->
match limit with
| None -> values
| Some value -> ("limit", string_of_int value) :: values )
|> fun values ->
match continue with
| None -> values
| Some value -> ("continue", value) :: values
in
let* response = raw ?cancel client `GET (with_query base_path query) in
try
let json = Yojson.Safe.from_string response.body in
let* raw_items =
match json_member "items" json with
| Some (`List items) -> Ok items
| _ -> Error (Decode "list response is missing items")
in
let rec decode_items accumulator = function
| [] -> Ok (List.rev accumulator)
| item :: rest -> (
match Resource.of_json item with
| Ok item -> decode_items (item :: accumulator) rest
| Error message -> Error (Decode message))
in
let* items = decode_items [] raw_items in
let* metadata =
match json_member "metadata" json with
| Some metadata -> Ok metadata
| None -> Error (Decode "list response is missing metadata")
in
let* resource_version =
match
Option.bind (json_member "resourceVersion" metadata) json_string
with
| Some value -> Ok (Core.Resource_version.of_string value)
| None -> Error (Decode "list metadata is missing resourceVersion")
in
let continue_token =
Option.bind (json_member "continue" metadata) json_string
in
let remaining_item_count =
Option.bind (json_member "remainingItemCount" metadata) json_int
in
Ok { items; resource_version; continue_token; remaining_item_count }
with Yojson.Json_error message -> Error (Decode message)
let list_all ?cancel ?namespace ?label_selector ?field_selector
?resource_version ?resource_version_match ?(page_size = 500) client =
let* () =
if page_size < 1 then
Error (Invalid_request "list_all page_size must be positive")
else Ok ()
in
let rec loop accumulator snapshot_version continue =
let* page =
list ?cancel ?namespace ?label_selector ?field_selector
?resource_version ?resource_version_match ~limit:page_size ?continue
client
in
let snapshot_version =
match snapshot_version with
| None -> page.resource_version
| Some value -> value
in
let* () =
if
Core.Resource_version.to_string snapshot_version
<> Core.Resource_version.to_string page.resource_version
then
Error
(Decode
"paginated LIST changed resourceVersion between continuation \
pages")
else Ok ()
in
let accumulator = List.rev_append page.items accumulator in
match page.continue_token with
| Some token when Some token = continue ->
Error (Decode "paginated LIST repeated its continuation token")
| Some token when token <> "" ->
loop accumulator (Some snapshot_version) (Some token)
| _ ->
Ok
{
items = List.rev accumulator;
resource_version = snapshot_version;
continue_token = None;
remaining_item_count = Some 0;
}
in
loop [] None None
let status_error json =
let reason = Option.bind (json_member "reason" json) json_string in
let message =
Option.bind (json_member "message" json) json_string
|> Option.value ~default:"watch returned a Status error"
in
let code =
Option.bind (json_member "code" json) json_int
|> Option.value ~default:500
in
let retry_after_seconds = retry_after_of_status (Some json) in
{ code; reason; message; retry_after_seconds; body = Some json }
let resource_version_of_object json =
Option.bind
(Option.bind
(json_member "metadata" json)
(json_member "resourceVersion"))
json_string
|> Option.map Core.Resource_version.of_string
let watch ?cancel ?namespace ?label_selector ?field_selector
?(timeout_seconds = 300) ?(allow_bookmarks = true) ?resource_version_match
?(send_initial_events = false) ?(max_event_bytes = 16 * 1024 * 1024)
client ~resource_version ~on_event =
let* () =
if timeout_seconds < 0 then
Error (Invalid_request "timeout_seconds must not be negative")
else if max_event_bytes < 1 then
Error (Invalid_request "max_event_bytes must be positive")
else if
send_initial_events && resource_version_match <> Some `Not_older_than
then
Error
(Invalid_request
"send_initial_events requires \
resource_version_match=`Not_older_than")
else Ok ()
in
let* base_path = path (Core.collection_path Resource.api ~namespace) in
let query =
( ( ( [
("watch", "true");
("allowWatchBookmarks", string_of_bool allow_bookmarks);
( "resourceVersion",
Core.Resource_version.to_string resource_version );
("timeoutSeconds", string_of_int timeout_seconds);
]
|> fun values ->
match label_selector with
| None -> values
| Some value -> ("labelSelector", value) :: values )
|> fun values ->
match field_selector with
| None -> values
| Some value -> ("fieldSelector", value) :: values )
|> fun values ->
match resource_version_match with
| None -> values
| Some value ->
("resourceVersionMatch", resource_version_match_string value)
:: values )
|> fun values ->
if send_initial_events then ("sendInitialEvents", "true") :: values
else values
in
let line_buffer = Buffer.create 4096 in
let latest = ref resource_version in
let parse_error = ref None in
let expired = ref false in
let terminal_error = ref None in
let process_line line =
if !parse_error = None && String.trim line <> "" then
try
let json = Yojson.Safe.from_string line in
match (json_member "type" json, json_member "object" json) with
| Some (`String event_type), Some object_json -> (
(match resource_version_of_object object_json with
| Some value -> latest := value
| None -> ());
match event_type with
| "BOOKMARK" ->
on_event (Bookmark (resource_version_of_object object_json))
| "ERROR" ->
let error = status_error object_json in
if Error.is_resource_expired (Api error) then expired := true
else (
terminal_error := Some error;
on_event (Watch_error error))
| "ADDED" | "MODIFIED" | "DELETED" -> (
match Resource.of_json object_json with
| Error message -> parse_error := Some (Decode message)
| Ok value ->
on_event
(match event_type with
| "ADDED" -> Added value
| "MODIFIED" -> Modified value
| _ -> Deleted value))
| _ -> ())
| _ -> parse_error := Some (Decode "invalid watch event envelope")
with Yojson.Json_error message -> parse_error := Some (Decode message)
in
let consume chunk =
Buffer.add_string line_buffer chunk;
let oversize () =
parse_error :=
Some
(Decode
(Printf.sprintf "watch event exceeds %d bytes" max_event_bytes));
raise (Failure "watch event exceeds configured limit")
in
let contents = Buffer.contents line_buffer in
let rec split start =
match String.index_from_opt contents start '\n' with
| None ->
let length = String.length contents - start in
if length > max_event_bytes then oversize ();
let remainder = String.sub contents start length in
Buffer.clear line_buffer;
Buffer.add_string line_buffer remainder
| Some ending ->
if ending - start > max_event_bytes then oversize ();
process_line (String.sub contents start (ending - start));
if !parse_error <> None then raise (Failure "invalid watch event");
if !expired || !terminal_error <> None then
raise (Failure "watch returned a Status error");
split (ending + 1)
in
split 0
in
match
raw ?cancel ~on_chunk:consume client `GET (with_query base_path query)
with
| Error _ when !parse_error <> None -> Error (Option.get !parse_error)
| Error _ when !expired -> Ok Resource_version_expired
| Error _ when !terminal_error <> None ->
Error (Api (Option.get !terminal_error))
| Error (Api _ as error) when Error.is_resource_expired error ->
Ok Resource_version_expired
| Error _ as error -> error
| Ok _ -> (
if Buffer.length line_buffer > 0 then
process_line (Buffer.contents line_buffer);
match !parse_error with
| Some error -> Error error
| None when !expired -> Ok Resource_version_expired
| None when !terminal_error <> None ->
Error (Api (Option.get !terminal_error))
| None -> Ok (Watch_ended !latest))
end