.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: __APPVERSION__
 openapi: 3.0.0
 paths:
   /api/analyse/determinedt:

.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: __APPVERSION__
 externalDocs:
   description: Sourcecode Documentation
   url: https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services

.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: __APPVERSION__
 externalDocs:
   description: Sourcecode Documentation
   url: https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services

.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: __APPVERSION__
 openapi: 3.0.0
 paths:
   /api/search:

.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: __APPVERSION__
 openapi: 3.0.0
 paths:
   /health:

.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: __APPVERSION__
 externalDocs:
   description: Sourcecode Documentation
   url: https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services

.docs/deployment-docker-compose.md

@@ -20,8 +20,8 @@ For this small, local, test deployment any modern hardware would suffice, we rec
 the following settings.
 
 - min. 8 vCPU cores
-- min. 16GB RAM memory
-- min. 200GB SSD storage
+- min. 8GB free RAM memory
+- min. 200GB free SSD storage
 - min. 100Mbit/s connection
 
 *Optional*: public IP-address if you want to secure the deployment with a (free) TLS-certificate from Let's Encrypt.
@@ -134,6 +134,22 @@ In case the deployment is unsuccessful, we have explanations on their origin and
                 `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).
 
+**IllegalArgumentException values less than -1 bytes are not supported**
+
+:   *Origin*:   Your deployment machine (e.g. laptop, virtual machine) appears to not have enough RAM assigned.
+:   *Solution*: Assign more RAM to the deployment machine (e.g. add vRAM to the virtual machine).
+
+## Next Steps
+
+You should now be able to view the front end at [http://localhost](http://localhost).
+
+Please be warned that the default configuration is not intended for public deployments. It is only intended to have a
+running system within minutes to play around within the system and explore features. It is strongly advised to change 
+the default `.env` environment variables.
+
+Next, create a [user account](../usage-overview/#create-user-account) and 
+then [create a database](../usage-overview/#create-database) to [import a dataset](../usage-overview/#import-dataset).
+
 ## Security
 
 !!! warning "Known security issues with the default configuration"

.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
 

.docs/overrides/main.html

@@ -14,7 +14,7 @@
         if (segments.length >= 4) {
             return segments[3]
         } else {
-            return '$VERSION'
+            return '__APPVERSION__'
         }
     }
     function switchVersion(value) {

.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

.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:__APPVERSION__`](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>

.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:__APPVERSION__`](https://hub.docker.com/r/dbrepo/metadata-db)
 
     * Ports: 3306/tcp
     * JDBC: `jdbc://mariadb:<hostname>:3306`

.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:__APPVERSION__`](https://hub.docker.com/r/dbrepo/search-db)
 
     * Ports: 9200/tcp
 

.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:__APPVERSION__`](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": "__APPVERSION___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:__APPVERSION__
     volumes:
       - ./my_logo.png:/app/static/my_logo.png
       - ./dbrepo.conf.json:/app/dbrepo.conf.json

.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:__APPVERSION__`](https://hub.docker.com/r/dbrepo/analyse-service)
 
     * Ports: 5000/tcp
     * Prometheus: `http://<hostname>:5000/metrics`

.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:__APPVERSION__`](https://hub.docker.com/r/dbrepo/authentication-service)
 
     * Ports: 8080/tcp
     * Health: `http://<hostname>:8080/api/auth/health`

.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:__APPVERSION__`](https://hub.docker.com/r/dbrepo/data-service)
 
     * Ports: 9093/tcp
     * Info: `http://<hostname>:9093/actuator/info`