Skip to content

Commit

Permalink
charts description and requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
blankdots committed Nov 20, 2023
1 parent 21d9c9d commit a1b2512
Showing 1 changed file with 38 additions and 5 deletions.
43 changes: 38 additions & 5 deletions docs/guides/deploy-k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/ega)) 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.19.0-0`
- 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 minum 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

Expand All @@ -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


0 comments on commit a1b2512

Please sign in to comment.