* feat: ansible DO teardown * fix(DO): idempotency issues in ansible teardown * chore(DO): remove unused code * docs(ansible): mention teardown in the docs * fix: pass ansible-lint * fix: point database backup upload to the correct location in DO space
2.3 KiB
2.3 KiB
DigitalOcean
Playbook Path: ansible/playbooks/install_microk8s.yml
This playbook provides an easy way to install BrowserTrix Cloud on DigitalOcean. It automatically sets up Browsertrix with, LetsEncrypt certificates.
Requirements
To run this ansible playbook, you need to:
- Have a DigitalOcean Account where this will run.
- Create a DigitalOcean API Key which will need to be set in your terminal sessions environment variables
export DO_API_TOKEN
doctl
command line client configured (rundoctl auth init
)- Create a DigitalOcean Spaces API Key which will also need to be set in your terminal sessions environment variables, which should be set as
DO_AWS_ACCESS_KEY
andDO_AWS_SECRET_KEY
- Configure a DNS A Record and CNAME record.
- Have a working python and pip configuration through your OS Package Manager
Install
- Clone the repo:
git clone https://github.com/webrecorder/browsertrix-cloud.git
cd browsertrix-cloud
- Install the Dependencies through pipenv
cd ansible
pip install pipenv
pipenv install
pipenv shell
-
Look at the configuration options and modify them or pass them as extra variables as shown below. If you haven't configured
kubectl
, please enable theconfigure_kube
option -
Run the playbook:
ansible-playbook playbooks/do_setup.yml -e project_name="your-project" -e superuser_email="you@yourdomain.com" -e domain="yourdomain.com"
Upgrading
-
Run
git pull
-
Run the playbook:
ansible-playbook playbooks/do_setup.yml -e project_name="your-project" -e superuser_email="you@yourdomain.com" -e domain_name="yourdomain.com" -t helm_upgrade
Uninstall
You can tear down your deployment through ansible as well. By default ansible will dump all the databases into your DO space. You can configure an option to disable this feature.
ansible-playbook playbooks/do_teardown.yml -e project_name="your-project" -e superuser_email="you@yourdomain.com" -e domain="yourdomain.com"