GitHub Integration Overview

Enable GitOps workflows with GitHub integration

What is GitHub Integration?

GitHub integration allows you to edit Kubernetes YAML files and create Pull Requests directly from Orphelix, following GitOps best practices.

Benefits

GitOps Workflow

Follow GitOps best practices with version-controlled infrastructure

YAML Editor

Edit Kubernetes manifests with Monaco editor and syntax highlighting

Pull Requests

Automatically create and manage PRs from the dashboard

Kustomize Support

Detect and edit Kustomize base & overlay structures

Features

YAML Editing

• Monaco Editor - VSCode-like editing experience
• Syntax Highlighting - YAML and Kubernetes schema validation
• Auto-completion - Smart suggestions for Kubernetes resources
• Error Detection - Real-time validation of YAML syntax

Smart File Matching

Orphelix can automatically find the correct YAML file for each deployment using AI-powered matching

Two matching methods:

1. AI-Powered (OpenAI) - Uses GPT-4o-mini to intelligently match deployments to files
2. Pattern-based - Fallback method using naming patterns

Pull Request Workflow

1. Edit YAML

   Make changes in the Monaco editor

2. Save Changes

   Click “Create Pull Request”

3. Automatic PR

   Orphelix creates a PR with your changes

4. Review & Merge

   Review in GitHub, then merge when ready

Authentication Methods

GitHub App (Recommended)

Why GitHub App?

More Secure

Fine-grained repository access - choose exactly which repos to grant access

Organization-Friendly

Centralized permission management, no personal tokens

Better Rate Limits

Higher API rate limits than OAuth

Independent Identity

App has its own identity, not tied to a personal account

Setup: See GitHub App Setup

OAuth (Legacy)

OAuth Authentication

Traditional OAuth flow with full repository access.

OAuth requires granting access to ALL repositories. GitHub App is recommended for better security.

Features:

• Simpler setup process
• Works with personal repositories
• Immediate access after authorization

Limitations:

• All-or-nothing repository access
• Lower API rate limits
• Tied to personal GitHub account

Use Cases

1. Update Deployment Image

# Before
spec:
  containers:
  - name: app
    image: myapp:v1.0.0

# After (edit in Orphelix)
spec:
  containers:
  - name: app
    image: myapp:v1.1.0

2. Adjust Resource Limits

# Edit resources directly in dashboard
resources:
  limits:
    memory: "1Gi"    # Updated from 512Mi
    cpu: "1000m"     # Updated from 500m
  requests:
    memory: "512Mi"
    cpu: "250m"

3. Update ConfigMap Values

# Edit configuration without kubectl
data:
  APP_ENV: "production"
  LOG_LEVEL: "info"    # Updated from "debug"
  CACHE_TTL: "3600"    # Added new config

Requirements

1. GitHub Account

   Personal or organization account

2. Repository Access

   Read/write access to your Kubernetes manifests repository

3. OpenAI API Key (Optional)

   For AI-powered file matching (recommended but not required)

Getting Started

Set up GitHub App

Recommended method for secure integration

Use YAML Editor

Learn how to edit Kubernetes manifests

Create Pull Requests

Manage PRs from the dashboard

Security

Credentials Storage

• GitHub App tokens stored in HTTP-only cookies
• Tokens never exposed to browser JavaScript
• Automatic token refresh every 8 hours

Repository Access

• Granular repository permissions
• Read + Write access only to selected repos
• Can revoke access anytime from GitHub settings

API Security

• All GitHub API calls server-side
• No direct browser-to-GitHub communication
• Rate limiting protection

FAQ

Can I use multiple GitHub accounts?

Yes! You can install the GitHub App on multiple accounts (personal + organizations) and switch between them in the repository selector.

What permissions does the GitHub App need?

• Contents: Read and write (to read/edit files)
• Pull Requests: Read and write (to create PRs)
• Metadata: Read-only (automatically set by GitHub)

Can I edit files in private repositories?

Yes! GitHub App works with both public and private repositories.

What if my repo uses Kustomize?

Orphelix automatically detects Kustomize structure and shows base + overlay files in separate tabs.

Next Steps

Set up GitHub App

Follow the step-by-step setup guide