diff --git a/docs/upgrade-guides/3-7-1-to-3-8-0.md b/docs/upgrade-guides/3-7-1-to-3-8-0.md index b690582..b7230b8 100644 --- a/docs/upgrade-guides/3-7-1-to-3-8-0.md +++ b/docs/upgrade-guides/3-7-1-to-3-8-0.md @@ -2,6 +2,27 @@ This document describes the upgrade instructions from `3.7.1` to `3.8.0`. +## Configuration changes + +### docker-compose changes +There are a few changes to our `docker-compose.yml` file for the `aerie_action` and `aerie_workspace` services. If you maintain your own docker-compose file, you'll need to make these changes: + +* Under the `aerie_action` container, in the `environment` section, add `HASURA_GRAPHQL_JWT_SECRET: "${HASURA_GRAPHQL_JWT_SECRET}"` +* Under the `aerie_action` container, in the `environment` section, you can remove the `HASURA_GRAPHQL_ADMIN_SECRET` variable as it is no longer needed +* Under the `aerie_workspace` container, add `HASURA_GRAPHQL_URL: http://hasura:8080/v1/graphql` (or your equivalent, if running on a different url/port) + +See this file in the `aerie` repo for a full example: https://github.com/NASA-AMMOS/aerie/blob/develop/deployment/docker-compose.yml + +### Hasura metadata yaml file changes + +If you maintain your own versions of Hasura metadata files for granular control of permissions (rare), you may need to update them to contain the latest values for Workspaces. [This PR is a good reference](https://github.com/NASA-AMMOS/aerie/pull/1757/files#diff-def18dd27c7d2c9dfe61a27ba55973f94e8354160d817a99c7ef0ad4c0682e7a) demonstrating the changes to the `yaml` files in `deployment/hasura/metadata` + + +# DB Migrations + +A DB migration was added in this release to support workspace permissions.. If you are upgrading from a past version and want to preserve your data, follow the instructions in the +[Database Migrations Guide](../deployment/advanced-database-migrations.mdx) to apply migrations after upgrading. Make sure you are using the latest version of the migration script from the `Deployment.zip`. + ## Sequence Adaptation interface changes This release contains breaking changes to our Sequence Adaptation interface. Most significantly, compiled adaptations are now expected to be *CommonJS modules*, which start with external `require(...)` statements for any CodeMirror dependencies, and end with `exports.adaptation = ...`.