/
service.py
581 lines (493 loc) · 24.5 KB
/
service.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
from typing import Any, cast
from kubernetes import client
from prefect import Task
from prefect.utilities.tasks import defaults_from_attrs
from prefect.utilities.kubernetes import get_kubernetes_client
class CreateNamespacedService(Task):
"""
Task for creating a namespaced service on Kubernetes.
Note that all initialization arguments can optionally be provided or overwritten at runtime.
This task will attempt to connect to a Kubernetes cluster in three steps with
the first successful connection attempt becoming the mode of communication with a
cluster.
1. Attempt to use a Prefect Secret that contains a Kubernetes API Key. If
`kubernetes_api_key_secret` = `None` then it will attempt the next two connection
methods. By default the value is `KUBERNETES_API_KEY` so providing `None` acts as
an override for the remote connection.
2. Attempt in-cluster connection (will only work when running on a Service in a cluster)
3. Attempt out-of-cluster connection using the default location for a kube config file
The arguments `body` and `kube_kwargs` will perform an in-place update when the task
is run. This means that it is possible to provide `body = {"info": "here"}` at
instantiation and then provide `body = {"more": "info"}` at run time which will make
`body = {"info": "here", "more": "info"}`. *Note*: Keys present in both instantiation
and runtime will be replaced with the runtime value.
Args:
- body (dict, optional): A dictionary representation of a Kubernetes V1Service
specification
- namespace (str, optional): The Kubernetes namespace to create this service in,
defaults to the `default` namespace
- kube_kwargs (dict, optional): Optional extra keyword arguments to pass to the
Kubernetes API (e.g. `{"pretty": "...", "dry_run": "..."}`)
- kubernetes_api_key_secret (str, optional): the name of the Prefect Secret
which stored your Kubernetes API Key; this Secret must be a string and in
BearerToken format
- **kwargs (dict, optional): additional keyword arguments to pass to the Task
constructor
"""
def __init__(
self,
body: dict = None,
namespace: str = "default",
kube_kwargs: dict = None,
kubernetes_api_key_secret: str = "KUBERNETES_API_KEY",
**kwargs: Any
):
self.body = body or {}
self.namespace = namespace
self.kube_kwargs = kube_kwargs or {}
self.kubernetes_api_key_secret = kubernetes_api_key_secret
super().__init__(**kwargs)
@defaults_from_attrs(
"body", "namespace", "kube_kwargs", "kubernetes_api_key_secret"
)
def run(
self,
body: dict = None,
namespace: str = "default",
kube_kwargs: dict = None,
kubernetes_api_key_secret: str = "KUBERNETES_API_KEY",
) -> None:
"""
Task run method.
Args:
- body (dict, optional): A dictionary representation of a Kubernetes V1Service
specification
- namespace (str, optional): The Kubernetes namespace to create this service in,
defaults to the `default` namespace
- kube_kwargs (dict, optional): Optional extra keyword arguments to pass to the
Kubernetes API (e.g. `{"pretty": "...", "dry_run": "..."}`)
- kubernetes_api_key_secret (str, optional): the name of the Prefect Secret
which stored your Kubernetes API Key; this Secret must be a string and in
BearerToken format
Raises:
- ValueError: if `body` is `None`
"""
if not body:
raise ValueError("A dictionary representing a V1Service must be provided.")
api_client = cast(
client.CoreV1Api,
get_kubernetes_client("service", kubernetes_api_key_secret),
)
body = {**self.body, **(body or {})}
kube_kwargs = {**self.kube_kwargs, **(kube_kwargs or {})}
api_client.create_namespaced_service(
namespace=namespace, body=body, **kube_kwargs
)
class DeleteNamespacedService(Task):
"""
Task for deleting a namespaced service on Kubernetes.
Note that all initialization arguments can optionally be provided or overwritten at runtime.
This task will attempt to connect to a Kubernetes cluster in three steps with
the first successful connection attempt becoming the mode of communication with a
cluster.
1. Attempt to use a Prefect Secret that contains a Kubernetes API Key. If
`kubernetes_api_key_secret` = `None` then it will attempt the next two connection
methods. By default the value is `KUBERNETES_API_KEY` so providing `None` acts as
an override for the remote connection.
2. Attempt in-cluster connection (will only work when running on a Service in a cluster)
3. Attempt out-of-cluster connection using the default location for a kube config file
The argument `kube_kwargs` will perform an in-place update when the task
is run. This means that it is possible to provide `kube_kwargs = {"info": "here"}` at
instantiation and then provide `kube_kwargs = {"more": "info"}` at run time which will make
`kube_kwargs = {"info": "here", "more": "info"}`. *Note*: Keys present in both instantiation
and runtime will be replaced with the runtime value.
Args:
- service_name (str, optional): The name of a service to delete
- namespace (str, optional): The Kubernetes namespace to delete this service from,
defaults to the `default` namespace
- kube_kwargs (dict, optional): Optional extra keyword arguments to pass to the
Kubernetes API (e.g. `{"pretty": "...", "dry_run": "..."}`)
- kubernetes_api_key_secret (str, optional): the name of the Prefect Secret
which stored your Kubernetes API Key; this Secret must be a string and in
BearerToken format
- **kwargs (dict, optional): additional keyword arguments to pass to the Task
constructor
"""
def __init__(
self,
service_name: str = None,
namespace: str = "default",
kube_kwargs: dict = None,
kubernetes_api_key_secret: str = "KUBERNETES_API_KEY",
**kwargs: Any
):
self.service_name = service_name
self.namespace = namespace
self.kube_kwargs = kube_kwargs or {}
self.kubernetes_api_key_secret = kubernetes_api_key_secret
super().__init__(**kwargs)
@defaults_from_attrs(
"service_name", "namespace", "kube_kwargs", "kubernetes_api_key_secret"
)
def run(
self,
service_name: str = None,
namespace: str = "default",
kube_kwargs: dict = None,
kubernetes_api_key_secret: str = "KUBERNETES_API_KEY",
delete_option_kwargs: dict = None,
) -> None:
"""
Task run method.
Args:
- service_name (str, optional): The name of a service to delete
- namespace (str, optional): The Kubernetes namespace to delete this service in,
defaults to the `default` namespace
- kube_kwargs (dict, optional): Optional extra keyword arguments to pass to the
Kubernetes API (e.g. `{"pretty": "...", "dry_run": "..."}`)
- kubernetes_api_key_secret (str, optional): the name of the Prefect Secret
which stored your Kubernetes API Key; this Secret must be a string and in
BearerToken format
- delete_option_kwargs (dict, optional): Optional keyword arguments to pass to
the V1DeleteOptions object (e.g. {"propagation_policy": "...",
"grace_period_seconds": "..."}.
Raises:
- ValueError: if `service_name` is `None`
"""
if not service_name:
raise ValueError("The name of a Kubernetes service must be provided.")
api_client = cast(
client.CoreV1Api,
get_kubernetes_client("service", kubernetes_api_key_secret),
)
kube_kwargs = {**self.kube_kwargs, **(kube_kwargs or {})}
delete_option_kwargs = delete_option_kwargs or {}
api_client.delete_namespaced_service(
name=service_name,
namespace=namespace,
body=client.V1DeleteOptions(**delete_option_kwargs),
**kube_kwargs
)
class ListNamespacedService(Task):
"""
Task for listing namespaced services on Kubernetes.
Note that all initialization arguments can optionally be provided or overwritten at runtime.
This task will attempt to connect to a Kubernetes cluster in three steps with
the first successful connection attempt becoming the mode of communication with a
cluster.
1. Attempt to use a Prefect Secret that contains a Kubernetes API Key. If
`kubernetes_api_key_secret` = `None` then it will attempt the next two connection
methods. By default the value is `KUBERNETES_API_KEY` so providing `None` acts as
an override for the remote connection.
2. Attempt in-cluster connection (will only work when running on a Service in a cluster)
3. Attempt out-of-cluster connection using the default location for a kube config file
The argument `kube_kwargs` will perform an in-place update when the task
is run. This means that it is possible to provide `kube_kwargs = {"info": "here"}` at
instantiation and then provide `kube_kwargs = {"more": "info"}` at run time which will make
`kube_kwargs = {"info": "here", "more": "info"}`. *Note*: Keys present in both instantiation
and runtime will be replaced with the runtime value.
Args:
- namespace (str, optional): The Kubernetes namespace to list services from,
defaults to the `default` namespace
- kube_kwargs (dict, optional): Optional extra keyword arguments to pass to the
Kubernetes API (e.g. `{"field_selector": "...", "label_selector": "..."}`)
- kubernetes_api_key_secret (str, optional): the name of the Prefect Secret
which stored your Kubernetes API Key; this Secret must be a string and in
BearerToken format
- **kwargs (dict, optional): additional keyword arguments to pass to the Task
constructor
"""
def __init__(
self,
namespace: str = "default",
kube_kwargs: dict = None,
kubernetes_api_key_secret: str = "KUBERNETES_API_KEY",
**kwargs: Any
):
self.namespace = namespace
self.kube_kwargs = kube_kwargs or {}
self.kubernetes_api_key_secret = kubernetes_api_key_secret
super().__init__(**kwargs)
@defaults_from_attrs("namespace", "kube_kwargs", "kubernetes_api_key_secret")
def run(
self,
namespace: str = "default",
kube_kwargs: dict = None,
kubernetes_api_key_secret: str = "KUBERNETES_API_KEY",
) -> None:
"""
Task run method.
Args:
- namespace (str, optional): The Kubernetes namespace to list services from,
defaults to the `default` namespace
- kube_kwargs (dict, optional): Optional extra keyword arguments to pass to the
Kubernetes API (e.g. `{"field_selector": "...", "label_selector": "..."}`)
- kubernetes_api_key_secret (str, optional): the name of the Prefect Secret
which stored your Kubernetes API Key; this Secret must be a string and in
BearerToken format
Returns:
- V1ServiceList: a Kubernetes V1ServiceList of the services which are found
"""
api_client = cast(
client.CoreV1Api,
get_kubernetes_client("service", kubernetes_api_key_secret),
)
kube_kwargs = {**self.kube_kwargs, **(kube_kwargs or {})}
return api_client.list_namespaced_service(namespace=namespace, **kube_kwargs)
class PatchNamespacedService(Task):
"""
Task for patching a namespaced service on Kubernetes.
Note that all initialization arguments can optionally be provided or overwritten at runtime.
This task will attempt to connect to a Kubernetes cluster in three steps with
the first successful connection attempt becoming the mode of communication with a
cluster.
1. Attempt to use a Prefect Secret that contains a Kubernetes API Key. If
`kubernetes_api_key_secret` = `None` then it will attempt the next two connection
methods. By default the value is `KUBERNETES_API_KEY` so providing `None` acts as
an override for the remote connection.
2. Attempt in-cluster connection (will only work when running on a Service in a cluster)
3. Attempt out-of-cluster connection using the default location for a kube config file
The arguments `body` and `kube_kwargs` will perform an in-place update when the task
is run. This means that it is possible to provide `body = {"info": "here"}` at
instantiation and then provide `body = {"more": "info"}` at run time which will make
`body = {"info": "here", "more": "info"}`. *Note*: Keys present in both instantiation
and runtime will be replaced with the runtime value.
Args:
- service_name (str, optional): The name of a service to patch
- body (dict, optional): A dictionary representation of a Kubernetes V1Service
patch specification
- namespace (str, optional): The Kubernetes namespace to patch this service in,
defaults to the `default` namespace
- kube_kwargs (dict, optional): Optional extra keyword arguments to pass to the
Kubernetes API (e.g. `{"pretty": "...", "dry_run": "..."}`)
- kubernetes_api_key_secret (str, optional): the name of the Prefect Secret
which stored your Kubernetes API Key; this Secret must be a string and in
BearerToken format
- **kwargs (dict, optional): additional keyword arguments to pass to the Task
constructor
"""
def __init__(
self,
service_name: str = None,
body: dict = None,
namespace: str = "default",
kube_kwargs: dict = None,
kubernetes_api_key_secret: str = "KUBERNETES_API_KEY",
**kwargs: Any
):
self.service_name = service_name
self.body = body or {}
self.namespace = namespace
self.kube_kwargs = kube_kwargs or {}
self.kubernetes_api_key_secret = kubernetes_api_key_secret
super().__init__(**kwargs)
@defaults_from_attrs(
"service_name", "body", "namespace", "kube_kwargs", "kubernetes_api_key_secret"
)
def run(
self,
service_name: str = None,
body: dict = None,
namespace: str = "default",
kube_kwargs: dict = None,
kubernetes_api_key_secret: str = "KUBERNETES_API_KEY",
) -> None:
"""
Task run method.
Args:
- service_name (str, optional): The name of a service to patch
- body (dict, optional): A dictionary representation of a Kubernetes V1Service
patch specification
- namespace (str, optional): The Kubernetes namespace to patch this service in,
defaults to the `default` namespace
- kube_kwargs (dict, optional): Optional extra keyword arguments to pass to the
Kubernetes API (e.g. `{"pretty": "...", "dry_run": "..."}`)
- kubernetes_api_key_secret (str, optional): the name of the Prefect Secret
which stored your Kubernetes API Key; this Secret must be a string and in
BearerToken format
Raises:
- ValueError: if `body` is `None`
- ValueError: if `service_name` is `None`
"""
if not body:
raise ValueError(
"A dictionary representing a V1Service patch must be provided."
)
if not service_name:
raise ValueError("The name of a Kubernetes service must be provided.")
api_client = cast(
client.CoreV1Api,
get_kubernetes_client("service", kubernetes_api_key_secret),
)
body = {**self.body, **(body or {})}
kube_kwargs = {**self.kube_kwargs, **(kube_kwargs or {})}
api_client.patch_namespaced_service(
name=service_name, namespace=namespace, body=body, **kube_kwargs
)
class ReadNamespacedService(Task):
"""
Task for reading a namespaced service on Kubernetes.
Note that all initialization arguments can optionally be provided or overwritten at runtime.
This task will attempt to connect to a Kubernetes cluster in three steps with
the first successful connection attempt becoming the mode of communication with a
cluster.
1. Attempt to use a Prefect Secret that contains a Kubernetes API Key. If
`kubernetes_api_key_secret` = `None` then it will attempt the next two connection
methods. By default the value is `KUBERNETES_API_KEY` so providing `None` acts as
an override for the remote connection.
2. Attempt in-cluster connection (will only work when running on a Service in a cluster)
3. Attempt out-of-cluster connection using the default location for a kube config file
The argument `kube_kwargs` will perform an in-place update when the task
is run. This means that it is possible to provide `kube_kwargs = {"info": "here"}` at
instantiation and then provide `kube_kwargs = {"more": "info"}` at run time which will make
`kube_kwargs = {"info": "here", "more": "info"}`. *Note*: Keys present in both instantiation
and runtime will be replaced with the runtime value.
Args:
- service_name (str, optional): The name of a service to read
- namespace (str, optional): The Kubernetes namespace to read this service from,
defaults to the `default` namespace
- kube_kwargs (dict, optional): Optional extra keyword arguments to pass to the
Kubernetes API (e.g. `{"pretty": "...", "exact": "..."}`)
- kubernetes_api_key_secret (str, optional): the name of the Prefect Secret
which stored your Kubernetes API Key; this Secret must be a string and in
BearerToken format
- **kwargs (dict, optional): additional keyword arguments to pass to the Task
constructor
"""
def __init__(
self,
service_name: str = None,
namespace: str = "default",
kube_kwargs: dict = None,
kubernetes_api_key_secret: str = "KUBERNETES_API_KEY",
**kwargs: Any
):
self.service_name = service_name
self.namespace = namespace
self.kube_kwargs = kube_kwargs or {}
self.kubernetes_api_key_secret = kubernetes_api_key_secret
super().__init__(**kwargs)
@defaults_from_attrs(
"service_name", "namespace", "kube_kwargs", "kubernetes_api_key_secret"
)
def run(
self,
service_name: str = None,
namespace: str = "default",
kube_kwargs: dict = None,
kubernetes_api_key_secret: str = "KUBERNETES_API_KEY",
) -> None:
"""
Task run method.
Args:
- service_name (str, optional): The name of a service to read
- namespace (str, optional): The Kubernetes namespace to read this service in,
defaults to the `default` namespace
- kube_kwargs (dict, optional): Optional extra keyword arguments to pass to the
Kubernetes API (e.g. `{"pretty": "...", "exact": "..."}`)
- kubernetes_api_key_secret (str, optional): the name of the Prefect Secret
which stored your Kubernetes API Key; this Secret must be a string and in
BearerToken format
Returns:
- V1Service: a Kubernetes V1Service matching the service that was found
Raises:
- ValueError: if `service_name` is `None`
"""
if not service_name:
raise ValueError("The name of a Kubernetes service must be provided.")
api_client = cast(
client.CoreV1Api,
get_kubernetes_client("service", kubernetes_api_key_secret),
)
kube_kwargs = {**self.kube_kwargs, **(kube_kwargs or {})}
return api_client.read_namespaced_service(
name=service_name, namespace=namespace, **kube_kwargs
)
class ReplaceNamespacedService(Task):
"""
Task for replacing a namespaced service on Kubernetes.
Note that all initialization arguments can optionally be provided or overwritten at runtime.
This task will attempt to connect to a Kubernetes cluster in three steps with
the first successful connection attempt becoming the mode of communication with a
cluster.
1. Attempt to use a Prefect Secret that contains a Kubernetes API Key. If
`kubernetes_api_key_secret` = `None` then it will attempt the next two connection
methods. By default the value is `KUBERNETES_API_KEY` so providing `None` acts as
an override for the remote connection.
2. Attempt in-cluster connection (will only work when running on a Service in a cluster)
3. Attempt out-of-cluster connection using the default location for a kube config file
The arguments `body` and `kube_kwargs` will perform an in-place update when the task
is run. This means that it is possible to provide `body = {"info": "here"}` at
instantiation and then provide `body = {"more": "info"}` at run time which will make
`body = {"info": "here", "more": "info"}`. *Note*: Keys present in both instantiation
and runtime will be replaced with the runtime value.
Args:
- service_name (str, optional): The name of a service to replace
- body (dict, optional): A dictionary representation of a Kubernetes V1Service
specification
- namespace (str, optional): The Kubernetes namespace to patch this service in,
defaults to the `default` namespace
- kube_kwargs (dict, optional): Optional extra keyword arguments to pass to the
Kubernetes API (e.g. `{"pretty": "...", "dry_run": "..."}`)
- kubernetes_api_key_secret (str, optional): the name of the Prefect Secret
which stored your Kubernetes API Key; this Secret must be a string and in
BearerToken format
- **kwargs (dict, optional): additional keyword arguments to pass to the Task
constructor
"""
def __init__(
self,
service_name: str = None,
body: dict = None,
namespace: str = "default",
kube_kwargs: dict = None,
kubernetes_api_key_secret: str = "KUBERNETES_API_KEY",
**kwargs: Any
):
self.service_name = service_name
self.body = body or {}
self.namespace = namespace
self.kube_kwargs = kube_kwargs or {}
self.kubernetes_api_key_secret = kubernetes_api_key_secret
super().__init__(**kwargs)
@defaults_from_attrs(
"service_name", "body", "namespace", "kube_kwargs", "kubernetes_api_key_secret"
)
def run(
self,
service_name: str = None,
body: dict = None,
namespace: str = "default",
kube_kwargs: dict = None,
kubernetes_api_key_secret: str = "KUBERNETES_API_KEY",
) -> None:
"""
Task run method.
Args:
- service_name (str, optional): The name of a service to replace
- body (dict, optional): A dictionary representation of a Kubernetes V1Service
specification
- namespace (str, optional): The Kubernetes namespace to patch this service in,
defaults to the `default` namespace
- kube_kwargs (dict, optional): Optional extra keyword arguments to pass to the
Kubernetes API (e.g. `{"pretty": "...", "dry_run": "..."}`)
- kubernetes_api_key_secret (str, optional): the name of the Prefect Secret
which stored your Kubernetes API Key; this Secret must be a string and in
BearerToken format
Raises:
- ValueError: if `body` is `None`
- ValueError: if `service_name` is `None`
"""
if not body:
raise ValueError("A dictionary representing a V1Service must be provided.")
if not service_name:
raise ValueError("The name of a Kubernetes service must be provided.")
api_client = cast(
client.CoreV1Api,
get_kubernetes_client("service", kubernetes_api_key_secret),
)
body = {**self.body, **(body or {})}
kube_kwargs = {**self.kube_kwargs, **(kube_kwargs or {})}
api_client.replace_namespaced_service(
name=service_name, namespace=namespace, body=body, **kube_kwargs
)