Karios

Getting Started

  • Introduction
    • Installation
      • Overview
      • System Requirements
        • Hardware Considerations
        • Processor Recommendations
        • Production Hardware Recommendations
      • Pre-Installation Planning
        • Understanding Virtualization Constraints
        • Critical Platform Dependencies
        • Bhyve Hardware Dependencies
        • Resource Planning Considerations
        • Nested Virtualization Limitations
        • Planning Considerations
        • Preparing Your Hardware and Software
      • Installation Process
        • Critical Filesystem Requirements
        • Understanding ZFS RAID Levels and Configuration
        • ZFS Swap Calculation Formula
        • Karios BSD Installation with ZFS
        • Karios Bootstrap Auto-Installation
        • Auto-Bootstrap Installation
      • Post-Installation Configuration
        • Retrieving Saved Credentials
        • Accessing the Karios Interface
        • Supported Web Browsers
      • Installation Troubleshooting
        • Getting Help
      • Next Steps
      • Browser Certificate Setup
        • Download the Root CA Certificate
        • Install on Windows
        • Install on macOS
        • Install on Linux (Ubuntu/Debian)
        • Install on Linux (RHEL/CentOS/Fedora)
        • Mozilla Firefox (All Platforms)
        • Verification
      • Next Steps
    • Control Node Registration
      • Overview
      • Prerequisites
      • Registration Steps
        • Step 1: Basic Information (Required)
        • Step 2: Optional Information
      • Completing Registration
      • After Registration
    • Welcome to Karios!
    • Beyond Virtualization
    • Core Philosophy
    • Hardware Requirements
      • Absolute Minimum Configuration
      • Recommended Configuration
      • Ideal Configuration
    • Next Steps

Getting Started

  • User Guide
    • Getting Started as a User
      • Accessing the System - Logging In & Registration
      • Account Recovery:
      • Configure Prerequisites
      • Interface Overview
    • User Management & Permissions
      • RBAC Architecture and Design Philosophy
      • Predefined Role Definitions
      • Role Assignment and Management Procedures
      • Role Creation Process
      • Predefined Roles Display
        • System Roles
        • Custom Roles
        • Role Actions
      • User Registration Process
      • User Account Management
        • User Status Management
        • Account Status Types
        • Role Assignment Display
        • Approval Workflow Management
      • Role Assignment Strategies
        • Full Access Implementation
        • Specialized Access Implementation
      • User Lifecycle Management
        • Account Activation Process
        • Account Maintenance
    • Two-Factor Management
    • Best Practices
      • Account Management
      • License Compliance
      • System Usage
      • Operational Guidelines
    • Web Interface Navigation
      • Dashboard Overview
      • Storage Management Operations
        • MooseFS Storage
        • S3 Storage
        • iSCSI Storage
        • NFS Storage
        • SMB Storage
        • Storage Operations
        • ISO Operations:
        • ISO Management Features:
      • Stats Management Operations
        • Stats Navigation Structure
        • Live Statistics Monitoring
        • Node Statistics Display
        • Virtual Machine Statistics
        • Recommendations System
        • Recommendation Details
        • Statistics Table Features
        • Performance Monitoring Capabilities
    • Node Level Management
      • Navigating to Node Level
      • Home Dashboard
        • System Information
        • Add-in Card and PCIe Devices
        • Storage System Overview
        • Network Interface Management
        • Chassis View
      • Node Console Management
        • Console Overview
        • Console Access and Authentication
        • Console Operations and Commands
        • Console Best Practices
        • Console Support and Documentation
      • ISO Management
      • PCIe Devices
        • Overview
        • What is PCIe?
        • Physical vs Virtual Functions
        • Virtual Function Management
        • Common Use Cases
        • Troubleshooting Common Issues
      • Node Storage Management
        • Storage Pool Management
        • Storage Pool Operations
        • ZFS Advanced Features
      • Node Monitoring
        • Time Range Selection
        • CPU Usage Monitoring
        • Memory Usage Monitoring
        • Storage Usage Monitoring
        • Performance Analytics
        • Historical Performance Analysis
      • Network Management
        • Network Interface Configuration
        • Virtual Switch Management
        • Switch Creation and Configuration
        • Network Configuration Best Practices
      • Firewall Management
        • Packet Filter Rules Interface
        • Firewall Rule Components
        • Packet Filter Management - Simple Mode
        • Rule Editing and Modification - Advanced Mode
        • Change Confirmation System Safety Mechanism:
      • Node Log Management
        • Log Viewer Dashboard
        • Log Filtering and Search
        • Log Export and Management
      • FreeBSD Debug Framework
        • Overview
        • Key Features
        • Command-Line Interface
        • Menu Options
        • CLI Features
        • Diagnostic Tools
        • Output Management
        • Automatic Cleanup
        • Configuration and Extensibility
        • Common Issues
        • Performance Considerations
        • Best Practices
        • Data Handling Considerations
      • Support Bundle Collection Instructions
        • Collection Process
        • Email Template
        • Handling the Support Bundle
        • Troubleshooting Collection Issues
        • Archive Information
    • Virtual Machine Management
      • VM Creation Overview
      • Standard VM Setup
      • Windows Virtual Machine Installation Guide
        • Prerequisites
        • Installation Steps
        • Post-Creation Steps
      • Cloud-Init VM Setup
      • VM Basic Configuration
      • SSH Key Authentication
      • VM Access Best Practices
      • VM Deployment Process
        • Pre-Deployment Validation
        • VM Creation Process
        • Post-Creation Verification
      • VM Lifecycle Management
      • VM Console Access
      • VM Snapshot Management
      • VM Bhyve Logs
      • VM Monitoring
      • VM Maintenance
      • VM Console Access
      • VM Snapshot Management
      • VM Monitoring
      • VM Maintenance
    • PCIe Device Passthrough - GPU and NIC Passthrough
      • Overview
      • GPU Passthrough
        • Hardware Requirements
        • System Requirements
      • GPU Passthrough Use Cases
        • Graphics and Rendering
        • Scientific Computing
      • NIC Passthrough
        • Benefits of NIC Passthrough
      • NIC Passthrough Use Cases
        • Network Appliances
        • High-Performance Applications
        • Development and Testing
      • Hardware Planning
        • Device Allocation
        • VM Resource Planning
      • Hardware Access Considerations
        • Access Control
        • Isolation Verification
      • Troubleshooting
        • IOMMU Problems
        • Device Recognition
        • Performance Issues
      • Monitoring and Maintenance
        • Device Health
        • System Impact
    • Virtual Machine CLI Commands
      • VM Creation and Configuration
        • Basic VM Creation
      • VM Management Operations
        • Starting and Stopping VMs
        • VM Status and Information
      • Resource Management
        • CPU and Memory Management
      • Network Configuration
        • Virtual Switch Operations
      • Template Management
        • Creating and Managing Templates
      • VM Console and Access
        • Console Management
      • VM Monitoring and Logs
        • Performance Monitoring
    • VLAN Interface Configuration
      • Creating VLAN Interfaces
      • Assigning IP Addresses
      • Making Configuration Persistent
    • ZFS CLI Commands
      • Pool Related Commands
      • Show File System Info
      • Mount/Umount Related Commands
      • Import/Export Commands
      • Clone Commands
      • Show Pool Information
      • File-system/Volume Related Commands
      • Set ZFS File System Properties
      • ZFS I/O Performance
      • ZFS Maintenance Commands
      • Snapshot Commands
    • Firewall CLI Commands
      • General Commands
      • Loading Rules
      • Flushing Rules
      • Showing Information
      • Debugging
      • Statistics
      • Tables
      • Common Usage Examples
      • Network Traffic Monitoring
    • Storage and File Sharing CLI Commands
      • Network File System (NFS)
      • Server Message Block (SMB/CIFS)
      • Internet Small Computer Systems Interface (iSCSI)
      • MooseFS Distributed File System
    • Karios Management Commands
      • Backend APIs
      • Database and Infrastructure Services
    • API Integration
      • API Authentication and Usage Guide
      • Swagger API Documentation Guide
      • Response Information
      • Common Response Codes

Getting Support

  • Getting Support
    • Overview
    • Creating a Discourse Account
      • Step 1: Navigate to Discourse
      • Step 2: Begin Registration
      • Step 3: Email Verification
    • Creating a Support Ticket
      • Access the Forum
      • Create New Topic
      • Submit Your Ticket
    • What Happens Next
    • Best Practices for Support Tickets
    • Getting Help with Discourse
    • Additional Support Channels

Technitium DHCP & DNS Setup Guide

  • Network Setup Prerequisites
    • Technitium Overview
    • Migration Recommendations (Recommended)
      • Pre-Migration Network Assessment
      • Migrating from Existing DHCP Server
    • Getting Started with Technitium DNS Server
      • Accessing the Technitium Web Interface
  • DHCP Server Configuration
    • Initial Access and Navigation
    • DHCP Server Configuration
    • Managing DHCP Scopes
    • DHCP Lease Management
    • Advanced DHCP Configuration
  • DNS Configuration
    • DNS Zones Management
    • DNS Records Management
    • DNS Zone Operations
    • Advanced DNS Configuration
    • View MAC Addresses and DHCP Information

Networking

  • Karios Integrated Network
    • Overview
      • Challenges Without Karios
      • How Karios Transforms Networking
      • What Makes Karios Essential
    • Core Network Components
      • Physical Interfaces
        • Overview
        • Monitoring Capabilities
        • Notes
      • Virtual Switches
        • Overview
        • Key Uses
        • Switch Management in Karios
        • Switch Lifecycle
        • Considerations
        • Best Practices
      • VALE High-Speed Network Switch
        • Overview
        • Key Caveats
        • Management in Karios
        • Connectivity Models
        • Best Practices
        • Recovery if Misconfigured
        • Use Cases
      • Virtual Local Area Networks (VLANs)
        • Overview
        • What VLANs Are in Karios
        • VLAN Dashboard in Karios
        • Connectivity & Status Tracking
        • Best Practices in Karios
        • How VLANs Fit Into the Bigger Picture
    • Troubleshooting and Best Practices
      • Performance Optimization Guidelines
      • Common Issues and Resolution Strategies
    • Conclusion

Integrated Firewall

  • Integrated Firewall
    • What is PF (Packet Filter)
      • Key Features
      • PF History & Evolution
    • PF: High-Level Architecture
      • Enabling PF on FreeBSD
      • PF Rule Processing Order & Syntax
        • pfctl Command Summary
        • Loading/Reloading Rulesets
        • Checking PF Status
        • Flushing/Resetting
        • Table Management (Dynamic IP Lists)
        • Logging & Debugging
      • pf.conf File Anatomy
        • 1. Macros
        • 2. Tables
        • 3. Options
        • 4. Filter Rules
        • Basic “Default Deny” Setup
      • Managing ICMP Traffic in PF
        • What is ICMP?
        • Basic Secure ICMP Rules
    • Overview of pf.conf Usage in the Application (Karios)
      • Why PF Matters for Karios
      • Key Features in Karios’s PF Setup
      • Configuration Concepts
        • 1. External Interface Declaration
        • Basic Defaults and Optimizations
        • SSH Access
        • Web & App Services (HTTP, HTTPS, etc.)
        • Outbound Rules
      • Anti-Spoofing
      • NAT & Port Redirection (Advanced Sample)
      • Blacklisting and Blocking
    • Simple PF UI Examples and Explanations
      • External Interface Configuration
      • Global Set Options
    • Basic Traffic Rules
      • ICMP Traffic
      • Default Blocking
      • Outbound Connections
      • Anti-Spoofing Protection
    • SSH Rules
      • Basic SSH Access
      • SSH Brute-Force Protection
    • Application Ports
    • NAT / Redirect Rules
      • Standard NAT Configuration
      • Port Redirection
    • Tables
      • Trusted Networks
      • Blacklist Table
      • SSH Guard Table
      • Include Rules
        • Modular Configuration
    • FAQ Section
    • Common Mistakes & Gotchas
    • Additional References

Kubernetes Integration

  • Kubernetes on Karios
    • Introduction
    • Sidero Kubernetes Overview
    • OmniServer Deployment
    • Cluster Installation
    • Manual Removal of Keycloak Jail Deployment
    • Overview
    • Removal Procedure
    • Command Explanation
    • Post-Removal Notes
    • OpenShift Overview
    • Creating the OpenShift Cluster
    • OpenShift Without DHCP
      • Prerequisites
      • Installation Steps
    • Configuration Summary
    • Open Source Kubernetes Overview
    • Create the Ubuntu Kubernetes Virtual-Machines Cluster
    • Accessing the Tech Stack
      • 3.2.1 Prometheus and Grafana
      • 3.3.2 ArgoCD
    • Create the K3s Cluster
    • 4.0 About K3s (Lightweight Kubernetes)
      • 4.1 Create the K3s Cluster
        • 4.1.1 Create the Cluster Machine in Karios UI
        • 4.1.2 Enter Cluster Details
        • 4.1.3 Add a Bootstrap Node
        • 4.1.4 Add Additional Server Nodes (K3s Control Plane)
        • 4.1.5 Add Worker Nodes
        • 4.1.6 Wait for Cluster VMs to Become Ready
        • 4.1.7 Verify Cluster High Availability
      • 4.2.1 Prometheus and Grafana
        • 4.2.1.1 Verify Deployment
        • 4.2.1.2 Access Grafana Dashboard
        • 4.2.1.3 Access Prometheus Dashboard
      • 4.4 Next Steps
    • Next Steps

Storage & Data Management

  • Local Storage - ZFS (Zettabyte File System)
    • Pool Architecture
      • Fundamental Concepts
      • Storage Pool Design Philosophy
        • Virtual Device (VDEV) Hierarchy
        • Copy-on-Write (COW) Transaction Model
        • Merkle Tree Structure
      • Pool Composition and Scaling
        • Scaling Characteristics
    • Disk Layout Types
      • Mirror VDEVs
        • Theoretical Foundation
        • Implementation Details
        • Performance Characteristics
      • RAID-Z Implementation
        • RAID-Z1 (Single Parity)
        • RAID-Z2 (Double Parity)
        • RAID-Z3 (Triple Parity)
      • Striped Configuration
    • ZVols (ZFS Volumes)
      • Block Device Abstraction
      • Implementation Architecture
        • Virtual Block Device
        • DMU Integration
      • Use Cases and Characteristics
    • Snapshots and Properties
      • Copy-on-Write Snapshot Implementation
      • Snapshot Hierarchy and Management
      • Properties System
        • Property Types
    • Data Integrity and Checksums
      • End-to-End Checksumming
        • Cryptographic Hash Functions
      • Self-Healing Architecture
      • Scrubbing Process
    • Encryption
      • ZFS Native Encryption Architecture
      • Key Management Framework
        • Key Formats
      • Encryption Implementation
        • Block-Level Encryption
      • File-Level vs Pool-Level Considerations
    • ARC (Adaptive Replacement Cache) Memory Management
      • ARC Algorithm Foundation
        • Adaptive Replacement
      • Cache Management Logic
      • Memory Pressure Handling
      • L2ARC (Level 2 ARC)
    • ZFS Properties, Features, and Internal Operations
      • Property System Architecture
        • Property Sources
      • Feature Flag System
        • Feature Activation
      • Internal Operations
    • Interactions with FreeBSD
      • Kernel Integration
      • Command-Line Tools
        • zpool Command
        • zfs Command
      • System Integration
      • Dump and Recovery
    • Performance, Redundancy, Failure Handling, and Recovery
      • Performance Characteristics
        • I/O Scheduling
        • Prefetching
      • Redundancy Implementation
        • Data Redundancy
      • Failure Detection and Response
        • Proactive Monitoring
        • Automated Response
      • Recovery Mechanisms
        • Resilver Process
        • Import Recovery
        • Data Recovery Options
      • Advanced Recovery Scenarios
        • Pool Import Force
        • Device Replacement Strategies
  • Storage Client Protocols on FreeBSD
    • Understanding Storage Client Protocols
      • What are Storage Client Protocols?
      • Why Do We Need Different Storage Protocols?
      • Basic Concepts You Need to Know
    • MooseFS (Moose File System)
      • What is MooseFS?
      • How MooseFS Works
        • Master Server (The Brain)
        • Chunkservers (The Storage Workers)
        • Clients (The Users)
      • MooseFS on FreeBSD
        • Installation and Setup
        • Configuration Basics
      • Understanding MooseFS Features
        • Data Replication (Goals)
        • Automatic Load Balancing
        • Self-Healing
      • Caching in MooseFS
        • Client-Side Caching
        • Attribute Caching
      • When to Use MooseFS
        • Ideal Scenarios
        • Not Ideal For
      • Virtual Machine Storage with MooseFS
        • How VMs Use MooseFS
        • Benefits for VMs
        • Performance Considerations
    • NFS (Network File System)
      • What is NFS?
      • How NFS Works
        • Basic Operation Flow
      • NFS on FreeBSD
        • Native FreeBSD NFS Features
        • Setting Up NFS Server on FreeBSD
        • Setting Up NFS Client on FreeBSD
      • Understanding NFS Caching
        • Client-Side Caching
        • Close-to-Open Consistency
      • NFS Access Control
        • Host-Based Access Control
        • Kerberos Authentication
      • Virtual Machine Storage with NFS
        • VM Disk Storage Models
        • Benefits for Virtual Machines
        • Performance Considerations
      • When to Use NFS
        • Ideal Scenarios
        • Consider Alternatives When
    • S3 (Simple Storage Service) Compatible Storage
      • What is S3?
      • Object Storage vs File Storage
        • Traditional File Storage
        • Object Storage
      • S3-Compatible Solutions on FreeBSD
        • MinIO
        • Ceph RadosGW
      • Understanding S3 Concepts
        • Buckets
        • Objects
        • Keys
      • S3 API Basics
        • Common Operations
      • S3 Caching Strategies
        • Client-Side Caching
        • CDN Caching
        • Gateway Caching
      • Encryption Options
        • Server-Side Encryption (SSE)
        • Client-Side Encryption (CSE)
        • Transport Encryption
      • Virtual Machine Storage with S3
        • VM Images as Objects
        • Benefits for VMs
        • Challenges
      • When to Use S3 Storage
        • Ideal Scenarios
        • Consider Alternatives When
    • SMB/CIFS (Server Message Block)
      • What is SMB/CIFS?
      • SMB Protocol Evolution
        • SMB1/CIFS (1984-1996)
        • SMB2 (2006)
        • SMB3 (2012)
        • SMB3.1.1 (2015)
      • Understanding SMB Features
        • SMB Direct (RDMA)
        • SMB Multichannel
        • Persistent Handles
      • SMB Caching Mechanisms
        • Client-Side Caching
        • Server-Side Optimization
      • Virtual Machine Storage with SMB
        • Benefits for VMs
        • Performance Considerations
      • When to Use SMB/CIFS
        • Ideal Scenarios
        • Consider Alternatives When
    • iSCSI (Internet Small Computer System Interface)
      • What is iSCSI?
      • iSCSI vs Other Storage Protocols
        • Block-Level vs File-Level Access
        • Benefits of Block-Level Access
      • iSCSI Architecture
        • Components
      • iSCSI on FreeBSD
        • iSCSI Target (Server) Setup
        • iSCSI Initiator (Client) Setup
      • Understanding iSCSI Features
        • Authentication Methods
        • Multiple Connections per Session (MC/S)
        • Error Recovery Levels
      • Virtual Machine Storage with iSCSI
        • VM Disk Configuration
        • Benefits for VMs
        • Performance Considerations
      • When to Use iSCSI
        • Ideal Scenarios
        • Consider Alternatives When
    • Storage Protocol Comparison and Selection Guide
      • Performance Comparison
        • Latency (Lower is Better)
        • Throughput (Higher is Better)
      • Scalability Comparison
        • Horizontal Scaling (Adding More Servers)
        • Vertical Scaling (More Powerful Servers)
      • Encryption Comparison
        • Built-in Encryption
        • Authentication Strength
      • Use Case Recommendations
        • Virtual Machine Storage
        • File Sharing
        • Backup and Archive
        • High-Performance Computing
        • Web Content
        • Database Storage
    • Decision Matrix
      • Primary Factors
      • Secondary Factors
    • FreeBSD-Specific Considerations
      • Native Support
      • ZFS Integration
      • Performance on FreeBSD
    • Conclusion
      • Protocol Selection Summary

Appendices

  • Appendices
    • Common Installation Issues
    • Obtaining UI Password from the CLI
    • Basic Operations
    • Getting Full Access
Karios
  • Search

© Copyright 2024, Karios Team.