Skip to content

Commit

Permalink
updates to 2.8.0 upgrade guide
Browse files Browse the repository at this point in the history
  • Loading branch information
dandelany committed Apr 18, 2024
1 parent c749ed0 commit 70c12c6
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/upgrade-guides/2-7-1-to-2-8-0.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,23 @@ Aerie v2.8.0 contains significant changes to our PostgreSQL database structure,
(ie. those running Aerie from the released `Deployment.zip` or the `deployment` folder in the repository)

### Changes to docker-compose configuration
Several changes have been made to the variables used in our `docker-compose.yml` config file. If you are using the supplied config as-is, you don't need to do anything - but if you are using **modified version of this file** for your own deployment, you'll need to make some updates. You can either:
Several changes have been made to the variables used in our `docker-compose.yml` config file. If you are using the supplied config as-is, you don't need to do anything - but if you are using a **modified version of this file** for your own deployment, you'll need to make some updates. You can either:

* Take a fresh copy of our `docker-compose.yml` file and recreate any modifications you made
* Or see the full detailed list of changes to the config variables at the bottom of this document, and manually apply these changes to your own version of the file.

### Changes to .env file
Several new environment variables are now required. Compare the new version of the `.env` file in the deployment directory to your existing `.env` file and copy over any new variables which are missing in your `.env`.
- existing values, especially AERIE_USERNAME, AERIE_PASSWORD, POSTGRES_USER and POSTGRES_PASSWORD, **must** remain unchanged from your previous version if you plan to migrate your data
- You must fill in (arbitrary) values for the password variables, which are left blank in the released `.env` file

## For Aerie Developers
(ie. anyone running Aerie from a cloned version of the `aerie` repository)

* Run `./gradlew clean` **before** checking out `develop` or `v2.8.0` in order to clean up old SQL files.
- Or if you have already checked it out, run `rm -rf deployment/postgres-init-db/sql && git restore deployment/postgres-init-db/sql`
* Several new environment variables are now required. Compare the new version of `env.template` to your existing `.env` file and copy over any new variables which are missing in your `.env`.
- existing values, especially AERIE_USERNAME, AERIE_PASSWORD, POSTGRES_USER and POSTGRES_PASSWORD, must remain unchanged from your previous version
- You must fill in (arbitrary) values for the password variables, which are left blank in the template
* If you plan migrate your data, follow migration instructions below before running Aerie v2.8.0 for the first time
* Several new environment variables are now required. Compare the new version of `env.template` in the repository root to your existing `.env` file and copy over any new variables which are missing in your `.env`. Keep any of your existing values, and fill in (arbitrary) values for the password variables which are blank in the template.
* If you plan to migrate your data, follow the migration instructions below before running Aerie v2.8.0 for the first time
* When running v2.8.0 for the first time, make sure to rebuild the backend, and build/pull all containers, ie.:
- `docker compose down --remove-orphans && ./gradlew assemble && docker compose up --pull always -d --build`

Expand All @@ -47,8 +49,6 @@ These instructions apply if you wish to save your data and **migrate it forward*
4. As a precaution, your **old** databases have been preserved at this point. If the last step failed for any reason, you can safely drop the `aerie` database, troubleshoot the problem and re-run the `merge_db.sh` script
5. After the migration has run successfully, run `drop_old_dbs.sh` to drop your old databases.

Aerie developers should also rebuild their backend following the migration (`./gradlew assemble`) - not required for end-users.

Your data should now be fully migrated and ready to run Aerie v2.8.0! Note that, due to breaking changes to the mission model framework in v2.7.0, you may need to **recompile and re-upload** your mission models if you are upgrading from a version **before v2.7.0**.


Expand Down

0 comments on commit 70c12c6

Please sign in to comment.