LocalEGA-helm

Table of Contents

• Prerequisites
  • Optional, add S3 storage
• Installing the Chart
  • Configuration
• Uninstalling the Chart

Helm chart to deploy LocalEGA to any kubernetes cluster.

Prerequisites

Before deploying the Helm charts HELM should be initialized and the tiller installed, following these instructions.

Download the helm chart

git clone https://github.com/NBISweden/LocalEGA-helm.git

Or

helm repo add ega-charts https://nbisweden.github.io/LocalEGA-helm/
helm update
helm fetch --untar ega-charts/localega

N.B: If you use git clone to get the charts you will have to prefix localega in the example command lines below with ega-charts/.

When deploying a dev environment for the first time you need to create the secrets using the legainit utility from LocalEGA-deploy-init. Follow the instructions in that repository and install the command line utility. After it has been installed use:

legainit --config-path localega/config
# legainit --config-path ega-charts/localega/config # If cloned with git

or if you want to include generate fake CEGA credentials use:

legainit --cega --config-path localega/config

Optional, add S3 storage

LocalEGA relies on a S3 type backend storage as data archive.
If the kubernetes environment doesn't supply a S3 storage it can be added using either minio or ceph.

Minio

See the documentation for how to configure minio.
More specifically the size of each backing volume and if minio should run in distributed mode or not.

If you set up all secrets with the legainit program grab the values for S3_access and S3_secret from the localega/config/trace.yml file.

helm install --set accessKey=S3_access,secretKey=S3_secret,minioConfig.region=S3_region stable/minio

Installing the Chart

Edit the values.yaml file and specify the relevant hostnames for cega-mq, cega-users, SQL and the relevant data_storage parts.

The values that has to be configured in values.yaml are:

• cega_users_host
• cega_mq_host
• cega_vhost
• data_storage_url
• s3_archive_bucket
• s3_archive_region
• (possibly disable persistence)

You can then install the localega chart via Helm CLI:

helm install --name <deployment name> --namespace <deployment namespace> localega -f localega/values.yaml -f localega/config/trace.yml

Configuration

localega chart

The following table lists the configurable parameters of the localega chart and their default values.

logging chart

The following table lists the configurable parameters of the logging chart and their default values.

Install fake CEGA

Unless you cloned the git repo you need to download the cega chart:

helm fetch --untar ega-charts/cega

Copy the relevant files from the config folder created by the init script.

cp localega/config/users.json localega/config/cega.* cega/config
mkdir cega/config/certs
cp localega/config/certs/{cega-*,root.ca.crt} cega/config/certs/

You can install the cega chart via Helm CLI:

helm install --name <deployment name> --namespace <deployment namespace> cega -f localega/config/trace.yml

Setup logging

See the logging readme.

Uninstalling the Chart

You can uninstall the Chart via Helm CLI:

helm delete ${deployment name} --purge