Skip to content

Commit

Permalink
docs: ✏️ schema (#1537)
Browse files Browse the repository at this point in the history
  • Loading branch information
StanGirard authored Oct 31, 2023
1 parent e3925bc commit 7845124
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 5 deletions.
28 changes: 28 additions & 0 deletions docs/docs/Developers/contribution/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,31 @@ Authorization: Bearer {api_key}
Replace `{api_key}` with the generated API key obtained from the frontend

You can find more information in the [Authentication](/docs/Developers/useQuivr/get_your_api_key) section of the documentation.


## Architectural Schema


<div style={{ textAlign: 'center' }}>
<img src="/img/architectural-high-level.png" alt="Quivr architecture" style={{ width: '60%' }} />
</div>

### Load Balancer

The role of the load balancer is to catch the incoming traffic and redirect to the corresponding server. It is also responsible for the SSL termination.

### Container Service

The role of this service is to manage the replicas of all the services. It hold the information about the number of replicas of each service and the corresponding server.

### Queue

The role of the queue it to store "tasks" that are long to run and that can be run asynchronously. In our case we use it to embed the files and to index them as it can take a lot of time.

### Celery Worker

The role of the celery worker is to run the tasks that are stored in the queue. It is a distributed task queue that can run tasks asynchronously.

### Supabase

Supabase is used to do the authentication and to store the users information. It is a great open-source alternative to Firebase. It is currently used as a database, an authentication service, a vector store and a file store.
5 changes: 0 additions & 5 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -71,11 +71,6 @@ const config = {
src: 'img/logo.png',
},
items: [
{
href: '/docs/roadmap',
label: 'Roadmap',
position: 'left',
},
{
href: 'https://quivr.app',
position: 'right',
Expand Down
Binary file added docs/static/img/architectural-high-level.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7845124

Please sign in to comment.