-
-
Notifications
You must be signed in to change notification settings - Fork 28
/
k8sapi.py
316 lines (269 loc) · 10.3 KB
/
k8sapi.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
""" K8S API Access """
import os
import traceback
import yaml
from kubernetes_asyncio import client, config
from kubernetes_asyncio.stream import WsApiClient
from kubernetes_asyncio.client.api_client import ApiClient
from kubernetes_asyncio.client.api import custom_objects_api
from kubernetes_asyncio.utils import create_from_dict
from kubernetes_asyncio.client.exceptions import ApiException
from redis import asyncio as aioredis
from fastapi import HTTPException
from fastapi.templating import Jinja2Templates
from .utils import get_templates_dir, dt_now
# ============================================================================
# pylint: disable=too-many-instance-attributes
class K8sAPI:
"""K8S API accessors"""
def __init__(self):
super().__init__()
self.namespace = os.environ.get("CRAWLER_NAMESPACE") or "crawlers"
self.custom_resources = {}
self.templates = Jinja2Templates(
directory=get_templates_dir(), autoescape=False
)
config.load_incluster_config()
self.client = client
self.api_client = ApiClient()
self.core_api = client.CoreV1Api(self.api_client)
self.core_api_ws = client.CoreV1Api(api_client=WsApiClient())
self.batch_api = client.BatchV1Api(self.api_client)
self.apps_api = client.AppsV1Api(self.api_client)
# try separate api client to avoid content-type issues
self.custom_api = custom_objects_api.CustomObjectsApi(self.api_client)
# custom resource's client API
self.add_custom_resource("CrawlJob", "crawljobs")
self.add_custom_resource("ProfileJob", "profilejobs")
def add_custom_resource(self, name, plural):
"""add custom resource"""
self.custom_resources[name] = plural
def get_custom_api(self, kind):
"""return custom API"""
return self.custom_resources[kind] if kind in self.custom_resources else None
def get_redis_url(self, crawl_id):
"""get redis url for crawl id"""
redis_url = (
f"redis://redis-{crawl_id}.redis.{self.namespace}.svc.cluster.local/0"
)
return redis_url
async def get_redis_client(self, redis_url):
"""return redis client with correct params for one-time use"""
return aioredis.from_url(
redis_url,
decode_responses=True,
auto_close_connection_pool=True,
socket_timeout=20,
)
# pylint: disable=too-many-arguments, too-many-locals
def new_crawl_job_yaml(
self,
cid,
userid,
oid,
storage,
crawler_channel,
scale=1,
crawl_timeout=0,
max_crawl_size=0,
manual=True,
crawl_id=None,
warc_prefix="",
qa_source="",
):
"""load job template from yaml"""
if not crawl_id:
ts_now = dt_now().strftime("%Y%m%d%H%M%S")
prefix = "manual" if manual else "sched"
crawl_id = f"{prefix}-{ts_now}-{cid[:12]}"
params = {
"id": crawl_id,
"cid": cid,
"oid": oid,
"userid": userid,
"scale": scale,
"timeout": crawl_timeout,
"max_crawl_size": max_crawl_size or 0,
"storage_name": str(storage),
"manual": "1" if manual else "0",
"crawler_channel": crawler_channel,
"warc_prefix": warc_prefix,
"qa_source": qa_source,
}
data = self.templates.env.get_template("crawl_job.yaml").render(params)
return crawl_id, data
async def new_crawl_job(self, *args, **kwargs) -> str:
"""load and init crawl job via k8s api"""
crawl_id, data = self.new_crawl_job_yaml(*args, **kwargs)
# create job directly
await self.create_from_yaml(data)
return crawl_id
async def create_from_yaml(self, doc, namespace=None):
"""init k8s objects from yaml"""
yml_document_all = yaml.safe_load_all(doc)
k8s_objects = []
for yml_document in yml_document_all:
custom = self.custom_resources.get(yml_document["kind"])
if custom is not None:
created = await self.create_custom_from_dict(
custom, yml_document, namespace
)
else:
created = await create_from_dict(
self.api_client,
yml_document,
verbose=False,
namespace=namespace or self.namespace,
)
k8s_objects.append(created)
return k8s_objects
async def create_custom_from_dict(self, custom, doc, namespace):
"""create custom from dict"""
apiver = doc["apiVersion"].split("/")
created = await self.custom_api.create_namespaced_custom_object(
group=apiver[0],
version=apiver[1],
plural=custom,
body=doc,
namespace=namespace or self.namespace,
)
return created
async def has_storage_secret(self, storage_secret) -> bool:
"""Check if storage is valid by trying to get the storage secret
Will throw if not valid, otherwise return True"""
try:
await self.core_api.read_namespaced_secret(
storage_secret,
namespace=self.namespace,
)
return True
# pylint: disable=broad-except
except Exception:
# pylint: disable=broad-exception-raised,raise-missing-from
raise HTTPException(
status_code=400, detail="invalid_config_missing_storage_secret"
)
async def delete_crawl_job(self, crawl_id):
"""delete custom crawljob object"""
try:
name = f"crawljob-{crawl_id}"
await self.custom_api.delete_namespaced_custom_object(
group="btrix.cloud",
version="v1",
namespace=self.namespace,
plural="crawljobs",
name=name,
grace_period_seconds=0,
# delete as background to allow operator to do proper cleanup
propagation_policy="Background",
)
return {"success": True}
except ApiException as api_exc:
return {"error": str(api_exc.reason)}
async def delete_profile_browser(self, browserid):
"""delete custom crawljob object"""
try:
await self.custom_api.delete_namespaced_custom_object(
group="btrix.cloud",
version="v1",
namespace=self.namespace,
plural="profilejobs",
name=f"profilejob-{browserid}",
grace_period_seconds=0,
propagation_policy="Background",
)
return True
except ApiException:
return False
async def get_profile_browser(self, browserid):
"""get profile browser"""
return await self.custom_api.get_namespaced_custom_object(
group="btrix.cloud",
version="v1",
namespace=self.namespace,
plural="profilejobs",
name=f"profilejob-{browserid}",
)
async def _patch_job(self, crawl_id, body, pluraltype="crawljobs") -> dict:
try:
name = f"{pluraltype[:-1]}-{crawl_id}"
await self.custom_api.patch_namespaced_custom_object(
group="btrix.cloud",
version="v1",
namespace=self.namespace,
plural=pluraltype,
name=name,
body={"spec": body},
_content_type="application/merge-patch+json",
)
return {"success": True}
# pylint: disable=broad-except
except Exception as exc:
traceback.print_exc()
return {"error": str(exc)}
async def print_pod_logs(self, pod_names, lines=100):
"""print pod logs"""
for pod in pod_names:
print(f"============== LOGS FOR POD: {pod} ==============")
try:
resp = await self.core_api.read_namespaced_pod_log(
pod, self.namespace, tail_lines=lines
)
print(resp)
# pylint: disable=bare-except
except:
print("Logs Not Found")
async def is_pod_metrics_available(self) -> bool:
"""return true/false if metrics server api is available by
attempting list operation. if operation succeeds, then
metrics are available, otherwise not available
"""
try:
await self.custom_api.list_namespaced_custom_object(
group="metrics.k8s.io",
version="v1beta1",
namespace=self.namespace,
plural="pods",
limit=1,
)
return True
# pylint: disable=broad-exception-caught
except Exception as exc:
print(exc)
return False
async def has_custom_jobs_with_label(self, plural, label) -> bool:
"""return true/false if any crawljobs or profilejobs
match given label"""
try:
await self.custom_api.list_namespaced_custom_object(
group="btrix.cloud",
version="v1",
namespace=self.namespace,
plural=plural,
label_selector=label,
limit=1,
)
return True
# pylint: disable=broad-exception-caught
except Exception:
return False
async def send_signal_to_pod(self, pod_name, signame) -> bool:
"""send signal to all pods"""
command = ["bash", "-c", f"kill -s {signame} 1"]
signaled = False
try:
print(f"Sending {signame} to {pod_name}", flush=True)
res = await self.core_api_ws.connect_get_namespaced_pod_exec(
name=pod_name,
namespace=self.namespace,
command=command,
stdout=True,
)
if res:
print("Result", res, flush=True)
else:
signaled = True
# pylint: disable=broad-except
except Exception as exc:
print(f"Send Signal Error: {exc}", flush=True)
return signaled