Apache CloudStack Documentation

Apache CloudStack is an open-source Infrastructure as a Service (IaaS) platform designed to deploy and manage large networks of virtual machines. It provides compute orchestration, Network-as-a-Service, user and account management, a native API, resource accounting, and a User Interface (UI).

Supported hypervisors include:

• VMware vSphere
• KVM
• XenServer
• XenProject
• Hyper-V
• OVM
• LXC containers

Apache CloudStack is an open-source Infrastructure-as-a-Service (IaaS) orchestration platform. It manages virtual machines across various hypervisors (KVM, VMware, XenServer/XCP-ng, Hyper-V, baremetal-bridge, OVM) and various storage types (NFS, Ceph/RBD, iSCSI, SMB, primary-storage plugins, S3-compatible secondary storage).

Key components include:

• Management Server: A Java/Tomcat-style servlet server backed by MariaDB/MySQL that exposes a signed REST/JSON API.
• Agents: Software running on each hypervisor host to orchestrate resources.
• System VMs: Specialized VMs including the Secondary Storage VM, Console Proxy VM, and virtual routers.
• Authorization: Uses RBAC (Role-Based Access Control) combined with a multi-tenant domain/account/project hierarchy.

Apache CloudStack is a distributed IaaS control plane, not a single-binary appliance or a hosted SaaS. A typical deployment consists of:

• Management Servers: One or more instances. Smaller clouds use a single instance; larger deployments use a cluster behind a load balancer.
• Database: A MariaDB or MySQL instance.
• Usage Server: One instance.
• System VMs: An optional set of VMs including SecondaryStorageVM, ConsoleProxyVM, and VirtualRouter.
• Agents/Bridges: A cloudstack-agent running on each hypervisor host (for KVM/baremetal) or out-of-process resource bridges (for VMware, XenServer, XCP-ng, or Hyper-V).

The operator is responsible for managing the surrounding networks (management, public, guest, and storage networks) and the physical hosts.

The CloudStack UI uses Less for styling. The main entry point is src/styles/index.less, which imports Ant Design Vue styles along with custom variables and rules.

Key entry points for Less files include:

• dist/antd.less: Imports everything via index.less and components.less.
• lib/style/index.less:
  • themes/default.less: Contains color/colors and default theme @variables.
  • core/index.less: Includes base styles, motion rules, and iconfont.

To use the DevCloud4 environment, you must manually configure three Host-Only network adapters in VirtualBox settings. Navigate to the Network tab and then the Host-only Networks tab, and configure the adapters as follows:

Handle deployment images in the UI:

Templates:

• Register or upload local templates
• Edit, copy, or delete templates
• Update template permissions
• Download templates

ISOs:

• Register or upload local ISOs
• Edit, copy, or delete ISOs
• Download ISOs

Kubernetes ISOs:

• Enable/disable Kubernetes ISOs
• Add specific Kubernetes versions

After creating an extension, you must deploy your executable to the management server. CloudStack resolves the executable in this order:

1. <extensionPath>/<extensionName>.sh (Preferred)
2. <extensionPath> (if it is a regular executable file)

The <extensionPath> is typically /usr/share/cloudstack-management/extensions/<extensionName>/. If you have multiple management servers, the script must be deployed to every one.

SCRIPT_PATH=$(cmk listExtensions name=my-sdn | jq -r '.[0].path')
# e.g. /usr/share/cloudstack-management/extensions/my-sdn/
mkdir -p "${SCRIPT_PATH}"
cp my-sdn.sh "${SCRIPT_PATH}/my-sdn.sh"
chmod 755    "${SCRIPT_PATH}/my-sdn.sh"

The rdpconsole project provides a Java-based command-line interface for basic VNC, RDP, and HyperV (RDP) clients. You can invoke the client using the java common.Client command followed by the protocol type and necessary options.

java common.Client vnc|rdp|hyperv OPTIONS