Skip to main content
Enterprise Only

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

Prerequisites Setup

Complete these requirements before running the Permit Platform installer.

1. Git Repository Setup​

Required: Permit Platform needs a Git repository to store and sync authorization policies.

Quick Setup​

# 1. Create SSH key pair
ssh-keygen -t rsa -b 4096 -f permit-policy-key -N ""

# This creates two files:
# permit-policy-key      (private key - keep secure)
# permit-policy-key.pub  (public key - add to Git repository)

# 2. Set correct permissions
chmod 600 permit-policy-key

Add Key to Your Git Platform​

  1. Go to your repository → Settings → Deploy keys
  2. Click "Add deploy key"
  3. Copy contents of permit-policy-key.pub and paste it
  4. ✅ CRITICAL: Check "Allow write access"
  5. Click "Add key"

Test Git Access​

# Test SSH connection (replace with your Git platform)
ssh -T git@github.com -i ./permit-policy-key

# Expected response:
# "Hi username/repository! You've successfully authenticated, but GitHub does not provide shell access."

Prepare Installation Information​

You'll need these during installation:

  • Repository SSH URL: git@github.com:yourorg/permit-policies.git
  • Private key file: permit-policy-key (in same directory as installer)

2. Server Requirements​

Sizing Guide​

SizeUse CaseServersCPURAMStorage
SmallTesting/Development14 cores8GB50GB
MediumProduction1-38 cores16GB100GB
LargeEnterprise3-516 cores32GB200GB

Operating System Support​

  • Ubuntu: 18.04, 20.04, 22.04 LTS
  • RHEL/CentOS: 7.x, 8.x, 9.x
  • SUSE: SLES 15+
  • Architecture: x86_64 (AMD64)

Network Requirements​

  • Web Access: Ports 80, 443
  • Multi-server: Ports 6443 (k3s API), 10250 (kubelet)
  • Servers: Must be on same network/VLAN and able to communicate
  • Internet: Not required after download

3. Access Requirements​

  • Root/sudo access on all servers
  • SSH access to servers for installation
  • Firewall rules allowing required ports

Common Setup Issues​

Git Access Problems​

❌ "Permission denied (publickey)"

  • Verify public key is added to repository
  • Check private key permissions: chmod 600 permit-policy-key
  • Ensure repository URL uses SSH format: git@github.com:...

Repository URL Format​

# ✅ Correct formats:
GitHub:    git@github.com:yourorg/permit-policies.git
GitLab:    git@gitlab.com:yourorg/permit-policies.git
Custom:    git@git.yourcompany.com:policies/permit.git

# ❌ Incorrect formats:
https://github.com/yourorg/permit-policies.git  # HTTPS not supported
github.com:yourorg/permit-policies.git         # Missing git@ prefix

Deploy Key Issues​

⚠️ "Deploy key already in use" (GitHub)
Each GitHub deploy key can only be used by one repository.

Solution: Generate a new key pair:
ssh-keygen -t rsa -b 4096 -f permit-policy-key-new -N ""

Verification Checklist​

Before proceeding to installation, verify:

  • Git repository created and accessible
  • SSH key pair generated (permit-policy-key and permit-policy-key.pub)
  • Public key added to repository with write access
  • Git access tested successfully
  • Server meets minimum requirements
  • Root/sudo access available
  • Required ports available

Prerequisites complete? Continue to Installation Guide →

Contents