Product SiteDocumentation Site

Apache CloudStack 4.2.0

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
http://www.apache.org/licenses/LICENSE-2.0
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.
Abstract
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 Regions
2.2. About Zones
2.3. About Pods
2.4. About Clusters
2.5. About Hosts
2.6. About Primary Storage
2.7. About Secondary Storage
2.8. About Physical Networks
2.8.1. Basic Zone Network Traffic Types
2.8.2. Basic Zone Guest IP Addresses
2.8.3. Advanced Zone Network Traffic Types
2.8.4. Advanced Zone Guest IP Addresses
2.8.5. Advanced Zone Public IP Addresses
2.8.6. System Reserved IP Addresses
3. Accounts
3.1. Accounts, Users, and Domains
3.1.1. Dedicating Resources to Accounts 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
5.2.5. Resetting SSH Keys
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 Regions (optional)
7.2.1. The First Region: The Default Region
7.2.2. Adding a Region
7.2.3. Adding Third and Subsequent Regions
7.2.4. Deleting a Region
7.3. Adding a Zone
7.3.1. Basic Zone Configuration
7.3.2. Advanced Zone Configuration
7.4. Adding a Pod
7.5. Adding a Cluster
7.5.1. Add Cluster: KVM or XenServer
7.5.2. Add Cluster: vSphere
7.6. Adding a Host
7.6.1. Adding a Host (XenServer or KVM)
7.6.2. Adding a Host (vSphere)
7.7. Add Primary Storage
7.7.1. System Requirements for Primary Storage
7.7.2. Adding Primary Storage
7.7.3. Configuring a Storage Plug-in
7.8. Add Secondary Storage
7.8.1. System Requirements for Secondary Storage
7.8.2. Adding Secondary Storage
7.8.3. Adding an NFS Secondary Staging Store for Each Zone
7.9. 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
8.2.1. Creating a New System Service Offering
8.3. Network Throttling
8.4. Changing the Default System Offering for System VMs
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
9.4.1. Creating a New Network Offering
10. Working With Virtual Machines
10.1. About Working with Virtual Machines
10.2. Best Practices for Virtual Machines
10.2.1. Monitor VMs for Max Capacity
10.2.2. Install Required Tools and Drivers
10.3. VM Lifecycle
10.4. Creating VMs
10.5. Accessing VMs
10.6. Stopping and Starting VMs
10.7. Assigning VMs to Hosts
10.7.1. Affinity Groups
10.8. Virtual Machine Snapshots for VMware
10.8.1. Limitations on VM Snapshots
10.8.2. Configuring VM Snapshots
10.8.3. Using VM Snapshots
10.9. Changing the VM Name, OS, or Group
10.10. Appending a Display Name to the Guest VM’s Internal Name
10.11. Changing the Service Offering for a VM
10.11.1. CPU and Memory Scaling for Running VMs
10.11.2. Updating Existing VMs
10.11.3. Configuring Dynamic CPU and RAM Scaling
10.11.4. How to Dynamically Scale CPU and RAM
10.11.5. Limitations
10.12. Resetting the Virtual Machine Root Volume on Reboot
10.13. Moving VMs Between Hosts (Manual Live Migration)
10.14. Deleting VMs
10.15. Working with ISOs
10.15.1. Adding an ISO
10.15.2. Attaching an ISO to a VM
10.15.3. Changing a VM's Base Image
11. Working With Hosts
11.1. Adding Hosts
11.2. Scheduled Maintenance and Maintenance Mode for Hosts
11.2.1. vCenter and Maintenance Mode
11.2.2. XenServer and Maintenance Mode
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. Over-Provisioning and Service Offering Limits
11.8.1. Limitations on Over-Provisioning in XenServer and KVM
11.8.2. Requirements for Over-Provisioning
11.8.3. Setting Over-Provisioning Ratios
11.8.4. Service Offering Limits and Over-Provisioning
11.9. VLAN Provisioning
11.9.1. VLAN Allocation Example
11.9.2. Adding Non Contiguous VLAN Ranges
11.9.3. Assigning VLANs to Isolated Networks
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. System Preparation 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. Working With Volumes
13.4.1. Creating a New Volume
13.4.2. Uploading an Existing Volume to a Virtual Machine
13.4.3. Attaching a Volume
13.4.4. Detaching and Moving Volumes
13.4.5. VM Storage Migration
13.4.6. Resizing Volumes
13.4.7. Reset VM to New Root Disk on Reboot
13.4.8. Volume Deletion and Garbage Collection
13.5. Working with Snapshots
13.5.1. Automatic Snapshot Creation and Retention
13.5.2. Incremental Snapshots and Backup
13.5.3. Volume Status
13.5.4. Snapshot Restore
13.5.5. Snapshot Job Throttling
13.5.6. VMware Volume Snapshot Performance
14. Working with Usage
14.1. Configuring the Usage Server
14.2. Setting Usage Limits
14.3. Globally Configured Limits
14.4. Limiting Resource Usage
14.4.1. User Permission
14.4.2. Limit Usage Considerations
14.4.3. Limiting Resource Usage in a Domain
14.4.4. Default Account Resource 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.5.3. Configuring a Shared Guest Network
15.6. Using Multiple Guest Networks
15.6.1. Adding an Additional Guest Network
15.6.2. Reconfiguring Networks in VMs
15.6.3. Changing the Network Offering on a Guest Network
15.7. IP Reservation in Isolated Guest Networks
15.7.1. IP Reservation Considerations
15.7.2. Limitations
15.7.3. Best Practices
15.7.4. Reserving an IP Range
15.8. Reserving Public IP Addresses and VLANs for Accounts
15.8.1. Dedicating IP Address Ranges to an Account
15.8.2. Dedicating VLAN Ranges to an Account
15.9. Configuring Multiple IP Addresses on a Single NIC
15.9.1. Use Cases
15.9.2. Guidelines
15.9.3. Assigning Additional IPs to a VM
15.9.4. Port Forwarding and StaticNAT Services Changes
15.10. About Multiple IP Ranges
15.11. About Elastic IP
15.12. Portable IPs
15.12.1. About Portable IP
15.12.2. Configuring Portable IPs
15.12.3. Acquiring a Portable IP
15.12.4. Transferring Portable IP
15.13. Multiple Subnets in Shared Network
15.13.1. Prerequisites and Guidelines
15.13.2. Adding Multiple Subnets to a Shared Network
15.14. Isolation in Advanced Zone Using Private VLAN
15.14.1. About Private VLAN
15.14.2. Prerequisites
15.14.3. Creating a PVLAN-Enabled Guest Network
15.15. Security Groups
15.15.1. About Security Groups
15.15.2. Adding a Security Group
15.15.3. Security Groups in Advanced Zones (KVM Only)
15.15.4. Enabling Security Groups
15.15.5. Adding Ingress and Egress Rules to a Security Group
15.16. External Firewalls and Load Balancers
15.16.1. About Using a NetScaler Load Balancer
15.16.2. Configuring SNMP Community String on a RHEL Server
15.16.3. Initial Setup of External Firewalls and Load Balancers
15.16.4. Ongoing Configuration of External Firewalls and Load Balancers
15.16.5. Load Balancer Rules
15.16.6. Configuring AutoScale
15.17. Global Server Load Balancing Support
15.17.1. About Global Server Load Balancing
15.17.2. Configuring GSLB
15.17.3. Known Limitation
15.18. Guest IP Ranges
15.19. Acquiring a New IP Address
15.20. Releasing an IP Address
15.21. Static NAT
15.21.1. Enabling or Disabling Static NAT
15.22. IP Forwarding and Firewalling
15.22.1. Firewall Rules
15.22.2. Egress Firewall Rules in an Advanced Zone
15.22.3. Port Forwarding
15.23. IP Load Balancing
15.24. DNS and DHCP
15.25. Remote Access VPN
15.25.1. Configuring Remote Access VPN
15.25.2. Using Remote Access VPN with Windows
15.25.3. Using Remote Access VPN with Mac OS X
15.25.4. Setting Up a Site-to-Site VPN Connection
15.26. About Inter-VLAN Routing (nTier Apps)
15.27. Configuring a Virtual Private Cloud
15.27.1. About Virtual Private Clouds
15.27.2. Adding a Virtual Private Cloud
15.27.3. Adding Tiers
15.27.4. Configuring Network Access Control List
15.27.5. Adding a Private Gateway to a VPC
15.27.6. Deploying VMs to the Tier
15.27.7. Deploying VMs to VPC Tier and Shared Networks
15.27.8. Acquiring a New IP Address for a VPC
15.27.9. Releasing an IP Address Alloted to a VPC
15.27.10. Enabling or Disabling Static NAT on a VPC
15.27.11. Adding Load Balancing Rules on a VPC
15.27.12. Adding a Port Forwarding Rule on a VPC
15.27.13. Removing Tiers
15.27.14. Editing, Restarting, and Removing a Virtual Private Cloud
15.28. Persistent Networks
15.28.1. Persistent Network Considerations
15.28.2. Creating a Persistent Guest Network
16. Working with System Virtual Machines
16.1. The System VM Template
16.2. Accessing System VMs
16.3. Multiple System VM Support for VMware
16.4. Console Proxy
16.4.1. Using a SSL Certificate for the Console Proxy
16.4.2. Changing the Console Proxy SSL Certificate and Domain
16.5. Virtual Router
16.5.1. Configuring the Virtual Router
16.5.2. Upgrading a Virtual Router with System Service Offerings
16.5.3. Best Practices for Virtual Routers
16.6. Secondary Storage VM
17. System Reliability and High Availability
17.1. HA for Management Server
17.2. Management Server Load Balancing
17.3. HA-Enabled Virtual Machines
17.4. HA for Hosts
17.4.1. Dedicated HA Hosts
17.5. Primary Storage Outage and Data Loss
17.6. Secondary Storage Outage and Data Loss
17.7. Limiting the Rate of API Requests
17.7.1. Configuring the API Request Rate
17.7.2. Limitations on API Throttling
18. Managing the Cloud
18.1. Using Tags to Organize Resources in the Cloud
18.2. Changing the Database Configuration
18.3. Changing the Database Password
18.4. Administrator Alerts
18.4.1. Sending Alerts to External SNMP and Syslog Managers
18.5. Customizing the Network Domain Name
18.6. Stopping and Restarting the Management Server
19. Setting Configuration Parameters
19.1. About Configuration Parameters
19.2. Setting Global Configuration Parameters
19.3. Setting Local Configuration Parameters
19.4. Granular 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. Event Notification
22.1.3. Standard Events
22.1.4. Long Running Job Events
22.1.5. Event Log Queries
22.1.6. Deleting and Archiving Events and Alerts
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