Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Add a step to make sure changelog is properly generated #1088

Merged
merged 2 commits into from
May 7, 2024
Merged

docs: Add a step to make sure changelog is properly generated #1088

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6583b1
docs: Add a step to make sure changelog is properly generated
alflennik May 6, 2024
c51bd9c
Update deploy/README.md
howard-e May 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions deploy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,9 @@ can view logging from ansible with `sudo -i cat /var/log/messages`.

## Deployment

To deploy this project to server:
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.
Expand All @@ -63,11 +64,11 @@ To deploy this project to server:
- 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`.
2. 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.
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.
3. Obtain a copy of the `ansible-vault-password.txt` file in LastPass and place it in the directory which contains this document.
4. Install [Ansible](https://www.ansible.com/) version 2.11. Instructions for macOS are as follows:
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.11. Instructions for macOS are as follows:
- Install Ansible at the specific 2.11 version: `python3 -m pip install --user ansible-core==2.11.1`
- Add the following line to your `~/.zshrc` file, changing the path below to match where Python installs Ansible for you:
```
Expand All @@ -76,7 +77,7 @@ To deploy this project to server:
- 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.11.
5. Execute the following command from the deploy directory:
1. Execute the following command from the deploy directory:
- Sandbox:
```
ansible-playbook provision.yml --inventory inventory/sandbox.yml
Expand Down
Loading