Cloudmin Documentation

First Things First

How to use the documentation - Start here. It provides a brief (about one page) overview of the conventions and organization of the Cloudmin documentation.

Getting Started

Installation Guides - Automatic and manual installation procedures for Cloudmin.

Upgrading Cloudmin Software - Upgrading Cloudmin and related software from within Cloudmin and from the command line.

Getting Started With Cloudmin - Machine and network configuration needed to run Cloudmin.

Creating IP Pools - Defining global IP ranges for assignment to virtual systems.

Replication - Setting up backup Cloudmin masters.

Bridged Networking Setup - Creating a network bridge for sites that don't allow VMs to be directly connected, like Hetzner.

About Cloudmin - Basic introduction and feature list.

Cloudmin Glossary - Terms used in Cloudmin and its documentation.

Cloudmin GPL - Installing and using the free Xen-only version of Cloudmin.

Cloudmin Roadmap - Future plans for Cloudmin.


Introduction to Virtualization Concepts - Introductory coverage of virtualization concepts, types of virtualization, and how Cloudmin interacts with virtualized cloud servers.

Setting Up Linux Open Source Xen Virtualization - Using Cloudmin with Linux open source Xen virtualized systems.

Setting Up Citrix Xen Virtualization - Using Cloudmin with Citrix Xen virtualized systems.

Setting Up Linux OpenVZ Virtualization - Using Cloudmin with Linux OpenVZ virtual containers.

Setting Up KVM Virtualization - Using Cloudmin with Linux KVM instances.

Setting Up Linux LXC Virtualization - Using Cloudmin with Linux LXC containers.

Setting Up Docker Virtualization - Using Cloudmin with Docker containers.

Setting Up Solaris/OpenSolaris Zones Virtualization - Using Cloudmin with Solaris/OpenSolaris Zones.

Setting Up Linux VServer Virtualization - Using Cloudmin with Linux vserver virtual containers.

Setting Up LVM for Xen or KVM - How to store Xen or KVM disk images in LVM logical volumes

Multiple Interfaces for Xen - How to connect multiple host system interfaces to Xen systems

Xen Kernels - Booting a kernel from the virtual system with Xen

Empty Systems - Installing any operating system into an empty Xen or KVM instance

Location Groups - Simplifying host system allocation with location groups

Virtual Machine Management

Using Cloudmin - An introduction to various tasks in Cloudmin.

Downloading System Images - How to download Virtual Machine images for products such as Xen, VServers, and Zones.

Registering Host Systems - Preparing your server for virtualization.

Virtualmin Licenses - Setting up your Virtualmin licenses in Cloudmin.

Creating an Open Source Xen Virtual Machine - How to create a new Xen Virtual Machine.

Creating an Citrix Xen Virtual Machine - How to create a new Citrix Xen VM.

Creating a KVM Virtual Machine - How to create a new KVM Virtual Machine.

Managing Virtual Domains - Using the Cloudmin interface to create, find, and manage domains on your Virtual Machines.

Replicating Virtual Domains - Using Cloudmin to replicate Virtualmin domains and settings between systems.

Backing Up Virtual Domains - Using Cloudmin to backup Virtualmin domains and settings on multiple systems.

Creating a VServers Virtual Machine - How to create a VServers Virtual Machine.

Creating a Solaris Zones Virtual Machine - How to create a Solaris Zones Virtual Machine.

Create FreeBSD Systems - How to create a virtual system running FreeBSD on a KVM host.

Making Your Own Images - How to create your own images for Virtual Server products such as Xen, VServers, and Zones.

Cloning Systems - How to easily duplicate an existing virtual system.

Backup and Restore - Backing up Cloudmin systems on schedule.

Automatic Failovers - Creating failover groups to handle host system failures.

Roundrobin DNS Records - Creating automatically updated DNS records that resolve to multiple systems, and web proxies that forward to multiple systems.

Cloudmin API and Development

Command Line API - Using the command line tools for managing Cloudmin instances.

Remote API - Using the remote API for managing Cloudmin instances.

Amazon EC2

Adding an EC2 Account - Information on Amazon's EC2, and how to setup an EC2 account.

Creating an EC2 Virtual Machine - How to create an Amazon EC2 Virtual Machine.

Creating an EC2 Image - How to create an Amazon EC2 Machine Image (AMI).

EC2 Security Groups - Creating and managing EC2 firewall security groups.

EC2 Static IP Addresses - Creating and assigning EC2 static addresses.

EC2 Volumes - Creating and assigning EC2 elastic block volumes.

Google Compute Engine

Adding a GCE Project - Information on Google Compute Engine, and how to create and register a project.

Creating a GCE Virtual Machine - How to create a GCE instance.

Creating a GCE Image - How to create a GCE instance Image.

GCE Disks - Creating and assigning GCE disks and snapshots.

System Resources

Managing Virtual Disks - Creating additional disks for Xen and KVM systems.

Managing RAM Limits - Setting limits on RAM usage.

Managing CPU Limits - Setting limits on CPU usage and virtual CPU cores.

Managing Bandwidth Limits - Restricting total network traffic and bandwidth.

Managing IO Classes - Setting the IO priority of a virtual system.

Managing Network Interfaces - Adding and changing IP addresses.

System Monitoring and Alerts - Setting up email notifications when systems go down or exceed thresholds.

Auto-Scaling Groups - Automatically creating systems in response to load.

Disk Image Directories - Defining additional directories for virtual system disks.

iSCSI Storage - Storing virtual system disks on an iSCSI server.

Disk Snapshots - Saving the state of virtual systems for later rollback.

System Owners and Plans

Account Plans - Defining limits on resource usage and functions.

System Owners - Accounts with limited access to Cloudmin.

Usage Accounting - Tracking total resource use by systems and owners.

Cloudmin Services

Introduction and Installation - What the Cloudmin Services does, and how to install it.

Host Systems - Setting up and adding host systems.

System Owners - Creating system owner accounts for service hosting.

Client Systems - Configuring Virtualmin client systems.

Services API - Calling the services API from your own code.

Contributed Documentation

Running Windows under Xen - How to install Windows into a Cloudmin-managed Xen instance, by Scott Grayban.