Product SiteDocumentation Site

Apache CloudStack 4.2.0

CloudStack Installation 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
Installation 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. Building from Source
3.1. Getting the release
3.2. Verifying the downloaded release
3.2.1. Getting the KEYS
3.2.2. GPG
3.2.3. MD5
3.2.4. SHA512
3.3. Prerequisites for building Apache CloudStack
3.4. Extracting source
3.5. Building DEB packages
3.5.1. Setting up an APT repo
3.5.2. Configuring your machines to use the APT repository
3.6. Building RPMs from Source
3.6.1. Generating RPMS
3.7. Building Non-OSS
4. Installation
4.1. Who Should Read This
4.2. Overview of Installation Steps
4.3. Minimum System Requirements
4.3.1. Management Server, Database, and Storage System Requirements
4.3.2. Host/Hypervisor System Requirements
4.4. Configure package repository
4.4.1. DEB package repository
4.4.2. RPM package repository
4.5. Management Server Installation
4.5.1. Management Server Installation Overview
4.5.2. Prepare the Operating System
4.5.3. Install the Management Server on the First Host
4.5.4. Install the database server
4.5.5. About Password and Key Encryption
4.5.6. Changing the Default Password Encryption
4.5.7. Prepare NFS Shares
4.5.8. Prepare and Start Additional Management Servers
4.5.9. Prepare the System VM Template
4.5.10. Installation Complete! Next Steps
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. Steps to Provisioning Your Cloud Infrastructure
6.1. Overview of Provisioning Steps
6.2. Adding Regions (optional)
6.2.1. The First Region: The Default Region
6.2.2. Adding a Region
6.2.3. Adding Third and Subsequent Regions
6.2.4. Deleting a Region
6.3. Adding a Zone
6.3.1. Basic Zone Configuration
6.3.2. Advanced Zone Configuration
6.4. Adding a Pod
6.5. Adding a Cluster
6.5.1. Add Cluster: KVM or XenServer
6.5.2. Add Cluster: vSphere
6.6. Adding a Host
6.6.1. Adding a Host (XenServer or KVM)
6.6.2. Adding a Host (vSphere)
6.7. Add Primary Storage
6.7.1. System Requirements for Primary Storage
6.7.2. Adding Primary Storage
6.7.3. Configuring a Storage Plug-in
6.8. Add Secondary Storage
6.8.1. System Requirements for Secondary Storage
6.8.2. Adding Secondary Storage
6.8.3. Adding an NFS Secondary Staging Store for Each Zone
6.9. Initialize and Test
7. Setting Configuration Parameters
7.1. About Configuration Parameters
7.2. Setting Global Configuration Parameters
7.3. Setting Local Configuration Parameters
7.4. Granular Global Configuration Parameters
8. Hypervisor Installation
8.1. KVM Hypervisor Host Installation
8.1.1. System Requirements for KVM Hypervisor Hosts
8.1.2. KVM Installation Overview
8.1.3. Prepare the Operating System
8.1.4. Install and configure the Agent
8.1.5. Install and Configure libvirt
8.1.6. Configure the Security Policies
8.1.7. Configure the network bridges
8.1.8. Configure the network using OpenVswitch
8.1.9. Configuring the firewall
8.1.10. Add the host to CloudStack
8.1.11. Hypervisor Support for Primary Storage
8.2. Citrix XenServer Installation for CloudStack
8.2.1. System Requirements for XenServer Hosts
8.2.2. XenServer Installation Steps
8.2.3. Configure XenServer dom0 Memory
8.2.4. Username and Password
8.2.5. Time Synchronization
8.2.6. Licensing
8.2.7. Install CloudStack XenServer Support Package (CSP)
8.2.8. Primary Storage Setup for XenServer
8.2.9. iSCSI Multipath Setup for XenServer (Optional)
8.2.10. Physical Networking Setup for XenServer
8.2.11. Upgrading XenServer Versions
8.3. VMware vSphere Installation and Configuration
8.3.1. System Requirements for vSphere Hosts
8.3.2. Preparation Checklist for VMware
8.3.3. vSphere Installation Steps
8.3.4. ESXi Host setup
8.3.5. Physical Host Networking
8.3.6. Configuring a vSphere Cluster with Nexus 1000v Virtual Switch
8.3.7. Configuring a VMware Datacenter with VMware Distributed Virtual Switch
8.3.8. Storage Preparation for vSphere (iSCSI only)
8.3.9. Add Hosts or Configure Clusters (vSphere)
8.3.10. Applying Hotfixes to a VMware vSphere Host
8.4. LXC Installation and Configuration
8.4.1. System Requirements for LXC Hosts
8.4.2. LXC Installation Overview
8.4.3. Prepare the Operating System
8.4.4. Install and configure the Agent
8.4.5. Install and Configure libvirt
8.4.6. Configure the Security Policies
8.4.7. Configure the network bridges
8.4.8. Configuring the firewall
8.4.9. Add the host to CloudStack
9. Additional Installation Options
9.1. Installing the Usage Server (Optional)
9.1.1. Requirements for Installing the Usage Server
9.1.2. Steps to Install the Usage Server
9.2. SSL (Optional)
9.3. Database Replication (Optional)
9.3.1. Failover
10. Choosing a Deployment Architecture
10.1. Small-Scale Deployment
10.2. Large-Scale Redundant Setup
10.3. Separate Storage Network
10.4. Multi-Node Management Server
10.5. Multi-Site Deployment
11. Choosing a Hypervisor: Supported Features
12. Amazon Web Services Compatible Interface
12.1. Amazon Web Services Compatible Interface
12.2. Supported API Version
12.3. Enabling the EC2 and S3 Compatible Interface
12.3.1. Enabling the Services
12.3.2. Creating EC2 Compatible Service Offerings
12.3.3. Modifying the AWS API Port
12.4. AWS API User Setup
12.4.1. AWS API User Registration
12.4.2. AWS API Command-Line Tools Setup
12.5. Using Timeouts to Ensure AWS API Command Completion
12.6. Supported AWS API Calls
12.7. Examples
12.7.1. Boto Examples
12.7.2. JClouds Examples
13. Network Setup
13.1. Basic and Advanced Networking
13.2. VLAN Allocation Example
13.3. Example Hardware Configuration
13.3.1. Dell 62xx
13.3.2. Cisco 3750
13.4. Layer-2 Switch
13.4.1. Dell 62xx
13.4.2. Cisco 3750
13.5. Hardware Firewall
13.5.1. Generic Firewall Provisions
13.5.2. External Guest Firewall Integration for Juniper SRX (Optional)
13.5.3. External Guest Firewall Integration for Cisco VNMC (Optional)
13.5.4. External Guest Load Balancer Integration (Optional)
13.6. Management Server Load Balancing
13.7. Topology Requirements
13.7.1. Security Requirements
13.7.2. Runtime Internal Communications Requirements
13.7.3. Storage Network Topology Requirements
13.7.4. External Firewall Topology Requirements
13.7.5. Advanced Zone Topology Requirements
13.7.6. XenServer Topology Requirements
13.7.7. VMware Topology Requirements
13.7.8. KVM Topology Requirements
13.7.9. LXC Topology Requirements
13.8. Guest Network Usage Integration for Traffic Sentinel
13.9. Setting Zone VLAN and Running VM Maximums
14. Storage Setup
14.1. Small-Scale Setup
14.2. Secondary Storage
14.3. Example Configurations
14.3.1. Linux NFS on Local Disks and DAS
14.3.2. Linux NFS on iSCSI
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. Best Practices
16.1. Process Best Practices
16.2. Setup Best Practices
16.3. Maintenance Best Practices
A. Revision History