charts description and requirements (#70)

neicnordic · Nov 24, 2023 · 2538979 · 2538979
2 parents a466d4a + 5df74c1
commit 2538979
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 10 deletions.
diff --git a/docs/dictionary/wordlist.txt b/docs/dictionary/wordlist.txt
@@ -88,6 +88,7 @@ gh
 ghcr
 golang
 gradle
+helpdesk
 hostname
 howto
 href
@@ -178,6 +179,7 @@ reencrypt
 reencrypted
 reencrypting
 repo
+reqs
 requesters
 rootedfilesystem
 routingkey
@@ -190,6 +192,7 @@ secretkey
 setaccessionid
 setarchived
 sftp
+sftpinbox
 sha
 smth
 somedir
@@ -199,6 +202,8 @@ ssl
 sslmode
 startcoordinate
 storeheader
+submitters
+svc
 svg
 sysdevs
 tada
@@ -231,8 +236,3 @@ wyenrumyh
 yaml
 yihkqimti
 yml
-PREFETCHCOUNT
-SetAccessionID
-DNS
-helpdesk
-submitters
diff --git a/docs/guides/deploy-k8s.md b/docs/guides/deploy-k8s.md
@@ -20,12 +20,47 @@ This guide explains how to deploy the Sensitive Data Archive (SDA) in kubernetes
 
 ## Charts overview
 
+### sda-db - Database component for Sensitive Data Archive (SDA) installation
+
+This chart deploys a pre-configured database ([PostgreSQL](https://www.postgresql.org/)) instance for Sensitive Data Archive, the database schemas are designed to adhere to [European Genome-Phenome Archive](https://ega-archive.org/) federated archiving model.
+
+### sda-mq - RabbitMQ component for Sensitive Data Archive (SDA) installation
+
+This chart deploys a pre-configured message broker ([RabbitMQ](https://www.rabbitmq.com/)) designed to work [European Genome-Phenome Archive](https://ega-archive.org/) federated messaging interface between Central EGA and Local/Federated EGAs.
+
+### sda-svc - Components for Sensitive Data Archive (SDA) installation
+
+This chart deploys the service components needed to operate the Sensitive Data Archive solution for running a Federated EGA node.
+The charts may include additional service components that might be beneficial for administrative operations or extending the Sensitive Data Archive solutions to facilitate other use cases.
+
 ## System requirements
 
- - k8s/helm minimal versions
- - rough estimate of hardware resources
+ - kubernetes minimal version required for running the helm charts is `>= 1.25`
+ - helm minimal version required for running the charts is `>=3.5`
 
-## Minimal working configuration
+### Resource estimation
+
+- RabbitMQ - official recommended resource requirements for a [RabbitMQ cluster](https://www.rabbitmq.com/kubernetes/operator/using-operator.html#resource-reqs)
+- PostgreSQL - official recommended resource requirements for [PostgreSQL](https://www.postgresql.org/docs/current/install-requirements.html)
+
+#### Minimal working configuration
+
+The table below reflects the minimum required resources to run the services in the helm charts.
+
+| Service    | CPU   | Memory | Disk |
+|------------|-------|--------|------|
+| RabbitMQ   | 1000m | 1Gi    | 8Gi  |
+| PostgreSQL | 100m  | 128Mi  | 8Gi  |
+| intercept  | 100m  | 32Mi   | -    |
+| ingest     | 100m  | 128Mi  | -    |
+| verify     | 100m  | 128Mi  | -    |
+| finalize   | 100m  | 128Mi  | -    |
+| download   | 100m  | 256Mi  | -    |
+| backup     | 100m  | 128Mi  | -    |
+| auth       | 100m  | 128Mi  | -    |
+| s3inbox    | 100m  | 128Mi  | -    |
+| sftpinbox  | 100m  | 128Mi  | -    |
+| doa        | 100m  | 128Mi  | -    |
 
 ## Security issues
 
@@ -39,5 +74,3 @@ This guide explains how to deploy the Sensitive Data Archive (SDA) in kubernetes
 ## Complementary services
 
  - sda-auth, sda-doa, sda-download
-
-