Go to file
Ilya Kreymer fb3d88291f
Background Jobs Work (#1321)
Fixes #1252 

Supports a generic background job system, with two background jobs,
CreateReplicaJob and DeleteReplicaJob.
- CreateReplicaJob runs on new crawls, uploads, profiles and updates the
`replicas` array with the info about the replica after the job succeeds.
- DeleteReplicaJob deletes the replica.
- Both jobs are created from the new `replica_job.yaml` template. The
CreateReplicaJob sets secrets for primary storage + replica storage,
while DeleteReplicaJob only needs the replica storage.
- The job is processed in the operator when the job is finalized
(deleted), which should happen immediately when the job is done, either
because it succeeds or because the backoffLimit is reached (currently
set to 3).
- /jobs/ api lists all jobs using a paginated response, including filtering and sorting
- /jobs/<job id> returns details for a particular job
- tests: nightly tests updated to check create + delete replica jobs for crawls as well as uploads, job api endpoints
- tests: also fixes to timeouts in nightly tests to avoid crawls finishing too quickly.

---------
Co-authored-by: Tessa Walsh <tessa@bitarchivist.net>
2023-11-02 13:02:17 -07:00
.github Background Jobs Work (#1321) 2023-11-02 13:02:17 -07:00
.vscode Add MkDocs YAML schema to vscode settings.json (#1075) 2023-08-15 12:06:05 -07:00
ansible ansible microk8s additional cleanup (#1295) 2023-10-16 18:55:35 -07:00
backend Background Jobs Work (#1321) 2023-11-02 13:02:17 -07:00
chart Background Jobs Work (#1321) 2023-11-02 13:02:17 -07:00
configs
docs Enforce quota and hard cap for monthly execution minutes (#1284) 2023-10-26 15:38:51 -07:00
frontend version: bump to 1.8.0-beta.1 2023-10-27 14:35:24 -07:00
scripts publish helm chart on release (fixes #1114) (#1117) (#1123) 2023-08-30 12:02:02 -07:00
test
.gitignore
.pre-commit-config.yaml Remove config from list endpoints to speed up responses (#1193) 2023-09-19 11:05:48 -05:00
btrix Add down command to uninstall and delete data (#1285) 2023-10-13 17:16:12 -07:00
CHANGES.md
LICENSE
mkdocs.yml Adds missing user documentation for launch! (#1286) 2023-10-16 19:16:38 -07:00
NOTICE
pylintrc
README.md Update README features link to new landing site (#1302) 2023-10-20 00:06:36 -04:00
update-version.sh fix: add "v" to helm chart release filename (#1141) 2023-09-05 15:47:39 -04:00
version.txt version: bump to 1.8.0-beta.1 2023-10-27 14:35:24 -07:00
yarn.lock

Browsertrix Cloud

Browsertrix Cloud is an open-source cloud-native high-fidelity browser-based crawling service designed to make web archiving easier and more accessible for everyone.

The service provides an API and UI for scheduling crawls and viewing results, and managing all aspects of crawling process. This system provides the orchestration and management around crawling, while the actual crawling is performed using Browsertrix Crawler containers, which are launched for each crawl.

See Browsertrix Cloud for a feature overview and information about Browsertrix Cloud Hosting.

Documentation

The full docs for using, deploying and developing Browsertrix Cloud are available at: https://docs.browsertrix.cloud

Deployment

The latest deployment documentation is available at: https://docs.browsertrix.cloud/deploy

The docs cover deploying Browsertrix Cloud in different environments using Kubernetes, from a single-node setup to scalable clusters in the cloud.

Previously, Browsertrix Cloud also supported Docker Compose and podman-based deployment. This is now deprecated due to the complexity of maintaining feature parity across different setups, and with various Kubernetes deployment options being available and easy to deploy, even on a single machine.

Making deployment of Browsertrix Cloud as easy as possible remains a key goal, and we welcome suggestions for how we can further improve our Kubernetes deployment options.

If you are looking to just try running a single crawl, you may want to try Browsertrix Crawler first to test out the crawling capabilities.

Development Status

Browsertrix Cloud is currently in a beta, though the system and backend API is fairly stable, we are working on many additional features.

Additional developer documentation is available at https://docs.browsertrix.cloud/develop

Please see the GitHub issues and this GitHub Project for our current project plan and tasks.

License

Browsertrix Cloud is made available under the AGPLv3 License.

Documentation is made available under the Creative Commons Attribution 4.0 International License