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

Run workflow on multiple OSs #149

Merged
merged 2 commits into from
May 22, 2024
Merged
Show file tree
Hide file tree
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
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,10 +129,15 @@ To add a new service (see the [backend v4](./services/backendv4/) for an extensi
3. create the `docker-compose.yaml` file with the required dependencies (if any)
4. eventually, include any service in (3) which is specific to the service and not shared across the global setup
5. eventually, add the condition on the backend version (e.g. [here](./services/frontend/docker-compose.yaml#L14))
6. eventually, create a `config` folder if it requires configuration
7. eventually, add a `README.md` file in the service
8. include the reference to (3) to the global [docker compose include list](docker-compose.yaml#L2)
9. eventually, update the main [README.md](README.md)
6. eventually, add the platform field, as described [here](#supported-os-architectures)
7. eventually, create a `config` folder if it requires configuration
8. eventually, add a `README.md` file in the service
9. include the reference to (3) to the global [docker-compose include list](docker-compose.yaml#L2)
10. eventually, update the main [README.md](README.md)

## Supported OS architectures

Since some images are not built with multi-arch, in particular the SciCat ones, make sure to specify the platform of the service in the docker-compose, when needed, to avoid possible issues when running `docker compose up` on different platforms, for example on MAC with arm64 architecture. See for example the [backendv4 docker-compose](./services/backendv4/docker-compose.yaml#L6)

## General use of SciCat

Expand Down
1 change: 1 addition & 0 deletions services/archivemock/docker-compose.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
services:
archivemock:
platform: linux/amd64
image: ghcr.io/scicatproject/archive-mock:v1.0.0
depends_on:
rabbitmq:
Expand Down
1 change: 1 addition & 0 deletions services/backendv3/docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ include:

services:
backend:
platform: linux/amd64
image: ghcr.io/scicatproject/backend:latest
depends_on:
mongodb:
Expand Down
1 change: 1 addition & 0 deletions services/backendv4/docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ include:

services:
backend:
platform: linux/amd64
image: ghcr.io/scicatproject/backend-next:v4.5.0
depends_on:
mongodb:
Expand Down
1 change: 1 addition & 0 deletions services/frontend/docker-compose.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
services:
frontend:
platform: linux/amd64
image: ghcr.io/scicatproject/frontend:v4.4.1
depends_on:
backend:
Expand Down
1 change: 1 addition & 0 deletions services/jupyter/docker-compose.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
services:
jupyter:
platform: linux/amd64
image: quay.io/jupyter/base-notebook:x86_64-notebook-7.1.2
depends_on:
backend:
Expand Down
1 change: 1 addition & 0 deletions services/searchapi/docker-compose.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
services:
searchapi:
platform: linux/amd64
image: ghcr.io/scicatproject/panosc-search-api:latest
depends_on:
- backend
Expand Down