tea/browsertrix
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: tweak ansible deployment docs

Browse Source
This commit is contained in:
Ilya Kreymer 2023-01-11 22:33:28 -08:00
parent b0f1379e42
commit 875364c05a
4 changed files with 28 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/deploy/ansible/digitalocean.md
View File

@ -1,6 +1,8 @@
## DigitalOcean # DigitalOcean
This provides an easy way to install BrowserTrix Cloud on DigitalOcean. It automatically sets up BrowserTrix with, letsencrypt certificates. *Playbook Path: [ansible/playbooks/install_microk8s.yml](https://github.com/webrecorder/browsertrix-cloud/blob/main/ansible/playbooks/do_setup.yml)*
This playbook provides an easy way to install BrowserTrix Cloud on DigitalOcean. It automatically sets up Browsertrix with, LetsEncrypt certificates.
### Requirements ### Requirements
@ -13,27 +15,24 @@ To run this ansible playbook, you need to:
#### Install #### Install
Clone the repo: 1. Clone the repo:
```zsh ```zsh
git clone https://github.com/webrecorder/browsertrix-cloud.git git clone https://github.com/webrecorder/browsertrix-cloud.git
cd browsertrix-cloud cd browsertrix-cloud
``` ```
[Look at the configuration options](https://github.com/webrecorder/browsertrix-cloud/blob/main/ansible/group_vars/do/main.yml) 2. [Look at the configuration options](https://github.com/webrecorder/browsertrix-cloud/blob/main/ansible/group_vars/do/main.yml) and modify them or pass them as extra variables as shown below.
and modify them or pass them as extra variables as shown below.
Run the playbook:
3. Run the playbook:
```zsh ```zsh
ansible-playbook playbooks/do_setup.yml -e project_name="your-project" -e superuser_email="you@yourdomain.com" -e domain_name="yourdomain.com" ansible-playbook playbooks/do_setup.yml -e project_name="your-project" -e superuser_email="you@yourdomain.com" -e domain_name="yourdomain.com"
``` ```
#### Upgrading #### Upgrading
* Run `git pull` 1. Run `git pull`
* Run the playbook:
2. Run the playbook:
```zsh ```zsh
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 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
``` ```

8
docs/deploy/ansible/index.md
View File

@ -1,8 +0,0 @@
## Ansible Deployment
[Ansible](https://ansible.com) makes the initial setup and configuration of your Browsertrix Cloud instance automated and repeatable.
At a minimum you will need to [install ansible](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#control-node-requirements) on your control computer and use any one of the playbooks we have to deploy Browsertrix Cloud in the following tested environments.
[DigitalOcean](digitalocean.md)
[Microk8s](microk8s.md)

24
docs/deploy/ansible/microk8s.md
View File

@ -1,6 +1,9 @@
## Microk8s # Microk8s
This provides an easy way to install BrowserTrix Cloud on an ubuntu (tested on Jammy Jellyfish) and a RedHat 9 (tested on Rocky Linux 9). It automatically sets up BrowserTrix with, letsencrypt certificates. *Playbook Path: [ansible/playbooks/install_microk8s.yml](https://github.com/webrecorder/browsertrix-cloud/blob/main/ansible/playbooks/install_microk8s.yml)*
This playbook provides an easy way to install Browsertrix Cloud on an Ubuntu (tested on Jammy Jellyfish) and a RedHat 9 (tested on Rocky Linux 9).
It automatically sets up Browsertrix with, Letsencrypt certificates.
### Requirements ### Requirements
@ -13,29 +16,26 @@ To run this ansible playbook, you need to:
#### Install #### Install
Clone the repo: 1. Clone the repo:
```zsh ```zsh
git clone https://github.com/webrecorder/browsertrix-cloud.git git clone https://github.com/webrecorder/browsertrix-cloud.git
cd browsertrix-cloud cd browsertrix-cloud
``` ```
[Look at the configuration options](https://github.com/webrecorder/browsertrix-cloud/blob/main/ansible/group_vars/microk8s/main.yml) 2. [Look at the configuration options](https://github.com/webrecorder/browsertrix-cloud/blob/main/ansible/group_vars/microk8s/main.yml) and modify them or pass them as extra variables as shown below.
and modify them or pass them as extra variables as shown below. 3. Add your IP address above to a new file called [inventory/hosts]
Add your IP address above to a new file called [inventory/hosts]
Run the playbook:
4. Run the playbook:
```zsh ```zsh
ansible-playbook -i inventory/hosts playbooks/install_microk8s.yml -e host_ip="1.2.3.4" -e domain_name="yourdomain.com" -e your_user="your_vps_admin_user" ansible-playbook -i inventory/hosts playbooks/install_microk8s.yml -e host_ip="1.2.3.4" -e domain_name="yourdomain.com" -e your_user="your_vps_admin_user"
``` ```
#### Upgrading #### Upgrading
* Run `git pull` 1. Run `git pull`
* Run the playbook:
2. Run the playbook:
```zsh ```zsh
ansible-playbook -i inventory/hosts playbooks/install_microk8s.yml -e host_ip="1.2.3.4" -e domain_name="yourdomain.com" -t helm_upgrade ansible-playbook -i inventory/hosts playbooks/install_microk8s.yml -e host_ip="1.2.3.4" -e domain_name="yourdomain.com" -t helm_upgrade
``` ```

10
docs/deploy/production.md
View File

@ -67,11 +67,13 @@ There are also many ways to deploy Browsertrix Cloud on various cloud providers.
To simplify this process, we are working on Ansible playbooks for setting up Browsertrix Cloud on commonly used infrastructure. To simplify this process, we are working on Ansible playbooks for setting up Browsertrix Cloud on commonly used infrastructure.
Thus, far we have the following Ansible playbooks available: ### Ansible Deployment
### Digital Ocean [Ansible](https://ansible.com) makes the initial setup and configuration of your Browsertrix Cloud instance automated and repeatable.
*TODO: Add more details*
To use, you will need to [install Ansible](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#control-node-requirements) on your control computer and then you can use these to deploy to Browsertrix Cloud on remote and cloud environments.
Currently, we provide playbooks for the following tested environments:
- [DigitalOcean](ansible/digitalocean.md)
- [Microk8s](ansible/microk8s.md)