browsertrix/chart/examples/local-config.yaml
Tessa Walsh 032859f361
Support multiple crawler versions (#1420)
Fixes #1385 

## Changes
Supports multiple crawler 'channels' which can be configured to
different browsertrix-crawler versions
- Replaces `crawler_image` in helm chart with `crawler_channels` array
similar to how storages are handled
- The `default` crawler channel must always be provided and specifies
the default crawler image
- Adds backend `/orgs/{oid}/crawlconfigs/crawler-channels` API endpoint
to fetch information about available crawler versions (name, image, and
label) and test
- Adds crawler channel select to workflow creation/edit screens and
profile creation dialog, and updates related API endpoints and
configmaps accordingly. The select dropdown is shown only if more than
one channel is configured.
- Adds `crawlerChannel` to workflow and crawl details.
- Add `image` to crawler image, used to display actual image used as
part of the crawl.
- Modifies `crawler_crawl_id` backend test fixture to use `test` crawler
version to ensure crawler versions other than latest work
- Adds migration to add `crawlerChannel` set to `default` to existing
workflow and profile objects and workflow configmaps

---------
Co-authored-by: Ilya Kreymer <ikreymer@gmail.com>
Co-authored-by: Henry Wilkinson <henry@wilkinson.graphics>
2024-01-16 15:32:12 -08:00

60 lines
1.9 KiB
YAML

# Local Config
# ------------
# This config is designed for local (non-hosted) use, with either Docker Desktop, minikube or local microk8s.
# With this setup, the cluster should be accessed locally via 'localhost'
# use custom port for local access, default is localhost:30870
# uncomment and change below
# local_service_port: 30870
# Uncomment to set custom organization name
# default_org: "My Local Organization"
# use version specified in values.yaml, uncomment to use :latest release instead
# backend_image: docker.io/webrecorder/browsertrix-backend:latest
# frontend_image: docker.io/webrecorder/browsertrix-frontend:latest
# uncomment to enable custom crawler dropdown
# Support for additional crawler release channels
# If more than one channel provided, a dropdown will be shown to users
# 'default' channel must always be included
# crawler_channels:
# - id: default
# image: "docker.io/webrecorder/browsertrix-crawler:latest"
#
# # Add, remove, or edit additional crawler release channels for example:
# - id: custom_version
# image: "<DOCKER IMAGE>"
# overrides to use existing images in local Docker, otherwise will pull from repository
# backend_pull_policy: "Never"
# frontend_pull_policy: "Never"
# crawler_pull_policy: "Never"
# redis_pull_policy: "Never"
# microk8s: if developing locally, can override these to use images from local microk8s repository (on localhost:32000)
# backend_image: "localhost:32000/webrecorder/browsertrix-backend:latest"
# frontend_image: "localhost:32000/webrecorder/browsertrix-frontend:latest"
# optionally, override default mongodb auth, used for all data storage:
#mongo_auth:
#username: root
#password: PASSWORD!
# optionally, set these to custom values
#superuser:
# set this to enable a superuser admim
# email: admin@example.com
# optional: if not set, automatically generated
# change or remove this
# password: PASSWORD!