Skip to content

Update deployment docs #95

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

Merged
bio-boris merged 2 commits into from
Feb 4, 2022
Merged

Update deployment docs #95

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b953e51
Update README.md
bio-boris Feb 3, 2022
02eced6
Update README.md
bio-boris Feb 3, 2022
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
18 changes: 17 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,20 @@ The relation engine server (`relation_engine_server/`) is a simple API that allo

## Relation Engine builds

The Relation Engine is available on dockerhub as `kbase/relation_engine_api`. Automated builds are performed whenever there is a new push to `master` or `develop`.
The Relation Engine is available on github packages. These images are built by the configs in the .github repo.
The develop tags are located at https://github.com/kbase/relation_engine/pkgs/container/relation_engine-develop
e.g.
```
docker pull ghcr.io/kbase/relation_engine-develop:latest (Built upon merging a PR)
docker pull ghcr.io/kbase/relation_engine-develop:pr-93 (Built upon creating a PR)
```

## How to Deploy in CI
The CI service is available in the `relationapi` service
* Press Upgrade Arrow
* Ensure the relationapi service uses `ghcr.io/kbase/relation_engine-develop:latest`
* Ensure the `Always pull image before creating` box is ticked
* Press `Upgrade` button
* If the deployment suceeded, you can finish the upgrade. If not, you can press the rollback button.

(For deployments to other environments, request help from the #devops channel)