Product SiteDocumentation Site

Apache CloudStack 4.0.0-incubating

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
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.
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 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. 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
3.6.1. Creating a yum repo
3.6.2. Configuring your systems to use your new yum repository
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. Prepare NFS Shares
4.5.6. Prepare and Start Additional Management Servers
4.5.7. Prepare the System VM Template
4.5.8. 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
6. Steps to Provisioning Your Cloud Infrastructure
6.1. Overview of Provisioning Steps
6.2. Adding a Zone
6.2.1. Basic Zone Configuration
6.2.2. Advanced Zone Configuration
6.3. Adding a Pod
6.4. Adding a Cluster
6.4.1. Add Cluster: KVM or XenServer
6.4.2. Add Cluster: vSphere
6.5. Adding a Host
6.5.1. Adding a Host (XenServer or KVM)
6.5.2. Adding a Host (vSphere)
6.6. Add Primary Storage
6.6.1. System Requirements for Primary Storage
6.6.2. Adding Primary Stroage
6.7. Add Secondary Storage
6.7.1. System Requirements for Secondary Storage
6.7.2. Adding Secondary Storage
6.8. Initialize and Test
7. Setting 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. Configuring the firewall
8.1.9. Add the host to CloudStack
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. Storage Preparation for vSphere (iSCSI only)
8.3.7. Add Hosts or Configure Clusters (vSphere)
9. Choosing a Deployment Architecture
9.1. Small-Scale Deployment
9.2. Large-Scale Redundant Setup
9.3. Separate Storage Network
9.4. Multi-Node Management Server
9.5. Multi-Site Deployment
10. Amazon Web Service Interface Compatibility
10.1. Amazon Web Services EC2 Compatible Interface
10.2. System Requirements
10.3. Enabling the AWS API Compatible Interface
10.4. AWS API User Setup Steps
10.4.1. AWS API User Registration
10.4.2. AWS API Command-Line Tools Setup
10.5. Using Timeouts to Ensure AWS API Command Completion
10.6. Supported AWS API Calls
11. Managing Networks and Traffic
11.1. Guest Traffic
11.2. Networking in a Pod
11.3. Networking in a Zone
11.4. Basic Zone Physical Network Configuration
11.5. Advanced Zone Physical Network Configuration
11.5.1. Configure Guest Traffic in an Advanced Zone
11.5.2. Configure Public Traffic in an Advanced Zone
11.6. Using Multiple Guest Networks
11.6.1. Adding an Additional Guest Network
11.6.2. Changing the Network Offering on a Guest Network
11.7. Security Groups
11.7.1. About Security Groups
11.7.2. Adding a Security Group
11.7.3. Enabling Security Groups
11.7.4. Adding Ingress and Egress Rules to a Security Group
11.8. External Firewalls and Load Balancers
11.9. Load Balancer Rules
11.10. Guest IP Ranges
11.11. Acquiring a New IP Address
11.12. Releasing an IP Address
11.13. Static NAT
11.14. IP Forwarding and Firewalling
11.15. IP Load Balancing
11.16. DNS and DHCP
11.17. VPN
11.17.1. Configuring VPN
11.17.2. Using VPN with Windows
11.17.3. Using VPN with Mac OS X
11.17.4. Setting Up a Site-to-Site VPN Connection
11.18. About Inter-VLAN Routing
11.19. Configuring a Virtual Private Cloud
11.19.1. About Virtual Private Clouds
11.19.2. Adding a Virtual Private Cloud
11.19.3. Adding Tiers
11.19.4. Configuring Access Control List
11.19.5. Adding a Private Gateway to a VPC
11.19.6. Deploying VMs to the Tier
11.19.7. Acquiring a New IP Address for a VPC
11.19.8. Releasing an IP Address Alloted to a VPC
11.19.9. Enabling or Disabling Static NAT on a VPC
11.19.10. Adding Load Balancing Rules on a VPC
11.19.11. Adding a Port Forwarding Rule on a VPC
11.19.12. Removing Tiers
11.19.13. Editing, Restarting, and Removing a Virtual Private Cloud
A. Revision History