Add repository docker compose profile (#604)

* simplify quickstart commands for docker compose

Signed-off-by: Paul S. Schweigert <paul@paulschweigert.com>

* update docs

Signed-off-by: Paul S. Schweigert <paul@paulschweigert.com>

* - hyphens

Signed-off-by: Paul S. Schweigert <paul@paulschweigert.com>

* repo profile on non-dev too

Signed-off-by: Paul S. Schweigert <paul@paulschweigert.com>

* drop one more hyphen

Signed-off-by: Paul S. Schweigert <paul@paulschweigert.com>

* linter

Signed-off-by: Paul S. Schweigert <paul@paulschweigert.com>

* keep jupyter profile

Signed-off-by: Paul S. Schweigert <paul@paulschweigert.com>

---------

Signed-off-by: Paul S. Schweigert <paul@paulschweigert.com>
This commit is contained in:
Paul Schweigert 2023-06-07 16:51:11 -04:00 committed by GitHub
parent 8d93196369
commit 325f62583f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 15 additions and 14 deletions

View File

@ -35,8 +35,8 @@ You don't have to worry about configuration or scaling up computational resource
1. Prepare local infrastructure
```shell
docker-compose pull
docker-compose --profile full up
docker compose pull
docker compose --profile jupyter up
```
2. Open jupyter notebook in browser at [http://localhost:8888/](http://localhost:8888/). Password for notebook is `123`

View File

@ -126,7 +126,7 @@ services:
build:
context: ./
dockerfile: infrastructure/docker/Dockerfile-repository-server
profiles: [ "full" ]
profiles: [ "full", "repo" ]
command: gunicorn main.wsgi:application --bind 0.0.0.0:8060 --workers=4
ports:
- 8060:8060
@ -146,7 +146,7 @@ services:
- safe-tier
repository-postgres:
image: postgres
profiles: [ "full" ]
profiles: [ "full", "repo" ]
environment:
POSTGRES_DB: repository_db
POSTGRES_USER: repository_user

View File

@ -116,7 +116,7 @@ services:
repository-server:
container_name: repository-server
image: icr.io/quantum-public/quantum-repository-server:${VERSION:-0.1.2}
profiles: [ "full" ]
profiles: [ "full", "repo" ]
command: gunicorn main.wsgi:application --bind 0.0.0.0:8060 --workers=4
ports:
- 8060:8060
@ -136,7 +136,7 @@ services:
- safe-tier
repository-postgres:
image: postgres
profiles: [ "full" ]
profiles: [ "full", "repo" ]
environment:
POSTGRES_DB: repository_db
POSTGRES_USER: repository_user

View File

@ -2,19 +2,20 @@
Local infrastructure setup
==========================
To set up Quantum Serverless on your local machine, you will need to use `docker-compose`_.
To set up Quantum Serverless on your local machine, you will need to use `docker compose`_.
.. _docker-compose: https://docs.docker.com/compose/
.. _docker compose: https://docs.docker.com/compose/
Once you have Docker and docker-compose installed, you can run the following command to set up the infrastructure:
.. code-block::
$ VERSION=<VERSION> docker-compose [--profile <PROFILE>] up
$ VERSION=<VERSION> docker compose [--profile <PROFILE>] up
The available profiles are `full` and `jupyter`.
The jupyter profile installs core services and Jupyter Notebook,
while the full profile installs all core services,
The available profiles are `full`, `jupyter`, and `repo`.
The repo profile installs core services and the program repository,
the jupyter profile installs core services and Jupyter Notebook,
and the full profile installs all core services,
Jupyter Notebook, and logging and monitoring systems.
Available version can be found in `GitHub releases`_ page.
@ -26,4 +27,4 @@ the command would be:
.. code-block::
$ VERSION=0.1.2 docker-compose --profile full up
$ VERSION=0.1.2 docker compose --profile full up

View File

@ -23,7 +23,7 @@ Step 2: Run infrastructure.
:caption: Run docker compose from the root of the quantum serverless project.
cd quantum-serverless/
docker compose --profile full up
docker compose --profile jupyter up
Step 3: Open the jupyter lab environment by going to ``localhost:8888`` via your favorite browser.