EbookFoundation
/
cce-search-ansible
mirror of https://github.com/EbookFoundation/cce-search-ansible.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README

master
Dylan DiGeronimo 2020-04-20 17:26:04 -04:00
parent 6f0555f279
commit d2c120c052
1 changed files with 16 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -1,24 +1,30 @@
# CCE Search Ansible Setup # CCE Search Ansible Setup
## Frontend Server (cce.ebookfoundation.org) # Frontend Server (cce.ebookfoundation.org)
### Pre-requisites ### Pre-requisites
1. Install `ansible` on your local machine 1. Install `ansible` on your local machine
2. Ensure you have obtained the SSH key for the server 2. Ensure you have obtained the SSH key for the server
3. Ensure Python 3.7 and pip3 are installed on the server you wish to deploy to 3. Ensure Python 3.7 and pip3 are installed on the server you wish to deploy to
### Deploying ## Complete Playbooks
### Updating and redeploying
Once new changes have been added to the master branch of the [frontend repo](https://github.com/EbookFoundation/cce-search-prototype), run the `update-frontend-prod` playbook:
```
$ ansible-playbook -i hosts update-frontend-prod.yml --key-file="/path/to/key/on/your/machine"
```
## In-progress Playbooks
### Initial bootstrapping and deployment
To deploy, run the `setup-frontend-prod` playbook from within the directory containing this repository: To deploy, run the `setup-frontend-prod` playbook from within the directory containing this repository:
``` ```
$ ansible-playbook -i hosts setup-frontend-prod.yml --key-file="/path/to/key/on/your/machine" $ ansible-playbook -i hosts setup-frontend-prod.yml --key-file="/path/to/key/on/your/machine"
``` ```
### Updating
Once new changes have been added to the master branch of the [frontend repo](https://github.com/EbookFoundation/cce-search-prototype), run `update-frontend-prod` playbook:
```
$ ansible-playbook -i hosts update-frontend-prod.yml --key-file="/path/to/key/on/your/machine"
```
### Manually renewing HTTPS cert ### Manually renewing HTTPS cert
If Certbot does not automatically renew the HTTPS certificate, run the `refresh-frontend-cert` playbook: If Certbot does not automatically renew the HTTPS certificate, run the `refresh-frontend-cert` playbook:
``` ```
@ -28,6 +34,5 @@ $ ansible-playbook -i hosts refresh-frontend-cert.yml --key-file="/path/to/key/o
### TODO ### TODO
1. Complete todos from setup-frontend-prod.yml 1. Complete todos from setup-frontend-prod.yml
2. Complete refresh-frontend-cert.yml 2. Complete refresh-frontend-cert.yml
3. Complete update-frontend-prod.yml 3. Automate installation of Python 3.7 and pip3
4. Automate installation of Python 3.7 and pip3 4. Setup Ansible Vault to handle keys
5. Setup Ansible Vault to handle keys