Skip to content

prep release and DATAUP-706-doc-startup #101

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
1 commit merged into from
Mar 3, 2022
Merged

prep release and DATAUP-706-doc-startup #101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0



##[0.0.18] - 2022-03-02
### Added
- taxonomy_search_species_strain and taxonomy_search_species_strain_no_sort stored queries

## [0.0.17] - 2022-01-25
### Added
- Ensure local specs match server specs
Expand Down
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ These specifications are used by the [Relation Engine API](relation_engine_serve

The relation engine server (`relation_engine_server/`) is a simple API that allows KBase community developers to interact with the Relation Engine graph database. You can run stored queries or do bulk updates on documents.

## Relation Engine Startup
* Docker image is built with environment variable `SPEC_RELEASE_PATH=/opt/spec.tar.gz'. This contains the specs from the repo itself.
* Wait for response from auth, workspace, and arangodb services, as they are set up
* Specs are set up. Either the repo specs or remote specs are loaded into the specs root path
* Collections, views, and analyzers from the specs are added to the ArangoDB server. If the collection, view, or analyzer already exists, but in a different configuration, it will _not_ be overwritten.
* Collections, views, and analyzers from the loaded specs are compared to those on the ArangoDB server. If the loaded specs' attributes are not recursively a subset of the server specs, then an exception is raise. (This is just preliminary validation behavior.)
Copy link
Copy Markdown
Collaborator

@ialarmedalien ialarmedalien Mar 2, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

an exception is raised

I'd incorporate the last sentence into the previous two, so you have something like:

Basic validation of the collections, views, and analyzers is performed by comparing the loaded specs to those on the ArangoDB server. If the loaded specs' attributes are not recursively a subset of the server specs, an exception is raised and ... (server start up fails? what happens if there's an exception?)

Copy link
Copy Markdown
Author

@ghost ghost Mar 3, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok ... that sounds good ... but I'm gonna call perfect is the opposite of good



## Relation Engine builds

The Relation Engine is available on github packages. These images are built by the configs in the .github repo.
Expand Down
2 changes: 1 addition & 1 deletion VERSION
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.0.17
0.0.18