Skip to main content
Before You Begin - Ensure all prerequisites are met to avoid self-hosting issues and ensure a smooth setup process.

​
Kubernetes Cluster Access

You need access to a Kubernetes cluster or the ability to create one. This guide primarily focuses on AWS EKS but supports any Kubernetes platform.

​
Cloud Platform Options

AWS (Primary Focus)
  • EKS (Elastic Kubernetes Service) for managed Kubernetes
  • RDS for managed PostgreSQL database
  • ACM (Certificate Manager) for SSL certificates
  • IAM permissions to create and manage these resources
Google Cloud Platform
  • GKE (Google Kubernetes Engine) for managed Kubernetes
  • Cloud SQL for managed PostgreSQL database
  • Google-managed SSL certificates
Azure
  • AKS (Azure Kubernetes Service) for managed Kubernetes
  • Azure Database for PostgreSQL for managed database
  • Azure Key Vault for SSL certificates

​
Required Tools

Before starting, install and configure these tools:

​
kubectl (Kubernetes CLI)

# macOS
brew install kubectl

# Linux
curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl"
sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl

# Windows
choco install kubernetes-cli

​
Helm (Package Manager)

# macOS
brew install helm

# Linux
curl https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash

# Windows
choco install kubernetes-helm

​
Cloud Provider CLI (Choose one)

AWS - eksctl 
# macOS
brew install eksctl

# Linux
ARCH=amd64
PLATFORM=$(uname -s)_$ARCH

curl -sLO "https://github.com/eksctl-io/eksctl/releases/latest/download/eksctl_$PLATFORM.tar.gz"
tar -xzf eksctl_$PLATFORM.tar.gz -C /tmp && rm eksctl_$PLATFORM.tar.gz

sudo install -m 0755 /tmp/eksctl /usr/local/bin && rm /tmp/eksctl
Google Cloud - gcloud 
# Install Google Cloud SDK
curl https://sdk.cloud.google.com | bash
Azure - az CLI 
# macOS
brew install azure-cli

# Linux
curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash

​
Domain Access

You need access to manage a domain name for the Relvy application:
  • DNS Management: Ability to create and modify CNAME records
  • Domain Registrar Access: Control over domain settings through your registrar
  • Subdomain Planning: Decide on your subdomain structure (e.g., relvy.yourcompany.com)
During self-hosting setup, you’ll need to create CNAME records for SSL certificate validation and domain routing.

​
License Key

To use Relvy after deployment, you need to obtain a license key from the Relvy team.

​
Important Notes

  • License key is required to use the product - Without a valid license key, users will not be able to login to Relvy
  • Deployment can be tested without a license key - You can deploy and verify that your infrastructure is working correctly, but you won’t be able to access the application features
  • Contact Relvy support to request your license key: Email: support@relvy.ai

​
Optional Integrations

​
Slack Integration

If you plan to use Slack integration, you’ll need:
  • Slack Workspace Access: Ability to install apps in your workspace
  • App Creation Permissions: Permission to create Slack apps

​
GitHub Integration

If you plan to use code-aware root cause analysis with GitHub, you’ll need:
  • GitHub Organization Access: Admin permissions to create GitHub Apps
  • Repository Access: Control over which repositories to authorize
  • App Creation Permissions: Ability to create and configure GitHub Apps in your organization

​
Next Steps

Once you’ve verified all prerequisites are met:
  1. Review the Architecture - Understand the deployment components in Overview & Architecture
  2. Begin Cluster Setup - Start with Kubernetes Cluster Setup