Product SiteDocumentation Site

Apache CloudStack 4.1.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.
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.
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. Prepare NFS Shares
4.5.7. Prepare and Start Additional Management Servers
4.5.8. Prepare the System VM Template
4.5.9. 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 Stroage
6.8. Add Secondary Storage
6.8.1. System Requirements for Secondary Storage
6.8.2. Adding Secondary Storage
6.9. Initialize and Test
7. Global Configuration Parameters
7.1. Setting Global Configuration Parameters
7.2. About 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.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)
8.3.8. Applying Hotfixes to a VMware vSphere Host
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. Amazon Web Services Compatible Interface
11.1. Amazon Web Services Compatible Interface
11.2. Supported API Version
11.3. Enabling the EC2 and S3 Compatible Interface
11.3.1. Enabling the Services
11.3.2. Creating EC2 Compatible Service Offerings
11.3.3. Modifying the AWS API Port
11.4. AWS API User Setup
11.4.1. AWS API User Registration
11.4.2. AWS API Command-Line Tools Setup
11.5. Using Timeouts to Ensure AWS API Command Completion
11.6. Supported AWS API Calls
11.7. Examples
11.7.1. Boto Examples
11.7.2. JClouds Examples
12. Network Setup
12.1. Basic and Advanced Networking
12.2. VLAN Allocation Example
12.3. Example Hardware Configuration
12.3.1. Dell 62xx
12.3.2. Cisco 3750
12.4. Layer-2 Switch
12.4.1. Dell 62xx
12.4.2. Cisco 3750
12.5. Hardware Firewall
12.5.1. Generic Firewall Provisions
12.5.2. External Guest Firewall Integration for Juniper SRX (Optional)
12.5.3. External Guest Load Balancer Integration (Optional)
12.6. Management Server Load Balancing
12.7. Topology Requirements
12.7.1. Security Requirements
12.7.2. Runtime Internal Communications Requirements
12.7.3. Storage Network Topology Requirements
12.7.4. External Firewall Topology Requirements
12.7.5. Advanced Zone Topology Requirements
12.7.6. XenServer Topology Requirements
12.7.7. VMware Topology Requirements
12.7.8. KVM Topology Requirements
12.8. Guest Network Usage Integration for Traffic Sentinel
12.9. Setting Zone VLAN and Running VM Maximums
13. Managing Networks and Traffic
13.1. Guest Traffic
13.2. Networking in a Pod
13.3. Networking in a Zone
13.4. Basic Zone Physical Network Configuration
13.5. Advanced Zone Physical Network Configuration
13.5.1. Configure Guest Traffic in an Advanced Zone
13.5.2. Configure Public Traffic in an Advanced Zone
13.6. Using Multiple Guest Networks
13.6.1. Adding an Additional Guest Network
13.6.2. Changing the Network Offering on a Guest Network
13.7. Security Groups
13.7.1. About Security Groups
13.7.2. Adding a Security Group
13.7.3. Security Groups in Advanced Zones (KVM Only)
13.7.4. Enabling Security Groups
13.7.5. Adding Ingress and Egress Rules to a Security Group
13.8. External Firewalls and Load Balancers
13.8.1. About Using a NetScaler Load Balancer
13.8.2. Configuring SNMP Community String on a RHEL Server
13.8.3. Initial Setup of External Firewalls and Load Balancers
13.8.4. Ongoing Configuration of External Firewalls and Load Balancers
13.8.5. Configuring AutoScale
13.9. Load Balancer Rules
13.9.1. Adding a Load Balancer Rule
13.9.2. Sticky Session Policies for Load Balancer Rules
13.10. Guest IP Ranges
13.11. Acquiring a New IP Address
13.12. Releasing an IP Address
13.13. Static NAT
13.13.1. Enabling or Disabling Static NAT
13.14. IP Forwarding and Firewalling
13.14.1. Creating Egress Firewall Rules in an Advanced Zone
13.14.2. Firewall Rules
13.14.3. Port Forwarding
13.15. IP Load Balancing
13.16. DNS and DHCP
13.17. VPN
13.17.1. Configuring VPN
13.17.2. Using VPN with Windows
13.17.3. Using VPN with Mac OS X
13.17.4. Setting Up a Site-to-Site VPN Connection
13.18. About Inter-VLAN Routing
13.19. Configuring a Virtual Private Cloud
13.19.1. About Virtual Private Clouds
13.19.2. Adding a Virtual Private Cloud
13.19.3. Adding Tiers
13.19.4. Configuring Access Control List
13.19.5. Adding a Private Gateway to a VPC
13.19.6. Deploying VMs to the Tier
13.19.7. Acquiring a New IP Address for a VPC
13.19.8. Releasing an IP Address Alloted to a VPC
13.19.9. Enabling or Disabling Static NAT on a VPC
13.19.10. Adding Load Balancing Rules on a VPC
13.19.11. Adding a Port Forwarding Rule on a VPC
13.19.12. Removing Tiers
13.19.13. Editing, Restarting, and Removing a Virtual Private Cloud
13.20. Persistent Networks
13.20.1. Persistent Network Considerations
13.20.2. Creating a Persistent Guest Network
A. Revision History