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

Update base URL

parent c28ddd34
No related branches found
No related tags found
No related merge requests found
.PHONY: clean docs .PHONY: clean docs
TAG ?= latest TAG ?= latest
BASE_URL ?= /
all: build-docs all: build
clean: clean:
rm -rf ./site rm -rf ./site
...@@ -14,12 +15,12 @@ deploy-dockerhub-docs: ...@@ -14,12 +15,12 @@ deploy-dockerhub-docs:
verify: verify:
sudo nginx -t sudo nginx -t
build: build: build-swagger
grep -rl __BASE_URL__ . | xargs sed -i 's|__BASE_URL__|${BASE_URL}|g'
mkdocs build mkdocs build
cd ./swagger && bash ./generate.sh
build-swagger: build-swagger:
cd ./swagger && UPDATE=1 ./generate.sh cd ./swagger && bash ./generate.sh
deploy-docs: deploy-docs:
tar czfv ./final.tar.gz ./final tar czfv ./final.tar.gz ./final
......
...@@ -49,6 +49,6 @@ in your Kubernetes Cluster). ...@@ -49,6 +49,6 @@ in your Kubernetes Cluster).
We recommend to create We recommend to create
a [Container](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction#containers) for the a [Container](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction#containers) for the
[Upload Service](/infrastructures/dbrepo/latest/system-services-upload/) to deposit files and mount the BLOB storage [Upload Service](__BASE_URL__/system-services-upload/) to deposit files and mount the BLOB storage
via CSI drivers into the *Deployment*. It greatly increases the available interfaces (see below) for file uploads and via CSI drivers into the *Deployment*. It greatly increases the available interfaces (see below) for file uploads and
provides a highly-available filesystem for the many deployments that need to use the files. provides a highly-available filesystem for the many deployments that need to use the files.
...@@ -83,9 +83,9 @@ in the cluster. In our test deployment we obtained a certificate from Let's Encr ...@@ -83,9 +83,9 @@ in the cluster. In our test deployment we obtained a certificate from Let's Encr
### Fileshare ### Fileshare
Since the Upload Service uses a shared filesystem with the [Analyst Service](/infrastructures/dbrepo/latest/system-services-analyse/), Since the Upload Service uses a shared filesystem with the [Analyst Service](__BASE_URL__/system-services-analyse/),
[Metadata Service](/infrastructures/dbrepo/latest/system-services-metadata/) and [Metadata Service](__BASE_URL__/system-services-metadata/) and
[Data Database](/infrastructures/dbrepo/latest/system-databases-data/), the dynamic provision of the *PersistentVolume* [Data Database](__BASE_URL__/system-databases-data/), the dynamic provision of the *PersistentVolume*
by the *PersistentVolumeClaim* by the *PersistentVolumeClaim*
of [`pvc.yaml`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-deployment/-/blob/master/charts/dbrepo-core/templates/upload-service/pvc.yaml) of [`pvc.yaml`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-deployment/-/blob/master/charts/dbrepo-core/templates/upload-service/pvc.yaml)
needs to happen statically. You can make use of the host's filesystem and mount it in each of those deployments. needs to happen statically. You can make use of the host's filesystem and mount it in each of those deployments.
......
...@@ -14,8 +14,8 @@ collection. Challenges revolve around organizing, searching and retrieving conte ...@@ -14,8 +14,8 @@ collection. Challenges revolve around organizing, searching and retrieving conte
constitute a major technical burden as their internal representation greatly differs from static documents most digital constitute a major technical burden as their internal representation greatly differs from static documents most digital
repositories are designed for. repositories are designed for.
[Get Started](/infrastructures/dbrepo/latest/deployment-docker-compose/){ .action-button .md-button .md-button--primary } [Get Started](__BASE_URL__/deployment-docker-compose/){ .action-button .md-button .md-button--primary }
[Learn More](/infrastructures/dbrepo/latest/system){ .action-button .md-button .md-button--secondary } [Learn More](__BASE_URL__/system){ .action-button .md-button .md-button--secondary }
## Application Areas ## Application Areas
......
...@@ -8,7 +8,7 @@ author: Martin Weise ...@@ -8,7 +8,7 @@ author: Martin Weise
* Ports: 5000/tcp * Ports: 5000/tcp
* Prometheus: `http://:5000/metrics` * Prometheus: `http://:5000/metrics`
* Swagger UI: `http://:5000/swagger-ui/index.html` <a href="/infrastructures/dbrepo/latest/swagger/analyse" target="_blank">:fontawesome-solid-square-up-right: view online</a> * Swagger UI: `http://:5000/swagger-ui/index.html` <a href="__BASE_URL__/swagger/analyse" target="_blank">:fontawesome-solid-square-up-right: view online</a>
It suggests data types for the FAIR Portal when creating a table from a *comma separated values* (CSV) file. It It suggests data types for the FAIR Portal when creating a table from a *comma separated values* (CSV) file. It
recommends enumerations for columns and returns e.g. a list of potential primary key candidates. The researcher is able recommends enumerations for columns and returns e.g. a list of potential primary key candidates. The researcher is able
......
...@@ -30,7 +30,7 @@ The Broker Service allows two ways of authentication: ...@@ -30,7 +30,7 @@ The Broker Service allows two ways of authentication:
2. OAuth2 2. OAuth2
For detailed examples how to authenticate with the Broker Service see For detailed examples how to authenticate with the Broker Service see
the [usage](/infrastructures/dbrepo/latest/usage-broker) page. the [usage](__BASE_URL__/usage-broker) page.
## Limitations ## Limitations
......
...@@ -12,7 +12,7 @@ author: Martin Weise ...@@ -12,7 +12,7 @@ author: Martin Weise
* Info: `http://:9093/actuator/info` * Info: `http://:9093/actuator/info`
* Health: `http://:9093/actuator/health` * Health: `http://:9093/actuator/health`
* Prometheus: `http://:9093/actuator/prometheus` * Prometheus: `http://:9093/actuator/prometheus`
* Swagger UI: `http://:9093/swagger-ui/index.html` <a href="/infrastructures/dbrepo/latest/swagger/data" target="_blank">:fontawesome-solid-square-up-right: view online</a> * Swagger UI: `http://:9093/swagger-ui/index.html` <a href="__BASE_URL__/swagger/data" target="_blank">:fontawesome-solid-square-up-right: view online</a>
## Overview ## Overview
......
...@@ -11,8 +11,10 @@ author: Martin Weise ...@@ -11,8 +11,10 @@ author: Martin Weise
* Ports: 9099/tcp * Ports: 9099/tcp
* Info: `http://:9099/actuator/info` * Info: `http://:9099/actuator/info`
* Health: `http://:9099/actuator/health` * Health: `http://:9099/actuator/health`
* Readiness: `http://:9099/actuator/health/readiness`
* Liveness: `http://:9099/actuator/health/liveness`
* Prometheus: `http://:9099/actuator/prometheus` * Prometheus: `http://:9099/actuator/prometheus`
* Swagger UI: `http://:9099/swagger-ui/index.html` <a href="/infrastructures/dbrepo/latest/swagger/metadata" target="_blank">:fontawesome-solid-square-up-right: view online</a> * Swagger UI: `http://:9099/swagger-ui/index.html` <a href="__BASE_URL__/swagger/metadata" target="_blank">:fontawesome-solid-square-up-right: view online</a>
## Overview ## Overview
......
...@@ -12,7 +12,7 @@ author: Martin Weise ...@@ -12,7 +12,7 @@ author: Martin Weise
* Info: `http://:9050/actuator/info` * Info: `http://:9050/actuator/info`
* Health: `http://:9050/actuator/health` * Health: `http://:9050/actuator/health`
* Prometheus: `http://:9050/actuator/prometheus` * Prometheus: `http://:9050/actuator/prometheus`
* Swagger UI: `http://:9050/swagger-ui/index.html` <a href="/infrastructures/dbrepo/latest/swagger/mirror" target="_blank">:fontawesome-solid-square-up-right: view online</a> * Swagger UI: `http://:9050/swagger-ui/index.html` <a href="__BASE_URL__/swagger/mirror" target="_blank">:fontawesome-solid-square-up-right: view online</a>
## Overview ## Overview
......
...@@ -9,8 +9,9 @@ author: Martin Weise ...@@ -9,8 +9,9 @@ author: Martin Weise
!!! debug "Debug Information" !!! debug "Debug Information"
* Ports: 1080/tcp * Ports: 1080/tcp
* TUSd: `http://:1080/api/upload/files` * TUS: `http://:1080/api/upload/files`
* Prometheus: `http://:1080/metrics` * Prometheus: `http://:1080/metrics`
* Swagger UI: <a href="__BASE_URL__/swagger/upload" target="_blank">:fontawesome-solid-square-up-right: view online</a>
## Overview ## Overview
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment