ProxShift

OpenShift clusters on Proxmox made simple

---

Project maintained by randyoyarzabal Hosted on GitHub Pages — Theme by mattgraham

ProxShift

Welcome to ProxShift - OpenShift clusters on Proxmox made simple.

Table of Contents

Getting Started

• Prerequisites - System requirements and virtual environment setup
• Setup Guide - Complete installation and configuration
• Environment Guide - Virtual environments and shell integration
• Welcome Guide - Comprehensive introduction

User Guides

• Architecture - How ProxShift works under the hood
• Template Generation - Preview manifests before provisioning
• Vault Guide - Secret management with HashiCorp Vault
• Backup & Restore - Certificate backup and restore
• Migration Notes - Version upgrade guidance
• Modular Tasks - Understanding ProxShift’s task structure

Advanced Topics

• Function Reference - Complete command reference
• System Requirements - Detailed system requirements
• Cluster Login Refactoring - Authentication improvements
• Demo Guide - Demonstration scenarios

Reference

• Changelog - Version history and changes

Quick Start

New to ProxShift? Start here:

1. Prerequisites - System requirements and virtual environment setup
2. Setup Guide - Complete installation and configuration
3. Environment Guide - Virtual environments and shell integration
4. Quick Examples - Common commands

Quick Examples

Single Node OpenShift (SNO)

cd /path/to/proxshift
source proxshift.sh  # Auto-activates virtual environment
ps.provision my-sno-cluster

Compact Cluster (3 masters)

ps.provision my-compact-cluster

Full Production Cluster (3 masters + 3 workers)

ps.provision my-production-cluster

Preview Templates Only

ps.generate_manifests my-sno-cluster --dry-run

Supported Cluster Types

ProxShift supports various OpenShift cluster configurations:

• Single Node OpenShift (SNO) - Single node clusters for edge, development, and testing
• Compact Clusters - Multi-master clusters for small production environments
• Standard Clusters - Full production clusters with masters and workers

Each cluster type can be customized in your inventory/clusters.yml configuration file.

Common Operations

# Load ProxShift (auto-activates venv)
source proxshift.sh

# List available clusters
ps.clusters

# Start/stop VMs
ps.start my-sno-cluster
ps.deprovision my-sno-cluster

# Generate templates only
ps.generate_manifests my-sno-cluster

# Full provisioning with preview
ps.provision my-sno-cluster --dry-run
ps.provision my-sno-cluster

Prerequisites

Essential setup requirements:

• Python 3.8+ with virtual environment (avoids “pip externally managed” errors)
• System packages for NFS/SMB mounting (varies by OS)
• OpenShift tools (installer and CLI binaries)
• Infrastructure access (Proxmox API, Vault, DNS)

Complete Prerequisites Guide

How It Works

ProxShift uses:

• Inventory-driven - All clusters in inventory/clusters.yml
• Universal templates - No per-cluster files to maintain
• Auto-detection - SNO vs multi-node, IPs, roles
• Portable - Works from any directory

---

ProxShift - Where Proxmox meets OpenShift

GitHub: https://github.com/randyoyarzabal/proxshift