Guides

Kubernetes

Suggest Edits

RegScale deploys to Kubernetes — including managed services such as Azure AKS, Amazon EKS, and Google GKE, as well as on-premises clusters — using the official RegScale Helm chart. The chart contains the complete, maintained deployment templates and configuration options.

Before You Deploy

Review the following for resource and database requirements:

You will need:

  • Kubernetes 1.19+ and Helm 3.0+
  • An external Microsoft SQL Server 2022+ database accessible from the cluster
  • A storage solution for uploaded files (Persistent Volume, Azure Files, Azure Blob, AWS EFS, or NFS)

Deploy with Helm

  1. Add the RegScale Helm repository:

    helm repo add regscale https://regscale.github.io/helm
helm repo update

  2. Create a values file (for example my-values.yaml) with your database connection string, secrets, storage, and ingress configuration:

    secrets:
  jwtSecretKey: "<yourJWTSecretKey>"          # 32-char hex; generate with: openssl rand -hex 16
  encryptionKey: "<yourEncryptionKey>"        # 32-char hex; generate with: openssl rand -hex 16
  sqlConnectionString: |
    Server=tcp:<db-server>,1433;
    Initial Catalog=REGSCALE;
    User ID=<db_admin>;
    Password=<db_password>;
    Encrypt=True;
    TrustServerCertificate=False;

storage:
  persistence:
    enabled: true
    size: 10Gi

ingress:
  enabled: true
  hosts:
    - host: regscale.your-domain.com
      paths:
        - path: /
          pathType: Prefix

    📘

    Cloud-specific example values files (azure-values.yaml, aws-values.yaml) and the full list of configuration options are in the chart source repository: https://github.com/RegScale/helm. Replace the image tag with the release you want — see the RegScale Changelog.

  3. Install RegScale:

    helm install regscale regscale/regscale \
  --values my-values.yaml \
  --namespace regscale \
  --create-namespace

  4. Configure DNS, SSL, and Ingress according to your IT organization's guidelines.

After Deployment

Complete the Post-Deployment Steps to secure your instance and create your first tenant.

To upgrade, see the Upgrade Guide.