Thorn Tech Marketing Ad
Skip to main content
Version: Next

Deploy StorageLink with Helm Chart on EKS

TLDR - Quick Summary

What: Deploy StorageLink on EKS using a Helm chart with bundled or external PostgreSQL

Steps: Create EKS cluster, download the chart, run helm install

Quick start:

helm install storagelink ./storagelink \
--namespace storagelink --create-namespace \
--set postgresql.auth.password=$(openssl rand -hex 16) \
--set admin.username=admin \
--set admin.password='YourSecurePassword1!'

Overview​

The StorageLink Helm chart simplifies deploying StorageLink on Amazon Elastic Kubernetes Service (EKS). It handles creating all Kubernetes resources (Deployments, Services, ConfigMaps, Secrets, PVCs, ServiceAccounts, NetworkPolicies, PodDisruptionBudgets) and supports two database modes:

  • Bundled PostgreSQL (default) — runs a PostgreSQL container inside the cluster using the Bitnami subchart. Good for testing and simple deployments.
  • External database — connects to a managed Amazon RDS for PostgreSQL instance. Recommended for production.
Container Reference

For detailed configuration options (TLS modes, client IP preservation, security context, LFS mode, image verification, and more), see the Container Deployment Reference.

Architecture​

                    ┌──────────────────────────────────────────────┐
│ Amazon Elastic Kubernetes Service (EKS) │
│ Namespace: storagelink │
│ │
HTTPS (443) │ ┌────────────┐ ┌────────────────┐ │
──────────────────┼──►│ Admin UI │───►│ Backend │ │
│ │ (Nginx) │ │ (Spring Boot) │ │
│ │ │ │ Port 8080 API │ │
│ └────────────┘ └───────┬────────┘ │
│ │ │
│ ┌───────▼────────┐ │
│ │ PostgreSQL │ │
│ │ (bundled or │ │
│ │ external) │ │
│ └────────────────┘ │
└──────────────────────────────────────────────┘

Components:

  • Backend — StorageLink API server (Spring Boot). Handles cloud storage operations and user management.
  • Admin UI — Web-based administration dashboard (Nginx). Exposed via a LoadBalancer on port 443.
  • PostgreSQL — Stores user accounts and configuration data.

Prerequisites​

Download the Helm chart​

Download the StorageLink Helm chart archive and extract it:

curl -LO https://help.thorntech.com/storagelink/downloads/storagelink-aws-0.4.2.tgz
tar xzf storagelink-aws-0.4.2.tgz

This creates a storagelink/ directory containing the chart (version 0.4.2, StorageLink 1.3.1), with EKS defaults already set. All helm install commands below reference this directory as ./storagelink.

Step 1: Create an EKS cluster​

cat > eks.yaml <<'EOF'
apiVersion: eksctl.io/v1alpha5
kind: ClusterConfig
metadata:
name: storagelink-eks
region: us-east-1
iam:
withOIDC: true
managedNodeGroups:
- name: ng
instanceType: t3.medium
desiredCapacity: 2
addons:
- name: aws-ebs-csi-driver # provisions the bundled PostgreSQL volume
wellKnownPolicies:
ebsCSIController: true
EOF
eksctl create cluster -f eks.yaml

This takes approximately 15 minutes. eksctl automatically creates the VPC, subnets, IAM roles, and node group.

The bundled PostgreSQL stores its data on an EBS volume with the gp2 storage class, which needs the Amazon EBS CSI driver add-on. EKS 1.30 and later mark no storage class as default, so the chart sets gp2 itself. On an existing cluster, install the add-on before you install the chart. With an external database (Option B), you can leave it out.

Verify the cluster is ready:

kubectl get nodes

Step 2: Create the namespace​

kubectl create namespace storagelink
kubectl label namespace storagelink pod-security.kubernetes.io/enforce=restricted

The chart is compatible with the restricted Pod Security Standard, so enforcing it is recommended.

The images are public on Docker Hub (thorntech/storagelink-backend and thorntech/storagelink-ui), so no pull secret is needed. The tag defaults to the chart's appVersion (1.3.1). To pull from your own registry or mirror, set backend.image.repository, ui.image.repository and, if the registry needs credentials, imagePullSecrets.

Step 3: Install the Helm chart​

Option A: Bundled PostgreSQL (quickstart)​

This is the simplest option — a PostgreSQL container runs alongside the backend inside your cluster.

helm install storagelink ./storagelink \
--namespace storagelink \
--set postgresql.auth.password=$(openssl rand -hex 16) \
--set admin.username=admin \
--set admin.password='YourSecurePassword1!'

After a few minutes, all pods should be running:

kubectl get pods -n storagelink

Expected output:

NAME                                   READY   STATUS    RESTARTS   AGE
storagelink-backend-xxxxx 1/1 Running 0 2m
storagelink-backend-yyyyy 1/1 Running 0 2m
storagelink-postgresql-0 1/1 Running 0 2m
storagelink-ui-xxxxx 1/1 Running 0 2m
storagelink-ui-yyyyy 1/1 Running 0 2m

Option B: Amazon RDS for PostgreSQL (production)​

For production deployments, use a managed Amazon RDS for PostgreSQL instance.

Create the database​

aws rds create-db-instance \
--db-instance-identifier storagelink-pg \
--db-instance-class db.t3.micro \
--engine postgres \
--engine-version 16 \
--master-username swiftgw \
--master-user-password '<your-strong-password>' \
--allocated-storage 20 \
--db-name swift_gw \
--no-multi-az \
--region us-east-1

Wait for the instance to become available:

aws rds wait db-instance-available \
--db-instance-identifier storagelink-pg \
--region us-east-1

Get the endpoint:

aws rds describe-db-instances \
--db-instance-identifier storagelink-pg \
--region us-east-1 \
--query 'DBInstances[0].Endpoint.Address' \
--output text

Configure network access​

The RDS instance must be reachable from your EKS nodes. If they are in the same VPC, add the EKS node security group to the RDS security group's inbound rules on port 5432. If they are in different VPCs, either:

  • Set up VPC peering between the EKS and RDS VPCs (recommended)
  • Create the RDS instance in the same VPC and subnets as EKS

Consult your network team for the approach that best fits your organization's security requirements.

Install with external database​

helm install storagelink ./storagelink \
--namespace storagelink \
--set postgresql.enabled=false \
--set externalDatabase.host=storagelink-pg.xxxxxxxxxxxx.us-east-1.rds.amazonaws.com \
--set externalDatabase.password='<your-strong-password>' \
--set externalDatabase.jdbcParams='?sslmode=require' \
--set admin.username=admin \
--set admin.password='YourSecurePassword1!'

Step 4: Access the Admin UI​

Get the external hostname of the UI service:

kubectl get svc storagelink-ui -n storagelink

It may take 1–2 minutes for AWS to provision the load balancer. Once available:

NAME             TYPE           CLUSTER-IP     EXTERNAL-IP                                    PORT(S)         AGE
storagelink-ui LoadBalancer 10.100.29.73 a71865...us-east-1.elb.amazonaws.com 443:30749/TCP 2m

Open https://<EXTERNAL-IP> in your browser. You will see a certificate warning because the chart generates a self-signed TLS certificate by default — this is expected for testing.

If you provided admin.username and admin.password, log in with those credentials. Otherwise, you will be prompted to create your admin account on first access.

caution

If no admin credentials were provided and the UI is publicly accessible, the first person to reach the UI can create the admin account. See Security considerations below.

Licensing​

Without a license, StorageLink starts unlicensed: sign in as the administrator and start the free 30-day trial or activate a purchased license under Settings → License. Until then, non-administrator users cannot sign in and file transfers are blocked. See Purchasing a License.

To license an unattended install instead, pass the license file you received (the whole JSON, on one line) with --set-file:

jq -c . license.json > license.min.json   # only if the file spans several lines
helm install storagelink ./storagelink \
--namespace storagelink \
--set-file license.content=license.min.json \
# ... other values

The backend activates the license at startup and binds it to this deployment's database. This needs outbound HTTPS to licensing.thorntech.com, and a new or wiped database needs a new license.

Security considerations​

Admin account​

The admin.username and admin.password values trigger a post-install Helm Job that waits for the backend to become healthy, then calls the setup API to create the admin account. If an admin account already exists (e.g., on helm upgrade), the Job detects this and exits successfully without changes.

Restrict Admin UI access​

Lock down the Admin UI to specific IP addresses using loadBalancerSourceRanges:

helm install storagelink ./storagelink \
--namespace storagelink \
--set 'ui.service.loadBalancerSourceRanges[0]=203.0.113.50/32' \
--set 'ui.service.loadBalancerSourceRanges[1]=198.51.100.0/24' \
# ... other values

Built-in hardening​

The Helm chart includes these security defaults:

  • Non-root containers — the backend runs as the image's own user (UID 1000, group 0; the chart does not pin runAsUser), the UI as UID 1000
  • Read-only root filesystem — enabled on the backend container
  • Dropped capabilities — all Linux capabilities are dropped
  • NetworkPolicies — restrict pod-to-pod and egress traffic
  • ServiceAccounts — dedicated accounts with token automount disabled
  • PodDisruptionBudgets — ensure availability during node maintenance
  • Backend not externally exposed — backend Service is ClusterIP, preventing X-Forwarded-For spoofing that would defeat login lockout and forge audit source IPs
  • Client IP preservation — UI Service uses externalTrafficPolicy: Local to preserve the client's real source IP for audit logging and login lockout
  • Zero-downtime rolling updates — UI Deployment uses maxSurge: 1, maxUnavailable: 0 to avoid dropped connections under the Local traffic policy

Custom TLS certificate​

To use your own TLS certificate instead of the auto-generated self-signed one:

helm install storagelink ./storagelink \
--namespace storagelink \
--set-file ui.tls.certificate=path/to/tls.crt \
--set-file ui.tls.privateKey=path/to/tls.key \
# ... other values

Behind an ingress controller or L7 load balancer​

To put an ingress controller or L7 load balancer in front of the Admin UI, give StorageLink its own hostname, route all of / to the UI, and point health checks at /index.html. Serving it under a path prefix (for example example.com/storagelink) is not supported. If the ingress terminates TLS, install with:

helm install storagelink ./storagelink \
--namespace storagelink \
--set ui.externalTlsTermination=true \
--set ui.service.type=ClusterIP \
--set ui.service.port=80 \
# ... other values

See Behind an Ingress Controller or L7 Load Balancer for the requirements and an example Ingress.

Configuration reference​

Key values​

ParameterDescriptionDefault
backend.image.repositoryBackend image. Public on Docker Hub; override to use your own registry or mirrorthorntech/storagelink-backend
backend.image.tagBackend image tag. Empty uses the chart's appVersion (1.3.1); that tag must exist in the repository""
ui.image.repositoryUI image. Public on Docker Hub; override to use your own registry or mirrorthorntech/storagelink-ui
ui.image.tagUI image tag. Empty uses the chart's appVersion (1.3.1)""
imagePullSecretsPull secrets, only needed for a private registry or mirror[]
admin.usernameInitial admin username""
admin.passwordInitial admin password""
security.jwtSecretJWT signing key, at least 32 characters (openssl rand -base64 32); a shorter one fails the install. If empty, the chart generates one and keeps it across upgrades""
license.contentThe whole license JSON, for unattended installs (pass it with --set-file). If empty, license the deployment from the admin UI — see Licensing""
license.keyDeprecated name for license.content (chart 0.3.0 and earlier). The value trial is ignored""
config.cloudProviderCloud provider hint: azure, aws, or gcpaws
config.maxHttpRequestHeaderSizeLargest request header the backend accepts. The image defaults to 8KB, which Microsoft Entra ID tokens exceed, so OIDC sign-in failed or worked only in a private window128KB
backend.replicaCountNumber of backend replicas2
ui.replicaCountNumber of UI replicas2
ui.tls.certificateCustom TLS certificate (PEM)"" (self-signed)
ui.tls.privateKeyCustom TLS private key (PEM)""
ui.service.typeLoadBalancer, or ClusterIP behind an ingress controllerLoadBalancer
ui.service.portUI Service port. Behind an ingress that terminates TLS, use 80443
ui.service.loadBalancerSourceRangesRestrict Admin UI to specific IPs[]
ui.externalTlsTerminationServe plain HTTP on port 8080 when a load balancer or ingress terminates TLS — see Behind an ingress controllerfalse
postgresql.enabledUse bundled PostgreSQLtrue
postgresql.auth.passwordBundled PostgreSQL password""
postgresql.primary.persistence.storageClassStorage class for the bundled database volumegp2
postgresql.image.digestBundled PostgreSQL image, pinned to PostgreSQL 18.6.0. Change it only for a deliberate major-version upgrade (back up first)pinned digest
externalDatabase.hostExternal PostgreSQL hostname. Required with postgresql.enabled=false""
externalDatabase.portExternal PostgreSQL port5432
externalDatabase.databaseDatabase nameswift_gw
externalDatabase.usernameDatabase userswiftgw
externalDatabase.passwordExternal PostgreSQL password. Required with postgresql.enabled=false unless existingSecret is set""
externalDatabase.existingSecretExisting Secret that holds the database password, instead of externalDatabase.password""
externalDatabase.existingSecretKeyKey of the password in that Secretpassword
externalDatabase.jdbcParamsAdditional JDBC params (e.g., ?sslmode=require)""
localStorage.enabledStore files on a PersistentVolume instead of cloud storage (LFS mode)false
localStorage.mountPathAbsolute path the volume is mounted at — must be outside /opt/swiftgw/mnt/data
localStorage.persistence.sizeSize of the PersistentVolumeClaim50Gi
localStorage.persistence.storageClassNameStorage class for the LFS volume. Must support ReadWriteMany — see Local File Storageefs-sc
localStorage.persistence.accessModeMust be ReadWriteMany when running more than one backend replicaReadWriteMany
networkPolicy.enabledEnable NetworkPoliciestrue
podDisruptionBudget.enabledEnable PodDisruptionBudgetstrue

Local File Storage​

Local File Storage (LFS) mode stores files on a PersistentVolume instead of cloud storage. Enable it with --set localStorage.enabled=true. The chart creates the storagelink-data PVC, mounts it at /mnt/data on every backend replica, and creates the first storage connection pointing at it on first launch.

On EKS the chart defaults the LFS volume to the efs-sc storage class (Amazon EFS). EKS does not create it for you:

  1. Create an EFS file system in your cluster's VPC, with a mount target in each subnet your nodes use and a security group that allows NFS (TCP 2049) from the nodes.
  2. Install the Amazon EFS CSI driver (EKS add-on aws-efs-csi-driver).
  3. Create the efs-sc storage class. It must set provisioningMode — a class with only fileSystemId leaves the PVC Pending with Missing provisioningMode parameter:
apiVersion: storage.k8s.io/v1
kind: StorageClass
metadata:
name: efs-sc
provisioner: efs.csi.aws.com
parameters:
provisioningMode: efs-ap # one EFS access point per PVC
fileSystemId: fs-0123456789abcdef0
directoryPerms: "700" # the access point's POSIX user owns the directory

To use a different class, set localStorage.persistence.storageClassName.

The volume must be ReadWriteMany, because both backend replicas read and write the same files. For mount-path rules, see Local File Storage (LFS) Mode.

Upgrading​

helm upgrade storagelink ./storagelink \
--namespace storagelink \
--reset-then-reuse-values
danger

--reset-then-reuse-values (Helm 3.14 and later) keeps the values you set at install and applies the new chart's defaults for everything else. Do not use --reuse-values: it keeps the previous release's values in place of the new chart's defaults, so a fix that arrives as a new default (the 0.4.2 request header size, the 0.4.0 PostgreSQL storage class and UI probes) never reaches the install. If you keep your settings in a values file, pass it with -f instead; Helm does not persist --set values between releases.

GitOps

The generated JWT key, OAuth client, self-signed certificate and PostgreSQL password are kept across upgrades through Helm's lookup, which runs only under the helm CLI. Argo CD renders with helm template, so every sync would generate new ones, sign everyone out and restart the pods. Under GitOps, set security.jwtSecret, security.clientId, security.clientSecret, postgresql.auth.password and ui.tls.* (or ui.externalTlsTermination=true) explicitly.

Upgrading from chart 0.4.1​

Chart 0.4.2 keeps StorageLink 1.3.1 and changes only the chart:

helm upgrade storagelink ./storagelink --namespace storagelink --reset-then-reuse-values
  • Request header size: the backend now accepts headers up to 128KB (config.maxHttpRequestHeaderSize). The image defaults to 8KB, which Microsoft Entra ID tokens exceed, so OIDC sign-in failed or worked only in a private window. StorageLink 1.4.0 makes 128KB the image default.

  • Self-signed certificate: the generated UI certificate is now valid for 10 years. Charts 0.4.0 and 0.4.1 kept it across upgrades but generated it for one year, so an install made with them would have served an expired certificate a year later. The upgrade keeps your existing certificate; to replace it, remove it from the Secret and upgrade again. The pods restart, and nobody is signed out because the JWT key is unchanged:

    kubectl patch secret storagelink-secret -n storagelink --type=json \
    -p='[{"op":"remove","path":"/data/tls-certificate"},{"op":"remove","path":"/data/tls-private-key"}]'
    helm upgrade storagelink ./storagelink --namespace storagelink --reset-then-reuse-values
  • Probe overrides: a tcpSocket, exec or grpc handler under ui.readinessProbe or ui.livenessProbe now replaces the default httpGet instead of being added beside it.

Upgrading from chart 0.4.0​

Chart 0.4.1 moves to StorageLink 1.3.1, a security patch release (Tomcat, Jackson and Log4j CVE fixes) with no configuration or database changes. Upgrading replaces the images and changes nothing else:

helm upgrade storagelink ./storagelink --namespace storagelink --reset-then-reuse-values

If you set backend.image.tag or ui.image.tag, change them to 1.3.1 too. From chart 0.3.0, also follow the next section.

Upgrading from chart 0.3.0​

With the bundled PostgreSQL, check its major version first. Chart 0.3.0 ran whatever Bitnami's latest image was at install time; 0.4.0 pins PostgreSQL 18.6.0:

kubectl exec -n storagelink storagelink-postgresql-0 -- postgres --version

If it is not 18, do not upgrade as is: set postgresql.image.digest to an image of the major version you run, or back up the database with pg_dump, upgrade, and restore.

Other changes in 0.4.0:

  • Bundled PostgreSQL volume: the chart now sets the gp2 storage class, because EKS 1.30 and later have no default class. Kubernetes rejects a change to a StatefulSet's volume template, so check the database PVC first:

    kubectl get pvc data-storagelink-postgresql-0 -n storagelink
    • Bound (the database is running, because your cluster has a default class): keep the volume as it is:

      helm upgrade storagelink ./storagelink --namespace storagelink --reset-then-reuse-values \
      --set postgresql.primary.persistence.storageClass=""
    • Pending (EKS 1.30 or later with no default class: the database never started, and neither did the backend): the PVC holds no data. Delete the StatefulSet and the PVC, then upgrade normally. helm uninstall alone does not help, because it leaves the PVC behind and a reinstall picks it up again.

      kubectl delete statefulset storagelink-postgresql -n storagelink
      kubectl delete pvc data-storagelink-postgresql-0 -n storagelink
  • Licensing: license.key is now license.content, passed to the backend as LICENSE_CONTENT. Chart 0.3.0 passed it as LICENSE, which StorageLink ignores, so a 0.3.0 install is licensed only if it was licensed from the admin UI, and that license stays in place. A license.key=trial from earlier instructions is ignored.

  • Sign-ins survive upgrades: the generated JWT key, OAuth client and self-signed certificate are now kept, so helm upgrade no longer signs everyone out.

  • security.jwtSecret shorter than 32 characters now fails the install. Earlier charts accepted it and every sign-in failed.

  • UI probes: with ui.externalTlsTermination=true, the probes now use HTTP on port 8080 and the path /index.html. Earlier charts probed HTTPS on 8443, and the UI pods restarted in a loop with no error in their log. In this mode the UI Service port is now named http; an Ingress that refers to it by name must use http.

  • External database: with postgresql.enabled=false, the install now fails unless externalDatabase.host and either externalDatabase.password or externalDatabase.existingSecret are set. Earlier charts installed, and the backend pods waited forever.

Upgrading from chart 0.2.0​

Chart 0.2.0 left the LFS storage class empty, so Kubernetes filled in the cluster's default class when it created the PVC. 0.3.0 and later default to efs-sc, and a PVC's storage class cannot be changed after it is created. If you enabled localStorage on 0.2.0, helm upgrade fails until you do one of the following:

  • PVC Pending (the default class is ReadWriteOnce, so it usually never bound): it holds no data, so delete it before upgrading:

    kubectl delete pvc storagelink-data -n storagelink
  • PVC Bound: keep it and pin the class it already has:

    kubectl get pvc storagelink-data -n storagelink -o jsonpath='{.spec.storageClassName}'
    helm upgrade storagelink ./storagelink --namespace storagelink --reset-then-reuse-values \
    --set localStorage.persistence.storageClassName=<that-class>

If localStorage was never enabled, upgrade normally.

Uninstalling​

helm uninstall storagelink --namespace storagelink

helm uninstall leaves two PersistentVolumeClaims in place, so your data is not deleted:

  • data-storagelink-postgresql-0 — the bundled PostgreSQL database, if used
  • storagelink-data — the LFS volume, if localStorage was enabled (the chart marks it helm.sh/resource-policy: keep)

A reinstall reattaches them only if it uses the same release name (storagelink) and namespace. With the bundled PostgreSQL, also pass the same postgresql.auth.password, or the backend cannot open the kept database. If you let the chart generate that password, save it before uninstalling, because helm uninstall deletes the Secret that holds it:

kubectl get secret storagelink-postgresql -n storagelink -o jsonpath='{.data.password}' | base64 -d

To remove them once the data is no longer needed:

kubectl delete pvc data-storagelink-postgresql-0 storagelink-data -n storagelink
danger

Deleting the PersistentVolumeClaims permanently deletes the underlying volumes (EBS volumes, and the LFS file share) and all data stored on them. Back up any important data first.

Troubleshooting​

Backend pod CrashLoopBackOff​

Check the backend logs:

kubectl logs -n storagelink -l app.kubernetes.io/component=backend --tail=50

Common causes:

  • Database connection failed — Verify credentials and that the RDS instance is running and accessible from the EKS nodes. Check security group rules.
  • Insufficient memory — The backend requires at least 2Gi of memory.

Backend stuck on "Waiting for changelog lock"​

This happens when a previous backend instance crashed during database migrations. The Helm chart includes an init container that, on every pod start, releases a lock held for more than 5 minutes. A newer lock may belong to a replica that is still migrating: wait 5 minutes, then delete the stuck pod.

PVCs stuck in Pending​

kubectl get storageclass
kubectl describe pvc -n storagelink
  • Bundled PostgreSQL (data-storagelink-postgresql-0) uses gp2, which needs the Amazon EBS CSI driver add-on — see Step 1. If you upgraded from chart 0.3.0, see Upgrading from chart 0.3.0.
  • LFS volume (storagelink-data) uses efs-sc. If the class is missing or misconfigured, the PVC stays Pending and so do the backend pods — see Local File Storage. If you upgraded from chart 0.2.0, see Upgrading from chart 0.2.0.

UI pod CrashLoopBackOff​

Check the UI logs:

kubectl logs -n storagelink -l app.kubernetes.io/component=ui --tail=50

Common causes:

  • TLS certificate issue — The chart auto-generates a self-signed certificate. If you provided a custom certificate, verify both ui.tls.certificate and ui.tls.privateKey are valid PEM and match each other.
  • Probes failing behind an ingress (chart 0.3.0) — with ui.externalTlsTermination=true, chart 0.3.0 probed HTTPS on port 8443 and the pods restart with nothing in their log. Upgrade to 0.4.0 or later, or see UI Pods Restart With No Errors in the Log.

Blank page behind an ingress or load balancer​

StorageLink must be served from the root of a hostname. Behind a path prefix such as example.com/storagelink, the Admin UI stays blank. Give it its own hostname and route all of / to the UI — see Blank Page Behind an Ingress or Load Balancer.

External IP stuck on \<pending>​

kubectl describe svc storagelink-ui -n storagelink

Check the Events section for error messages. On EKS, the LoadBalancer creates a Classic Load Balancer (ELB) by default. Ensure your EKS node security group allows inbound traffic on the NodePort range.

Backend pod not becoming Ready​

The backend takes 60–90 seconds to start on first launch due to database migrations. Check readiness probe status:

kubectl describe pod -n storagelink -l app.kubernetes.io/component=backend

Resource summary​

ComponentMemory (request/limit)CPU (request/limit)Storage
PostgreSQL (bundled)256Mi / 512Mi250m / 500m20Gi
Backend (x2)2Gi / 3Gi500m / 1500m—
Admin UI (x2)128Mi / 256Mi100m / 500m—
Total~4.5Gi / ~7Gi1450m / 4000m20Gi