60ba9e366f
* Btrixjobs Operator - Phase 1 (#679) - add metacontroller and custom crds - add main_op entrypoint for operator * Btrix Operator Crawl Management (#767) * operator backend: - run operator api in separate container but in same pod, with WEB_CONCURRENCY=1 - operator creates statefulsets and services for CrawlJob and ProfileJob - operator: use service hook endpoint, set port in values.yaml * crawls working with CrawlJob - jobs start with 'crawljob-' prefix - update status to reflect current crawl state - set sync time to 10 seconds by default, overridable with 'operator_resync_seconds' - mark crawl as running, failed, complete when finished - store finished status when crawl is complete - support updating scale, forcing rollover, stop via patching CrawlJob - support cancel via deletion - requires hack to content-length for patching custom resources - auto-delete of CrawlJob via 'ttlSecondsAfterFinished' - also delete pvcs until autodelete supported via statefulset (k8s >1.27) - ensure filesAdded always set correctly, keep counter in redis, add to status display - optimization: attempt to reduce automerging, by reusing volumeClaimTemplates from existing children, as these may have additional props added - add add_crawl_errors_to_db() for storing crawl errors from redis '<crawl>:e' key to mongodb when crawl is finished/failed/canceled - add .status.size to display human-readable crawl size, if available (from webrecorder/browsertrix-crawler#291) - support new page size, >0.9.0 and old page size key (changed in webrecorder/browsertrix-crawler#284) * support for scheduled jobs! - add main_scheduled_job entrypoint to run scheduled jobs - add crawl_cron_job.yaml template for declaring CronJob - CronJobs moved to default namespace * operator manages ProfileJobs: - jobs start with 'profilejob-' - update expiry time by updating ProfileJob object 'expireTime' while profile is active * refactor/cleanup: - remove k8s package - merge k8sman and basecrawlmanager into crawlmanager - move templates, k8sapi, utils into root package - delete all *_job.py files - remove dt_now, ts_now from crawls, now in utils - all db operations happen in crawl/crawlconfig/org files - move shared crawl/crawlconfig/org functions that use the db to be importable directly, including get_crawl_config, add_new_crawl, inc_crawl_stats * role binding: more secure setup, don't allow crawler namespace any k8s permissions - move cronjobs to be created in default namespace - grant default namespace access to create cronjobs in default namespace - remove role binding from crawler namespace * additional tweaks to templates: - templates: split crawler and redis statefulset into separate yaml file (in case need to load one or other separately) * stats / redis optimization: - don't update stats in mongodb on every operator sync, only when crawl is finished - for api access, read stats directly from redis to get up-to-date stats - move get_page_stats() to utils, add get_redis_url() to k8sapi to unify access * Add migration for operator changes - Update configmap for crawl configs with scale > 1 or crawlTimeout > 0 and schedule exists to recreate CronJobs - add option to rerun last migration, enabled via env var and by running helm with --set=rerun_last_migration=1 * subcharts: move crawljob and profilejob crds to separate subchart, as this seems best way to guarantee proper install order with + update on upgrade with helm, add built btrix-crds-0.1.0.tgz subchart - metacontroller: use release from ghcr, add metacontroller-helm-v4.10.1.tgz subchart * backend api fixes - ensure changing scale of crawl also updates it in the db - crawlconfigs: add 'currCrawlSize' and 'lastCrawlSize' to crawlconfig api --------- Co-authored-by: D. Lee <leepro@gmail.com> Co-authored-by: Tessa Walsh <tessa@bitarchivist.net>
65 lines
2.3 KiB
Python
65 lines
2.3 KiB
Python
"""
|
|
Migration 0005 - Updating scheduled cron jobs after Operator changes
|
|
"""
|
|
from btrixcloud.crawlconfigs import CrawlConfig, UpdateCrawlConfig
|
|
from btrixcloud.crawlmanager import CrawlManager
|
|
from btrixcloud.migrations import BaseMigration
|
|
|
|
|
|
MIGRATION_VERSION = "0005"
|
|
|
|
|
|
class Migration(BaseMigration):
|
|
"""Migration class."""
|
|
|
|
def __init__(self, mdb, migration_version=MIGRATION_VERSION):
|
|
super().__init__(mdb, migration_version)
|
|
|
|
async def migrate_up(self):
|
|
"""Perform migration up.
|
|
|
|
Find existing workflows with schedule and create new crawl_cron_jobs
|
|
from template for each, then delete existing scheduled jobs from
|
|
crawler namespace.
|
|
|
|
Additionally update the configmap for crawl configs with scale > 1
|
|
or crawlTimeout > 0.
|
|
"""
|
|
# pylint: disable=too-many-locals
|
|
crawl_configs = self.mdb["crawl_configs"]
|
|
crawl_manager = CrawlManager()
|
|
|
|
# Update configmap for crawl configs that have non-zero timeout or scale > 1
|
|
match_query = {
|
|
"$or": [
|
|
{"crawlTimeout": {"$gt": 0}},
|
|
{"scale": {"$gt": 1}},
|
|
{"schedule": {"$nin": ["", None]}},
|
|
]
|
|
}
|
|
configs_to_update = [res async for res in crawl_configs.find(match_query)]
|
|
for config_dict in configs_to_update:
|
|
config = CrawlConfig.from_dict(config_dict)
|
|
print(
|
|
f"Updating Crawl Config {config.id}: schedule: {config.schedule}, "
|
|
+ "timeout: {config.crawlTimeout}, scale: {config.scale}"
|
|
)
|
|
await crawl_manager.update_crawl_config(
|
|
config,
|
|
UpdateCrawlConfig(
|
|
scale=config.scale,
|
|
crawlTimeout=config.crawlTimeout,
|
|
schedule=config.schedule,
|
|
),
|
|
)
|
|
|
|
# Delete existing scheduled jobs from crawler namespace
|
|
print("Deleting cronjobs from crawler namespace")
|
|
await crawl_manager.batch_api.delete_collection_namespaced_cron_job(
|
|
namespace=crawl_manager.namespace
|
|
)
|
|
result = await crawl_manager.batch_api.list_namespaced_cron_job(
|
|
namespace=crawl_manager.namespace
|
|
)
|
|
assert len(result.items) == 0
|