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>
78 lines
1.7 KiB
YAML
78 lines
1.7 KiB
YAML
---
|
|
apiVersion: metacontroller.k8s.io/v1alpha1
|
|
kind: CompositeController
|
|
metadata:
|
|
name: crawljobs-operator
|
|
spec:
|
|
generateSelector: false
|
|
resyncPeriodSeconds: {{ .Values.operator_resync_seconds | default 10 }}
|
|
parentResource:
|
|
apiVersion: btrix.cloud/v1
|
|
resource: crawljobs
|
|
childResources:
|
|
- apiVersion: apps/v1
|
|
resource: statefulsets
|
|
updateStrategy:
|
|
method: InPlace
|
|
|
|
- apiVersion: v1
|
|
resource: services
|
|
updateStrategy:
|
|
method: OnDelete
|
|
|
|
hooks:
|
|
sync:
|
|
webhook:
|
|
service:
|
|
namespace: {{ .Release.Namespace }}
|
|
name: {{ .Values.name }}-backend
|
|
port: {{ .Values.opPort }}
|
|
path: /op/crawls/sync
|
|
|
|
finalize:
|
|
webhook:
|
|
service:
|
|
namespace: {{ .Release.Namespace }}
|
|
name: {{ .Values.name }}-backend
|
|
port: {{ .Values.opPort }}
|
|
path: /op/crawls/finalize
|
|
|
|
customize:
|
|
webhook:
|
|
service:
|
|
namespace: {{ .Release.Namespace }}
|
|
name: {{ .Values.name }}-backend
|
|
port: {{ .Values.opPort }}
|
|
path: /op/crawls/customize
|
|
|
|
---
|
|
apiVersion: metacontroller.k8s.io/v1alpha1
|
|
kind: CompositeController
|
|
metadata:
|
|
name: profilejobs-operator
|
|
spec:
|
|
generateSelector: false
|
|
resyncPeriodSeconds: 30
|
|
parentResource:
|
|
apiVersion: btrix.cloud/v1
|
|
resource: profilejobs
|
|
childResources:
|
|
- apiVersion: apps/v1
|
|
resource: statefulsets
|
|
updateStrategy:
|
|
method: InPlace
|
|
|
|
- apiVersion: v1
|
|
resource: services
|
|
updateStrategy:
|
|
method: OnDelete
|
|
|
|
hooks:
|
|
sync:
|
|
webhook:
|
|
service:
|
|
namespace: {{ .Release.Namespace }}
|
|
name: {{ .Values.name }}-backend
|
|
port: {{ .Values.opPort }}
|
|
path: /op/profilebrowsers/sync
|