From 1055f9fb335cf4457bbd243aaf7fdd050b29809d Mon Sep 17 00:00:00 2001
From: Martin Weise <martin.weise@tuwien.ac.at>
Date: Thu, 25 Jan 2024 10:33:31 +0100
Subject: [PATCH] Updated the pipeline placeholders and release the chart
---
.docs/.swagger/api-analyse.yaml | 2 +-
.docs/.swagger/api-data.yaml | 2 +-
.docs/.swagger/api-metadata.yaml | 2 +-
.docs/.swagger/api-search.yaml | 2 +-
.docs/.swagger/api-sidecar.yaml | 2 +-
.docs/.swagger/api-upload.yaml | 2 +-
.docs/deployment-helm.md | 22 +++-----
.docs/overrides/main.html | 2 +-
.docs/redirect.html | 6 +--
.docs/system-databases-data.md | 2 +-
.docs/system-databases-metadata.md | 2 +-
.docs/system-databases-search.md | 2 +-
.docs/system-other-ui.md | 6 +--
.docs/system-services-analyse.md | 2 +-
.docs/system-services-authentication.md | 2 +-
.docs/system-services-data.md | 2 +-
.docs/system-services-metadata.md | 2 +-
.docs/system-services-search.md | 2 +-
.gitlab-ci.yml | 16 +++---
Makefile | 3 ++
README.md | 2 +-
dbrepo-analyse-service/app.py | 2 +-
dbrepo-data-db/sidecar/app.py | 2 +-
.../java/at/tuwien/config/SwaggerConfig.java | 2 +-
.../java/at/tuwien/config/SwaggerConfig.java | 2 +-
dbrepo-search-service/app/__init__.py | 2 +-
helm-charts/README.md | 1 -
helm-charts/dbrepo/Chart.yaml | 12 ++---
helm-charts/dbrepo/README.md | 53 +++++++++++++++++++
helm-charts/dbrepo/values.yaml | 4 +-
30 files changed, 107 insertions(+), 58 deletions(-)
delete mode 100644 helm-charts/README.md
create mode 100644 helm-charts/dbrepo/README.md
diff --git a/.docs/.swagger/api-analyse.yaml b/.docs/.swagger/api-analyse.yaml
index d40208256c..7dc467e7ad 100644
--- a/.docs/.swagger/api-analyse.yaml
+++ b/.docs/.swagger/api-analyse.yaml
@@ -12,7 +12,7 @@ info:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
title: Database Repository Analyse Service API
- version: $TAG
+ version: __TAG__
openapi: 3.0.0
paths:
/api/analyse/determinedt:
diff --git a/.docs/.swagger/api-data.yaml b/.docs/.swagger/api-data.yaml
index 2dd3a10e30..1c50ab8f46 100644
--- a/.docs/.swagger/api-data.yaml
+++ b/.docs/.swagger/api-data.yaml
@@ -8,7 +8,7 @@ info:
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
- version: $TAG
+ version: __TAG__
externalDocs:
description: Sourcecode Documentation
url: https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services
diff --git a/.docs/.swagger/api-metadata.yaml b/.docs/.swagger/api-metadata.yaml
index ee2919a16e..272bf7ae58 100644
--- a/.docs/.swagger/api-metadata.yaml
+++ b/.docs/.swagger/api-metadata.yaml
@@ -8,7 +8,7 @@ info:
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
- version: $TAG
+ version: __TAG__
externalDocs:
description: Sourcecode Documentation
url: https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services
diff --git a/.docs/.swagger/api-search.yaml b/.docs/.swagger/api-search.yaml
index 6c6822d5fd..76522bb1b0 100644
--- a/.docs/.swagger/api-search.yaml
+++ b/.docs/.swagger/api-search.yaml
@@ -12,7 +12,7 @@ info:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
title: Database Repository Search Service API
- version: $TAG
+ version: __TAG__
openapi: 3.0.0
paths:
/api/search:
diff --git a/.docs/.swagger/api-sidecar.yaml b/.docs/.swagger/api-sidecar.yaml
index 16840f5350..8b62af9d7c 100644
--- a/.docs/.swagger/api-sidecar.yaml
+++ b/.docs/.swagger/api-sidecar.yaml
@@ -21,7 +21,7 @@ info:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
title: Database Repository Data Database sidecar API
- version: $TAG
+ version: __TAG__
openapi: 3.0.0
paths:
/health:
diff --git a/.docs/.swagger/api-upload.yaml b/.docs/.swagger/api-upload.yaml
index 138a9bb51e..3145628872 100644
--- a/.docs/.swagger/api-upload.yaml
+++ b/.docs/.swagger/api-upload.yaml
@@ -8,7 +8,7 @@ info:
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
- version: $TAG
+ version: __TAG__
externalDocs:
description: Sourcecode Documentation
url: https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services
diff --git a/.docs/deployment-helm.md b/.docs/deployment-helm.md
index d87f53e453..70372724aa 100644
--- a/.docs/deployment-helm.md
+++ b/.docs/deployment-helm.md
@@ -10,27 +10,21 @@ for your deployment and update the variables, especially `hostname`.
```shell
helm upgrade --install dbrepo \
-n dbrepo \
- "oci://s210.dl.hpc.tuwien.ac.at/dbrepo/helm/dbrepo-core" \
+ "oci://s210.dl.hpc.tuwien.ac.at/dbrepo/helm/dbrepo" \
--values ./values.yaml \
- --version "1.4.0" \
+ --version "__CHARTVERSION__" \
--create-namespace \
--cleanup-on-fail
```
-This chart is also on [Artifact Hub](https://artifacthub.io/packages/helm/dbrepo/dbrepo-core).
+This chart is also on [Artifact Hub](https://artifacthub.io/packages/helm/dbrepo/dbrepo) with a full documentation
+about values, etc.
-## Dependencies
+## Prerequisites
-Our chart depends on seven other charts which will be automatically resolved when installing our `dbrepo-core` chart:
-
-* Keycloak (Bitnami, v17.3.3) for [Authentication Service](../system-services-authentication)
-* MariaDB Galera (Bitnami, v11.0.1) for [Data Database](../system-databases-data) & [Metadata Database](../system-databases-metadata)
-* SeaweedFS (SeaweedFS, v3.59.4) for [Storage Service](../system-services-storage)
-* OpenSearch (OpenSearch Project, v2.16.0) for [Search Database](../system-databases-search)
-* OpenSearch Dashboards (OpenSearch Project, v2.14.0) for [Search Dashboard](../system-other-search-dashboard)
-* PostgreSQL HA (Bitnami, v12.1.7) for [Auth Database](../system-databases-auth)
-* RabbitMQ (Bitnami, v12.5.1) for [Broker Service](../system-services-broker)
-* FluentBit (FluentBit, v0.40.0) for logging in the cluster.
+* Kubernetes 1.24+
+* Kubernetes 3.8.0+
+* PV provisioner support in the underlying infrastructure
## Limitations
diff --git a/.docs/overrides/main.html b/.docs/overrides/main.html
index 5da83ed925..bc23fb67ea 100644
--- a/.docs/overrides/main.html
+++ b/.docs/overrides/main.html
@@ -14,7 +14,7 @@
if (segments.length >= 4) {
return segments[3]
} else {
- return '$VERSION'
+ return '__APPVERSION__'
}
}
function switchVersion(value) {
diff --git a/.docs/redirect.html b/.docs/redirect.html
index de670e15b3..053a5581bf 100644
--- a/.docs/redirect.html
+++ b/.docs/redirect.html
@@ -5,16 +5,16 @@
<head>
<meta charset="UTF-8">
<title>Redirect Notice</title>
- <meta http-equiv="Refresh" content="0; url='https://www.ifs.tuwien.ac.at/infrastructures/dbrepo/$VERSION/'" />
+ <meta http-equiv="Refresh" content="0; url='https://www.ifs.tuwien.ac.at/infrastructures/dbrepo/__APPVERSION__/'" />
</head>
<body>
<h1>Redirect Notice</h1>
<p>
- This page should automatically open the documentation for version <code>$VERSION</code>. In case this page does not load the site is
+ This page should automatically open the documentation for version <code>__APPVERSION__</code>. In case this page does not load the site is
available at:
</p>
<p>
- <a href="https://www.ifs.tuwien.ac.at/infrastructures/dbrepo/$VERSION/">https://www.ifs.tuwien.ac.at/infrastructures/dbrepo/$VERSION/</a>
+ <a href="https://www.ifs.tuwien.ac.at/infrastructures/dbrepo/__APPVERSION__/">https://www.ifs.tuwien.ac.at/infrastructures/dbrepo/__APPVERSION__/</a>
</p>
</body>
</html>
\ No newline at end of file
diff --git a/.docs/system-databases-data.md b/.docs/system-databases-data.md
index 7e02599f94..b5096f6078 100644
--- a/.docs/system-databases-data.md
+++ b/.docs/system-databases-data.md
@@ -15,7 +15,7 @@ author: Martin Weise
!!! debug "Debug Information"
- Image: [`dbrepo/data-db-sidecar:$TAG`](https://hub.docker.com/r/dbrepo/data-db-sidecar)
+ Image: [`dbrepo/data-db-sidecar:__TAG__`](https://hub.docker.com/r/dbrepo/data-db-sidecar)
* Ports: 3305/tcp
* Swagger UI: `http://<hostname>:1080/swagger-ui/` <a href="../swagger/sidecar" target="_blank">:fontawesome-solid-square-up-right: view online</a>
diff --git a/.docs/system-databases-metadata.md b/.docs/system-databases-metadata.md
index 326ed3874e..e86ed67e71 100644
--- a/.docs/system-databases-metadata.md
+++ b/.docs/system-databases-metadata.md
@@ -8,7 +8,7 @@ author: Martin Weise
!!! debug "Debug Information"
- Image: [`dbrepo/metadata-db:$TAG`](https://hub.docker.com/r/dbrepo/metadata-db)
+ Image: [`dbrepo/metadata-db:__TAG__`](https://hub.docker.com/r/dbrepo/metadata-db)
* Ports: 3306/tcp
* JDBC: `jdbc://mariadb:<hostname>:3306`
diff --git a/.docs/system-databases-search.md b/.docs/system-databases-search.md
index c01fa7c638..2761b47c0e 100644
--- a/.docs/system-databases-search.md
+++ b/.docs/system-databases-search.md
@@ -8,7 +8,7 @@ author: Martin Weise
!!! debug "Debug Information"
- Image: [`dbrepo/search-db:$TAG`](https://hub.docker.com/r/dbrepo/search-db)
+ Image: [`dbrepo/search-db:__TAG__`](https://hub.docker.com/r/dbrepo/search-db)
* Ports: 9200/tcp
diff --git a/.docs/system-other-ui.md b/.docs/system-other-ui.md
index 54194cf7f9..d693c6ffbb 100644
--- a/.docs/system-other-ui.md
+++ b/.docs/system-other-ui.md
@@ -8,7 +8,7 @@ author: Martin Weise
!!! debug "Debug Information"
- Image: [`dbrepo/ui:$TAG`](https://hub.docker.com/r/dbrepo/ui)
+ Image: [`dbrepo/ui:__TAG__`](https://hub.docker.com/r/dbrepo/ui)
* Ports: 3000/tcp, 9100/tcp
* Prometheus: `http://<hostname>:9100/metrics`
@@ -46,7 +46,7 @@ configured as well via the `dbrepo.config.json` values file. The important links
```json title="dbrepo.config.json"
{
"title": "Database Repository",
- "version": "$TAG_DOCKER-COMPOSE",
+ "version": "__TAG___DOCKER-COMPOSE",
"logo": {
"path": "/my_logo.png"
},
@@ -65,7 +65,7 @@ if you use a Kubernetes deployment via ConfigMap and Volumes).
```yaml title="docker-compose.yml"
services:
dbrepo-ui:
- image: docker.io/dbrepo/ui:$TAG
+ image: docker.io/dbrepo/ui:__TAG__
volumes:
- ./my_logo.png:/app/static/my_logo.png
- ./dbrepo.conf.json:/app/dbrepo.conf.json
diff --git a/.docs/system-services-analyse.md b/.docs/system-services-analyse.md
index 66ee40d477..49857e7dd9 100644
--- a/.docs/system-services-analyse.md
+++ b/.docs/system-services-analyse.md
@@ -8,7 +8,7 @@ author: Martin Weise
!!! debug "Debug Information"
- Image: [`dbrepo/analyse-service:$TAG`](https://hub.docker.com/r/dbrepo/analyse-service)
+ Image: [`dbrepo/analyse-service:__TAG__`](https://hub.docker.com/r/dbrepo/analyse-service)
* Ports: 5000/tcp
* Prometheus: `http://<hostname>:5000/metrics`
diff --git a/.docs/system-services-authentication.md b/.docs/system-services-authentication.md
index 41cea49974..20e451ff0c 100644
--- a/.docs/system-services-authentication.md
+++ b/.docs/system-services-authentication.md
@@ -8,7 +8,7 @@ author: Martin Weise
!!! debug "Debug Information"
- Image: [`dbrepo/authentication-service:$TAG`](https://hub.docker.com/r/dbrepo/authentication-service)
+ Image: [`dbrepo/authentication-service:__TAG__`](https://hub.docker.com/r/dbrepo/authentication-service)
* Ports: 8080/tcp
* Health: `http://<hostname>:8080/api/auth/health`
diff --git a/.docs/system-services-data.md b/.docs/system-services-data.md
index 88e781e6e8..902f216900 100644
--- a/.docs/system-services-data.md
+++ b/.docs/system-services-data.md
@@ -8,7 +8,7 @@ author: Martin Weise
!!! debug "Debug Information"
- Image: [`dbrepo/data-service:$TAG`](https://hub.docker.com/r/dbrepo/data-service)
+ Image: [`dbrepo/data-service:__TAG__`](https://hub.docker.com/r/dbrepo/data-service)
* Ports: 9093/tcp
* Info: `http://<hostname>:9093/actuator/info`
diff --git a/.docs/system-services-metadata.md b/.docs/system-services-metadata.md
index 434a831838..b564925b70 100644
--- a/.docs/system-services-metadata.md
+++ b/.docs/system-services-metadata.md
@@ -8,7 +8,7 @@ author: Martin Weise
!!! debug "Debug Information"
- Image: [`dbrepo/metadata-service:$TAG`](https://hub.docker.com/r/dbrepo/metadata-service)
+ Image: [`dbrepo/metadata-service:__TAG__`](https://hub.docker.com/r/dbrepo/metadata-service)
* Ports: 9099/tcp
* Info: `http://<hostname>:9099/actuator/info`
diff --git a/.docs/system-services-search.md b/.docs/system-services-search.md
index 397feff381..deda610d4a 100644
--- a/.docs/system-services-search.md
+++ b/.docs/system-services-search.md
@@ -8,7 +8,7 @@ author: Martin Weise
!!! debug "Debug Information"
- Image: [`dbrepo/search-service:$TAG`](https://hub.docker.com/r/dbrepo/search-service)
+ Image: [`dbrepo/search-service:__TAG__`](https://hub.docker.com/r/dbrepo/search-service)
* Ports: 4000/tcp
* Health: `http://<hostname>:4000/api/search/health`
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 7a4515ea16..9f4768f71e 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -516,6 +516,7 @@ release-helm-latest:
- apk add sed helm
- 'sed -i -e "s/^version:.*/version: \"${CHART_VERSION}-0.git.${CI_PIPELINE_ID}.${CI_COMMIT_SHORT_SHA}\"/g" ./helm-charts/dbrepo/Chart.yaml'
- 'sed -i -e "s/^appVersion:.*/appVersion: \"${CHART_VERSION}-0.git.${CI_PIPELINE_ID}.${CI_COMMIT_SHORT_SHA}\"/g" ./helm-charts/dbrepo/Chart.yaml'
+ - find ./site -type f -exec sed -i -e "s/__CHARTVERSION__/${CHART_VERSION}/g" {} \;
- helm package ./helm-charts/dbrepo --destination ./build
- helm push "./build/dbrepo-${CHART_VERSION}-0.git.${CI_PIPELINE_ID}.${CI_COMMIT_SHORT_SHA}.tgz" "oci://${CI_REGISTRY2_URL}/helm"
@@ -531,9 +532,10 @@ release-helm-1.4:
- apk add sed helm curl
- 'sed -i -e "s/^version:.*/version: \"${CHART_VERSION}\"/g" ./helm-charts/dbrepo/Chart.yaml'
- 'sed -i -e "s/^appVersion:.*/appVersion: \"${APP_VERSION}\"/g" ./helm-charts/dbrepo/Chart.yaml'
+ - find ./site -type f -exec sed -i -e "s/__CHARTVERSION__/${CHART_VERSION}/g" {} \;
- helm package ./helm-charts/dbrepo --destination ./build
- helm push "./build/dbrepo-${CHART_VERSION}.tgz" "oci://${CI_REGISTRY2_URL}/helm"
- - curl -sSL -X POST --form 'chart=@dbrepo-${CHART_VERSION}.tgz' --user mweise:${GITLAB_ACCESS_TOKEN} https://gitlab.example.com/api/v4/projects/450/packages/helm/api/stable/charts
+ - curl -sSL -X POST --form 'chart=@build/dbrepo-${CHART_VERSION}.tgz' --user mweise:${GITLAB_ACCESS_TOKEN} https://gitlab.example.com/api/v4/projects/450/packages/helm/api/stable/charts
build-api-latest:
stage: build
@@ -547,7 +549,7 @@ build-api-latest:
- apk add bash git
- git fetch && git checkout master
- bash .docs/.swagger/swagger-site.sh
- - find ./site -type f -exec sed -i -e "s/\$TAG/latest/g" {} \;
+ - find ./site -type f -exec sed -i -e "s/__TAG__/latest/g" {} \;
- mkdir -p ./swagger/latest
- cp -r ./site/* ./swagger/latest/
cache:
@@ -594,7 +596,7 @@ build-api-1.4:
- apk add bash git maven
- git fetch && git checkout release-v1.4
- bash .docs/.swagger/swagger-site.sh
- - find ./site -type f -exec sed -i -e "s/\$TAG/${APP_VERSION}/g" {} \;
+ - find ./site -type f -exec sed -i -e "s/__TAG__/${APP_VERSION}/g" {} \;
- mkdir -p ./swagger/${APP_VERSION}
- cp -r ./site/* ./swagger/${APP_VERSION}/
cache:
@@ -643,8 +645,8 @@ docs-latest:
- git fetch && git checkout master
- pip install -r ./requirements.txt
- mkdir -p ./final/{latest,1.3}
- - find ./.docs -type f -exec sed -i -e "s/\$TAG/latest/g" {} \;
- - find ./.docs -type f -exec sed -i -e "s/\$VERSION/${APP_VERSION}/g" {} \;
+ - find ./.docs -type f -exec sed -i -e "s/__TAG__/latest/g" {} \;
+ - find ./.docs -type f -exec sed -i -e "s/__APPVERSION__/${APP_VERSION}/g" {} \;
- mkdocs build && cp -r ./site ./final/latest
- cp ./.docs/redirect.html ./final/index.html
- cp ./.docs/redirect.html ./final/1.3/index.html
@@ -704,8 +706,8 @@ docs-1.4:
- pip install -r ./.docs/requirements.txt
- wget https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/dev/.docs/overrides/main.html -O .docs/overrides/main.html -q
- mkdir -p ./final
- - find .docs -type f -exec sed -i -e "s/\$TAG/${APP_VERSION}/g" {} \;
- - find .docs -type f -exec sed -i -e "s/\$VERSION/${APP_VERSION}/g" {} \;
+ - find .docs -type f -exec sed -i -e "s/__TAG__/${APP_VERSION}/g" {} \;
+ - find .docs -type f -exec sed -i -e "s/__APPVERSION__/${APP_VERSION}/g" {} \;
- mkdocs build && cp -r ./site ./final/${APP_VERSION}
- cp -r ./swagger/${APP_VERSION} ./final/${APP_VERSION}/swagger
cache:
diff --git a/Makefile b/Makefile
index 3dc5869a3c..19f2a215f9 100644
--- a/Makefile
+++ b/Makefile
@@ -36,6 +36,9 @@ build-frontend:
build-swagger:
bash ./.docs/generate.sh
+build-helm:
+ helm package ./helm-charts/dbrepo --destination ./build
+
tag: tag-analyse-service tag-authentication-service tag-metadata-db tag-ui tag-metadata-service tag-data-service tag-search-db tag-search-db-init tag-search-service tag-data-db-sidecar
tag-analyse-service:
diff --git a/README.md b/README.md
index 92d200dc15..3fbcba67d0 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
[](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/commits/master)
[](https://opensource.org/licenses/Apache-2.0)
[](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/tags)
-[](https://artifacthub.io/packages/helm/dbrepo/dbrepo-core)
+[](https://artifacthub.io/packages/helm/dbrepo/dbrepo)
diff --git a/dbrepo-analyse-service/app.py b/dbrepo-analyse-service/app.py
index 4d4c5cda88..d2d666b14d 100644
--- a/dbrepo-analyse-service/app.py
+++ b/dbrepo-analyse-service/app.py
@@ -80,7 +80,7 @@ template = {
"info": {
"title": "Database Repository Analyse Service API",
"description": "Service that analyses data structures",
- "version": "$TAG",
+ "version": "__TAG__",
"contact": {
"name": "Prof. Andreas Rauber",
"email": "andreas.rauber@tuwien.ac.at",
diff --git a/dbrepo-data-db/sidecar/app.py b/dbrepo-data-db/sidecar/app.py
index 931f18d855..82c409dca8 100644
--- a/dbrepo-data-db/sidecar/app.py
+++ b/dbrepo-data-db/sidecar/app.py
@@ -61,7 +61,7 @@ template = {
"info": {
"title": "Database Repository Data Database sidecar API",
"description": "Sidecar that downloads the import .csv file",
- "version": "$TAG",
+ "version": "__TAG__",
"contact": {
"name": "Prof. Andreas Rauber",
"email": "andreas.rauber@tuwien.ac.at"
diff --git a/dbrepo-data-service/rest-service/src/main/java/at/tuwien/config/SwaggerConfig.java b/dbrepo-data-service/rest-service/src/main/java/at/tuwien/config/SwaggerConfig.java
index d19efa0784..0d9df429c1 100644
--- a/dbrepo-data-service/rest-service/src/main/java/at/tuwien/config/SwaggerConfig.java
+++ b/dbrepo-data-service/rest-service/src/main/java/at/tuwien/config/SwaggerConfig.java
@@ -24,7 +24,7 @@ public class SwaggerConfig {
.name("Prof. Andreas Rauber")
.email("andreas.rauber@tuwien.ac.at"))
.description("Service that manages the data")
- .version("$TAG")
+ .version("__TAG__")
.license(new License()
.name("Apache 2.0")
.url("https://www.apache.org/licenses/LICENSE-2.0")))
diff --git a/dbrepo-metadata-service/rest-service/src/main/java/at/tuwien/config/SwaggerConfig.java b/dbrepo-metadata-service/rest-service/src/main/java/at/tuwien/config/SwaggerConfig.java
index ad5f5d273e..4354c5c374 100644
--- a/dbrepo-metadata-service/rest-service/src/main/java/at/tuwien/config/SwaggerConfig.java
+++ b/dbrepo-metadata-service/rest-service/src/main/java/at/tuwien/config/SwaggerConfig.java
@@ -24,7 +24,7 @@ public class SwaggerConfig {
.name("Prof. Andreas Rauber")
.email("andreas.rauber@tuwien.ac.at"))
.description("Service that manages the metadata")
- .version("$TAG")
+ .version("__TAG__")
.license(new License()
.name("Apache 2.0")
.url("https://www.apache.org/licenses/LICENSE-2.0")))
diff --git a/dbrepo-search-service/app/__init__.py b/dbrepo-search-service/app/__init__.py
index c8cd7d4073..51e42b19a9 100644
--- a/dbrepo-search-service/app/__init__.py
+++ b/dbrepo-search-service/app/__init__.py
@@ -66,7 +66,7 @@ def create_app(config_class=Config):
"info": {
"title": "Database Repository Search Service API",
"description": "Service that searches the search database",
- "version": "$TAG",
+ "version": "__TAG__",
"contact": {
"name": "Prof. Andreas Rauber",
"email": "andreas.rauber@tuwien.ac.at"
diff --git a/helm-charts/README.md b/helm-charts/README.md
deleted file mode 100644
index 02cc2b3954..0000000000
--- a/helm-charts/README.md
+++ /dev/null
@@ -1 +0,0 @@
-# DBRepo
\ No newline at end of file
diff --git a/helm-charts/dbrepo/Chart.yaml b/helm-charts/dbrepo/Chart.yaml
index e7cb091c5a..5929578227 100644
--- a/helm-charts/dbrepo/Chart.yaml
+++ b/helm-charts/dbrepo/Chart.yaml
@@ -1,10 +1,9 @@
apiVersion: v2
name: dbrepo
-description: |
- We present a database repository system that allows researchers to ingest data into a central, versioned repository
- through common interfaces, provides efficient access to arbitrary subsets of data even when the underlying data store
- is evolving, allows reproducing of query results and supports findable-, accessible-, interoperable- and reusable
- data.
+description: Helm Chart for installing DBRepo
+category: Database
+sources:
+ - https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services
type: application
version: "1.4.1-RC1"
appVersion: "1.4.0"
@@ -14,8 +13,7 @@ maintainers:
- name: Martin Weise
email: martin.weise@tuwien.ac.at
home: https://www.ifs.tuwien.ac.at/infrastructures/dbrepo/
-icon:
- https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/dbrepo-ui/static/favicon.png
+icon: https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/.docs/images/signet_white.png
dependencies:
- name: opensearch
alias: search-db
diff --git a/helm-charts/dbrepo/README.md b/helm-charts/dbrepo/README.md
new file mode 100644
index 0000000000..e8cdbdc800
--- /dev/null
+++ b/helm-charts/dbrepo/README.md
@@ -0,0 +1,53 @@
+# DBRepo Helm chart
+
+[DBRepo](https://www.ifs.tuwien.ac.at/infrastructures/dbrepo/__CHARTVERSION__/) is a database repository system that
+allows researchers to ingest data into a central, versioned repository through common interfaces.
+
+## TL;DR
+
+Download the
+sample [`values.yaml`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/helm-charts/dbrepo/values.yaml?inline=true)
+for your deployment and update the variables, especially `hostname`.
+
+```bash
+helm install my-release "oci://s210.dl.hpc.tuwien.ac.at/dbrepo/helm/dbrepo" --values ./values.yaml --version "__CHARTVERSION__"
+```
+
+## Prerequisites
+
+* Kubernetes 1.24+
+* Kubernetes 3.8.0+
+* PV provisioner support in the underlying infrastructure
+
+## Installing the Chart
+
+To install the chart with the release name `my-release`:
+
+```bash
+helm install my-release "oci://s210.dl.hpc.tuwien.ac.at/dbrepo/helm/dbrepo" --values ./values.yaml --version "__CHARTVERSION__"
+```
+
+The command deploys DBRepo on the Kubernetes cluster in the default configuration. The Parameters section lists the
+parameters that can be configured during installation.
+
+## Uninstalling the Chart
+
+To uninstall/delete the `my-release` deployment:
+
+```bash
+helm delete my-release
+```
+
+The command removes all the Kubernetes components associated with the chart and deletes the release.
+
+## Parameters
+
+### Common parameters
+
+| Name | Description | Value |
+|-----------------|--------------------------------------|-----------------|
+| `namespace` | Namespace which DBRepo is running in | `""` |
+| `hostname` | The hostname for ingress rules | `""` |
+| `strategyType` | Deployments update strategy | `RollingUpdate` |
+| `clusterDomain` | Internal cluster domain | `cluster.local` |
+
diff --git a/helm-charts/dbrepo/values.yaml b/helm-charts/dbrepo/values.yaml
index 4fb5af517d..a477b725a9 100644
--- a/helm-charts/dbrepo/values.yaml
+++ b/helm-charts/dbrepo/values.yaml
@@ -1,6 +1,6 @@
-namespace: dbrepo
+namespace:
-hostname: example.com
+hostname:
strategyType: RollingUpdate
--
GitLab