Added deployment

docs/deployment-vm.md → docs/deployment-docker-compose.md

@@ -2,20 +2,12 @@
 author: Martin Weise
 ---
 
-# Deployment (Virtual Machine)
+# Deploy DBRepo with Docker Compose
 
 ## TL;DR
 
 ```shell
-# download auxilary files
-curl -o docker-compose.yml https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.prod.yml
-curl -o dbrepo.conf https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/dbrepo.conf
-curl -o .env https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/.env.unix.example
-# increase memory for open search
-echo "vm.max_map_count=262144" >> /etc/sysctl.conf
-sysctl -p
-# start
-docker compose up -d
+curl -sSL https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/dev/install.sh | sudo bash
 ```
 
 ## Architecture
@@ -25,11 +17,8 @@ technologies. The conceptualized microservices operate the basic database operat
 *findability*, *accessability*, *interoperability* and *reuseability* (FAIR).
 
 <figure markdown>
-![DBRepo architecture](images/architecture-vm.png)
-<figcaption>Architecture of the services on a Virtual Machine</figcaption>
+![DBRepo architecture](images/architecture-docker-compose.svg)
+<figcaption>Architecture of the services deployed via Docker Compose</figcaption>
 </figure>
 
-## Docker Images
-
-* [docker.io](https://hub.docker.com/u/dbrepo)
-* dbrepo.azurecr.io
+Alternatively, you can also deploy DBRepo with [minikube](../deployment-kubernetes-minikube/) in your virtual machine instead.

docs/deployment-kubernetes-azure.md

@@ -2,10 +2,11 @@
 author: Martin Weise
 ---
 
-# Kubernetes (Azure)
+# Deploy DBRepo with Azure
 
-You can use our pre-built Helm chart for deploying DBRepo in your Kubernetes Cluster with Azure infrastructure
-provider.
+You can use our pre-built Helm chart for deploying DBRepo in your Kubernetes Cluster 
+with [Azure](https://azure.microsoft.com/) as infrastructure provider. We recommend at least a *Standard_B4ms* node size
+(Kubernetes version 1.24.10, 2 node pools) Kubernetes cluster, suitable for small operational deployments.
 
 ## TL;DR
 
@@ -19,7 +20,7 @@ helm install dbrepo "oci://dbrepo.azurecr.io/helm/dbrepo-azure" \
 This section will be extended in the future.
 
 <figure markdown>
-![Architecture Kubernetes Azure](images/architecture-kubernetes.png)
+![Architecture Kubernetes Azure](images/architecture-kubernetes.svg)
 <figcaption>Architecture of the services on Azure Kubernetes</figcaption>
 </figure>
 

docs/deployment-kubernetes-openstack.md → docs/deployment-kubernetes-minikube.md

@@ -2,10 +2,15 @@
 author: Martin Weise
 ---
 
-# Kubernetes (OpenStack)
+# Deploy DBRepo with minikube
 
-You can use our pre-built Helm chart for deploying DBRepo in your Kubernetes Cluster with OpenStack as infrastructure
-provider.
+You can use our pre-built Helm chart for deploying DBRepo in your Kubernetes Cluster
+with [minikube](https://minikube.sigs.k8s.io/docs/start/) as infrastructure provider which deploys a single-node
+Kubernetes cluster on your machine, suitable for test-deployments.
+
+!!! info "Rootless Docker"
+
+    We use a minikube installation with rootless Docker driver in this section.
 
 ## TL;DR
 
@@ -19,7 +24,7 @@ helm install dbrepo "oci://dbrepo.azurecr.io/helm/dbrepo-core" \
 This section will be extended in the future.
 
 <figure markdown>
-![Architecture Kubernetes OpenStack](images/architecture-kubernetes.png)
+![Architecture Kubernetes OpenStack](images/architecture-kubernetes.svg)
 <figcaption>Architecture of the services on OpenStack Kubernetes</figcaption>
 </figure>
 
@@ -28,7 +33,7 @@ This section will be extended in the future.
 This section will be extended in the future.
 
 | Key              | Type   | Default | Description                                           |
-|-----|------|---------|-------------|
+|------------------|--------|---------|-------------------------------------------------------|
 | replicaCount     | int    | `1`     | Number of replicas (pods) to launch.                  |
 | nameOverride     | string | `""`    | A name in place of the chart name for `app:` labels.  |
 | fullnameOverride | string | `""`    | A name to substitute for the full names of resources. |

docs/get-started.md

@@ -4,7 +4,7 @@ author: Martin Weise
 
 # Get Started
 
-!!! info "Abstract"
+!!! abstract "Abstract"
 
     In this short getting started guide we show the dependencies to run the database repository and perform a small, 
     local, test deployment for quickly trying out the features that the repository offers.

docs/system.md

@@ -4,7 +4,7 @@ author: Martin Weise
 
 # System
 
-!!! info "Abstract"
+!!! abstract "Abstract"
 
     This is the full system description from a technical/developer view.
 

docs/usage-overview.md

@@ -4,7 +4,7 @@ author: Martin Weise
 
 # Overview
 
-!!! info "Abstract"
+!!! abstract "Abstract"
 
     We modified some services and exchanged them with reviewed, open-source implementations that extend the functionality
     even more from version 1.2 onwards. On this page, some of the configuration possible is summarized.

mkdocs.yml

@@ -7,9 +7,9 @@ nav:
   - Home: index.md
   - get-started.md
   - Deployment:
-    - Virtual Machine: deployment-vm.md
+    - Docker Compose: deployment-docker-compose.md
     - Kubernetes:
-        - OpenStack: deployment-kubernetes-openstack.md
+        - minikube: deployment-kubernetes-minikube.md
         - Azure: deployment-kubernetes-azure.md
   - system.md
   - Usage: