Home

Joblet Wiki

Welcome to the Joblet documentation! This is a high-performance distributed job execution system built in Go that provides secure remote command execution with comprehensive resource management and real-time monitoring capabilities.

🚀 Quick Start

• Installation Guide - Get up and running quickly
• Basic Usage - Learn the fundamentals
• CLI Reference - Complete command reference

📚 Core Documentation

Architecture & Design

• System Architecture - High-level system design and components
• Security Model - Authentication, authorization, and isolation
• Process Isolation - Namespace and cgroup isolation details
• Resource Management - CPU, memory, and I/O limiting

Development & Operations

• Development Setup - Setting up development environment
• Deployment Guide - Production deployment strategies
• Configuration Reference - All configuration options
• Troubleshooting - Common issues and solutions

API & Integration

• gRPC API - Complete API documentation
• Platform Abstraction - Cross-platform compatibility layer
• Authentication & Authorization - Certificate-based security

🛠️ Advanced Topics

• Performance Tuning - Optimize for your workload
• Monitoring & Observability - Logging and metrics
• Contributing - How to contribute to the project
• Changelog - Version history and changes

🔧 Key Features

Feature	Description
🎛️ Advanced Resource Management	Linux Cgroups v2 with CPU, memory, and I/O bandwidth limiting
🔒 Process Isolation	PID, mount, IPC, and UTS namespaces per job
🌐 Host Networking	Jobs use host network interface for maximum compatibility
📡 Real-Time Operations	Live log streaming and comprehensive monitoring
🔐 Mutual TLS Security	Certificate-based authentication with role-based access
⚡ High Performance	gRPC communication with configurable limits

💡 Use Cases

• CI/CD Pipelines - Execute build and deployment jobs with resource limits
• Batch Processing - Run data processing tasks with isolation
• Development Environments - Provide isolated development containers
• Microservice Testing - Test services in controlled environments
• Educational Platforms - Safe code execution for learning environments

🏗️ Architecture Overview

┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
│   RNX Client    │────│  Joblet Server  │────│   Job Process   │
│  (Admin/Viewer) │    │  (TLS + Auth)   │    │   (Linux Only)  │
└─────────────────┘    └─────────────────┘    └─────────────────┘
                               │                        │
                               │                        │
                       ┌───────▼────────┐      ┌────────▼────────┐
                       │  State Store   │      │  Process Mgmt   │
                       │  (In-Memory)   │      │ (Namespaces +   │
                       └────────────────┘      │   Cgroups)      │
                                               └─────────────────┘

🎯 Quick Example

# Start a simple job
rnx run echo "Hello, World!"

# Run with resource limits
rnx run --max-cpu=50 --max-memory=512 python3 script.py

# Monitor job status
rnx list
rnx log <job-id>

# Stop a job
rnx stop <job-id>

📖 Getting Help

• Issues: Report bugs and request features on GitHub Issues
• Discussions: Ask questions in GitHub Discussions
• Security: Report security issues privately to the maintainers

---

Note: This system requires Linux for full functionality. macOS is supported for RNX client and limited development use only.