Settings

Configure Orphelix preferences, GitHub integration, AI features, and design options

Overview

The Settings page allows you to customize Orphelix behavior, appearance, and integrations. Access settings from the gear icon in the header or navigate to /settings.

Settings Tabs

Settings are organized into 4 tabs:

Cluster Configuration

Cluster aliases and connection preferences

GitHub Integration

GitHub App setup and repository configuration

AI Features

OpenAI API configuration for AI-powered features

Design

Theme, visual preset, and UI customization

Cluster Configuration

Cluster Aliases

Give clusters friendly, recognizable names:

1. Add Alias

   Click “Add Alias” button

2. Select Context

   Choose kubectl context from dropdown

3. Configure

   • Friendly Name: Display name (e.g., ”🚀 Production”)
   • Description: Optional notes
   • Color: Badge color (optional)
4. Save

   Alias appears in context selector

Example aliases:

arn:aws:eks:us-east-1:123:cluster/prod → 🚀 Production (US East)
gke_project_us-central1_cluster → 🌎 GKE Staging
minikube → 💻 Local Development

Critical Issues Monitoring

Configure which resource types trigger critical alerts:

Configurable per resource type:

Deployments

Alert when:

• ✅ No replicas available
• ✅ Image pull failures
• ✅ CrashLoopBackOff pods

Default: Enabled

Pods

Alert when:

• ✅ OOMKilled
• ✅ Failed status
• ✅ Evicted
• ✅ High restart count (>10)

Default: Enabled

Nodes

Alert when:

• ✅ NotReady status
• ✅ Disk pressure
• ✅ Memory pressure
• ✅ PID pressure

Default: Enabled

HPA

Alert when:

• ✅ Cannot scale (no metrics)
• ✅ At max replicas
• ✅ Scaling failures

Default: Disabled (less critical)

Alert Settings:

• Enable/Disable per type: Toggle monitoring
• Severity threshold: Choose alert level (Warning, Error, Critical)
• Cooldown period: Minimum time between alerts (default: 5 minutes)

Desktop Notifications

Configure browser notifications for critical issues:

Enable

1. Click Enable Notifications

   Button in Critical Issues section

2. Grant Browser Permission

   Browser prompts for notification permission

   Click “Allow”

3. Test Notification

   Click “Send Test” to verify it works

Configure

Notification options:

• Show for: Select resource types
• Severity: Warning, Error, or Critical only
• Sound: Enable notification sound
• Persistent: Keep notification until closed
• Do Not Disturb: Disable during specified hours

Examples

Example notifications:

⚠️ Deployment Alert
api-gateway has 0/3 replicas available
Namespace: production
[View Details]

🔴 Node Critical
node-1 is NotReady
Reason: Kubelet stopped posting status
[View Details]

💀 Pod OOMKilled
backend-abc123 killed due to OOM
Memory limit: 512Mi
[View Logs]

Auto-refresh

Configure automatic resource refresh interval:

Intervals

Available intervals:

• Off (manual refresh only)
• 10 seconds (real-time)
• 30 seconds (recommended)
• 1 minute
• 5 minutes

Default: 30 seconds

Behavior

When enabled:

• Resources automatically refresh
• Real-time status updates
• Event stream updates
• No page reload required

Auto-refresh pauses when tab is inactive (saves resources)

Per-page

Some pages have independent refresh:

• Dashboard: Auto-refresh enabled
• Logs viewer: Real-time streaming
• Events: Auto-update

Can be toggled per page

GitHub Integration

Configure GitHub App for YAML editing and PRs:

GitHub App Setup

1. Create GitHub App

   See GitHub App Setup for detailed instructions

2. Configure Environment Variables

   Add to .env.local:

   GITHUB_APP_ID=123456
   GITHUB_APP_CLIENT_ID=Iv1.abc123
   GITHUB_APP_CLIENT_SECRET=secret_here
   GITHUB_APP_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\n..."
   NEXTAUTH_SECRET=random_secret
   NEXTAUTH_URL=http://localhost:3000
   
3. Login in Settings

   Click “Login with GitHub App” button

   Redirects to GitHub for authorization

4. Select Repository

   After login, select default repository for YAML editing

Repository Settings

Default Repository

Purpose: Repository used for YAML editing

Selection:

• Choose from installed repositories
• Must have Contents & Pull Requests permissions
• Can be changed anytime

Example: myorg/k8s-manifests

Default Branch

Purpose: Branch to create PRs from

Options:

• main (recommended)
• master
• develop
• Custom branch

Default: main

File Path Patterns

Purpose: Where to find deployment YAML files

Examples:

• k8s/deployments/*.yaml
• manifests/production/*.yaml
• */deployment.yaml

Default: **/*.yaml (search all)

GitHub Status

Shows current GitHub integration state:

Connected

✅ GitHub App connected

Display:

• Logged in as: @username
• Repositories: 5 accessible
• Default repo: myorg/k8s-manifests
• Token expires: Never (GitHub App)

Actions:

• Change repository
• Logout

Not Connected

⚪ No GitHub connection

Display:

• Login button available
• Setup instructions link

Actions:

• Login with GitHub App
• View setup guide

Error

❌ Connection error

Possible causes:

• Token expired
• App uninstalled
• Repository access revoked
• API rate limit exceeded

Actions:

• Re-authenticate
• Check app installation
• Review permissions

AI Features

Configure OpenAI integration for AI-powered features:

OpenAI API Key

1. Get API Key

   Create key at platform.openai.com/api-keys

2. Add to Environment

   Update .env.local:

   OPENAI_API_KEY=sk-proj-...
   
3. Verify in Settings

   Settings shows:

   • ✅ API key configured
   • Model: gpt-4o-mini
   • Features enabled

AI-Powered Features

When OpenAI configured, enables:

Smart File Matching

Feature: AI finds correct YAML file for deployment

How it works:

1. Analyzes deployment spec
2. Reads repository files
3. GPT-4o-mini calculates match scores
4. Suggests best match

Fallback: Pattern-based matching if API unavailable

Issue Explanations

Feature: AI explains critical cluster issues

How it works:

1. Detects issue (OOMKill, CrashLoop, etc.)
2. Collects context (logs, events, specs)
3. GPT-4o-mini analyzes problem
4. Provides explanation and solutions

Example:

Issue: Pod repeatedly OOMKilled

Explanation:
Your pod is exceeding its 512Mi memory limit due to a 
memory leak in the application. The Java heap size is 
configured to use 1GB but the pod limit is only 512Mi.

Solutions:
1. Increase memory limit to 1Gi
2. Reduce Java heap size to 400m
3. Investigate memory leak with profiler

Troubleshooting Chat

Feature: Interactive AI assistant for debugging

How it works:

1. User describes problem
2. AI asks clarifying questions
3. Analyzes logs, events, manifests
4. Suggests solutions step-by-step

Usage: Click “AI Troubleshoot” button on resources

Repository Analysis

Feature: AI understands repo structure

How it works:

1. Scans repository
2. Identifies structure (Helm, Kustomize, plain YAML)
3. Maps deployments to files
4. Suggests improvements

Example:

Structure detected: Kustomize
Base: k8s/base/
Overlays: k8s/overlays/production/

Mapped deployments:
- api-gateway → k8s/base/api-gateway/deployment.yaml
- user-service → k8s/base/user-service/deployment.yaml

AI Usage & Costs

Token Usage

Estimated costs (gpt-4o-mini):

• File matching: ~500 tokens = $0.0001
• Issue explanation: ~1000 tokens = $0.0002
• Troubleshooting chat: ~2000 tokens/message = $0.0004
• Repository analysis: ~5000 tokens = $0.001

Total typical monthly cost: $1-5

Costs depend on usage frequency and repository size

Rate Limits

OpenAI rate limits (Tier 1):

• 500 requests/minute
• 30,000 tokens/minute

Orphelix automatically:

• Queues requests
• Retries on rate limit
• Shows progress indicators

Privacy

Data sent to OpenAI:

• Deployment specifications (YAML)
• Pod logs (last 100 lines)
• Event messages
• File contents from repository

NOT sent:

• Secret values (masked)
• Passwords or tokens
• Full cluster state

Review OpenAI’s privacy policy if handling sensitive data

Design

Customize Orphelix appearance:

Theme Mode

Light Mode

Appearance: Bright, high contrast

Best for:

• Daytime use
• Well-lit environments
• Presentations

Colors:

• Background: White
• Text: Dark gray
• Primary: Purple/Blue

Dark Mode

Appearance: Low contrast, easy on eyes

Best for:

• Extended use
• Low-light environments
• Late night work

Colors:

• Background: Dark gray
• Text: Light gray
• Primary: Purple/Blue

Default theme

System

Appearance: Follows OS preference

Behavior:

• Auto-switches based on system
• Detects OS dark mode setting
• Updates in real-time

Best for: Consistency with OS

Visual Preset

Choose UI style:

Classic

Style: Traditional flat design

Features:

• Solid backgrounds
• Sharp borders
• High contrast
• Faster rendering

Best for: Performance, accessibility

Liquid Glass

Style: Modern glassmorphism

Features:

• Frosted glass effects
• Subtle shadows
• Backdrop blur
• Gradient accents

Best for: Modern aesthetic, visual appeal

Default preset

Sidebar

Customize sidebar behavior:

• Auto-collapse: Collapse on small screens
• Pin favorite pages: Quick access menu
• Show icons only: Compact mode
• Default width: Sidebar width (200-300px)

Animations

Control UI animations:

• Enable animations: Smooth transitions
• Reduce motion: Minimal animations (accessibility)
• Animation speed: Fast, Normal, Slow

Saving Settings

Auto-save

Most settings save automatically:

• Theme changes
• Auto-refresh interval
• Sidebar preferences

No save button needed

Manual Save

Some settings require save:

• Cluster aliases
• Notification preferences
• GitHub repository selection

Click “Save” button after changes

Persistence

Settings stored in:

• Browser: LocalStorage (theme, sidebar)
• Database: SQLite (aliases, notifications)
• Environment: .env.local (API keys)

Sync: Settings sync across browser tabs

Exporting/Importing Settings

1. Export Settings

   Click “Export Settings” button

   Downloads orphelix-settings.json:

   {
     "theme": "dark",
     "visualPreset": "liquid-glass",
     "autoRefresh": 30,
     "aliases": [
       {
         "context": "prod",
         "name": "🚀 Production"
       }
     ],
     "notifications": {
       "enabled": true,
       "types": ["deployments", "pods", "nodes"]
     }
   }
   
2. Import Settings

   Click “Import Settings” button

   Upload orphelix-settings.json file

   Overwrites current settings

3. Share with Team

   Distribute settings file to team:

   # Commit to repo
   git add .orphelix/settings.json
   git commit -m "Add Orphelix team settings"
   
   # Team members import file
   

Resetting Settings

Resetting settings cannot be undone. Export first if needed.

1. Open Reset Dialog

   Click “Reset All Settings” button at bottom

2. Confirm Reset

   Checkbox: “I understand this will reset all settings”

   Click “Reset”

3. Settings Cleared

   All settings return to defaults:

   • Theme: Dark
   • Visual Preset: Liquid Glass
   • Auto-refresh: 30s
   • Aliases: None
   • Notifications: Disabled

Next Steps

Cluster Connection

Configure cluster access

GitHub Setup

Set up GitHub integration

Demo Mode

Explore demo mode

Dashboard

Back to dashboard