Product SiteDocumentation Site

Apache CloudStack 4.0.1-incubating

CloudStack Administrator's Guide

Edition 1

Apache CloudStack

Legal Notice

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Apache CloudStack is an effort undergoing incubation at The Apache Software Foundation (ASF).
Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
Administration Guide for CloudStack.

1. Concepts
1.1. What Is CloudStack?
1.2. What Can CloudStack Do?
1.3. Deployment Architecture Overview
1.3.1. Management Server Overview
1.3.2. Cloud Infrastructure Overview
1.3.3. Networking Overview
2. Cloud Infrastructure Concepts
2.1. About Zones
2.2. About Pods
2.3. About Clusters
2.4. About Hosts
2.5. About Primary Storage
2.6. About Secondary Storage
2.7. About Physical Networks
2.7.1. Configurable Characteristics of Physical Networks
2.7.2. Basic Zone Network Traffic Types
2.7.3. Basic Zone Guest IP Addresses
2.7.4. Advanced Zone Network Traffic Types
2.7.5. Advanced Zone Guest IP Addresses
2.7.6. Advanced Zone Public IP Addresses
2.7.7. System Reserved IP Addresses
3. Accounts
3.1. Accounts, Users, and Domains
3.2. Using an LDAP Server for User Authentication
3.2.1. Example LDAP Configuration Commands
3.2.2. Search Base
3.2.3. Query Filter
3.2.4. Search User Bind DN
3.2.5. SSL Keystore Path and Password
4. User Services Overview
4.1. Service Offerings, Disk Offerings, Network Offerings, and Templates
5. User Interface
5.1. Log In to the UI
5.1.1. End User's UI Overview
5.1.2. Root Administrator's UI Overview
5.1.3. Logging In as the Root Administrator
5.1.4. Changing the Root Password
5.2. Using SSH Keys for Authentication
5.2.1. Creating an Instance Template that Supports SSH Keys
5.2.2. Creating the SSH Keypair
5.2.3. Creating an Instance
5.2.4. Logging In Using the SSH Keypair
6. Using Projects to Organize Users and Resources
6.1. Overview of Projects
6.2. Configuring Projects
6.2.1. Setting Up Invitations
6.2.2. Setting Resource Limits for Projects
6.2.3. Setting Project Creator Permissions
6.3. Creating a New Project
6.4. Adding Members to a Project
6.4.1. Sending Project Membership Invitations
6.4.2. Adding Project Members From the UI
6.5. Accepting a Membership Invitation
6.6. Suspending or Deleting a Project
6.7. Using the Project View
7. Steps to Provisioning Your Cloud Infrastructure
7.1. Overview of Provisioning Steps
7.2. Adding a Zone
7.2.1. Basic Zone Configuration
7.2.2. Advanced Zone Configuration
7.3. Adding a Pod
7.4. Adding a Cluster
7.4.1. Add Cluster: KVM or XenServer
7.4.2. Add Cluster: vSphere
7.5. Adding a Host
7.5.1. Adding a Host (XenServer or KVM)
7.5.2. Adding a Host (vSphere)
7.6. Add Primary Storage
7.6.1. System Requirements for Primary Storage
7.6.2. Adding Primary Stroage
7.7. Add Secondary Storage
7.7.1. System Requirements for Secondary Storage
7.7.2. Adding Secondary Storage
7.8. Initialize and Test
8. Service Offerings
8.1. Compute and Disk Service Offerings
8.1.1. Creating a New Compute Offering
8.1.2. Creating a New Disk Offering
8.1.3. Modifying or Deleting a Service Offering
8.2. System Service Offerings
9. Setting Up Networking for Users
9.1. Overview of Setting Up Networking for Users
9.2. About Virtual Networks
9.2.1. Isolated Networks
9.2.2. Shared Networks
9.2.3. Runtime Allocation of Virtual Network Resources
9.3. Network Service Providers
9.4. Network Offerings
10. Working With Virtual Machines
10.1. About Working with Virtual Machines
10.2. Best Practices for Virtual Machines
10.3. VM Lifecycle
10.4. Creating VMs
10.5. Accessing VMs
10.6. Stopping and Starting VMs
10.7. Changing the VM Name, OS, or Group
10.8. Changing the Service Offering for a VM
10.9. Moving VMs Between Hosts (Manual Live Migration)
10.10. Deleting VMs
10.11. Working with ISOs
10.11.1. Adding an ISO
10.11.2. Attaching an ISO to a VM
11. Working With Hosts
11.1. Adding Hosts
11.2. Scheduled Maintenance and Maintenance Mode for Hosts
11.3. Disabling and Enabling Zones, Pods, and Clusters
11.4. Removing Hosts
11.4.1. Removing XenServer and KVM Hosts
11.4.2. Removing vSphere Hosts
11.5. Re-Installing Hosts
11.6. Maintaining Hypervisors on Hosts
11.7. Changing Host Password
11.8. Host Allocation
11.9. VLAN Provisioning
12. Working with Templates
12.1. Creating Templates: Overview
12.2. Requirements for Templates
12.3. Best Practices for Templates
12.4. The Default Template
12.5. Private and Public Templates
12.6. Creating a Template from an Existing Virtual Machine
12.7. Creating a Template from a Snapshot
12.8. Uploading Templates
12.9. Exporting Templates
12.10. Creating a Windows Template
12.10.1. System Preparation for Windows Server 2008 R2
12.10.2. Sysprep for Windows Server 2003 R2
12.11. Importing Amazon Machine Images
12.12. Converting a Hyper-V VM to a Template
12.13. Adding Password Management to Your Templates
12.13.1. Linux OS Installation
12.13.2. Windows OS Installation
12.14. Deleting Templates
13. Working With Storage
13.1. Storage Overview
13.2. Primary Storage
13.2.1. Best Practices for Primary Storage
13.2.2. Runtime Behavior of Primary Storage
13.2.3. Hypervisor Support for Primary Storage
13.2.4. Storage Tags
13.2.5. Maintenance Mode for Primary Storage
13.3. Secondary Storage
13.4. Using Swift for Secondary Storage
13.5. Working with Snapshots
14. Working with Usage
14.1. Configuring the Usage Server
14.2. Setting Usage Limits
14.3. Globally Configured Limits
14.4. Default Account Resource Limits
14.5. Per-Domain Limits
15. Managing Networks and Traffic
15.1. Guest Traffic
15.2. Networking in a Pod
15.3. Networking in a Zone
15.4. Basic Zone Physical Network Configuration
15.5. Advanced Zone Physical Network Configuration
15.5.1. Configure Guest Traffic in an Advanced Zone
15.5.2. Configure Public Traffic in an Advanced Zone
15.6. Using Multiple Guest Networks
15.6.1. Adding an Additional Guest Network
15.6.2. Changing the Network Offering on a Guest Network
15.7. Security Groups
15.7.1. About Security Groups
15.7.2. Adding a Security Group
15.7.3. Enabling Security Groups
15.7.4. Adding Ingress and Egress Rules to a Security Group
15.8. External Firewalls and Load Balancers
15.9. Load Balancer Rules
15.10. Guest IP Ranges
15.11. Acquiring a New IP Address
15.12. Releasing an IP Address
15.13. Static NAT
15.14. IP Forwarding and Firewalling
15.15. IP Load Balancing
15.16. DNS and DHCP
15.17. VPN
15.17.1. Configuring VPN
15.17.2. Using VPN with Windows
15.17.3. Using VPN with Mac OS X
15.17.4. Setting Up a Site-to-Site VPN Connection
15.18. About Inter-VLAN Routing
15.19. Configuring a Virtual Private Cloud
15.19.1. About Virtual Private Clouds
15.19.2. Adding a Virtual Private Cloud
15.19.3. Adding Tiers
15.19.4. Configuring Access Control List
15.19.5. Adding a Private Gateway to a VPC
15.19.6. Deploying VMs to the Tier
15.19.7. Acquiring a New IP Address for a VPC
15.19.8. Releasing an IP Address Alloted to a VPC
15.19.9. Enabling or Disabling Static NAT on a VPC
15.19.10. Adding Load Balancing Rules on a VPC
15.19.11. Adding a Port Forwarding Rule on a VPC
15.19.12. Removing Tiers
15.19.13. Editing, Restarting, and Removing a Virtual Private Cloud
16. Working with System Virtual Machines
16.1. The System VM Template
16.2. Multiple System VM Support for VMware
16.3. Console Proxy
16.4. Virtual Router
16.5. Secondary Storage VM
17. System Reliability and High Availability
17.1. HA for Management Server
17.2. HA-Enabled Virtual Machines
17.3. HA for Hosts
17.4. Primary Storage Outage and Data Loss
17.5. Secondary Storage Outage and Data Loss
18. Managing the Cloud
18.1. Using Tags to Organize Resources in the Cloud
18.2. Changing the Database Configuration
18.3. Administrator Alerts
18.4. Customizing the Network Domain Name
18.5. Stopping and Restarting the Management Server
19. Setting Global Configuration Parameters
20. CloudStack API
20.1. Provisioning and Authentication API
20.2. Allocators
20.3. User Data and Meta Data
21. Tuning
21.1. Performance Monitoring
21.2. Increase Management Server Maximum Memory
21.3. Set Database Buffer Pool Size
21.4. Set and Monitor Total VM Limits per Host
21.5. Configure XenServer dom0 Memory
22. Troubleshooting
22.1. Events
22.1.1. Event Logs
22.1.2. Standard Events
22.1.3. Long Running Job Events
22.1.4. Event Log Queries
22.2. Working with Server Logs
22.3. Data Loss on Exported Primary Storage
22.4. Recovering a Lost Virtual Router
22.5. Maintenance mode not working on vCenter
22.6. Unable to deploy VMs from uploaded vSphere template
22.7. Unable to power on virtual machine on VMware
22.8. Load balancer rules fail after changing network offering
A. Time Zones
B. Event Types
C. Alerts
D. Revision History