docs: Update deploy/README.md on how to use API functions to backup a…

…nd restore database
w3c · Feb 4, 2025 · 34d5bdc · 34d5bdc
1 parent 46851ce
commit 34d5bdc
Showing 1 changed file with 53 additions and 32 deletions.
diff --git a/deploy/README.md b/deploy/README.md
@@ -52,38 +52,38 @@ can view logging from ansible with `sudo -i cat /var/log/messages`.
 To deploy this project to server:
 
 1. Merge from development to the releases branch as detailed in [docs/release.md](../docs/release.md).
-1. Obtain an authorized key and add it to your keychain. This is needed for deploys to Staging and Production.
-
-- The shared key is named `aria-at-bocoup`.
-- Place it in the ~/.ssh directory.
-- For security, set permissions on the key file, which is required by the OS: `chmod 600 ~/.ssh/aria-at-bocoup`.
-- Add it to your keychain with the following command: `ssh-add ~/.ssh/aria-at-bocoup`.
-- Add the following `Host` client configuration option to `~/.ssh/config`:
-  ```
-  Host *.w3.internal
-    ProxyJump [email protected]
-  ```
-  - The RSA key fingerprint for `ssh-aws.w3.org` is `SHA256:Nlyly0XFZebw0/k8yCGUXA+Y03W7WB7CPnXiZZb7XE8`.
-- Run `ssh [email protected]` (aria-at-staging.w3.org's server) and `ssh [email protected]` (aria-at.w3.org's server) to verify that you can connect to the servers.
-  - The RSA key fingerprint for `bestla.w3.internal` is `SHA256:F16aX2Wx4e39jbHhqEkeH8iRgY41C3WgxvAgvh7PQZ0`.
-  - The RSA key fingerprint for `fenrir.w3.internal` is `SHA256:cF6u/K00P2ELEVbIazVVqqMz5q+Sbh4+Jog/VmXZomg`.
+1. Obtain an authorized key and add it to your keychain. This is needed for deploys to staging and production.
+
+   - The shared key is named `aria-at-bocoup`.
+   - Place it in the `~/.ssh` directory.
+   - For security, set permissions on the key file, as required by the OS: `chmod 600 ~/.ssh/aria-at-bocoup`.
+   - Add it to your keychain with the following command: `ssh-add ~/.ssh/aria-at-bocoup`.
+   - Add the following `Host` client configuration to `~/.ssh/config`:
+     ```
+     Host *.w3.internal
+       ProxyJump [email protected]
+     ```
+     - Note: The RSA key fingerprint for `ssh-aws.w3.org` is `SHA256:Nlyly0XFZebw0/k8yCGUXA+Y03W7WB7CPnXiZZb7XE8`.
+   - Run `ssh [email protected]` (aria-at-staging.w3.org's server) and `ssh [email protected]` (aria-at.w3.org's server) to verify that you can connect to the servers.
+     - Note: The RSA key fingerprint for `bestla.w3.internal` is `SHA256:F16aX2Wx4e39jbHhqEkeH8iRgY41C3WgxvAgvh7PQZ0`.
+     - Note: The RSA key fingerprint for `fenrir.w3.internal` is `SHA256:cF6u/K00P2ELEVbIazVVqqMz5q+Sbh4+Jog/VmXZomg`.
 
 1. Bocoup maintains its own instance of the app on its internal infrastructure for quick and easy testing. Note that you must be a Bocouper to deploy to this environment. Follow the steps below to verify you are able to connect.
 
-- Run `ssh aria-at-app-sandbox.bocoup.com` and confirm you can connect.
-- Confirm that `sudo su` successfully switches you to the root user. You will need to enter the sudo password you chose during your Bocoup onboarding. This password will be required when deploying to the Sandbox.
+   - Run `ssh aria-at-app-sandbox.bocoup.com` to confirm you can connect.
+   - Confirm that `sudo su` successfully switches you to the root user. You will need to enter the sudo password you set during your Bocoup onboarding. This password will be required when deploying to the sandbox.
 
 1. Obtain a copy of the `ansible-vault-password.txt` file in LastPass and place it in the directory which contains this document.
 1. Install [Ansible](https://www.ansible.com/) version 2.16. Instructions for macOS are as follows:
 
-- Install Ansible at the specific 2.16 version: `python3 -m pip install --user ansible-core==2.16.14`
-- Add the following line to your `~/.zshrc` file, changing the path below to match where Python installs Ansible for you:
-  ```
-  export PATH=$PATH:/Users/Luigi/Library/Python/3.9/bin
-  ```
-- Run `source ~/.zshrc` to refresh your shell.
-- Install `ansible.posix` to make use of the [ansible.posix.synchronize](https://docs.ansible.com/ansible/latest/collections/ansible/posix/synchronize_module.html#ansible-posix-synchronize-module-a-wrapper-around-rsync-to-make-common-tasks-in-your-playbooks-quick-and-easy) module: `ansible-galaxy collection install ansible.posix`
-- Run `ansible --version` to verify your ansible is on version 2.16.
+   - Install Ansible at the specific 2.16 version: `python3 -m pip install --user ansible-core==2.16.14`
+   - Add the following line to your `~/.zshrc` file, changing the path below to match where Python installs Ansible for you:
+     ```
+     export PATH=$PATH:/Users/Mario/Library/Python/3.9/bin
+     ```
+   - Run `source ~/.zshrc` to refresh your shell.
+   - Install `ansible.posix` to make use of the [ansible.posix.synchronize](https://docs.ansible.com/ansible/latest/collections/ansible/posix/synchronize_module.html#ansible-posix-synchronize-module-a-wrapper-around-rsync-to-make-common-tasks-in-your-playbooks-quick-and-easy) module: `ansible-galaxy collection install ansible.posix`
+   - Run `ansible --version` to verify your ansible is on version 2.16.
 
 1. Execute the following command from the deploy directory:
    - Sandbox:
@@ -103,33 +103,54 @@ To deploy this project to server:
 
 Configuration files are located in the `files/` folder. Each config file is in the format `config-<environment>.env`
 
-Command to edit encrypted files (must be run in the deploy folder):
+Command to edit encrypted files (must be run in the `deploy` folder):
 
 ```
 ansible-vault edit files/config-sandbox.env
 ```
 
 ## Manual DB Backup
 
+### Local
+
 From the `deploy` folder:
 
 1. Retrieve the database user (aka PGUSER) and database password (aka PGPASSWORD), the environment is `production` or `staging`.
    `ansible-vault view --vault-password-file ansible-vault-password.txt files/config-<environment>.env`
-2. Ssh into the machine. The deploy key will be at `~/.ssh/aria-at-bocoup`, if you followed the deploy setup instructions. The domain is `aria-at.w3.org` for production and `aria-at-staging.w3.org` for staging.
+2. SSH into the machine. The deploy key will be at `~/.ssh/aria-at-bocoup`, if you followed the deploy setup instructions. The domain is `aria-at.w3.org` for production and `aria-at-staging.w3.org` for staging.
    `ssh -i <deploy key> root@<domain>`
-3. Create the backup and save it to a file. After running the command, the terminal prompt will ask for the PGPASSWORD. Use the current date for the timestamp, e.g. `20230406`. Run
-   `pg_dump -U <value for PGUSER> -h localhost -d aria_at_report > <environment>_dump_<timestamp>.sql`.
+3. Create the backup and save it to a file. After running the command, the terminal prompt will ask for the PGPASSWORD. Run
+   `pg_dump -U <value for PGUSER> -h localhost -d aria_at_report > <environment>_dump_<timestamp>.sql`. Use the current date for the timestamp in the format, `YYYYMMDD`, e.g. `20230406`.
 4. From another terminal window that's not connected to the server, copy the backup to your machine.
    `scp -i <deploy key> root@<domain>:<environment>_dump_<timestamp>.sql .`
 
+### API
+
+1. Run `curl -X POST 'https://<deploy_url>/api/database/dump`. This will create a dump of the current database at `/home/aria-bot/db_dumps/<environment>_dump_<YYYYMMDD_HHmmss>.sql`.
+2. Copy the backup to your machine.
+   `scp -i <deploy key> root@<domain>:/home/aria-bot/db_dumps/<environment>_dump_<YYYYMMDD_HHmmss>.sql .`
+
 ## Database Restore
 
-1. Ssh into the machine.
-   `ssh -i <deploy key> [email protected]`
+### Local
+
+1. SSH into the machine.
+   `ssh -i <deploy key> root@<domain>`
 2. Load the backup that was created
    `psql -d aria_at_report -f <environment>_dump_<timestamp>.sql`
 
-## Github Workflow Automation Configuration
+### API
+
+1. Ensure the backup you want to use to restore the database is present in the expected environment.
+   `scp -i <deploy key> /path/to/<environment>_dump_<timestamp>.sql root@<domain>:/folder/path/to/copy/file`
+2. Run the following to run the database restore:
+   ```bash
+   curl -X POST 'https://<deploy_url>/api/database/restore' \
+   -H 'Content-Type: application/json' \
+   -d '{ "pathToFile": "/folder/path/to/copy/file/<environment>_dump_<timestamp>.sql" }'
+   ```
+
+## GitHub Workflow Automation Configuration
 
 - The `jwt-signing-key.pem` file should be located in the project root folder.
   From within the `deploy` folder, you can run `ansible-vault view --vault-password-file ansible-vault-password.txt files/jwt-signing-key.pem.enc > ../jwt-signing-key.pem` to decrypt the configuration file.