⏳ Reading time: 10 minutes
Termius setup guide
This guide provides instructions on how to download, install configure and use Termius for our three environments: development (Mars), pre-release (Venus), and production.
Prerequisites
- Download Termius and create an account: Termius Download
- Ask Dima or AntonS for PEM keys.
Configuring environments
- Open Termius.
- Open Settings (⚙ icon in the top left) -> Keychain
- Add PEM keys in the Keychain (Key -> New Key -> Fill in the fields and add some labels like “mars-frontend” and “venus-frontend”)
- Add a new host and fill in these fields:
- Domain
- Username
- Select the correct PEM key. (keys for Mars and Venus are the same for all the platforms)
Students-web
| Environment | Domain | User | PEM |
|---|---|---|---|
| Mars | students.eu-north-1.mars.matteappen.se | ubuntu | mars-frontend.pem |
| Venus | students.eu-north-1.venus.matteappen.se | ubuntu | venus-frontend.pem |
| Production EU | students.eu-north-1.matteappen.se | ubuntu | |
| Production US | students.us-east-1.matteappen.se | ubuntu |
Teachers-web
| Environment | Domain | User | PEM |
|---|---|---|---|
| Mars | teachers.eu-north-1.mars.matteappen.se | ubuntu | mars-frontend.pem |
| Venus | teachers.eu-north-1.venus.matteappen.se | ubuntu | venus-frontend.pem |
| Production EU | teachers.eu-north-1.matteappen.se | ubuntu | |
| Production US | teachers.us-east-1.matteappen.se | ubuntu |
Auth-web
| Environment | Domain | User | PEM |
|---|---|---|---|
| Mars | app.eu-north-1.mars.matteappen.se | ubuntu | mars-frontend.pem |
| Venus | app.eu-north-1.venus.matteappen.se | ubuntu | venus-frontend.pem |
| Production EU | app.eu-north-1.matteappen.se | ubuntu | |
| Production US | app.us-east-1.matteappen.se | ubuntu |
District-dash
| Environment | Domain | User | PEM |
|---|---|---|---|
| Mars | district.eu-north-1.mars.matteappen.se | ubuntu | mars-frontend.pem |
| Venus | district.eu-north-1.venus.matteappen.se | ubuntu | venus-frontend.pem |
| Production EU | district.eu-north-1.magmamath.com | ubuntu | |
| Production US | district.us-east-1.magmamath.com | ubuntu |
Releasing changes
Before releasing any changes, it’s important to ensure that the build is successful. Here are the steps to follow:
-
Check for a Successful Build:
- Monitor the build status on Amplify, repository Github or
devbotschannel on Slack for build notifications.
- Monitor the build status on Amplify, repository Github or
-
Releasing to Mars or Venus:
- Once you decide to release any of those environments simply connect to already created hosts and connect to the server and run this command:
./update-app-version.sh latest - this will release changes on latest commit.
or
./update-app-version.sh c6fdb89f9d9af41c3829decd20b77a8fcb5c1369 - commit hash you want to use for releasing. It is helpful in case of fast rollbacks since you do not have to wait for a build to finish - simply use the previous commit that worked.
- Releasing to Production:
- Merge changes to the
masterbranch and wait for the build to pass. - Draft a new release and create a tag for it.
- Connect to Production hosts and run the script with the new tag version from the Github draft for example:
./update-app-version.sh v1.5.6, do it for both environments US and EU.
- Merge changes to the
Remember, releasing changes to production environments should be done cautiously and typically during designated release windows to minimize the impact on users (check Magma calendar to see release windows) and double-check with PM.
Additional notes
- 🚨⚠️❗ Ensure to not leak PEM keys and keep them very secure. It is super sensitive data that cannot be leaked. 🚨⚠️❗
- If you encounter any issues, reach out to Dima (or AntonS) on Slack.