Go to file
Tessa Walsh 38f32f11ea
Enforce quota and hard cap for monthly execution minutes (#1284)
Fixes #1261 Closes #1092

The quota for monthly execution minutes is treated as a hard cap. Once
it is exceeded, an alert indicating that an org has exceeded its monthly
execution minutes will display and the user will be unable to start new
crawls. Any running crawls will be stopped once the quota is exceeded.

An execution minutes meter bar is also added in the Org Dashboard and
displayed if a quota is set. More detail in #1305 which was
merged into this branch.

## Changes

- Enable setting 'maxExecMinutesPerMonth' in orgs list quotas by superadmin
- Enforce quota by stopping crawls in operator once quota is reached
- Show alert banner once execution time quota is hit:
- Once quota is hit, disable Run Crawl buttons in frontend, return 403
message with `exec_minutes_quota_reached` detail in backend from
crawl config `/run` endpoint, and don't run new workflows on creation
(similar to storage quota)
- Display execution time for crawls in the crawl details overview,
immediately below
- Show execution minutes meter on dashboard (from #1305)

---------
Co-authored-by: Henry Wilkinson <henry@wilkinson.graphics>
Co-authored-by: Ilya Kreymer <ikreymer@gmail.com>
Co-authored-by: sua yoo <sua@webrecorder.org>
2023-10-26 15:38:51 -07:00
.github avoid exception if 'errors' key doesn't exist (#1301) 2023-10-19 14:39:54 -07:00
.vscode
ansible ansible microk8s additional cleanup (#1295) 2023-10-16 18:55:35 -07:00
backend Enforce quota and hard cap for monthly execution minutes (#1284) 2023-10-26 15:38:51 -07:00
chart Provide full resources in archived items finished webhooks (#1308) 2023-10-23 19:01:58 -07:00
configs
docs Enforce quota and hard cap for monthly execution minutes (#1284) 2023-10-26 15:38:51 -07:00
frontend Enforce quota and hard cap for monthly execution minutes (#1284) 2023-10-26 15:38:51 -07:00
scripts
test
.gitignore
.pre-commit-config.yaml
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
version.txt version: update to 1.8.0-beta.0 2023-10-17 18:06:55 -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