Skip to main content
Enterprise Only

This section is only relevant to Enterprise customers who acquired an on-prem license.

Quick Start Guide

Get your Permit Platform up and running in just a few minutes.

What You Need​

⚠️ Important: Complete the prerequisites setup before starting installation.

Quick Checklist​

  • ✅ Kubernetes cluster (8+ CPU, 32GB+ RAM, 100GB+ storage)
  • ✅ Git repository for policies (GitHub/GitLab/Bitbucket) - REQUIRED
  • ✅ SSH key pair for Git access - REQUIRED
  • ✅ kubectl and helm installed
  • ✅ Docker installed

Installation in 3 Steps​

Step 1: Download & Extract​

# Download the package (using your provided link)
tar -xzf permit-platform-on-prem-installer.tar.gz
cd permit-platform-on-prem-installer

Step 2: Configure & Install​

Required Configuration:

# Edit configuration file (REQUIRED)
vi charts/permit-platform/values.yaml

# Replace ALL placeholders with your actual values:
# 1. CHANGEME_FRONTEND_DOMAIN → your domain (e.g., app.company.com)
# 2. CHANGEME_GIT_REPO_URL → your Git repository URL
# 3. CHANGEME_SSH_PRIVATE_KEY → your SSH private key content

⚠️ Critical: The installer will fail if any placeholders remain unchanged. You must replace:

  • • CHANGEME_FRONTEND_DOMAIN with your actual domain
  • • CHANGEME_GIT_REPO_URL with your Git repository SSH URL
  • • CHANGEME_SSH_PRIVATE_KEY with your SSH private key content

Example configuration:

global:
  frontendDomain: "app.company.com"  # Replace CHANGEME_FRONTEND_DOMAIN

permitServices:
  policySync:
    policyRepoUrl: "git@github.com:your-org/policies.git"  # Replace CHANGEME_GIT_REPO_URL
    sshPrivateKey: |  # Replace CHANGEME_SSH_PRIVATE_KEY
      -----BEGIN OPENSSH PRIVATE KEY-----
      b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAA...
      -----END OPENSSH PRIVATE KEY-----

Choose Your Deployment Target:

💡 Tip: The installer automatically detects your environment and configures accordingly. Choose the option that matches your cluster type.

# Standard Kubernetes (EKS, GKE, AKS, on-premise) - Most common
./scripts/install-permit-platform.sh

# Red Hat OpenShift (ROSA, OCP, OpenShift Dedicated)
./scripts/install-permit-platform.sh --openshift

# Local development with Kind cluster (testing only)
./scripts/install-permit-platform.sh --kind

# Auto-generate TLS certificates (for custom domains)
./scripts/install-permit-platform.sh --generate-tls

# See all available options and help
./scripts/install-permit-platform.sh --help

Installation time: 10-15 minutes
What you'll see: Progress updates, image loading, and service deployment status

Step 3: Access Platform​

After installation completes, you'll see:

[SUCCESS] 🎉 Permit Platform On-Prem deployed successfully!

[INFO] Access your Permit Platform at:
[INFO]   • Frontend: https://your-configured-domain.com
[INFO]     - Admin user: admin/[Generated Password]
[INFO]   
[INFO] For .local domains, add to your /etc/hosts file:
[INFO]   127.0.0.1 your-configured-domain.local
[INFO]   
[INFO] Services deployed: 35 total
[INFO] Installation time: ~10-15 minutes

Next Steps​

  1. Open the platform in your web browser
  2. Complete the setup wizard - create your organization
  3. Create admin users and configure initial policies
  4. Test the integration with your applications

Essential Commands​

# Check all services status
kubectl get pods -n permit-platform

# View installation progress  
kubectl get events -n permit-platform --sort-by='.lastTimestamp' --watch

# View logs for specific services
kubectl logs -f deployment/permit-backend-v2 -n permit-platform
kubectl logs -f deployment/permit-frontend -n permit-platform
kubectl logs -f deployment/keycloak -n permit-platform

# Check ingress and networking
kubectl get svc,ingress -n permit-platform

# Uninstall platform (if needed)
helm uninstall permit-platform -n permit-platform
kubectl delete namespace permit-platform

Need More Control?​

For advanced installation options including multi-server setup, custom configurations, and automated deployment, see the detailed installation guide.

Something Not Working?​

Check the troubleshooting guide for common issues and solutions.

Ready for production? Continue to Management Guide to learn about day-to-day operations.

Support​

Need help with installation?

Contents