Qubinode KVM Host Setup Collection Documentation

Welcome to the comprehensive documentation for the Qubinode KVM Host Setup Collection - an Ansible collection that provides automated setup and management of KVM hosts on RHEL-based systems.

This documentation follows the Diátaxis framework to provide you with exactly the information you need, when you need it.

📚 Tutorials

Learning-oriented guides

Step-by-step tutorials to help you learn by doing. Perfect for newcomers who want to get started with the collection.

Tutorials - Learning-Oriented Guides
🛠️ How-To Guides

Problem-oriented guides

Practical solutions for specific problems. Use these when you have a particular goal to accomplish.

How-To Guides - Problem-Oriented Solutions
👨‍💻 Developer Guides

Contribution-oriented guides

Everything you need to contribute to the project, from setting up your development environment to submitting pull requests.

Developer How-To Guides - Contribution-Oriented
📖 Reference

Information-oriented documentation

Complete technical specifications, API documentation, and configuration references.

Reference Documentation - Technical Specifications
💡 Explanations

Understanding-oriented documentation

Architecture, design decisions, and concepts that help you understand how and why the collection works.

Explanations - Understanding-Oriented Documentation
🚀 Quick Start

Get started in 10 minutes

Rapid setup guide for experienced users who want to get running immediately.

Quick Start Guide

Quick Navigation

Start your journey here:

  1. Quick Start Guide - Get running in 10 minutes

  2. Your First KVM Host Setup - Comprehensive beginner guide

  3. Basic Network Configuration - Learn networking

  4. Storage Pool Creation - Manage storage

Solve specific problems:

Contribute to the project:

  1. Development Environment - Set up dev environment

  2. Run Tests - Testing procedures

  3. Contributing Guidelines - Contribution process

  4. Architecture Overview - Understand the design

Collection Overview

The Qubinode KVM Host Setup Collection provides:

  • Automated KVM Host Setup: Complete automation for RHEL-based KVM hosts

  • Modular Architecture: Nine specialized roles for different aspects of setup

  • Platform Support: RHEL 8/9/10, Rocky Linux, AlmaLinux

  • Comprehensive Testing: Molecule-based testing framework

  • Production Ready: Used in enterprise environments

Key Features

Feature

Description

Base System Setup

RHEL detection, package management, EPEL configuration

Network Configuration

Bridge creation, interface management, connectivity validation

Virtualization Setup

Libvirt configuration, KVM optimization, hardware detection

Storage Management

Storage pools, LVM configuration, performance tuning

Web Interface

Cockpit installation, SSL configuration, user management

User Environment

Shell configuration, SSH setup, development tools

Installation

# Install from Ansible Galaxy
ansible-galaxy collection install tosin2013.qubinode_kvmhost_setup_collection

# Quick setup
ansible-playbook -i localhost, -c local -b \
  -e admin_user=$USER \
  ~/.ansible/collections/ansible_collections/tosin2013/qubinode_kvmhost_setup_collection/playbooks/kvmhost_setup.yml

Support and Community

Documentation Structure

This documentation is organized according to the Diátaxis framework, which provides four types of documentation based on user needs:

Indices and tables