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.

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

Improve Orion deployment docs #346

Merged
Merged
Changes from all commits
Commits
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
14 changes: 12 additions & 2 deletions docs/operator-guide/tutorials/upgrading-orion.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ On the Atlas side, you can check the list of releases [here](https://github.com/

Always make sure the versions of Orion and Atlas you're planing to upgrade to are compatible with each other.

## Typical upgrade process
## Typical upgrade process (For Breaking Changes)

1. Turn on the _kill switch_ ([maintenance mode](./maintenance-mode.md)). This will prevent the users from interactig with the Gateway during the upgrade, as this could have undesired consequences (for example, due to processor not being fully synced). To do that you should execute `setKillSwitch(isKilled: true)` operator mutation using Orion's GraphQL API (you need to be authenticated as Operator first).

Expand Down Expand Up @@ -71,4 +71,14 @@ In case something goes wrong during the upgrade, you can restore the database fr
docker exec orion_db psql -f /tmp/orion-production.bak -U postgres -p 23798 postgres
# Bring up the Orion services
docker-compose up -d
```
```


## Upgrade Process (For Non-breaking Changes)

The non breaking changes include examples such as adding nullable field to the entity or making the change to the mappings that does not require processor re-syncing. In this case, you just new to restart the services to deploy new changes:

```bash
# Restart the Orion services to apply latest code changes
docker restart orion_processor orion_graphql-server orion_auth-api
```
Loading