RegScale Helm Repository

Continuous Compliance Automation Platform for Kubernetes

📋 Table of Contents

🚀 Quick Start

1 Add the RegScale Helm repository:
helm repo add regscale https://regscale.github.io/helm
helm repo update
2 Download and configure the values file:

Download the my-values.yaml template:

curl -o my-values.yaml https://raw.githubusercontent.com/RegScale/community/main/kubernetes/helm/my-values.yaml

Edit the file with your specific values. You'll need to update the following sections:

  • secrets.jwtSecretKey (32 characters)
  • secrets.encryptionKey (32 characters)
  • secrets.sqlConnectionString (your database connection)
  • storage configuration
  • ingress hosts (your domain)

💡 Important: After downloading, open my-values.yaml and replace all placeholder values with your actual configuration. Pay special attention to the security keys and database connection string.

3 Install RegScale:
helm install regscale regscale/regscale --values my-values.yaml --namespace regscale --create-namespace

📋 Prerequisites

Required Components

  • Kubernetes 1.19+ - Your cluster version
  • Helm 3.0+ - Package manager
  • Microsoft SQL Server - Database instance accessible from cluster
  • Storage Solution - Persistent Volume, Azure File Share, Azure Blob, or NFS

🔧 Required Configuration

🔐 Security Keys

Must be exactly 32 characters

  • jwtSecretKey: "YourJWTSecretKey"
  • encryptionKey: "YourEncryptionKey"

🗄️ Database Connection

Connection Pool Sizing

Calculate pool sizes based on your database capacity and RegScale replica count:

Max Pool Size:
(SQL Max Connections × 0.8) ÷ Number of Replicas

Min Pool Size:
Max Pool Size ÷ 8 (minimum 1)

💡 Safety Factor: 0.8 (80% utilization, 20% buffer)
💡 Warmup Factor: 8 (for connection warmup)

Example Calculation

Scenario: SQL Server with 200 max connections, 3 replica sets

Max Pool Size:
(200 × 0.8) ÷ 3 = 160 ÷ 3 = 53.33 ≈ 53

Min Pool Size per Replica:
53 ÷ 8 = 6.625 ≈ 6

💡 Result: Set Max Pool Size = 53, Min Pool Size = 6 per replica

Required Configuration

  • Server: "YourDatabaseServer"
  • User ID: "YourDatabaseUserID"
  • Password: "YourDatabasePassword"
  • Max Pool Size: YourMaxPoolSize
  • Min Pool Size: YourMinPoolSize

💾 Common Cloud Storage Options

The following are common cloud storage options that can be used with RegScale
Refrence the my-values.yaml file for other options

🚀 Azure Blob Storage

Requires Azure Blob CSI driver

azureBlob:
    enabled: true
    resourceGroup: "" # Required
    storageAccount: "regscale-files" # Required
    containerName: "" # Required
    secretName: "" # Required: Secret containing storage account key

🚀 AWS EFS (Elastic File System)

Requires AWS EFS CSI driver

awsEFS:
    enabled: true
    fileSystemId: "" # Required: EFS file system ID (fs-xxxxxx)
    accessPoint: "" # Optional: EFS access point ID (fsap-xxxxxx)
    region: "" # Required: AWS region

🔒 Security Best Practices

⚠️ Important Security Notes

  • Change Default Secrets: Always change the default JWT and encryption keys
  • Use Existing Secrets: For production, create secrets outside of Helm
  • Enable Network Policies: Use network policies for network isolation
  • Pod Security: Use pod security standards and non-root containers

🔍 Troubleshooting

Common Issues

Useful Commands

Check pod status:

kubectl get pods -n regscale

View logs:

kubectl logs -n regscale deployment/regscale-app

Port forward for local access:

kubectl port-forward -n regscale svc/regscale-svc 8080:80

🔄 Upgrading

# Update repository helm repo update regscale # Upgrade release helm upgrade regscale regscale/regscale \ --values my-values.yaml \ --namespace regscale

📚 Resources

📦 Repository Files

🔗 External Links

🏢 About RegScale

RegScale is a continuous compliance automation platform that helps organizations maintain security and compliance across their infrastructure.

Learn more about RegScale →