Welcome to Apache CloudStack’s Documentation — Apache CloudStack 4.22.0.0 documentation

Welcome to Apache CloudStack’s Documentation — Apache CloudStack 4.22.0.0 documentation
Welcome to Apache CloudStack’s Documentation
View page source
Welcome to Apache CloudStack’s Documentation
We have a number of guides, starting with a guide to cloudstack’s terminology and concepts, moving through some information about possible topologies. We then have a quick start guide to help you get a very simple cloudstack up and running. Followed by the full installation guide, an administrator’s guide and then further detailed guides on complex configurations.
Information can also be found at CloudStack’s wiki
and on cloudstack mailing lists
Contents:
CloudStack Concepts and Terminology
Concepts and Terminology
What is Apache CloudStack?
What can Apache CloudStack do?
Deployment Architecture Overview
CloudStack Terminology
Object Types in CloudStack
All Object Types in Apache CloudStack
Choosing a Deployment Architecture
Small-Scale Deployment
Large-Scale Redundant Setup
Separate Storage Network
Multi-Node Management Server
Multi-Site Deployment
Choosing a Hypervisor
Best Practices
Network Setup
Basic and Advanced Networking
VLAN Allocation Example
Example Hardware Configuration
Layer-2 Switch
Hardware Firewall
Management Server Load Balancing
Topology Requirements
Guest Network Usage Integration for Traffic Sentinel
Setting Zone VLAN and Running VM Maximums
Storage Setup
Introduction
Configurations
Storage Architecture
CloudStack Networking For Storage
Quick Installation Guide
Overview
What exactly are we building?
High-level overview of the process
Prerequisites
Environment
Operating System
NFS
Management Server Installation
Database Installation and Configuration
Installation
System Template Setup
KVM Setup and Installation
Prerequisites
Installation
KVM Configuration
Configuration
UI Access
Setting up a Zone
Zone Type
Zone Details
Physical Network
Public Traffic
Pod Configuration
Guest Traffic
Cluster
Host
Installation Guide
Building from Source
Introduction
Downloading the Release
Verifying the Downloaded Release
Prerequisites for building Apache CloudStack
Extracting source
Install new MySQL connector
Building DEB packages
Building RPMs from Source
Building Non-OSS
General Installation
Installation overview
Management Server Installation
Configuration
Configuring your CloudStack Installation
Hypervisor Setup
Custom Hypervisor Installation
Host Hyper-V Installation
Host KVM Installation
Host LXC Installation
Host VMware vSphere Installation
Host Citrix XenServer Installation
Optional Installation
Additional Installation Options
About Password and Key Encryption
Upgrading CloudStack
Upgrading CloudStack
Java version upgraded to Java 17
Java Version Requirement
MySQL upgrade problems
Validate 4.22.0.0 source code tarball
Upgrade Instruction from 4.22.x
Overview of Upgrade Steps:
CloudStack Customisations
Update System VM Templates
Java Version Requirement
Packages repository
Database Preparation
Management Server
Upgrade Hypervisors
Restart management services
System VMs and Virtual Routers
Upgrade Instruction from 4.21.x
Overview of Upgrade Steps:
CloudStack Customisations
Update System VM Templates
Java Version Requirement
Packages repository
Database Preparation
Management Server
Upgrade Hypervisors
Restart management services
System VMs and Virtual Routers
Upgrade Instruction from 4.20.x
Overview of Upgrade Steps:
CloudStack Customisations
Update System VM Templates
Java Version Requirement
Packages repository
Database Preparation
Management Server
Upgrade Hypervisors
Restart management services
System VMs and Virtual Routers
Upgrade Instruction from 4.19.x
Overview of Upgrade Steps:
CloudStack Customisations
Update System VM Templates
Java Version Requirement
Packages repository
Database Preparation
Management Server
Upgrade Hypervisors
Restart management services
System VMs and Virtual Routers
Upgrade Instruction from 4.18.x
Overview of Upgrade Steps:
CloudStack Customisations
Update System VM Templates
Packages repository
Database Preparation
Management Server
Upgrade Hypervisors
Restart management services
System VMs and Virtual Routers
Upgrade Instruction from 4.17.x
Overview of Upgrade Steps:
CloudStack Customisations
Update System VM Templates
Packages repository
Database Preparation
Management Server
Upgrade Hypervisors
Restart management services
System VMs and Virtual Routers
Upgrade Instruction from 4.16.x
Overview of Upgrade Steps:
CloudStack Customisations
Update System VM Templates
Packages repository
Database Preparation
Management Server
Upgrade Hypervisors
Restart management services
System VMs and Virtual Routers
Upgrade Instruction from 4.15.x
Overview of Upgrade Steps:
CloudStack Customisations
Update System VM Templates
Packages repository
Database Preparation
Management Server
Upgrade Hypervisors
Restart management services
System VMs and Virtual Routers
Upgrade Instruction from 4.14.x
Overview of Upgrade Steps:
CloudStack Customisations
Update System VM Templates
Packages repository
Database Preparation
Management Server
Upgrade Hypervisors
Restart management services
System VMs and Virtual Routers
Upgrade Instruction from 4.13.x
Overview of Upgrade Steps:
CloudStack Customisations
Update System VM Templates
Java Version Requirement
Packages repository
Database Preparation
Management Server
Upgrade Hypervisors
Restart management services
System VMs and Virtual Routers
Upgrade Instruction from 4.12.x
Overview of Upgrade Steps:
CloudStack Customisations
Update System VM Templates
Java Version Requirement
Packages repository
Database Preparation
Management Server
Upgrade Hypervisors
Restart management services
System VMs and Virtual Routers
Upgrade Instruction from 4.11.x
Overview of Upgrade Steps:
CloudStack Customisations
Update System VM Templates
Java Version Requirement
Packages repository
Database Preparation
Management Server
Upgrade Hypervisors
Restart management services
System VMs and Virtual Routers
Upgrade Instruction from 4.10.x
Overview of Upgrade Steps:
CloudStack Customisations
Update System VM Templates
Java Version Requirement
Packages repository
Database Preparation
Management Server
Upgrade Hypervisors
Restart management services
System VMs and Virtual Routers
Upgrade Instruction from 4.9.x
Overview of Upgrade Steps:
CloudStack Customisations
Update System VM Templates
Java Version Requirement
Packages repository
Database Preparation
Management Server
Upgrade Hypervisors
Restart management services
System VMs and Virtual Routers
Upgrade Instruction from 4.8.x
Update System VM Templates
Java Version Requirement
Packages repository
Database Preparation
Management Server on Ubuntu
Management Server on CentOS/RHEL
Hypervisor: XenServer
Hypervisor: VMware
Hypervisor: KVM
Restart management services
Upgrade Instruction from 4.7.x
Packages repository
Update System VM Templates
Java Version Requirement
Database Preparation
Management Server on Ubuntu
Management Server on CentOS/RHEL
Hypervisor: XenServer
Hypervisor: VMware
Hypervisor: KVM
Restart management services
Upgrade Instruction from 4.6.x
Packages repository
Update System VM Templates
Java Version Requirement
Database Preparation
Management Server on Ubuntu
Management Server on CentOS/RHEL
Hypervisor: XenServer
Hypervisor: VMware
Hypervisor: KVM
Restart management services
Upgrade Instruction from 4.5.x
CloudStack Customisations
Update System VM Templates
Java Version Requirement
Packages repository
Database Preparation
Management Server on Ubuntu
Management Server on CentOS/RHEL
Hypervisor: XenServer
Hypervisor: VMware
Hypervisor: KVM
Restart management services
System VMs and Virtual Routers
Upgrade Instruction from 4.4.x
Packages repository
Update System VM Templates
Java Version Requirement
Database Preparation
Management Server on Ubuntu
Management Server on CentOS/RHEL
Hypervisor: XenServer
Hypervisor: VMware
Hypervisor: KVM
Restart management services
System VMs and Virtual Routers
Upgrade Instruction from 4.3.x
Packages repository
Update System VM Templates
Java Version Requirement
Database Preparation
Management Server on Ubuntu
Management Server on CentOS/RHEL
Hypervisor: XenServer
Hypervisor: VMware
Hypervisor: KVM
Restart management services
System VMs and Virtual Routers
Usage Guide
User Interface
Log In to the UI
Instance Image Selection Customisation
Managing Accounts, Users and Domains
Roles, Accounts, Users, and Domains
Using Dynamic Roles
Dedicating Resources to Accounts and Domains
How to Dedicate a Zone, Cluster, Pod, or Host to an Account or Domain
Using an LDAP Server for User Authentication
Using a SAML 2.0 Identity Provider for User Authentication
Using OAuth2 Authentication For Users
Using Two Factor Authentication For Users
Password Recovery for Users (Forgot Password)
Using API Key and Secret Key based Authentication
Using Projects to Organize User Resources
Overview of Projects
Configuring Projects
Creating a New Project
Adding Members to a Project
Working with Project Roles
Accepting a Membership Invitation
Suspending or Deleting a Project
Using the Project View
Service Offerings
Service Offerings, Disk Offerings, Network Offerings, and Templates
Compute and Disk Service Offerings
System Service Offerings
Network Throttling
Changing the Default System Offering for System VMs
Changing the Default System Offering for Virtual Routers
Setting up Networking for Users
Overview of Setting Up Networking for Users
About Virtual Networks
Network Service Providers
Network Offerings
Configuring AutoScale with the CloudStack Virtual Router
Working with Instances
About Working with Instances
Instance Lifecycle
Managing Instances
Instance Snapshots
Support for Virtual Appliances
Importing and Unmanaging Instances
Importing Virtual Machines From VMware into KVM
Instance Backups (Backup and Recovery Feature)
Using SSH Keys for Authentication
Assigning GPU/vGPU to Guest Instances
Instance Metrics
Working with Templates & ISOs
Working With Templates
Working with ISOs
Working with Clusters
Adding Clusters
CloudStack DRS
Working with Hosts
Adding Hosts
Scheduled Maintenance and Maintenance Mode for Hosts
Disabling and Enabling Zones, Pods, and Clusters
Removing Hosts
Re-Installing Hosts
Maintaining Hypervisors on Hosts
Hypervisor Capabilities
Discovering GPU Devices on KVM Hosts
Changing Host Password
Over-Provisioning and Service Offering Limits
VLAN Provisioning
Out-of-band Management
Security
Server Address Usage
Securing Process
KVM Libvirt Hook Script Include
KVM Rolling Maintenance
KVM Auto Enable/Disable Hosts
Working with Storage
Storage Overview
Primary Storage
Secondary Storage
Working With Volumes
Working with Volume Snapshots
Object Storage
Shared FileSystems
Working with System VMs
The System VM Template
System VM Template bundled with packages
Changing the Default System VM Template
Accessing System VMs
Multiple System VM Support for VMware
Console Proxy
Virtual Router
Secondary Storage VM
Migrating System VMs
Customizing System VMs
Troubleshoot networks from System VMs
Working with Usage
Working with Usage
Managing VM and Volume Allocation
Host and Storage Tags
Hosts/Cluster Arch Types Allocation
VM and Volume Allocators
Cluster, Pod and Host Ordering
Managing Networks and Traffic
Guest Traffic
Networking in a Pod
Networking in a Zone
Basic Zone Physical Network Configuration
Advanced Zone Physical Network Configuration
Editing, Restarting, and Removing a Guest Network
Using Multiple Guest Networks
Dynamic and Static Routing
Guest Network Permissions
IP Reservation in Isolated Guest Networks
Reserving Public IP Addresses and VLANs for Accounts
Configuring Multiple IP Addresses on a Single NIC
About Multiple IP Ranges
About Elastic IPs
Portable IPs
Multiple Subnets in Shared Network
Isolation in Advanced Zone Using Private VLANs
Security Groups
External Firewalls and Load Balancers
Global Server Load Balancing Support
Guest IP Ranges
Acquiring a New IP Address
Releasing an IP Address
Reserving a Public IP Address
Releasing a Reserved Public IP Address
Static NAT
IP Forwarding and Firewalling
IP Load Balancing
DNS and DHCP
Remote Access VPN
Limitations of Remote Access VPN
About Inter-VLAN Routing (nTier Apps)
Configuring a Virtual Private Cloud
Persistent Networks
Setup a Palo Alto Networks Firewall
Using Remote Access VPN
VNF Templates and Appliances
Managing the Cloud
Using Tags to Organize Resources in the Cloud
Using Comments on the Resources in the Cloud
Reporting CPU Sockets
Changing the Database Configuration
Changing the Database Password
File encryption type
Administrator Alerts
Customizing the Network Domain Name
Managing log files
Stopping and Restarting the Management Server
Management Server Statistics and Peers
System Reliability and Availability
HA for Management Server
Management Server Load Balancing
Multiple Management Servers Support on agents
HA-Enabled Instances
Dedicated HA Hosts
HA-Enabled Hosts
Primary Storage Outage and Data Loss
Secondary Storage Outage and Data Loss
Database High Availability
Tuning
Tuning
Events and Troubleshooting
Event Notification
TroubleShooting
Extensions
Extensions
In-built Orchestrator Extensions
Limitations
Troubleshooting Extensions
Writing Extensions for CloudStack
Best Practices
Best Practices
Developers Guide
CloudStack Installation from GIT repo for Developers
Prerequisites
Installing CloudStack from Source
Using the Simulator
Using Appliance for development
Building Packages
The CloudStack API
Conclusions
Programmer Guide
The CloudStack API
Event Types
Time Zones
Plugins
Storage Plugins
Allocators
Implementing a custom HostAllocator
Implementing a custom StoragePoolAllocator
Deploying CloudStack with Ansible
What is Ansible
There’s already Chef and Puppet, so what’s the fuss about Ansible?
So let’s see something
Installing Ansible
Playbooks
Modules
Planning
MySQL
CloudStack Management server service
System VM Templates:
Bringing it all together
How is this example different from a production deployment?
Acknowledgements
Getting Help
Documentation Available
Books
Support
Plugins Guide
The Cloudian Connector Plugin
Introduction to the Cloudian Connector Plugin
Connector Overview
Configuring the Cloudian Connector
Cloudian as CloudStack Secondary Storage
Adding Cloudian as CloudStack Secondary Storage
Revision History
The Nicira NVP Plugin
Introduction to the Nicira NVP Plugin
Configuring the Nicira NVP Plugin
Using the Nicira NVP plugin with VPC
Troubleshooting the Nicira NVP Plugin
Revision History
The VMware NSX Plugin
Introduction
Supported Versions
Configuration
The Netris Plugin
Introduction
Supported Versions
Configuration
The VXLAN Plugin
General
System Requirements / Networking for VXLAN
VXLAN using Multicast
VXLAN using EVPN
Setup zone using VXLAN
The OVS Plugin
Introduction to the OVS Plugin
Configuring the OVS Plugin
Using the OVS plugin with VPC
DPDK Support
Revision History
IPv6 Support in CloudStack
Shared network
Isolated network and VPC Network Tier
Quota Plugin
Enabling the Quota Service
Quota Tariff
Quota Credits
Quota Balance
Quota Statement
Quota Monthly Statement
Quota Alert Management
CloudStack Kubernetes Service
Enabling the Kubernetes Service
Kubernetes Supported Versions
Kubernetes clusters
Flexible Kubernetes Clusters
The CloudStack Kubernetes Provider
Introduction
Deployment
Usage
CloudStack CSI Driver
Features
Advanced Storage Features
Core Components
Release Notes
What’s New in 4.22.0.0
Known Issues
Changes in 4.22.0.0 since 4.21.0.0
Changes in 4.22.0.0 since 4.20.1.0
Changes in 4.22.0.0 since 4.20.0.0
Changes in 4.22.0.0 since 4.19.1.0
Compatibility Matrix
Supported OS Versions for Management Server
Supported Hypervisor Versions
Supported External Devices
Supported Browsers
Notice Of Management OSes and Hypervisors to be Deprecated
API Changes Introduced in 4.22.0.0
Parameters Changed API Commands
Other Documentation:
API Documentation
Apache CloudStack Wiki
Apache CloudStack web site
Apache CloudStack Source Code
Apache CloudStack on GitHub
Apache CloudStack Documentation on GitHub
Indices and Tables
Index
Search Page