Skip to content
Snippets Groups Projects
Commit ad1370db authored by Martin Weise's avatar Martin Weise
Browse files

Merge branch 'master' into 'release-v1.4'

Better error message handling in the frontend

See merge request !228
parents ef11f9c4 e93fd7ab
Branches
Tags
1 merge request!228Better error message handling in the frontend
...@@ -61,7 +61,7 @@ since RabbitMQ maintains state inside the container. ...@@ -61,7 +61,7 @@ since RabbitMQ maintains state inside the container.
We maintain a rapid prototype deployment option through Docker Compose (v2.17.0 and newer). This deployment creates the We maintain a rapid prototype deployment option through Docker Compose (v2.17.0 and newer). This deployment creates the
core infrastructure and a single Docker container for all user-generated databases. core infrastructure and a single Docker container for all user-generated databases.
=== ":simple-linux: Linux" === "Linux"
Download and install [Docker Engine](https://docs.docker.com/desktop/install/linux-install/) for your Linux Download and install [Docker Engine](https://docs.docker.com/desktop/install/linux-install/) for your Linux
distribution. Although the installation might work, we *do not* recommend Docker Desktop. distribution. Although the installation might work, we *do not* recommend Docker Desktop.
...@@ -74,7 +74,7 @@ core infrastructure and a single Docker container for all user-generated databas ...@@ -74,7 +74,7 @@ core infrastructure and a single Docker container for all user-generated databas
curl -sSL https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/dev/install.sh | bash curl -sSL https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/dev/install.sh | bash
=== ":simple-windows: Windows" === "Windows"
Open `cmd.exe` as administrator and install WSL2 and the Debian subsystem: Open `cmd.exe` as administrator and install WSL2 and the Debian subsystem:
...@@ -126,6 +126,14 @@ In case the deployment is unsuccessful, we have explanations on their origin and ...@@ -126,6 +126,14 @@ In case the deployment is unsuccessful, we have explanations on their origin and
: *Solution*: Update your local Docker image cache by executing `docker compose pull`, it automatically downloads : *Solution*: Update your local Docker image cache by executing `docker compose pull`, it automatically downloads
all Docker images that have updates. Then apply the new images with `docker compose up -d`. all Docker images that have updates. Then apply the new images with `docker compose up -d`.
**Error response from daemon: Error starting userland proxy: listen tcp4 0.0.0.0:xyz: bind: address already in use**
: *Origin*: Your deployment machine (e.g. laptop, virtual machine) has the port `xyz` already assigned. Some service
or application is already listening to this port.
: *Solution*: This service or application needs to be stopped. You can find out the service or application via
`sudo netstat -tulpn` (sudo is necessary for the process id) and then stop the service or application
gracefully or force a stop via `kill -15 PID` (not recommended).
## Security ## Security
!!! warning "Known security issues with the default configuration" !!! warning "Known security issues with the default configuration"
......
...@@ -4,19 +4,21 @@ author: Martin Weise ...@@ -4,19 +4,21 @@ author: Martin Weise
## TL;DR ## TL;DR
To install DBRepo in your existing cluster, download the sample [`values.yaml`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-deployment/-/raw/dev/charts/dbrepo-core/values.yaml?inline=false) To install DBRepo in your existing cluster, download the sample [`values.yaml`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-deployment/-/raw/master/charts/dbrepo-core/values.yaml?inline=false)
for your deployment and update the variables, especially `hostname`. for your deployment and update the variables, especially `hostname`.
```shell ```shell
helm upgrade --install dbrepo \ helm upgrade --install dbrepo \
-n dbrepo \ -n dbrepo \
"oci://dbrepo.azurecr.io/helm/dbrepo-core" \ "oci://s210.dl.hpc.tuwien.ac.at/dbrepo/helm/dbrepo-core" \
--values ./values.yaml \ --values ./values.yaml \
--version "0.1.4" \ --version "1.4.0" \
--create-namespace \ --create-namespace \
--cleanup-on-fail --cleanup-on-fail
``` ```
This chart is also on [Artifact Hub](https://artifacthub.io/packages/helm/dbrepo/dbrepo-core).
## Dependencies ## Dependencies
Our chart depends on seven other charts which will be automatically resolved when installing our `dbrepo-core` chart: Our chart depends on seven other charts which will be automatically resolved when installing our `dbrepo-core` chart:
......
...@@ -447,7 +447,7 @@ release-latest: ...@@ -447,7 +447,7 @@ release-latest:
- echo "$CI_REGISTRY2_PASSWORD" | docker login --username "$CI_REGISTRY2_USER" --password-stdin $CI_REGISTRY2_URL - echo "$CI_REGISTRY2_PASSWORD" | docker login --username "$CI_REGISTRY2_USER" --password-stdin $CI_REGISTRY2_URL
script: script:
- "ifconfig eth0 mtu 1450 up" - "ifconfig eth0 mtu 1450 up"
- "apk add make" - "apk add make bash"
- TAG=latest make release - TAG=latest make release
release-1.3: release-1.3:
...@@ -466,7 +466,7 @@ release-1.3: ...@@ -466,7 +466,7 @@ release-1.3:
- echo "$CI_REGISTRY2_PASSWORD" | docker login --username "$CI_REGISTRY2_USER" --password-stdin $CI_REGISTRY2_URL - echo "$CI_REGISTRY2_PASSWORD" | docker login --username "$CI_REGISTRY2_USER" --password-stdin $CI_REGISTRY2_URL
script: script:
- "ifconfig eth0 mtu 1450 up" - "ifconfig eth0 mtu 1450 up"
- "apk add make" - "apk add make bash"
- "TAG=1.3.0 make release" - "TAG=1.3.0 make release"
release-1.4: release-1.4:
...@@ -485,7 +485,7 @@ release-1.4: ...@@ -485,7 +485,7 @@ release-1.4:
- echo "$CI_REGISTRY2_PASSWORD" | docker login --username "$CI_REGISTRY2_USER" --password-stdin $CI_REGISTRY2_URL - echo "$CI_REGISTRY2_PASSWORD" | docker login --username "$CI_REGISTRY2_USER" --password-stdin $CI_REGISTRY2_URL
script: script:
- "ifconfig eth0 mtu 1450 up" - "ifconfig eth0 mtu 1450 up"
- "apk add make" - "apk add make bash"
- "TAG=${VERSION} make release" - "TAG=${VERSION} make release"
build-api-latest: build-api-latest:
......
.gitlab/logo.png

11.5 KiB

...@@ -28,9 +28,7 @@ build-analyse-service: ...@@ -28,9 +28,7 @@ build-analyse-service:
bash ./dbrepo-analyse-service/build.sh bash ./dbrepo-analyse-service/build.sh
build-docker: build-docker:
docker build --network=host -t dbrepo-metadata-service:build --target build dbrepo-metadata-service bash ./bin/build-docker.sh
docker build --network=host -t dbrepo-data-service:build --target build dbrepo-data-service
docker compose build --parallel
build-frontend: build-frontend:
yarn --cwd ./dbrepo-ui install --legacy-peer-deps yarn --cwd ./dbrepo-ui install --legacy-peer-deps
...@@ -220,7 +218,7 @@ test-clients: ...@@ -220,7 +218,7 @@ test-clients:
test: test-backend test-frontend test: test-backend test-frontend
teardown: teardown:
./.scripts/teardown.sh ./bin/teardown.sh
docs: build-docker docs: build-docker
docker compose up -d || docker compose down docker compose up -d || docker compose down
......
...@@ -2,8 +2,9 @@ ...@@ -2,8 +2,9 @@
[![coverage report](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/badges/master/coverage.svg)](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/commits/master) [![coverage report](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/badges/master/coverage.svg)](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/commits/master)
[![license](.gitlab/license.svg)](https://opensource.org/licenses/Apache-2.0) [![license](.gitlab/license.svg)](https://opensource.org/licenses/Apache-2.0)
[![release](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/badges/release.svg)](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/tags) [![release](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/badges/release.svg)](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/tags)
[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/dbrepo)](https://artifacthub.io/packages/helm/dbrepo/dbrepo-core)
<img src="./dbrepo-ui/static/logo.png" alt="DBREPO &mdash; Repository for Data in Databases" width="200" /> ![DBRepo &mdash; Repository for Data in Databases](./.gitlab/logo.png)
## tl;dr ## tl;dr
...@@ -19,11 +20,53 @@ curl -sSL https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-service ...@@ -19,11 +20,53 @@ curl -sSL https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-service
Find a system description, component documentation and endpoint documentation Find a system description, component documentation and endpoint documentation
online: https://www.ifs.tuwien.ac.at/infrastructures/dbrepo/. online: https://www.ifs.tuwien.ac.at/infrastructures/dbrepo/.
## Contribute ## Development
Contributions are always welcome and encouraged, please read the [contribution overview](./CONTRIBUTING.md) and Contributions are always welcome and encouraged, please read the [contribution overview](./CONTRIBUTING.md) and
contact [Prof. Andreas Rauber](http://www.ifs.tuwien.ac.at/~andi/) or [Martin Weise](https://ec.tuwien.ac.at/~weise/). contact [Prof. Andreas Rauber](http://www.ifs.tuwien.ac.at/~andi/) or [Martin Weise](https://ec.tuwien.ac.at/~weise/).
### Build
Install the build dependencies under Debian
12 ([Instructions for Docker Engine](https://docs.docker.com/engine/install/debian/#install-using-the-repository)):
```console
$ apt install -y bash maven openjdk-17-jdk nodejs && npm install --global yarn
$ node --version
v18.19.0
```
Build the Docker containers:
```console
./bin/build-docker.sh
```
### Test
Install the [build dependencies](#build) as they also cover the test dependencies.
Test the backend and frontend:
```console
./bin/test.sh
```
## Run
After [building the docker containers](#build) you can run them using the default `docker-compose.yml` in the root of
the sourcecode directory. This starts all services in the background (as daemons hence the `-d` flag).
```console
$ docker compose up -d
```
Optionally view all logs in real-time:
```console
$ docker compose logs -f
```
## Acknowledgements ## Acknowledgements
We want to thank the following organizations: We want to thank the following organizations:
......
#!/bin/bash
docker build --network=host -t dbrepo-metadata-service:build --target build dbrepo-metadata-service
docker build --network=host -t dbrepo-data-service:build --target build dbrepo-data-service
docker compose build --parallel
\ No newline at end of file
File moved
#!/bin/bash
mvn -f ./dbrepo-metadata-service/pom.xml clean install -DskipTests
# test java services
mvn -f ./dbrepo-metadata-service/pom.xml clean test verify
mvn -f ./dbrepo-data-service/pom.xml clean test verify
# test python services
bash ./dbrepo-analyse-service/test.sh
bash ./dbrepo-search-service/test.sh
# test ui
yarn --cwd ./dbrepo-ui install
yarn --cwd ./dbrepo-ui run test:unit
yarn --cwd ./dbrepo-ui run coverage
\ No newline at end of file
...@@ -7,8 +7,8 @@ docs_dir: .docs ...@@ -7,8 +7,8 @@ docs_dir: .docs
nav: nav:
- Home: index.md - Home: index.md
- Deployment: - Deployment:
- Kubernetes: deployment-helm.md
- Docker Compose: deployment-docker-compose.md - Docker Compose: deployment-docker-compose.md
- Kubernetes: deployment-helm.md
- System: - System:
- Overview: system.md - Overview: system.md
- Services: - Services:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment