From 4a8bb9dfc70a1d0b1b855b10d821a54ed51a0ba6 Mon Sep 17 00:00:00 2001 From: Radhika Puthiyetath Date: Tue, 11 Sep 2012 14:23:59 +0530 Subject: [PATCH] Feature Documentation for s2svpn interVlan and Autoscale --- .../LDAPserver-for-user-authentication.xml | 33 +- docs/en-US/about-clusters.xml | 2 +- docs/en-US/about-hosts.xml | 34 +- docs/en-US/about-physical-networks.xml | 38 +- docs/en-US/about-pods.xml | 41 +- docs/en-US/about-primary-storage.xml | 2 +- docs/en-US/about-secondary-storage.xml | 2 +- docs/en-US/about-virtual-networks.xml | 39 +- docs/en-US/about-working-with-vms.xml | 54 +-- docs/en-US/about-zones.xml | 37 +- docs/en-US/accessing-vms.xml | 66 +-- docs/en-US/accounts-users-domains.xml | 31 +- docs/en-US/accounts.xml | 35 +- docs/en-US/add-additional-guest-network.xml | 70 +-- docs/en-US/add-ingress-egress-rules.xml | 123 +++-- docs/en-US/add-iso.xml | 178 +++---- docs/en-US/add-load-balancer-rule.xml | 84 ++-- docs/en-US/add-security-group.xml | 54 +-- docs/en-US/advanced-zone-configuration.xml | 437 +++++++++++------- .../advanced-zone-guest-ip-addresses.xml | 33 +- .../advanced-zone-network-traffic-types.xml | 35 +- ...ed-zone-physical-network-configuration.xml | 39 +- .../advanced-zone-public-ip-addresses.xml | 33 +- docs/en-US/alerts.xml | 96 ++-- docs/en-US/attach-iso-to-vm.xml | 59 +-- .../automatic-snapshot-creation-retention.xml | 47 +- docs/en-US/basic-zone-configuration.xml | 39 +- docs/en-US/basic-zone-guest-ip-addresses.xml | 35 +- .../basic-zone-network-traffic-types.xml | 35 +- ...ic-zone-physical-network-configuration.xml | 38 +- docs/en-US/best-practices-for-vms.xml | 55 ++- ...ange-network-offering-on-guest-network.xml | 77 +-- docs/en-US/changing-root-password.xml | 37 +- docs/en-US/changing-secondary-storage-ip.xml | 74 +-- .../changing-service-offering-for-vm.xml | 83 ++-- docs/en-US/changing-vm-name-os-group.xml | 95 ++-- docs/en-US/cloud-infrastructure-concepts.xml | 50 +- docs/en-US/cloud-infrastructure-overview.xml | 75 +-- docs/en-US/cloudstack_admin.xml | 59 ++- docs/en-US/cluster-add.xml | 39 +- docs/en-US/compute-disk-service-offerings.xml | 40 +- docs/en-US/concepts.xml | 41 +- ...nfigure-guest-traffic-in-advanced-zone.xml | 88 ++-- docs/en-US/configure-usage-server.xml | 47 +- docs/en-US/configure-vpn.xml | 87 ++-- docs/en-US/console-proxy.xml | 33 +- docs/en-US/convert-hyperv-vm-to-template.xml | 117 ++--- .../create-template-from-existing-vm.xml | 87 ++-- docs/en-US/create-template-from-snapshot.xml | 38 +- docs/en-US/create-templates-overview.xml | 52 ++- docs/en-US/create-windows-template.xml | 58 +-- docs/en-US/creating-compute-offerings.xml | 74 +-- docs/en-US/creating-network-offerings.xml | 122 +++-- docs/en-US/creating-new-volumes.xml | 88 ++-- docs/en-US/creating-vms.xml | 86 ++-- docs/en-US/default-account-resource-limit.xml | 53 ++- docs/en-US/deleting-vms.xml | 66 +-- .../deployment-architecture-overview.xml | 69 ++- docs/en-US/detach-move-volumes.xml | 71 +-- docs/en-US/developer-guide.xml | 39 +- docs/en-US/enable-disable-static-nat.xml | 70 +-- docs/en-US/enable-security-groups.xml | 39 +- docs/en-US/end-user-ui-overview.xml | 37 +- docs/en-US/event-log-queries.xml | 33 +- docs/en-US/event-types.xml | 425 +++++++++-------- docs/en-US/events-log.xml | 43 +- docs/en-US/events.xml | 31 +- .../external-firewalls-and-load-balancers.xml | 38 +- docs/en-US/feature-overview.xml | 117 +++-- docs/en-US/firewall-rules.xml | 91 ++-- docs/en-US/globally-configured-limits.xml | 178 +++---- docs/en-US/guest-traffic.xml | 55 ++- docs/en-US/ha-for-hosts.xml | 35 +- docs/en-US/host-add.xml | 48 +- docs/en-US/host-allocation.xml | 33 +- .../hypervisor-support-for-primarystorage.xml | 183 ++++---- docs/en-US/images/cluster-overview.png | Bin 6973 -> 6080 bytes docs/en-US/import-ami.xml | 108 ++--- docs/en-US/initialize-and-test.xml | 102 ++-- docs/en-US/ip-forwarding-firewalling.xml | 34 +- docs/en-US/isolated-networks.xml | 33 +- docs/en-US/linux-installation.xml | 82 ++-- docs/en-US/load-balancer-rules.xml | 37 +- docs/en-US/log-in-root-admin.xml | 34 +- docs/en-US/log-in.xml | 44 +- docs/en-US/maintain-hypervisors-on-hosts.xml | 33 +- docs/en-US/manage-cloud.xml | 45 +- docs/en-US/manual-live-migration.xml | 83 ++-- ...-vm-rootvolume-volume-new-storage-pool.xml | 54 +-- docs/en-US/minimum-system-requirements.xml | 153 +++--- docs/en-US/network-offerings.xml | 46 +- docs/en-US/network-service-providers.xml | 133 +++++- docs/en-US/networking-in-a-pod.xml | 69 +-- docs/en-US/networking-in-a-zone.xml | 56 +-- docs/en-US/networking-overview.xml | 51 +- docs/en-US/pod-add.xml | 51 +- docs/en-US/port-forwarding.xml | 80 ++-- docs/en-US/primary-storage-add.xml | 60 ++- docs/en-US/primary-storage.xml | 42 +- docs/en-US/projects.xml | 53 ++- docs/en-US/provisioning-steps-overview.xml | 70 ++- docs/en-US/provisioning-steps.xml | 36 +- docs/en-US/release-ip-address.xml | 64 +-- docs/en-US/removing-vsphere-hosts.xml | 32 +- ...e-allocation-virtual-network-resources.xml | 37 +- ...led-maintenance-maintenance-mode-hosts.xml | 34 +- docs/en-US/secondary-storage-add.xml | 41 +- docs/en-US/secondary-storage-vm.xml | 41 +- docs/en-US/secondary-storage.xml | 38 +- docs/en-US/security-groups.xml | 36 +- docs/en-US/set-up-invitations.xml | 53 ++- docs/en-US/set-up-network-for-users.xml | 46 +- docs/en-US/set-usage-limit.xml | 36 +- docs/en-US/shared-networks.xml | 38 +- docs/en-US/site-to-site-vpn.xml | 72 +-- docs/en-US/standard-events.xml | 35 +- docs/en-US/static-nat.xml | 34 +- docs/en-US/stop-restart-management-server.xml | 33 +- docs/en-US/stopping-and-starting-vms.xml | 7 +- docs/en-US/storage.xml | 43 +- docs/en-US/suspend-project.xml | 48 +- docs/en-US/sys-reliability-and-ha.xml | 45 +- .../sysprep-for-windows-server-2003R2.xml | 96 ++-- docs/en-US/sysprep-windows-server-2008R2.xml | 48 +- docs/en-US/system-reserved-ip-addresses.xml | 36 +- docs/en-US/system-service-offerings.xml | 34 +- docs/en-US/time-zones.xml | 259 +++++------ docs/en-US/troubleshooting.xml | 52 +-- docs/en-US/tuning.xml | 36 +- docs/en-US/ui.xml | 35 +- docs/en-US/upload-template.xml | 100 ++-- docs/en-US/user-services-overview.xml | 119 ++--- docs/en-US/using-multiple-guest-networks.xml | 43 +- docs/en-US/using-sshkeys.xml | 95 ++-- docs/en-US/vcenter-maintenance-mode.xml | 36 +- docs/en-US/virtual-router.xml | 35 +- docs/en-US/vm-lifecycle.xml | 63 +-- docs/en-US/vm-storage-migration.xml | 44 +- docs/en-US/vpc.xml | 160 +++++-- docs/en-US/vpn.xml | 58 ++- docs/en-US/windows-installation.xml | 37 +- docs/en-US/work-with-usage.xml | 47 +- docs/en-US/working-with-hosts.xml | 51 +- docs/en-US/working-with-iso.xml | 43 +- docs/en-US/working-with-snapshots.xml | 49 +- docs/en-US/working-with-system-vm.xml | 39 +- docs/en-US/working-with-templates.xml | 44 +- docs/en-US/working-with-volumes.xml | 46 +- docs/en-US/xenserver-maintenance-mode.xml | 40 +- 149 files changed, 5092 insertions(+), 4360 deletions(-) diff --git a/docs/en-US/LDAPserver-for-user-authentication.xml b/docs/en-US/LDAPserver-for-user-authentication.xml index 5fcb300af65..376631cbbc2 100644 --- a/docs/en-US/LDAPserver-for-user-authentication.xml +++ b/docs/en-US/LDAPserver-for-user-authentication.xml @@ -5,23 +5,22 @@ ]> -
Using an LDAP Server for User Authentication You can use an external LDAP server such as Microsoft Active Directory or ApacheDS to authenticate &PRODUCT; end-users. Just map &PRODUCT; accounts to the corresponding LDAP accounts using a query filter. The query filter is written using the query syntax of the particular LDAP server, and can include special wildcard characters provided by &PRODUCT; for matching common values such as the user’s email address and name. &PRODUCT; will search the external LDAP directory tree starting at a specified base directory and return the distinguished name (DN) and password of the matching user. This information along with the given password is used to authenticate the user.. @@ -37,4 +36,4 @@ -
+ diff --git a/docs/en-US/about-clusters.xml b/docs/en-US/about-clusters.xml index e328cbaa169..b01fcfcea1d 100644 --- a/docs/en-US/about-clusters.xml +++ b/docs/en-US/about-clusters.xml @@ -1,5 +1,5 @@ - %BOOK_ENTITIES; ]> diff --git a/docs/en-US/about-hosts.xml b/docs/en-US/about-hosts.xml index 956c695a520..2002a6a74d0 100644 --- a/docs/en-US/about-hosts.xml +++ b/docs/en-US/about-hosts.xml @@ -1,25 +1,25 @@ - %BOOK_ENTITIES; ]>
@@ -28,7 +28,7 @@ The host is the smallest organizational unit within a &PRODUCT; deployment. Hosts are contained within clusters, clusters are contained within pods, and pods are contained within zones. Hosts in a &PRODUCT; deployment: - Provde the CPU, memory, storage, and networking resources needed to host the virtual machines + Provide the CPU, memory, storage, and networking resources needed to host the virtual machines Interconnect using a high bandwidth TCP/IP network and connect to the Internet May reside in multiple data centers across different geographic locations May have different capacities (different CPU speeds, different amounts of RAM, etc.), although the hosts within a cluster must all be homogeneous diff --git a/docs/en-US/about-physical-networks.xml b/docs/en-US/about-physical-networks.xml index 8edb9e060c2..b22e48b7779 100644 --- a/docs/en-US/about-physical-networks.xml +++ b/docs/en-US/about-physical-networks.xml @@ -1,29 +1,28 @@ - %BOOK_ENTITIES; ]> -
- About Physical Networks + About Physical Networks Part of adding a zone is setting up the physical network. One or (in an advanced zone) more physical networks can be associated with each zone. The network corresponds to a NIC on the hypervisor host. Each physical network can carry one or more types of network traffic. The choices of traffic type for each network vary depending on whether you are creating a zone with basic networking or advanced networking. A physical network is the actual network hardware and wiring in a zone. A zone can have multiple physical networks. An administrator can: @@ -33,8 +32,7 @@ Configure the service providers (firewalls, load balancers, etc.) available on a physical network Configure the IP addresses trunked to a physical network Specify what type of traffic is carried on the physical network, as well as other properties like network speed - - + diff --git a/docs/en-US/about-pods.xml b/docs/en-US/about-pods.xml index ed3520c6451..57ae1a319b3 100644 --- a/docs/en-US/about-pods.xml +++ b/docs/en-US/about-pods.xml @@ -1,33 +1,34 @@ - %BOOK_ENTITIES; ]>
About Pods - A pod often represents a single rack. Hosts in the same pod are in the same subnet. - A pod is the second-largest organizational unit within a &PRODUCT; deployment. Pods are contained within zones. Each zone can contain one or more pods. - Pods are not visible to the end user. - A pod consists of one or more clusters of hosts and one or more primary storage servers. + A pod often represents a single rack. Hosts in the same pod are in the same subnet. + A pod is the second-largest organizational unit within a &PRODUCT; deployment. Pods are contained within zones. Each zone can contain one or more pods. + A pod consists of one or more clusters of hosts and one or more primary storage servers. + Pods are not visible to the end user. + diff --git a/docs/en-US/about-primary-storage.xml b/docs/en-US/about-primary-storage.xml index 68d7a25ba5a..a9cf05486c6 100644 --- a/docs/en-US/about-primary-storage.xml +++ b/docs/en-US/about-primary-storage.xml @@ -1,5 +1,5 @@ - %BOOK_ENTITIES; ]> diff --git a/docs/en-US/about-secondary-storage.xml b/docs/en-US/about-secondary-storage.xml index c4df0b8c6e8..c5b4f5d5a2f 100644 --- a/docs/en-US/about-secondary-storage.xml +++ b/docs/en-US/about-secondary-storage.xml @@ -1,5 +1,5 @@ - %BOOK_ENTITIES; ]> diff --git a/docs/en-US/about-virtual-networks.xml b/docs/en-US/about-virtual-networks.xml index 2fc6ba9ddd5..225717e59a6 100644 --- a/docs/en-US/about-virtual-networks.xml +++ b/docs/en-US/about-virtual-networks.xml @@ -5,27 +5,26 @@ ]> -
About Virtual Networks - A virtual network is a logical construct that enables multi-tenancy on a single physical network. In &PRODUCT;, a virtual network can be shared or isolated. - XenServer and Maintenance Mode - Working with Usage - XenServer and Maintenance Mode + A virtual network is a logical construct that enables multi-tenancy on a single physical network. In &PRODUCT; a virtual network can be shared or isolated. + + +
diff --git a/docs/en-US/about-working-with-vms.xml b/docs/en-US/about-working-with-vms.xml index 47153e2f374..259c61bc814 100644 --- a/docs/en-US/about-working-with-vms.xml +++ b/docs/en-US/about-working-with-vms.xml @@ -5,35 +5,35 @@ ]>
- About Working with Virtual Machines - &PRODUCT; provides administrators with complete control over the lifecycle of all guest VMs executing in the cloud. &PRODUCT; provides several guest management operations for end users and administrators. VMs may be stopped, started, rebooted, and destroyed. - Guest VMs have a name and group. VM names and groups are opaque to &PRODUCT; and are available for end users to organize their VMs. Each VM can have three names for use in different contexts. Only two of these names can be controlled by the user: - - Instance name – a unique, immutable ID that is generated by &PRODUCT; and can not be modified by the user. This name conforms to the requirements in IETF RFC 1123. - Display name – the name displayed in the &PRODUCT; web UI. Can be set by the user. Defaults to instance name. - Name – host name that the DHCP server assigns to the VM. Can be set by the user. Defaults to instance name - - Guest VMs can be configured to be Highly Available (HA). An HA-enabled VM is monitored by the system. If the system detects that the VM is down, it will attempt to restart the VM, possibly on a different host. For more information, see HA-Enabled Virtual Machines on - Each new VM is allocated one public IP address. When the VM is started, &PRODUCT; automatically creates a static NAT between this public IP address and the private IP address of the VM. - If elastic IP is in use (with the NetScaler load balancer), the IP address initially allocated to the new VM is not marked as elastic. The user must replace the automatically configured IP with a specifically acquired elastic IP, and set up the static NAT mapping between this new IP and the guest VM’s private IP. The VM’s original IP address is then released and returned to the pool of available public IPs. - &PRODUCT; cannot distinguish a guest VM that was shut down by the user (such as with the “shutdown” command in Linux) from a VM that shut down unexpectedly. If an HA-enabled VM is shut down from inside the VM, &PRODUCT; will restart it. To shut down an HA-enabled VM, you must go through the &PRODUCT; UI or API. + About Working with Virtual Machines + &PRODUCT; provides administrators with complete control over the lifecycle of all guest VMs executing in the cloud. &PRODUCT; provides several guest management operations for end users and administrators. VMs may be stopped, started, rebooted, and destroyed. + Guest VMs have a name and group. VM names and groups are opaque to &PRODUCT; and are available for end users to organize their VMs. Each VM can have three names for use in different contexts. Only two of these names can be controlled by the user: + + Instance name – a unique, immutable ID that is generated by &PRODUCT;, and can not be modified by the user. This name conforms to the requirements in IETF RFC 1123. + Display name – the name displayed in the &PRODUCT; web UI. Can be set by the user. Defaults to instance name. + Name – host name that the DHCP server assigns to the VM. Can be set by the user. Defaults to instance name + + Guest VMs can be configured to be Highly Available (HA). An HA-enabled VM is monitored by the system. If the system detects that the VM is down, it will attempt to restart the VM, possibly on a different host. For more information, see HA-Enabled Virtual Machines on + Each new VM is allocated one public IP address. When the VM is started, &PRODUCT; automatically creates a static NAT between this public IP address and the private IP address of the VM. + If elastic IP is in use (with the NetScaler load balancer), the IP address initially allocated to the new VM is not marked as elastic. The user must replace the automatically configured IP with a specifically acquired elastic IP, and set up the static NAT mapping between this new IP and the guest VM’s private IP. The VM’s original IP address is then released and returned to the pool of available public IPs. + &PRODUCT; cannot distinguish a guest VM that was shut down by the user (such as with the “shutdown” command in Linux) from a VM that shut down unexpectedly. If an HA-enabled VM is shut down from inside the VM, &PRODUCT; will restart it. To shut down an HA-enabled VM, you must go through the &PRODUCT; UI or API.
diff --git a/docs/en-US/about-zones.xml b/docs/en-US/about-zones.xml index a05a9a6e517..5385df05088 100644 --- a/docs/en-US/about-zones.xml +++ b/docs/en-US/about-zones.xml @@ -1,29 +1,28 @@ - %BOOK_ENTITIES; ]> -
- About Zones + About Zones A zone is the largest organizational unit within a &PRODUCT; deployment. A zone typically corresponds to a single datacenter, although it is permissible to have multiple zones in a datacenter. The benefit of organizing infrastructure into zones is to provide physical isolation and redundancy. For example, each zone can have its own power supply and network uplink, and the zones can be widely separated geographically (though this is not required). A zone consists of: @@ -34,7 +33,7 @@ - zone-overview.png: Nested structure of a simple zone + zone-overview.png: Nested structure of a simple zone. Zones are visible to the end user. When a user starts a guest VM, the user must select a zone for their guest. Users might also be required to copy their private templates to additional zones to enable creation of guest VMs using their templates in those zones. Zones can be public or private. Public zones are visible to all users. This means that any user may create a guest in that zone. Private zones are reserved for a specific domain. Only users in that domain or its subdomains may create guests in that zone. diff --git a/docs/en-US/accessing-vms.xml b/docs/en-US/accessing-vms.xml index d69d021471b..7053996e3c3 100644 --- a/docs/en-US/accessing-vms.xml +++ b/docs/en-US/accessing-vms.xml @@ -5,37 +5,43 @@ ]> -
- Accessing VMs - Any user can access their own virtual machines. The administrator can access all VMs running in the cloud. - To access a VM through the &PRODUCT; UI: - - Log in to the &PRODUCT; UI as a user or admin. - Click Instances, then click the name of a running VM. - Click the View Console button . - - To access a VM directly over the network: - - The VM must have some port open to incoming traffic. For example, in a basic zone, a new VM might be assigned to a security group which allows incoming traffic. This depends on what security group you picked when creating the VM. In other cases, you can open a port by setting up a port forwarding policy. See IP Forwarding and Firewalling. - If a port is open but you can not access the VM using ssh, it’s possible that ssh is not already enabled on the VM. This will depend on whether ssh is enabled in the template you picked when creating the VM. Access the VM through the &PRODUCT; UI and enable ssh on the machine using the commands for the VM’s operating system. - If the network has an external firewall device, you will need to create a firewall rule to allow access. See IP Forwarding and Firewalling. - + Accessing VMs + Any user can access their own virtual machines. The administrator can access all VMs running in the cloud. + To access a VM through the &PRODUCT; UI: + + Log in to the &PRODUCT; UI as a user or admin. + Click Instances, then click the name of a running VM. + Click the View Console + + + + + consoleicon.png: button to view the console. + + + + To access a VM directly over the network: + + The VM must have some port open to incoming traffic. For example, in a basic zone, a new VM might be assigned to a security group which allows incoming traffic. This depends on what security group you picked when creating the VM. In other cases, you can open a port by setting up a port forwarding policy. See IP Forwarding and Firewalling. + If a port is open but you can not access the VM using ssh, it’s possible that ssh is not already enabled on the VM. This will depend on whether ssh is enabled in the template you picked when creating the VM. Access the VM through the &PRODUCT; UI and enable ssh on the machine using the commands for the VM’s operating system. + If the network has an external firewall device, you will need to create a firewall rule to allow access. See IP Forwarding and Firewalling. +
diff --git a/docs/en-US/accounts-users-domains.xml b/docs/en-US/accounts-users-domains.xml index 85491295218..a3f5837db8e 100644 --- a/docs/en-US/accounts-users-domains.xml +++ b/docs/en-US/accounts-users-domains.xml @@ -5,23 +5,22 @@ ]> -
Accounts, Users, and Domains diff --git a/docs/en-US/accounts.xml b/docs/en-US/accounts.xml index 5292a9ca2f6..aa62f680452 100644 --- a/docs/en-US/accounts.xml +++ b/docs/en-US/accounts.xml @@ -5,24 +5,25 @@ ]> -
+ + Accounts -
+ diff --git a/docs/en-US/add-additional-guest-network.xml b/docs/en-US/add-additional-guest-network.xml index 57e7ffd57a8..3d3858a43a1 100644 --- a/docs/en-US/add-additional-guest-network.xml +++ b/docs/en-US/add-additional-guest-network.xml @@ -5,39 +5,43 @@ ]> -
- Adding an Additional Guest Network - - Log in to the &PRODUCT; UI as an administrator or end user. - In the left navigation, choose Network - Click Add guest network. Provide the following information: - - Name. The name of the network. This will be user-visible. - Description. The description of the network. This will be user-visible. - Network offering. If the administrator has configured multiple network offerings, select the one you want to use for this network. - Pod. The name of the pod this network applies to. Each pod in a basic zone is a broadcast domain, and therefore each pod has a different IP range for the guest network. The administrator must configure the IP range for each pod. - VLAN ID. The VLAN tag for this network. - Gateway. The gateway that the guests should use. - Netmask. The netmask in use on the subnet the guests will use. - Start IP/End IP. Enter the first and last IP addresses that define a range that &PRODUCT; can assign to guests. We strongly recommend the use of multiple NICs. If multiple NICs are used, they may be in a different subnet. If one NIC is used, these IPs should be in the same CIDR as the pod CIDR. - Click Create. - + Adding an Additional Guest Network + + Log in to the &PRODUCT; UI as an administrator or end user. + In the left navigation, choose Network. + Click Add guest network. Provide the following information: + + Name: The name of the network. This will be user-visible. + Display Text: The description of the network. This will be + user-visible. + Zone. The name of the zone this network applies to. Each zone is a broadcast domain, and therefore each zone has a different + IP range for the guest network. The administrator must configure the IP + range for each zone. + Network offering: If the administrator has configured + multiple network offerings, select the one you want to use for this + network. + Guest Gateway: The gateway that the guests should use. + Guest Netmask: The netmask in use on the subnet the guests will + use. + + Click Create. + -
+
diff --git a/docs/en-US/add-ingress-egress-rules.xml b/docs/en-US/add-ingress-egress-rules.xml index 964045f4076..10895d6737c 100644 --- a/docs/en-US/add-ingress-egress-rules.xml +++ b/docs/en-US/add-ingress-egress-rules.xml @@ -5,55 +5,88 @@ ]>
Adding Ingress and Egress Rules to a Security Group - + Log in to the &PRODUCT; UI as an administrator or end user. In the left navigation, choose Network - In Select view, choose Security Groups, then click the security group you want . - To add an ingress rule, click the Ingress Rules tab and fill out the following fields to specify what network traffic is allowed into VM instances in this security group. If no ingress rules are specified, then no traffic will be allowed in, except for responses to any traffic that has been allowed out through an egress rule. - - Add by CIDR/Account. Indicate whether the source of the traffic will be defined by IP address (CIDR) or an existing security group in a &PRODUCT; account (Account). Choose Account if you want to allow incoming traffic from all VMs in another security group - Protocol. The networking protocol that sources will use to send traffic to the security group. TCP and UDP are typically used for data exchange and end-user communications. ICMP is typically used to send error messages or network monitoring data. - Start Port, End Port. (TCP, UDP only) A range of listening ports that are the destination for the incoming traffic. If you are opening a single port, use the same number in both fields. - ICMP Type, ICMP Code. (ICMP only) The type of message and error code that will be accepted. - CIDR. (Add by CIDR only) To accept only traffic from IP addresses within a particular address block, enter a CIDR or a comma-separated list of CIDRs. The CIDR is the base IP address of the incoming traffic. For example, 192.168.0.0/22. To allow all CIDRs, set to 0.0.0.0/0. - Account, Security Group. (Add by Account only) To accept only traffic from another security group, enter the &PRODUCT; account and name of a security group that has already been defined in that account. To allow traffic between VMs within the security group you are editing now, enter the same name you used in step 7. - - The following example allows inbound HTTP access from anywhere: - - - - - httpaccess.png: allows inbound HTTP access from anywhere - - - To add an egress rule, click the Egress Rules tab and fill out the following fields to specify what type of traffic is allowed to be sent out of VM instances in this security group. If no egress rules are specified, then all traffic will be allowed out. Once egress rules are specified, the following types of traffic are allowed out: traffic specified in egress rules; queries to DNS and DHCP servers; and responses to any traffic that has been allowed in through an ingress rule - - Add by CIDR/Account. Indicate whether the destination of the traffic will be defined by IP address (CIDR) or an existing security group in a &PRODUCT; account (Account). Choose Account if you want to allow outgoing traffic to all VMs in another security group. - Protocol. The networking protocol that VMs will use to send outgoing traffic. TCP and UDP are typically used for data exchange and end-user communications. ICMP is typically used to send error messages or network monitoring data. - Start Port, End Port. (TCP, UDP only) A range of listening ports that are the destination for the outgoing traffic. If you are opening a single port, use the same number in both fields. - ICMP Type, ICMP Code. (ICMP only) The type of message and error code that will be sent - CIDR. (Add by CIDR only) To send traffic only to IP addresses within a particular address block, enter a CIDR or a comma-separated list of CIDRs. The CIDR is the base IP address of the destination. For example, 192.168.0.0/22. To allow all CIDRs, set to 0.0.0.0/0. - Account, Security Group. (Add by Account only) To allow traffic to be sent to another security group, enter the &PRODUCT; account and name of a security group that has already been defined in that account. To allow traffic between VMs within the security group you are editing now, enter its name. - - Click Add. - + In Select view, choose Security Groups, then click the security group you want . + To add an ingress rule, click the Ingress Rules tab and fill out the following fields to specify what network traffic is allowed into VM instances in this security group. If no ingress rules are specified, then no traffic will be allowed in, except for responses to any traffic that has been allowed out through an egress rule. + + Add by CIDR/Account. Indicate whether the source of the + traffic will be defined by IP address (CIDR) or an existing security group + in a &PRODUCT; account (Account). Choose Account if you want to allow + incoming traffic from all VMs in another security group + Protocol. The networking protocol that sources will use to + send traffic to the security group. TCP and UDP are typically used for data + exchange and end-user communications. ICMP is typically used to send error + messages or network monitoring data. + Start Port, End Port. (TCP, UDP only) A range of listening + ports that are the destination for the incoming traffic. If you are opening + a single port, use the same number in both fields. + ICMP Type, ICMP Code. (ICMP only) The type of message and + error code that will be accepted. + CIDR. (Add by CIDR only) To accept only traffic from IP + addresses within a particular address block, enter a CIDR or a + comma-separated list of CIDRs. The CIDR is the base IP address of the + incoming traffic. For example, 192.168.0.0/22. To allow all CIDRs, set to + 0.0.0.0/0. + Account, Security Group. (Add by Account only) To accept only + traffic from another security group, enter the &PRODUCT; account and + name of a security group that has already been defined in that account. To + allow traffic between VMs within the security group you are editing now, + enter the same name you used in step 7. + + The following example allows inbound HTTP access from anywhere: + + + + + httpaccess.png: allows inbound HTTP access from anywhere + + + To add an egress rule, click the Egress Rules tab and fill out the following fields to specify what type of traffic is allowed to be sent out of VM instances in this security group. If no egress rules are specified, then all traffic will be allowed out. Once egress rules are specified, the following types of traffic are allowed out: traffic specified in egress rules; queries to DNS and DHCP servers; and responses to any traffic that has been allowed in through an ingress rule + + Add by CIDR/Account. Indicate whether the destination of the + traffic will be defined by IP address (CIDR) or an existing security group + in a &PRODUCT; account (Account). Choose Account if you want to allow + outgoing traffic to all VMs in another security group. + Protocol. The networking protocol that VMs will use to send + outgoing traffic. TCP and UDP are typically used for data exchange and + end-user communications. ICMP is typically used to send error messages or + network monitoring data. + Start Port, End Port. (TCP, UDP only) A range of listening + ports that are the destination for the outgoing traffic. If you are opening + a single port, use the same number in both fields. + ICMP Type, ICMP Code. (ICMP only) The type of message and + error code that will be sent + CIDR. (Add by CIDR only) To send traffic only to IP addresses + within a particular address block, enter a CIDR or a comma-separated list of + CIDRs. The CIDR is the base IP address of the destination. For example, + 192.168.0.0/22. To allow all CIDRs, set to 0.0.0.0/0. + Account, Security Group. (Add by Account only) To allow + traffic to be sent to another security group, enter the &PRODUCT; + account and name of a security group that has already been defined in that + account. To allow traffic between VMs within the security group you are + editing now, enter its name. + + Click Add. +
diff --git a/docs/en-US/add-iso.xml b/docs/en-US/add-iso.xml index f56d10cb0f5..60f61169905 100644 --- a/docs/en-US/add-iso.xml +++ b/docs/en-US/add-iso.xml @@ -5,87 +5,103 @@ ]> -
- Adding an ISO - To make additional operating system or other software available for use with guest VMs, you can add an ISO. The ISO is typically thought of as an operating system image, but you can also add ISOs for other types of software, such as desktop applications that you want to be installed as part of a template. - - Log in to the &PRODUCT; UI as an administrator or end user. - In the left navigation bar, click Templates. - In Select View, choose ISOs. - Click Add ISO. - In the Add ISO screen, provide the following: - - Name. Short name for the ISO image. (E.g. CentOS 6.2 64 bit). - Description. Display test for the ISO image. (E.g. CentOS 6.2 64 bit). - URL. The URL that hosts the ISO image. The Management Server must be able to access this location via HTTP. If needed you can place the ISO image directly on the Management Server - Zone. Choose the zone where you want the ISO to be available, or All Zones to make it available throughout &PRODUCT;. - Bootable. Whether or not a guest could boot off this ISO image. For example, a CentOS ISO is bootable, a Microsoft Office ISO is not bootable. - OS Type. This helps &PRODUCT; and the hypervisor perform certain operations and make assumptions that improve the performance of the guest. Select one of the following. - - If the operating system of your desired ISO image is listed, choose it. - If the OS Type of the ISO is not listed or if the ISO is not bootable, choose Other. - (XenServer only) If you want to boot from this ISO in PV mode, choose Other PV (32-bit) or Other PV (64-bit) - (KVM only) If you choose an OS that is PV-enabled, the VMs created from this ISO will have a SCSI (virtio) root disk. If the OS is not PV-enabled, the VMs will have an IDE root disk. The PV-enabled types are: - - - - - Fedora 13 - Fedora 12 - Fedora 11 - - - - Fedora 10 - Fedora 9 - Other PV - - - - Debian GNU/Linux - CentOS 5.3 - CentOS 5.4 - - - CentOS 5.5 - Red Hat Enterprise Linux 5.3 - Red Hat Enterprise Linux 5.4 - - - Red Hat Enterprise Linux 5.5 - Red Hat Enterprise Linux 6 - - - - - - - Note: It is not recommended to choose an older version of the OS than the version in the image. For example, choosing CentOS 5.4 to support a CentOS 6.2 image will usually not work. In these cases, choose Other. - - Extractable. Choose Yes if the ISO should be available for extraction. - Public. Choose Yes if this ISO should be available to other users. - Featured. Choose Yes if you would like this ISO to be more prominent for users to select. The ISO will appear in the Featured ISOs list. Only an administrator can make an ISO Featured. - - Click OK. - The Management Server will download the ISO. Depending on the size of the ISO, this may take a long time. The ISO status column will display Ready once it has been successfully downloaded into secondary storage. Clicking Refresh updates the download percentage. - - Important: Wait for the ISO to finish downloading. If you move on to the next task and try to use the ISO right away, it will appear to fail. The entire ISO must be available before &PRODUCT; can work with it - + Adding an ISO + To make additional operating system or other software available for use with guest VMs, you can add an ISO. The ISO is typically thought of as an operating system image, but you can also add ISOs for other types of software, such as desktop applications that you want to be installed as part of a template. + + Log in to the &PRODUCT; UI as an administrator or end user. + In the left navigation bar, click Templates. + In Select View, choose ISOs. + Click Add ISO. + In the Add ISO screen, provide the following: + + Name: Short name for the ISO image. For example, CentOS 6.2 + 64-bit. + Description: Display test for the ISO image. For example, + CentOS 6.2 64-bit. + URL: The URL that hosts the ISO image. The Management Server + must be able to access this location via HTTP. If needed you can place the + ISO image directly on the Management Server + Zone: Choose the zone where you want the ISO to be available, + or All Zones to make it available throughout &PRODUCT;. + Bootable: Whether or not a guest could boot off this ISO + image. For example, a CentOS ISO is bootable, a Microsoft Office ISO is not + bootable. + OS Type: This helps &PRODUCT; and the hypervisor perform + certain operations and make assumptions that improve the performance of the + guest. Select one of the following. + + If the operating system of your desired ISO image is listed, choose it. + If the OS Type of the ISO is not listed or if the ISO is not bootable, choose Other. + (XenServer only) If you want to boot from this ISO in PV mode, choose Other PV (32-bit) or Other PV (64-bit) + (KVM only) If you choose an OS that is PV-enabled, the VMs created from this ISO will have a SCSI (virtio) root disk. If the OS is not PV-enabled, the VMs will have an IDE root disk. The PV-enabled types are: + + + + + Fedora 13 + Fedora 12 + Fedora 11 + + + + Fedora 10 + Fedora 9 + Other PV + + + + Debian GNU/Linux + CentOS 5.3 + CentOS 5.4 + + + CentOS 5.5 + Red Hat Enterprise Linux 5.3 + Red Hat Enterprise Linux 5.4 + + + Red Hat Enterprise Linux 5.5 + Red Hat Enterprise Linux 6 + + + + + + + It is not recommended to choose an older version of the OS than the version in the image. For + example, choosing CentOS 5.4 to support a CentOS 6.2 image will usually + not work. In these cases, choose Other. + + Extractable: Choose Yes if the ISO should be available for + extraction. + Public: Choose Yes if this ISO should be available to other + users. + Featured: Choose Yes if you would like this ISO to be more + prominent for users to select. The ISO will appear in the Featured ISOs + list. Only an administrator can make an ISO Featured. + + Click OK. + The Management Server will download the ISO. Depending on the size of the ISO, this may take a long time. The ISO status column will display Ready once it has been successfully downloaded into secondary storage. Clicking Refresh updates the download percentage. + + Important: Wait for the ISO to finish downloading. If you + move on to the next task and try to use the ISO right away, it will appear to fail. + The entire ISO must be available before &PRODUCT; can work with it. +
diff --git a/docs/en-US/add-load-balancer-rule.xml b/docs/en-US/add-load-balancer-rule.xml index ddbce957926..30128efba29 100644 --- a/docs/en-US/add-load-balancer-rule.xml +++ b/docs/en-US/add-load-balancer-rule.xml @@ -5,42 +5,56 @@ ]>
- Adding a Load Balancer Rule - - Log in to the &PRODUCT; UI as an administrator or end user. - In the left navigation, choose Network. - Click the name of the network where you want to load balance the traffic. - Click View IP Addresses. - Click the IP address for which you want to create the rule, then click the Configuration tab. - In the Load Balancing node of the diagram, click View All. - Fill in the following: - - Name. A name for the load balancer rule. - Public Port. The port receiving incoming traffic to be balanced. - Private Port. The port that the VMs will use to receive the traffic. - Algorithm. Choose the load balancing algorithm you want &PRODUCT; to use. &PRODUCT; supports a variety of well-known algorithms. If you are not familiar with these choices, you will find plenty of information about them on the Internet. - Stickiness. (Optional) Click Configure and choose the algorithm for the stickiness policy. See Sticky Session Policies for Load Balancer Rules. - - Click Add VMs, then select two or more VMs that will divide the load of incoming traffic, and click Apply. - The new load balancer rule appears in the list. You can repeat these steps to add more load balancer rules for this IP address. - - + Adding a Load Balancer Rule + + Log in to the &PRODUCT; UI as an administrator or end user. + In the left navigation, choose Network. + Click the name of the network where you want to load balance the traffic. + Click View IP Addresses. + Click the IP address for which you want to create the rule, then click the Configuration tab. + In the Load Balancing node of the diagram, click View All. + In a Basic zone, you can also create a load balancing rule without acquiring or selecting an + IP address. &PRODUCT; internally assign an IP when you create the load balancing + rule, which is listed in the IP Addresses page when the rule is created. + To do that, select the name of the network, then click Add Load Balancer tab. Continue with + . + Fill in the following: + + Name: A name for the load balancer rule. + Public Port: The port receiving incoming traffic to be + balanced. + Private Port: The port that the VMs will use to receive the + traffic. + Algorithm: Choose the load balancing algorithm you want + &PRODUCT; to use. &PRODUCT; supports a variety of well-known + algorithms. If you are not familiar with these choices, you will find plenty + of information about them on the Internet. + Stickiness: (Optional) Click Configure and choose the + algorithm for the stickiness policy. See Sticky Session Policies for Load + Balancer Rules. + AutoScale: Click Configure and complete the AutoScale + configuration as explained in . + + Click Add VMs, then select two or more VMs that will divide the load of incoming traffic, and click Apply. + The new load balancer rule appears in the list. You can repeat these steps to add more load balancer rules for this IP address. + +
diff --git a/docs/en-US/add-security-group.xml b/docs/en-US/add-security-group.xml index e4c8b3ce2da..7d86c9beabb 100644 --- a/docs/en-US/add-security-group.xml +++ b/docs/en-US/add-security-group.xml @@ -5,35 +5,35 @@ ]>
- Adding a Security Group - A user or administrator can change the network offering that is associated with an existing guest network. - - Log in to the &PRODUCT; UI as an administrator or end user. - In the left navigation, choose Network - In Select view, choose Security Groups. - Click Add Security Group. - Provide a name and description. - Click OK. - The new security group appears in the Security Groups Details tab. - To make the security group useful, continue to Adding Ingress and Egress Rules to a Security Group. - + Adding a Security Group + A user or administrator can define a new security group. + + Log in to the &PRODUCT; UI as an administrator or end user. + In the left navigation, choose Network + In Select view, choose Security Groups. + Click Add Security Group. + Provide a name and description. + Click OK. + The new security group appears in the Security Groups Details tab. + To make the security group useful, continue to Adding Ingress and Egress Rules to a Security Group. +
diff --git a/docs/en-US/advanced-zone-configuration.xml b/docs/en-US/advanced-zone-configuration.xml index 85909e3a08b..5186bc51fc0 100644 --- a/docs/en-US/advanced-zone-configuration.xml +++ b/docs/en-US/advanced-zone-configuration.xml @@ -1,182 +1,277 @@ - %BOOK_ENTITIES; ]> -
- Advanced Zone Configuration + Advanced Zone Configuration - After you select Advanced in the Add Zone wizard and click Next, you will be asked to enter the following details. Then click Next. - - Name. A name for the zone. - DNS 1 and 2. These are DNS servers for use by guest VMs in the zone. These DNS servers will be accessed via the public network you will add later. The public IP addresses for the zone must have a route to the DNS server named here. - Internal DNS 1 and Internal DNS 2. These are DNS servers for use by system VMs in the zone(these are VMs used by &PRODUCT; itself, such as virtual routers, console proxies,and Secondary Storage VMs.) These DNS servers will be accessed via the management traffic network interface of the System VMs. The private IP address you provide for the pods must have a route to the internal DNS server named here. - Network Domain. (Optional) If you want to assign a special domain name to the guest VM network, specify the DNS suffix. - Guest CIDR. This is the CIDR that describes the IP addresses in use in the guest virtual networks in this zone. For example, 10.1.1.0/24. As a matter of good practice you should set different CIDRs for different zones. This will make it easier to set up VPNs between networks in different zones. - Hypervisor. (Introduced in version 3.0.1) Choose the hypervisor for the first cluster in the zone. You can add clusters with different hypervisors later, after you finish adding the zone. - Public. A public zone is available to all users. A zone that is not public will be assigned to a particular domain. Only users in that domain will be allowed to create guest VMs in this zone. - - - Choose which traffic types will be carried by the physical network. - The traffic types are management, public, guest, and storage traffic. For more information about the types, roll over the icons to display their tool tips, or see . This screen starts out with one network already configured. If you have multiple physical networks, you need to add more. Drag and drop traffic types onto a greyed-out network and it will become active. You can move the traffic icons from one network to another; for example, if the default traffic types shown for Network 1 do not match your actual setup, you can move them down. You can also change the network names if desired. - - (Introduced in version 3.0.1) Assign a network traffic label to each traffic type on each physical network. These labels must match the labels you have already defined on the hypervisor host. To assign each label, click the Edit button under the traffic type icon within each physical network. A popup dialog appears where you can type the label, then click OK. - These traffic labels will be defined only for the hypervisor selected for the first cluster. For all other hypervisors, the labels can be configured after the zone is created. - (VMware only) If you have enabled Nexus dvSwitch in the environment, you must specify the corresponding Ethernet port profile names as network traffic label for each traffic type on the physical network. For more information on Nexus dvSwitch, see Configuring a vSphere Cluster with Nexus 1000v Virtual Switch. - - Click Next. - - Configure the IP range for public Internet traffic. Enter the following details, then click Add. If desired, you can repeat this step to add more public Internet IP ranges. When done, click Next. - - Gateway. The gateway in use for these IP addresses. - Netmask. The netmask associated with this IP range. - VLAN. The VLAN that will be used for public traffic. - Start IP/End IP. A range of IP addresses that are assumed to be accessible from the Internet and will be allocated for access to guest networks. - - - In a new zone, &PRODUCT; adds the first pod for you. You can always add more pods later. For an overview of what a pod is, see . - To configure the first pod, enter the following, then click Next: - - Pod Name. A name for the pod. - Reserved system gateway. The gateway for the hosts in that pod. - Reserved system netmask. The network prefix that defines the pod's subnet. Use CIDR notation. - Start/End Reserved System IP. The IP range in the management network that &PRODUCT; uses to manage various system VMs, such as Secondary Storage VMs, Console Proxy VMs, and DHCP. For more information, see . - - - Specify a range of VLAN IDs to carry guest traffic for each physical network (see VLAN Allocation Example ), then click Next. - - In a new pod, &PRODUCT; adds the first cluster for you. You can always add more clusters later. For an overview of what a cluster is, see . - To configure the first cluster, enter the following, then click Next: - - Hypervisor. (Version 3.0.0 only; in 3.0.1, this field is read only) Choose the type of hypervisor software that all hosts in this cluster will run. If you choose VMware, additional fields appear so you can give information about a vSphere cluster. For vSphere servers, we recommend creating the cluster of hosts in vCenter and then adding the entire cluster to &PRODUCT;. See Add Cluster: vSphere . - Cluster name. Enter a name for the cluster. This can be text of your choosing and is not used by &PRODUCT;. - - - In a new cluster, &PRODUCT; adds the first host for you. You can always add more hosts later. For an overview of what a host is, see . - When you deploy &PRODUCT;, the hypervisor host must not have any VMs already running. - Before you can configure the host, you need to install the hypervisor software on the host. You will need to know which version of the hypervisor software version is supported by &PRODUCT; and what additional configuration is required to ensure the host will work with &PRODUCT;. To find these installation details, see: - - Citrix XenServer Installation for &PRODUCT; - VMware vSphere Installation and Configuration - KVM Installation and Configuration - Oracle VM (OVM) Installation and Configuration - - To configure the first host, enter the following, then click Next: - - Host Name. The DNS name or IP address of the host. - Username. Usually root. - Password. This is the password for the user named above (from your XenServer or KVM install). - Host Tags. (Optional) Any labels that you use to categorize hosts for ease of maintenance. For example, you can set to the cloud's HA tag (set in the ha.tag global configuration parameter) if you want this host to be used only for VMs with the "high availability" feature enabled. For more information, see HA-Enabled Virtual Machines as well as HA for Hosts, both in the Administration Guide. - - - In a new cluster, &PRODUCT; adds the first primary storage server for you. You can always add more servers later. For an overview of what primary storage is, see . - To configure the first primary storage server, enter the following, then click Next: - - Name. The name of the storage device. - Protocol. For XenServer, choose either NFS, iSCSI, or PreSetup. For KVM, choose NFS or SharedMountPoint. For vSphere choose either VMFS (iSCSI or FiberChannel) or NFS. The remaining fields in the screen vary depending on what you choose here. - - - - - - - NFS - - - Server. The IP address or DNS name of the storage device. - Path. The exported path from the server. - - Tags (optional). The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings. - The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2. - - - - - - iSCSI - - - Server. The IP address or DNS name of the storage device. - Target IQN. The IQN of the target. For example, iqn.1986-03.com.sun:02:01ec9bb549-1271378984. - Lun. The LUN number. For example, 3. - - Tags (optional). The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings. - The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2. - - - - - - preSetup - - - Server. The IP address or DNS name of the storage device. - SR Name-Label. Enter the name-label of the SR that has been set up outside &PRODUCT;. - - Tags (optional). The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings. - The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2. - - - - - - SharedMountPoint - - - Path. The path on each host that is where this primary storage is mounted. For example, "/mnt/primary". - - Tags (optional). The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings. - The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2. - - - - - - VMFS - - - Server. The IP address or DNS name of the vCenter server. - Path. A combination of the datacenter name and the datastore name. The format is "/" datacenter name "/" datastore name. For example, "/cloud.dc.VM/cluster1datastore". - - Tags (optional). The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings. - The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2. - - - - - - - - - - - In a new zone, &PRODUCT; adds the first secondary storage server for you. For an overview of what secondary storage is, see . - Before you can fill out this screen, you need to prepare the secondary storage by setting up NFS shares and installing the latest &PRODUCT; System VM template. See Adding Secondary Storage : - - NFS Server. The IP address of the server. - Path. The exported path from the server. - - - Click Launch. - + + After you select Advanced in the Add Zone wizard and click Next, you will be asked to enter the following details. Then click Next. + + + + Name. A name for the zone. + + DNS 1 and 2. These are DNS servers for use by guest VMs in the zone. These DNS servers will be accessed via the public network you will add later. The public IP addresses for the zone must have a route to the DNS server named here. + Internal DNS 1 and Internal DNS 2. These are DNS servers for use by system VMs in the zone(these are VMs used by &PRODUCT; itself, such as virtual routers, console proxies,and Secondary Storage VMs.) These DNS servers will be accessed via the management traffic network interface of the System VMs. The private IP address you provide for the pods must have a route to the internal DNS server named here. + + Network Domain. (Optional) If you want to assign a special domain name to the guest VM network, specify the DNS suffix. + Guest CIDR. This is the CIDR that describes the IP addresses in use in the guest virtual networks in this zone. For example, 10.1.1.0/24. As a matter of good practice you should set different CIDRs for different zones. This will make it easier to set up VPNs between networks in different zones. + + Hypervisor. (Introduced in version 3.0.1) Choose the hypervisor for the first cluster in the zone. You can add clusters with different hypervisors later, after you finish adding the zone. + Public. A public zone is available to all users. A zone that is not public will be assigned to a particular domain. Only users in that domain will be allowed to create guest VMs in this zone. + + + + + + Choose which traffic types will be carried by the physical network. + + The traffic types are management, public, guest, and storage traffic. For more information about the types, roll over the icons to display their tool tips, or see . This screen starts out with one network already configured. If you have multiple physical networks, you need to add more. Drag and drop traffic types onto a greyed-out network and it will become active. You can move the traffic icons from one network to another; for example, if the default traffic types shown for Network 1 do not match your actual setup, you can move them down. You can also change the network names if desired. + + + + (Introduced in version 3.0.1) Assign a network traffic label to each traffic type on each physical network. These labels must match the labels you have already defined on the hypervisor host. To assign each label, click the Edit button under the traffic type icon within each physical network. A popup dialog appears where you can type the label, then click OK. + + These traffic labels will be defined only for the hypervisor selected for the first cluster. For all other hypervisors, the labels can be configured after the zone is created. + + (VMware only) If you have enabled Nexus dvSwitch in the environment, you must specify the corresponding Ethernet port profile names as network traffic label for each traffic type on the physical network. For more information on Nexus dvSwitch, see Configuring a vSphere Cluster with Nexus 1000v Virtual Switch. + + + + Click Next. + + + + Configure the IP range for public Internet traffic. Enter the following details, then click Add. If desired, you can repeat this step to add more public Internet IP ranges. When done, click Next. + + + + Gateway. The gateway in use for these IP addresses. + + Netmask. The netmask associated with this IP range. + + VLAN. The VLAN that will be used for public traffic. + + Start IP/End IP. A range of IP addresses that are assumed to be accessible from the Internet and will be allocated for access to guest networks. + + + + + + In a new zone, &PRODUCT; adds the first pod for you. You can always add more pods later. For an overview of what a pod is, see . + + To configure the first pod, enter the following, then click Next: + + + + Pod Name. A name for the pod. + + Reserved system gateway. The gateway for the hosts in that pod. + + Reserved system netmask. The network prefix that defines the pod's subnet. Use CIDR notation. + + Start/End Reserved System IP. The IP range in the management network that &PRODUCT; uses to manage various system VMs, such as Secondary Storage VMs, Console Proxy VMs, and DHCP. For more information, see . + + + + + + Specify a range of VLAN IDs to carry guest traffic for each physical network (see VLAN Allocation Example ), then click Next. + + + + In a new pod, &PRODUCT; adds the first cluster for you. You can always add more clusters later. For an overview of what a cluster is, see . + + To configure the first cluster, enter the following, then click Next: + + + + Hypervisor. (Version 3.0.0 only; in 3.0.1, this field is read only) Choose the type of hypervisor software that all hosts in this cluster will run. If you choose VMware, additional fields appear so you can give information about a vSphere cluster. For vSphere servers, we recommend creating the cluster of hosts in vCenter and then adding the entire cluster to &PRODUCT;. See Add Cluster: vSphere . + + Cluster name. Enter a name for the cluster. This can be text of your choosing and is not used by &PRODUCT;. + + + + + + In a new cluster, &PRODUCT; adds the first host for you. You can always add more hosts later. For an overview of what a host is, see . + + When you deploy &PRODUCT;, the hypervisor host must not have any VMs already running. + + Before you can configure the host, you need to install the hypervisor software on the host. You will need to know which version of the hypervisor software version is supported by &PRODUCT; and what additional configuration is required to ensure the host will work with &PRODUCT;. To find these installation details, see: + + + Citrix XenServer Installation for &PRODUCT; + + VMware vSphere Installation and Configuration + + KVM Installation and Configuration + + Oracle VM (OVM) Installation and Configuration + + + + To configure the first host, enter the following, then click Next: + + + + Host Name. The DNS name or IP address of the host. + + Username. Usually root. + + Password. This is the password for the user named above (from your XenServer or KVM install). + + Host Tags. (Optional) Any labels that you use to categorize hosts for ease of maintenance. For example, you can set to the cloud's HA tag (set in the ha.tag global configuration parameter) if you want this host to be used only for VMs with the "high availability" feature enabled. For more information, see HA-Enabled Virtual Machines as well as HA for Hosts, both in the Administration Guide. + + + + + + In a new cluster, &PRODUCT; adds the first primary storage server for you. You can always add more servers later. For an overview of what primary storage is, see . + + To configure the first primary storage server, enter the following, then click Next: + + + Name. The name of the storage device. + + Protocol. For XenServer, choose either NFS, iSCSI, or PreSetup. For KVM, choose NFS or SharedMountPoint. For vSphere choose either VMFS (iSCSI or FiberChannel) or NFS. The remaining fields in the screen vary depending on what you choose here. + + + + + + + + + + + + + + NFS + + + + Server. The IP address or DNS name of the storage device. + Path. The exported path from the server. + Tags (optional). The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings. + + + The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2. + + + + + iSCSI + + + + Server. The IP address or DNS name of the storage device. + + Target IQN. The IQN of the target. For example, iqn.1986-03.com.sun:02:01ec9bb549-1271378984. + + Lun. The LUN number. For example, 3. + + Tags (optional). The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings. + + The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2. + + + + + preSetup + + + + Server. The IP address or DNS name of the storage device. + + SR Name-Label. Enter the name-label of the SR that has been set up outside &PRODUCT;. + + Tags (optional). The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings. + + + The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2. + + + + + SharedMountPoint + + + + + Path. The path on each host that is where this primary storage is mounted. For example, "/mnt/primary". + Tags (optional). The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings. + + + + The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2. + + + + + + + + VMFS + + + + Server. The IP address or DNS name of the vCenter server. + Path. A combination of the datacenter name and the datastore name. The format is "/" datacenter name "/" datastore name. For example, "/cloud.dc.VM/cluster1datastore". + + Tags (optional). The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings. + + + The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2. + + + + + + + + + + + + In a new zone, &PRODUCT; adds the first secondary storage server for you. For an overview of what secondary storage is, see . + + Before you can fill out this screen, you need to prepare the secondary storage by setting up NFS shares and installing the latest &PRODUCT; System VM template. See Adding Secondary Storage : + + + + NFS Server. The IP address of the server. + + Path. The exported path from the server. + + + + + + Click Launch. + + +
diff --git a/docs/en-US/advanced-zone-guest-ip-addresses.xml b/docs/en-US/advanced-zone-guest-ip-addresses.xml index b5d10a02d05..fbc6144bec1 100644 --- a/docs/en-US/advanced-zone-guest-ip-addresses.xml +++ b/docs/en-US/advanced-zone-guest-ip-addresses.xml @@ -1,27 +1,26 @@ - %BOOK_ENTITIES; ]> -
Advanced Zone Guest IP Addresses When advanced networking is used, the administrator can create additional networks for use by the guests. These networks can span the zone and be available to all accounts, or they can be scoped to a single account, in which case only the named account may create guests that attach to these networks. The networks are defined by a VLAN ID, IP range, and gateway. The administrator may provision thousands of these networks if desired. diff --git a/docs/en-US/advanced-zone-network-traffic-types.xml b/docs/en-US/advanced-zone-network-traffic-types.xml index 9f475cf3f80..d8035929374 100644 --- a/docs/en-US/advanced-zone-network-traffic-types.xml +++ b/docs/en-US/advanced-zone-network-traffic-types.xml @@ -1,29 +1,28 @@ - %BOOK_ENTITIES; ]> -
- Advanced Zone Network Traffic Types + Advanced Zone Network Traffic Types When advanced networking is used, there can be multiple physical networks in the zone. Each physical network can carry one or more traffic types, and you need to let &PRODUCT; know which type of network traffic you want each network to carry. The traffic types in an advanced zone are: Guest. When end users run VMs, they generate guest traffic. The guest VMs communicate with each other over a network that can be referred to as the guest network. This network can be isolated or shared. In an isolated guest network, the administrator needs to reserve VLAN ranges to provide isolation for each &PRODUCT; account’s network (potentially a large number of VLANs). In a shared guest network, all guest VMs share a single network. diff --git a/docs/en-US/advanced-zone-physical-network-configuration.xml b/docs/en-US/advanced-zone-physical-network-configuration.xml index 4c44c7d4a42..0d917da5d67 100644 --- a/docs/en-US/advanced-zone-physical-network-configuration.xml +++ b/docs/en-US/advanced-zone-physical-network-configuration.xml @@ -5,24 +5,25 @@ ]> -
- Advanced Zone Physical Network Configuration - Within a zone that uses advanced networking, you need to tell the Management Server how the physical network is set up to carry different kinds of traffic in isolation. -
+ Advanced Zone Physical Network Configuration + Within a zone that uses advanced networking, you need to tell the Management Server how the physical network is set up to carry different kinds of traffic in isolation. + + +
diff --git a/docs/en-US/advanced-zone-public-ip-addresses.xml b/docs/en-US/advanced-zone-public-ip-addresses.xml index eeb94045e08..82b71d1f23a 100644 --- a/docs/en-US/advanced-zone-public-ip-addresses.xml +++ b/docs/en-US/advanced-zone-public-ip-addresses.xml @@ -1,27 +1,26 @@ - %BOOK_ENTITIES; ]> -
Advanced Zone Public IP Addresses When advanced networking is used, the administrator can create additional networks for use by the guests. These networks can span the zone and be available to all accounts, or they can be scoped to a single account, in which case only the named account may create guests that attach to these networks. The networks are defined by a VLAN ID, IP range, and gateway. The administrator may provision thousands of these networks if desired. diff --git a/docs/en-US/alerts.xml b/docs/en-US/alerts.xml index f9030238d43..9f926cf3080 100644 --- a/docs/en-US/alerts.xml +++ b/docs/en-US/alerts.xml @@ -1,49 +1,55 @@ + + +%BOOK_ENTITIES; +]> + -
- Alerts - The following is the list of alert type numbers. The current alerts can be found by calling listAlerts. - MEMORY = 0 - CPU = 1 - STORAGE =2 - STORAGE_ALLOCATED = 3 - PUBLIC_IP = 4 - PRIVATE_IP = 5 - HOST = 6 - USERVM = 7 - DOMAIN_ROUTER = 8 - CONSOLE_PROXY = 9 - ROUTING = 10// lost connection to default route (to the gateway) - STORAGE_MISC = 11 // lost connection to default route (to the gateway) - USAGE_SERVER = 12 // lost connection to default route (to the gateway) - MANAGMENT_NODE = 13 // lost connection to default route (to the gateway) - DOMAIN_ROUTER_MIGRATE = 14 - CONSOLE_PROXY_MIGRATE = 15 - USERVM_MIGRATE = 16 - VLAN = 17 - SSVM = 18 - USAGE_SERVER_RESULT = 19 - STORAGE_DELETE = 20; - UPDATE_RESOURCE_COUNT = 21; //Generated when we fail to update the resource count - USAGE_SANITY_RESULT = 22; - DIRECT_ATTACHED_PUBLIC_IP = 23; - LOCAL_STORAGE = 24; - RESOURCE_LIMIT_EXCEEDED = 25; //Generated when the resource limit exceeds the limit. Currently used for recurring snapshots only -
+ + Alerts + The following is the list of alert type numbers. The current alerts can be found by calling listAlerts. + MEMORY = 0 + CPU = 1 + STORAGE =2 + STORAGE_ALLOCATED = 3 + PUBLIC_IP = 4 + PRIVATE_IP = 5 + HOST = 6 + USERVM = 7 + DOMAIN_ROUTER = 8 + CONSOLE_PROXY = 9 + ROUTING = 10// lost connection to default route (to the gateway) + STORAGE_MISC = 11 // lost connection to default route (to the gateway) + USAGE_SERVER = 12 // lost connection to default route (to the gateway) + MANAGMENT_NODE = 13 // lost connection to default route (to the gateway) + DOMAIN_ROUTER_MIGRATE = 14 + CONSOLE_PROXY_MIGRATE = 15 + USERVM_MIGRATE = 16 + VLAN = 17 + SSVM = 18 + USAGE_SERVER_RESULT = 19 + STORAGE_DELETE = 20; + UPDATE_RESOURCE_COUNT = 21; //Generated when we fail to update the resource count + USAGE_SANITY_RESULT = 22; + DIRECT_ATTACHED_PUBLIC_IP = 23; + LOCAL_STORAGE = 24; + RESOURCE_LIMIT_EXCEEDED = 25; //Generated when the resource limit exceeds the limit. Currently used for recurring snapshots only + diff --git a/docs/en-US/attach-iso-to-vm.xml b/docs/en-US/attach-iso-to-vm.xml index 30e5d51947d..8e0d4247f9b 100644 --- a/docs/en-US/attach-iso-to-vm.xml +++ b/docs/en-US/attach-iso-to-vm.xml @@ -5,35 +5,36 @@ ]> -
- Attaching an ISO to a VM - - In the left navigation, click Instances. - Choose the virtual machine you want to work with. - Click the Attach ISO button - - - - iso.png: Depicts adding an iso image - - In the Attach ISO dialog box, select the desired ISO. - Click OK - + Attaching an ISO to a VM + + In the left navigation, click Instances. + Choose the virtual machine you want to work with. + Click the Attach ISO button. + + + + + iso.png: depicts adding an iso image + + + In the Attach ISO dialog box, select the desired ISO. + Click OK. +
diff --git a/docs/en-US/automatic-snapshot-creation-retention.xml b/docs/en-US/automatic-snapshot-creation-retention.xml index ee4cf73f957..a1f62df8c73 100644 --- a/docs/en-US/automatic-snapshot-creation-retention.xml +++ b/docs/en-US/automatic-snapshot-creation-retention.xml @@ -5,26 +5,33 @@ ]>
- Automatic Snapshot Creation and Retention - (Supported for the following hypervisors: XenServer, VMware vSphere, and KVM) - Users can set up a recurring snapshot policy to automatically create multiple snapshots of a disk at regular intervals. Snapshots can be created on an hourly, daily, weekly, or monthly interval. One snapshot policy can be set up per disk volume. For example, a user can set up a daily snapshot at 02:30. - With each snapshot schedule, users can also specify the number of scheduled snapshots to be retained. Older snapshots that exceed the retention limit are automatically deleted. This user-defined limit must be equal to or lower than the global limit set by the &PRODUCT; administrator. See . The limit applies only to those snapshots that are taken as part of an automatic recurring snapshot policy. Additional manual snapshots can be created and retained. -
+ Automatic Snapshot Creation and Retention + (Supported for the following hypervisors: XenServer, + VMware vSphere, and KVM) + Users can set up a recurring snapshot policy to automatically create multiple snapshots of a disk at regular intervals. Snapshots can be created on an hourly, daily, weekly, or monthly interval. One snapshot policy can be set up per disk volume. For example, a user can set up a daily snapshot at 02:30. + With each snapshot schedule, users can also specify the number of scheduled snapshots to be + retained. Older snapshots that exceed the retention limit are automatically deleted. This + user-defined limit must be equal to or lower than the global limit set by the &PRODUCT; + administrator. See . The limit applies only to + those snapshots that are taken as part of an automatic recurring snapshot policy. Additional + manual snapshots can be created and retained. +
diff --git a/docs/en-US/basic-zone-configuration.xml b/docs/en-US/basic-zone-configuration.xml index 18afa84f794..2b37f80f4b3 100644 --- a/docs/en-US/basic-zone-configuration.xml +++ b/docs/en-US/basic-zone-configuration.xml @@ -1,29 +1,28 @@ - %BOOK_ENTITIES; ]> -
- Basic Zone Configuration + Basic Zone Configuration After you select Basic in the Add Zone wizard and click Next, you will be asked to enter the following details. Then click Next. @@ -66,7 +65,7 @@ Choose which traffic types will be carried by the physical network. The traffic types are management, public, guest, and storage traffic. For more information about the types, roll over the icons to display their tool tips, or see Basic Zone Network Traffic Types. This screen starts out with some traffic types already assigned. To add more, drag and drop traffic types onto the network. You can also change the network name if desired. - (Introduced in version 3.0.1) Assign a network traffic label to each traffic type on the physical network. These labels must match the labels you have already defined on the hypervisor host. To assign each label, click the Edit button under the traffic type icon. A popup dialog appears where you can type the label, then click OK. + 3. (Introduced in version 3.0.1) Assign a network traffic label to each traffic type on the physical network. These labels must match the labels you have already defined on the hypervisor host. To assign each label, click the Edit button under the traffic type icon. A popup dialog appears where you can type the label, then click OK. These traffic labels will be defined only for the hypervisor selected for the first cluster. For all other hypervisors, the labels can be configured after the zone is created. (VMware only) If you have enabled Nexus dvSwitch in the environment, you must specify the corresponding Ethernet port profile names as network traffic label for each traffic type on the physical network. For more information on Nexus dvSwitch, see Configuring a vSphere Cluster with Nexus 1000v Virtual Switch. @@ -136,7 +135,7 @@ Host Tags. (Optional) Any labels that you use to categorize hosts for ease of maintenance. For example, you can set this to the cloud's HA tag (set in the ha.tag global configuration parameter) if you want this host to be used only for VMs with the "high availability" feature enabled. For more information, see HA-Enabled Virtual Machines as well as HA for Hosts. - In a new cluster, CloudPlatform adds the first primary storage server for you. You can always add more servers later. For an overview of what primary storage is, see About Primary Storage. + In a new cluster, &PRODUCT; adds the first primary storage server for you. You can always add more servers later. For an overview of what primary storage is, see About Primary Storage. To configure the first primary storage server, enter the following, then click Next: Name. The name of the storage device. diff --git a/docs/en-US/basic-zone-guest-ip-addresses.xml b/docs/en-US/basic-zone-guest-ip-addresses.xml index d1d9135b4c6..5143f71f17e 100644 --- a/docs/en-US/basic-zone-guest-ip-addresses.xml +++ b/docs/en-US/basic-zone-guest-ip-addresses.xml @@ -1,28 +1,27 @@ - %BOOK_ENTITIES; ]> -
Basic Zone Guest IP Addresses - When basic networking is used, CloudPlatform will assign IP addresses in the CIDR of the pod to the guests in that pod. The administrator must add a Direct IP range on the pod for this purpose. These IPs are in the same VLAN as the hosts. + When basic networking is used, &PRODUCT; will assign IP addresses in the CIDR of the pod to the guests in that pod. The administrator must add a Direct IP range on the pod for this purpose. These IPs are in the same VLAN as the hosts.
diff --git a/docs/en-US/basic-zone-network-traffic-types.xml b/docs/en-US/basic-zone-network-traffic-types.xml index fa3be0f442b..70789d0fa1a 100644 --- a/docs/en-US/basic-zone-network-traffic-types.xml +++ b/docs/en-US/basic-zone-network-traffic-types.xml @@ -1,29 +1,28 @@ - %BOOK_ENTITIES; ]> -
- Basic Zone Network Traffic Types + Basic Zone Network Traffic Types When basic networking is used, there can be only one physical network in the zone. That physical network carries the following traffic types: Guest. When end users run VMs, they generate guest traffic. The guest VMs communicate with each other over a network that can be referred to as the guest network. Each pod in a basic zone is a broadcast domain, and therefore each pod has a different IP range for the guest network. The administrator must configure the IP range for each pod. diff --git a/docs/en-US/basic-zone-physical-network-configuration.xml b/docs/en-US/basic-zone-physical-network-configuration.xml index 83833a73e78..302c2932a51 100644 --- a/docs/en-US/basic-zone-physical-network-configuration.xml +++ b/docs/en-US/basic-zone-physical-network-configuration.xml @@ -5,25 +5,23 @@ ]> -
- Basic Zone Physical Network Configuration - In a basic network, configuring the physical network is fairly straightforward. You only need to configure one guest network to carry traffic that is generated by guest VMs. When you first add a zone to CloudPlatform, you set up the guest network through the Add Zone screens. - -
+ Basic Zone Physical Network Configuration + In a basic network, configuring the physical network is fairly straightforward. You only need to configure one guest network to carry traffic that is generated by guest VMs. When you first add a zone to &PRODUCT;, you set up the guest network through the Add Zone screens. +
diff --git a/docs/en-US/best-practices-for-vms.xml b/docs/en-US/best-practices-for-vms.xml index a67add4edeb..0ccb183a4f7 100644 --- a/docs/en-US/best-practices-for-vms.xml +++ b/docs/en-US/best-practices-for-vms.xml @@ -1,23 +1,40 @@ + + +%BOOK_ENTITIES; +]> + -
- VM Lifecycle - The CloudPlatform administrator should monitor the total number of VM instances in each cluster, and disable allocation to the cluster if the total is approaching the maximum that the hypervisor can handle. Be sure to leave a safety margin to allow for the possibility of one or more hosts failing, which would increase the VM load on the other hosts as the VMs are automatically redeployed. Consult the documentation for your chosen hypervisor to find the maximum permitted number of VMs per host, then use CloudPlatform global configuration settings to set this as the default limit. Monitor the VM activity in each cluster at all times. Keep the total number of VMs below a safe level that allows for the occasional host failure. For example, if there are N hosts in the cluster, and you want to allow for one host in the cluster to be down at any given time, the total number of VM instances you can permit in the cluster is at most (N-1) * (per-host-limit). Once a cluster reaches this number of VMs, use the CloudPlatform UI to disable allocation of more VMs to the cluster.. - +
+ Best Practices for Virtual Machines + The &PRODUCT; administrator should monitor the total number of VM instances in each + cluster, and disable allocation to the cluster if the total is approaching the maximum that + the hypervisor can handle. Be sure to leave a safety margin to allow for the possibility of + one or more hosts failing, which would increase the VM load on the other hosts as the VMs + are automatically redeployed. Consult the documentation for your chosen hypervisor to find + the maximum permitted number of VMs per host, then use &PRODUCT; global configuration + settings to set this as the default limit. Monitor the VM activity in each cluster at all + times. Keep the total number of VMs below a safe level that allows for the occasional host + failure. For example, if there are N hosts in the cluster, and you want to allow for one + host in the cluster to be down at any given time, the total number of VM instances you can + permit in the cluster is at most (N-1) * (per-host-limit). Once a cluster reaches this + number of VMs, use the &PRODUCT; UI to disable allocation of more VMs to the + cluster.
diff --git a/docs/en-US/change-network-offering-on-guest-network.xml b/docs/en-US/change-network-offering-on-guest-network.xml index 98f1b63f484..c440c208ffc 100644 --- a/docs/en-US/change-network-offering-on-guest-network.xml +++ b/docs/en-US/change-network-offering-on-guest-network.xml @@ -5,40 +5,47 @@ ]> - + 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. +-->
- Changing the Network Offering on a Guest Network - A user or administrator can change the network offering that is associated with an existing guest network. - - Log in to the &PRODUCT; UI as an administrator or end user. - If you are changing from a network offering that uses the &PRODUCT; virtual router to one that uses external devices as network service providers, you must first stop all the VMs on the network. See Stopping and Starting VMs. Then return here and continue to the next step - In the left navigation, choose Network - Click the name of the network you want to modify - - - - AttachDiskButton.png: button to attach a volume - . - In Network Offering, choose the new network offering, then click Apply. - A prompt appears asking whether you want to keep the existing CIDR. This is to let you know that if you change the network offering, the CIDR will be affected. Choose No to proceed with the change. - Wait for the update to complete. Don’t try to restart VMs until after the network change is complete. - If you stopped any VMs in step 2, restart them. - + Changing the Network Offering on a Guest Network + A user or administrator can change the network offering that is associated with an existing guest network. + + Log in to the &PRODUCT; UI as an administrator or end user. + If you are changing from a network offering that uses the &PRODUCT; virtual router to one + that uses external devices as network service providers, you must first stop all the + VMs on the network. See . + In the left navigation, choose Network. + Click the name of the network you want to modify. + In the Details tab, click Edit. + + + + + EditButton.png: button to edit a network + + + In Network Offering, choose the new network offering, then click Apply. + A prompt is displayed asking whether you want to keep the existing CIDR. This is to let you + know that if you change the network offering, the CIDR will be affected. Choose No + to proceed with the change. + Wait for the update to complete. Don’t try to restart VMs until the network change is + complete. + If you stopped any VMs, restart them. + +
-
diff --git a/docs/en-US/changing-root-password.xml b/docs/en-US/changing-root-password.xml index 0d2333a2a67..880f50fcf22 100644 --- a/docs/en-US/changing-root-password.xml +++ b/docs/en-US/changing-root-password.xml @@ -1,29 +1,28 @@ - %BOOK_ENTITIES; ]> - + 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. +-->
- Changing the Root Password + Changing the Root Password During installation and ongoing cloud administration, you will need to log in to the UI as the root administrator. The root administrator account manages the &PRODUCT; deployment, including physical infrastructure. The root administrator can modify configuration settings to change basic functionality, create or delete user accounts, and take many actions that should be performed only by an authorized person. diff --git a/docs/en-US/changing-secondary-storage-ip.xml b/docs/en-US/changing-secondary-storage-ip.xml index 7e146de812f..34f93e32c61 100644 --- a/docs/en-US/changing-secondary-storage-ip.xml +++ b/docs/en-US/changing-secondary-storage-ip.xml @@ -2,43 +2,43 @@ %BOOK_ENTITIES; -]> +]> - + 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. +-->
- Making API Requests - You can change the secondary storage IP address after it has been provisioned. After changing the IP address on the host, log in to your management server and execute the following commands. Replace HOSTID below with your own value, and change the URL to use the appropriate IP address and path for your server: - - # mysql -p - mysql> use cloud; - mysql> select id from host where type = 'SecondaryStorage'; - mysql> update host_details set value = 'nfs://192.168.160.20/export/mike-ss1' - where host_id = HOSTID and name = 'orig.url'; - mysql> update host set name = 'nfs://192.168.160.20/export/mike-ss1' where type - = 'SecondaryStorage' and id = #; - mysql> update host set url = 'nfs://192.168.160.20/export/mike-ss1' where type - = 'SecondaryStorage' and id = #; - mysql> update host set guid = 'nfs://192.168.160.20/export/mike-ss1' where type - = 'SecondaryStorage' and id = #; - - When copying and pasting a command, be sure the command has pasted as a single line before executing. Some document viewers may introduce unwanted line breaks in copied text. - Then log in to the cloud console UI and stop and start (not reboot) the Secondary Storage VM for that Zone. - -
+ Changing the Secondary Storage IP Address + You can change the secondary storage IP address after it has been provisioned. After changing the IP address on the host, log in to your management server and execute the following commands. Replace HOSTID below with your own value, and change the URL to use the appropriate IP address and path for your server: + + # mysql -p + mysql> use cloud; + mysql> select id from host where type = 'SecondaryStorage'; + mysql> update host_details set value = 'nfs://192.168.160.20/export/mike-ss1' + where host_id = HOSTID and name = 'orig.url'; + mysql> update host set name = 'nfs://192.168.160.20/export/mike-ss1' where type + = 'SecondaryStorage' and id = #; + mysql> update host set url = 'nfs://192.168.160.20/export/mike-ss1' where type + = 'SecondaryStorage' and id = #; + mysql> update host set guid = 'nfs://192.168.160.20/export/mike-ss1' where type + = 'SecondaryStorage' and id = #; + + When copying and pasting a command, be sure the command has pasted as a single line before executing. Some document viewers may introduce unwanted line breaks in copied text. + Then log in to the cloud console UI and stop and start (not reboot) the Secondary Storage VM for that Zone. + +
+ diff --git a/docs/en-US/changing-service-offering-for-vm.xml b/docs/en-US/changing-service-offering-for-vm.xml index 5a42912e130..4fc9ef4270b 100644 --- a/docs/en-US/changing-service-offering-for-vm.xml +++ b/docs/en-US/changing-service-offering-for-vm.xml @@ -5,45 +5,50 @@ ]> -
- Changing the Service Offering for a VM - To upgrade or downgrade the level of compute resources available to a virtual machine, you can change the VM's compute offering. - - Log in to the &PRODUCT; UI as a user or admin. - In the left navigation, click Instances. - Choose the VM that you want to work with. - Click the Stop button to stop the VM - - - - StopButton.png: button to stop a VM - - - Click the Change Service button - - - - ChangeServiceButton.png: button to change the service of a VM - . The Change service dialog box is displayed. - Select the offering you want. - Click OK. - -
+ Changing the Service Offering for a VM + To upgrade or downgrade the level of compute resources available to a virtual machine, you can change the VM's compute offering. + + Log in to the &PRODUCT; UI as a user or admin. + In the left navigation, click Instances. + Choose the VM that you want to work with. + Click the Stop button to stop the VM. + + + + + StopButton.png: button to stop a VM + + + + Click the Change Service button. + + + + + ChangeServiceButton.png: button to change the service of a + VM + + + The Change service dialog box is displayed. + Select the offering you want to apply to the selected VM. + Click OK. + +
diff --git a/docs/en-US/changing-vm-name-os-group.xml b/docs/en-US/changing-vm-name-os-group.xml index f16ffdab059..daf78bca107 100644 --- a/docs/en-US/changing-vm-name-os-group.xml +++ b/docs/en-US/changing-vm-name-os-group.xml @@ -5,50 +5,55 @@ ]> -
- Changing the VM Name, OS, or Group - After a VM is created, you can modify the display name, operating system, and the group it belongs to. - To access a VM through the &PRODUCT; UI: - - Log in to the &PRODUCT; UI as a user or admin. - In the left navigation, click Instances. - Select the VM that you want to modify. - Click the Stop button to stop the VM - - - - StopButton.png: button to stop a VM - - - Click Edit - - - - StopButton.png: button to edit the properties of a VM - . - Make the desired changes to the following: - - Display name: Enter a new display name if you want to change the name of the VM. - OS Type: Select the desired operating system. - Group: Enter the group name for the VM. - - Click Apply. - -
+ Changing the VM Name, OS, or Group + After a VM is created, you can modify the display name, operating system, and the group it belongs to. + To access a VM through the &PRODUCT; UI: + + Log in to the &PRODUCT; UI as a user or admin. + In the left navigation, click Instances. + Select the VM that you want to modify. + Click the Stop button to stop the VM. + + + + + StopButton.png: button to stop a VM + + + + Click Edit. + + + + + EditButton.png: button to edit the properties of a VM + + + Make the desired changes to the following: + + Display name: Enter a new display name if you want to change + the name of the VM. + OS Type: Select the desired operating system. + Group: Enter the group name for the VM. + + Click Apply. + +
+ diff --git a/docs/en-US/cloud-infrastructure-concepts.xml b/docs/en-US/cloud-infrastructure-concepts.xml index 58f8844c826..8860d3a39f5 100644 --- a/docs/en-US/cloud-infrastructure-concepts.xml +++ b/docs/en-US/cloud-infrastructure-concepts.xml @@ -1,34 +1,34 @@ - %BOOK_ENTITIES; ]> -
+ Cloud Infrastructure Concepts - - - - - - - -
+ + + + + + + + diff --git a/docs/en-US/cloud-infrastructure-overview.xml b/docs/en-US/cloud-infrastructure-overview.xml index 5b467a33d4c..a761c47523c 100644 --- a/docs/en-US/cloud-infrastructure-overview.xml +++ b/docs/en-US/cloud-infrastructure-overview.xml @@ -1,46 +1,47 @@ - %BOOK_ENTITIES; ]> + 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. +-->
- Cloud Infrastructure Overview - - The Management Server manages one or more zones (typically, datacenters) containing host computers where guest virtual machines will run. The cloud infrastructure is organized as follows: - - - Zone: Typically, a zone is equivalent to a single datacenter. A zone consists of one or more pods and secondary storage. - Pod: A pod is usually one rack of hardware that includes a layer-2 switch and one or more clusters. - Cluster: A cluster consists of one or more hosts and primary storage. - Host: A single compute node within a cluster. The hosts are where the actual cloud services run in the form of guest virtual machines. - Primary storage is associated with a cluster, and it stores the disk volumes for all the VMs running on hosts in that cluster. - Secondary storage is associated with a zone, and it stores templates, ISO images, and disk volume snapshots. - - - - - - infrastructure_overview.png: Nested organization of a zone - - More Information - For more information, see . + Cloud Infrastructure Overview + + The Management Server manages one or more zones (typically, datacenters) containing host computers where guest virtual machines will run. The cloud infrastructure is organized as follows: + + + Zone: Typically, a zone is equivalent to a single datacenter. A zone consists of one or more pods and secondary storage. + Pod: A pod is usually one rack of hardware that includes a layer-2 switch and one or more clusters. + Cluster: A cluster consists of one or more hosts and primary storage. + Host: A single compute node within a cluster. The hosts are where the actual cloud services run in the form of guest virtual machines. + Primary storage is associated with a cluster, and it stores the disk volumes for all the VMs running on hosts in that cluster. + Secondary storage is associated with a zone, and it stores templates, ISO images, and disk volume snapshots. + + + + + + infrastructure-overview.png: Nested organization of a zone + + More Information + For more information, see .
+ diff --git a/docs/en-US/cloudstack_admin.xml b/docs/en-US/cloudstack_admin.xml index c80c94f5ff5..30ccebd5539 100644 --- a/docs/en-US/cloudstack_admin.xml +++ b/docs/en-US/cloudstack_admin.xml @@ -1,31 +1,52 @@ - %BOOK_ENTITIES; ]> - + - - + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/en-US/cluster-add.xml b/docs/en-US/cluster-add.xml index 5210bd8b84c..89f9bd2dc9d 100644 --- a/docs/en-US/cluster-add.xml +++ b/docs/en-US/cluster-add.xml @@ -1,28 +1,31 @@ - %BOOK_ENTITIES; ]>
- Adding a Cluster - TODO + Adding a Cluster + You need to tell &PRODUCT; about the hosts that it will manage. Hosts exist inside clusters, so before you begin adding hosts to the cloud, you must add at least one cluster. + + +
diff --git a/docs/en-US/compute-disk-service-offerings.xml b/docs/en-US/compute-disk-service-offerings.xml index 2469dfe3a15..1fd2a91a38b 100644 --- a/docs/en-US/compute-disk-service-offerings.xml +++ b/docs/en-US/compute-disk-service-offerings.xml @@ -5,33 +5,32 @@ ]> -
Compute and Disk Service Offerings - A service offering is a set of virtual hardware features such as CPU core count and speed, memory, and disk size. The CloudPlatform administrator can set up various offerings, and then end users choose from the available offerings when they create a new VM. A service offering includes the following elements: + A service offering is a set of virtual hardware features such as CPU core count and speed, memory, and disk size. The &PRODUCT; administrator can set up various offerings, and then end users choose from the available offerings when they create a new VM. A service offering includes the following elements: CPU, memory, and network resource guarantees How resources are metered How the resource usage is charged How often the charges are generated - For example, one service offering might allow users to create a virtual machine instance that is equivalent to a 1 GHz Intel Core 2 CPU, with 1 GB memory at $0.20/hour, with network traffic metered at $0.10/GB. Based on the user’s selected offering, CloudPlatform emits usage records that can be integrated with billing systems. CloudPlatform separates service offerings into compute offerings and disk offerings. The computing service offering specifies: + For example, one service offering might allow users to create a virtual machine instance that is equivalent to a 1 GHz Intel® Core™ 2 CPU, with 1 GB memory at $0.20/hour, with network traffic metered at $0.10/GB. Based on the user’s selected offering, &PRODUCT; emits usage records that can be integrated with billing systems. &PRODUCT; separates service offerings into compute offerings and disk offerings. The computing service offering specifies: Guest CPU Guest RAM @@ -43,4 +42,9 @@ Disk size (optional). An offering without a disk size will allow users to pick their own Tags on the data disk + + +
+ + diff --git a/docs/en-US/concepts.xml b/docs/en-US/concepts.xml index 1912c23a8c9..e20f442a935 100644 --- a/docs/en-US/concepts.xml +++ b/docs/en-US/concepts.xml @@ -1,30 +1,29 @@ - %BOOK_ENTITIES; ]> - - Concepts - - - + Concepts + + + diff --git a/docs/en-US/configure-guest-traffic-in-advanced-zone.xml b/docs/en-US/configure-guest-traffic-in-advanced-zone.xml index 95df4730985..a626c1332a2 100644 --- a/docs/en-US/configure-guest-traffic-in-advanced-zone.xml +++ b/docs/en-US/configure-guest-traffic-in-advanced-zone.xml @@ -5,46 +5,52 @@ ]> -
- Configure Guest Traffic in an Advanced Zone - These steps assume you have already logged in to the &PRODUCT; UI. To configure the base guest network: - - In the left navigation, choose Infrastructure. On Zones, click View More, then click the zone to which you want to add a network. - Click the Network tab. - Click Add network. - Provide the following information: - - Name. The name of the network. This will be user-visible - Description: The description of the network. This will be user-visible - VLAN ID: Enter an administrator-configured VLAN ID so you can create different networks for use by different VM users in the zone - Scope: Choose account-specific or domain-specific if you would like to make the network accessible to only a single account or domain. Choose zone-wide if all accounts with access to the zone should be able to access the network. - Domain/Account: If Scope is account-specific, enter the domain and account name for the account - Network offering: If the administrator has configured multiple network offerings, select the one you want to use for this network - Gateway: The gateway that the guests should use - Netmask: The netmask in use on the subnet the guests will use - Start IP/End IP: Enter the first and last IP addresses that define a range that &PRODUCT; can assign to guests. If one NIC is used, these IPs should be in the same CIDR as the pod CIDR. If multiple NICs are used, they may be in a different subnet. - Network Domain: (Optional) If you want to assign a special domain name to this network, specify the DNS suffix. - - - Click OK. - - - -
+ Configure Guest Traffic in an Advanced Zone + These steps assume you have already logged in to the &PRODUCT; UI. To configure the base guest network: + + In the left navigation, choose Infrastructure. On Zones, click View More, then click the zone to which you want to add a network. + Click the Network tab. + Click Add guest network. + The Add guest network window is displayed: + + + + + networksetupzone.png: Depicts network setup in a single zone + + + Provide the following information: + + Name. The name of the network. This will be + user-visible + Display Text: The description of the network. This will be + user-visible + Zone: The zone in which you are configuring the guest network. + Network offering: If the administrator has configured + multiple network offerings, select the one you want to use for this + network + Guest Gateway: The gateway that the guests should use + Guest Netmask: The netmask in use on the subnet the guests + will use + + + Click OK. + +
diff --git a/docs/en-US/configure-usage-server.xml b/docs/en-US/configure-usage-server.xml index d167a497b16..173f4a5306d 100644 --- a/docs/en-US/configure-usage-server.xml +++ b/docs/en-US/configure-usage-server.xml @@ -5,23 +5,22 @@ ]> -
Configuring the Usage Server To configure the usage server: @@ -54,17 +53,17 @@ usage.aggregation.timezone Time zone of usage records. Set this if the usage records and daily job execution are in different time zones. For example, with the following settings, the usage job will run at PST 00:15 and generate usage records for the 24 hours from 00:00:00 GMT to 23:59:59 GMT: - usage.stats.job.exec.time = 00:15 + usage.stats.job.exec.time = 00:15 usage.execution.timezone = PST usage.aggregation.timezone = GMT - Valid values for the time zone are specified in + Valid values for the time zone are specified in Default: GMT usage.execution.timezone - The time zone of usage.stats.job.exec.time. Valid values for the time zone are specified in + The time zone of usage.stats.job.exec.time. Valid values for the time zone are specified in Default: The time zone of the management server. @@ -75,13 +74,13 @@ usage.aggregation.timezone = GMT usage.stats.job.aggregation.range The time period in minutes between Usage Server processing jobs. For example, if you set it to 1440, the Usage Server will run once per day. If you set it to 600, it will run every ten hours. In general, when a Usage Server job runs, it processes all events generated since usage was last run. - There is special handling for the case of 1440 (once per day). In this case the Usage Server does not necessarily process all records since Usage was last run. &PRODUCT; assumes that you require processing once per day for the previous, complete day’s records. For example, if the current day is October 7, then it is assumed you would like to process records for October 6, from midnight to midnight. &PRODUCT; assumes this "midnight to midnight" is relative to the usage.execution.timezone. + There is special handling for the case of 1440 (once per day). In this case the Usage Server does not necessarily process all records since Usage was last run. &PRODUCT; assumes that you require processing once per day for the previous, complete day’s records. For example, if the current day is October 7, then it is assumed you would like to process records for October 6, from midnight to midnight. &PRODUCT; assumes this “midnight to midnight” is relative to the usage.execution.timezone. Default: 1440 usage.stats.job.exec.time - The time when the Usage Server processing will start. It is specified in 24-hour format (HH:MM) in the time zone of the server, which should be GMT. For example, to start the Usage job at 10:30 GMT, enter "10:30". + The time when the Usage Server processing will start. It is specified in 24-hour format (HH:MM) in the time zone of the server, which should be GMT. For example, to start the Usage job at 10:30 GMT, enter “10:30”. If usage.stats.job.aggregation.range is also set, and its value is not 1440, then its value will be added to usage.stats.job.exec.time to get the time to run the Usage Server job again. This is repeated until 24 hours have elapsed, and the next day's processing begins again at usage.stats.job.exec.time. Default: 00:15. @@ -97,5 +96,9 @@ usage.aggregation.timezone = GMT usage.stats.job.aggregation.range = 1440 With this configuration, the Usage job will run every night at 2 AM EST and will process records for the previous day’s midnight-midnight as defined by the EST (America/New_York) time zone. - Because the special value 1440 has been used for usage.stats.job.aggregation.range, the Usage Server will ignore the data between midnight and 2 AM. That data will be included in the next day's run + Because the special value 1440 has been used for usage.stats.job.aggregation.range, the Usage + Server will ignore the data between midnight and 2 AM. That data will be included in the + next day's run. + +
diff --git a/docs/en-US/configure-vpn.xml b/docs/en-US/configure-vpn.xml index 9e059f7aaba..87b4e65b56f 100644 --- a/docs/en-US/configure-vpn.xml +++ b/docs/en-US/configure-vpn.xml @@ -5,48 +5,49 @@ ]> - + 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. +-->
- Configuring VPN - To set up VPN for the cloud: - - Log in to the &PRODUCT; UI as an administrator or end user. - In the left navigation, click Global Settings. - Set the following global configuration parameters. - - remote.access.vpn.client.ip.range – The range of IP addressess to be allocated to remote access VPN clients. The first IP in the range is used by the VPN server. - remote.access.vpn.psk.length – Length of the IPSec key. - remote.access.vpn.user.limit – Maximum number of VPN users per account. - - To enable VPN for a particular network: - - Log in as a user or administrator to the &PRODUCT; UI. - In the left navigation, click Network. - Click the name of the network you want to work with. - Click View IP Addresses. - Click one of the displayed IP address names. - Click the Enable VPN button - - - - AttachDiskButton.png: button to attach a volume - . - The IPsec key is displayed in a popup window. - + Configuring VPN + To set up VPN for the cloud: + + Log in to the &PRODUCT; UI as an administrator or end user. + In the left navigation, click Global Settings. + Set the following global configuration parameters. + + remote.access.vpn.client.ip.range – The range of IP addressess to be allocated to remote access VPN clients. The first IP in the range is used by the VPN server. + remote.access.vpn.psk.length – Length of the IPSec key. + remote.access.vpn.user.limit – Maximum number of VPN users per account. + + To enable VPN for a particular network: + + Log in as a user or administrator to the &PRODUCT; UI. + In the left navigation, click Network. + Click the name of the network you want to work with. + Click View IP Addresses. + Click one of the displayed IP address names. + Click the Enable VPN button. + + + + + AttachDiskButton.png: button to attach a volume + + + The IPsec key is displayed in a popup window. +
diff --git a/docs/en-US/console-proxy.xml b/docs/en-US/console-proxy.xml index df29c428ad2..ade50bbd59f 100644 --- a/docs/en-US/console-proxy.xml +++ b/docs/en-US/console-proxy.xml @@ -5,21 +5,21 @@ ]>
@@ -32,4 +32,5 @@ Assignment of guest VM to console proxy is determined by first determining if the guest VM has a previous session associated with a console proxy. If it does, the Management Server will assign the guest VM to the target Console Proxy VM regardless of the load on the proxy VM. Failing that, the first available running Console Proxy VM that has the capacity to handle new sessions is used. Console proxies can be restarted by administrators but this will interrupt existing console sessions for users. The console viewing functionality uses a dynamic DNS service under the domain name realhostip.com to assist in providing SSL security to console sessions. The console proxy is assigned a public IP address. In order to avoid browser warnings for mismatched SSL certificates, the URL for the new console window is set to the form of https://aaa-bbb-ccc-ddd.realhostip.com. Customers will see this URL during console session creation. &PRODUCT; includes the realhostip.com SSL certificate in the console proxy VM. Of course, &PRODUCT; cannot know about DNS A records for our customers' public IPs prior to shipping the software. &PRODUCT; therefore runs a dynamic DNS server that is authoritative for the realhostip.com domain. It maps the aaa-bbb-ccc-ddd part of the DNS name to the IP address aaa.bbb.ccc.ddd on lookups. This allows the browser to correctly connect to the console proxy's public IP, where it then expects and receives a SSL certificate for realhostip.com, and SSL is set up without browser warnings. -
+ +
\ No newline at end of file diff --git a/docs/en-US/convert-hyperv-vm-to-template.xml b/docs/en-US/convert-hyperv-vm-to-template.xml index c6294d4443c..df388234d1f 100644 --- a/docs/en-US/convert-hyperv-vm-to-template.xml +++ b/docs/en-US/convert-hyperv-vm-to-template.xml @@ -5,64 +5,65 @@ ]> -
- Converting a Hyper-V VM to a Template - To convert a Hyper-V VM to a XenServer-compatible &PRODUCT; template, you will need a standalone XenServer host with an attached NFS VHD SR. Use whatever XenServer version you are using with &PRODUCT;, but use XenCenter 5.6 FP1 or SP2 (it is backwards compatible to 5.6). Additionally, it may help to have an attached NFS ISO SR. - For Linux VMs, you may need to do some preparation in Hyper-V before trying to get the VM to work in XenServer. Clone the VM and work on the clone if you still want to use the VM in Hyper-V. Uninstall Hyper-V Integration Components and check for any references to device names in /etc/fstab: - - From the linux_ic/drivers/dist directory, run make uninstall (where "linux_ic" is the path to the copied Hyper-V Integration Components files). - Restore the original initrd from backup in /boot/ (the backup is named *.backup0). - Remove the "hdX=noprobe" entries from /boot/grub/menu.lst. - Check /etc/fstab for any partitions mounted by device name. Change those entries (if any) to mount by LABEL or UUID (get that information with the "blkid" command).. - - The next step is make sure the VM is not running in Hyper-V, then get the VHD into XenServer. There are two options for doing this. - Option one: - - Import the VHD using XenCenter. In XenCenter, go to Tools>Virtual Appliance Tools>Disk Image Import. - Choose the VHD, then click Next. - Name the VM, choose the NFS VHD SR under Storage, enable "Run Operating System Fixups" and choose the NFS ISO SR. - Click Next, then Finish. A VM should be created. - - Option two - - Run XenConvert, under From choose VHD, under To choose XenServer. Click Next. - Choose the VHD, then click Next. - Input the XenServer host info, then click Next. - Name the VM, then click Next, then Convert. A VM should be created - - Once you have a VM created from the Hyper-V VHD, prepare it using the following steps: - - Boot the VM, uninstall Hyper-V Integration Services, and reboot. - Install XenServer Tools, then reboot. - Prepare the VM as desired. For example, run sysprep on Windows VMs. See - - Either option above will create a VM in HVM mode. This is fine for Windows VMs, but Linux VMs may not perform optimally. Converting a Linux VM to PV mode will require additional steps and will vary by distribution. - - Shut down the VM and copy the VHD from the NFS storage to a web server; for example, mount the NFS share on the web server and copy it, or from the XenServer host use sftp or scp to upload it to the web server. - In &PRODUCT;, create a new template using the following values: - - URL. Give the URL for the VHD - OS Type. Use the appropriate OS. For PV mode on CentOS, choose Other PV (32-bit) or Other PV (64-bit). This choice is available only for XenServer. - Hypervisor. XenServer - Format. VHD - - - The template will be created, and you can create instances from it. + Converting a Hyper-V VM to a Template + To convert a Hyper-V VM to a XenServer-compatible &PRODUCT; template, you will need a standalone XenServer host with an attached NFS VHD SR. Use whatever XenServer version you are using with &PRODUCT;, but use XenCenter 5.6 FP1 or SP2 (it is backwards compatible to 5.6). Additionally, it may help to have an attached NFS ISO SR. + For Linux VMs, you may need to do some preparation in Hyper-V before trying to get the VM to work in XenServer. Clone the VM and work on the clone if you still want to use the VM in Hyper-V. Uninstall Hyper-V Integration Components and check for any references to device names in /etc/fstab: + + From the linux_ic/drivers/dist directory, run make uninstall (where "linux_ic" is the path to the copied Hyper-V Integration Components files). + Restore the original initrd from backup in /boot/ (the backup is named *.backup0). + Remove the "hdX=noprobe" entries from /boot/grub/menu.lst. + Check /etc/fstab for any partitions mounted by device name. Change those entries (if any) to + mount by LABEL or UUID. You can get that information with the blkid command. + + The next step is make sure the VM is not running in Hyper-V, then get the VHD into XenServer. There are two options for doing this. + Option one: + + Import the VHD using XenCenter. In XenCenter, go to Tools>Virtual Appliance Tools>Disk Image Import. + Choose the VHD, then click Next. + Name the VM, choose the NFS VHD SR under Storage, enable "Run Operating System Fixups" and choose the NFS ISO SR. + Click Next, then Finish. A VM should be created. + + Option two: + + Run XenConvert, under From choose VHD, under To choose XenServer. Click Next. + Choose the VHD, then click Next. + Input the XenServer host info, then click Next. + Name the VM, then click Next, then Convert. A VM should be created. + + Once you have a VM created from the Hyper-V VHD, prepare it using the following steps: + + Boot the VM, uninstall Hyper-V Integration Services, and reboot. + Install XenServer Tools, then reboot. + Prepare the VM as desired. For example, run sysprep on Windows VMs. See . + + Either option above will create a VM in HVM mode. This is fine for Windows VMs, but Linux VMs may not perform optimally. Converting a Linux VM to PV mode will require additional steps and will vary by distribution. + + Shut down the VM and copy the VHD from the NFS storage to a web server; for example, mount the NFS share on the web server and copy it, or from the XenServer host use sftp or scp to upload it to the web server. + In &PRODUCT;, create a new template using the following values: + + URL. Give the URL for the VHD + OS Type. Use the appropriate OS. For PV mode on CentOS, choose Other PV (32-bit) or Other PV (64-bit). This choice is available only for XenServer. + Hypervisor. XenServer + Format. VHD + + + + The template will be created, and you can create instances from it.
diff --git a/docs/en-US/create-template-from-existing-vm.xml b/docs/en-US/create-template-from-existing-vm.xml index c22b7ec7f5c..35788fdfcc1 100644 --- a/docs/en-US/create-template-from-existing-vm.xml +++ b/docs/en-US/create-template-from-existing-vm.xml @@ -5,45 +5,52 @@ ]> - + 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. +-->
- Creating a Template from an Existing Virtual Machine - Once you have at least one VM set up in the way you want, you can use it as the prototype for other VMs. - - Create and start a virtual machine using any of the techniques given in . - Make any desired configuration changes on the running VM, then click Stop. - Wait for the VM to stop. When the status shows Stopped, go to the next step. - Click Create Template and provide the following: - - Name and Display Text. These will be shown in the UI, so choose something descriptive. - OS Type. This helps &PRODUCT; and the hypervisor perform certain operations and make assumptions that improve the performance of the guest. Select one of the following. - - If the operating system of the stopped VM is listed, choose it. - If the OS type of the stopped VM is not listed, choose Other. - If you want to boot from this template in PV mode, choose Other PV (32-bit) or Other PV (64-bit). This choice is available only for XenServere: - Note: Generally you should not choose an older version of the OS than the version in the image. For example, choosing CentOS 5.4 to support a CentOS 6.2 image will in general not work. In those cases you should choose Other. - - - Public. Choose Yes to make this template accessible to all users of this &PRODUCT; installation. The template will appear in the Community Templates list. See . - Password Enabled. Choose Yes if your template has the &PRODUCT; password change script installed. See Adding Password Management to Your Templates. - - Click Add. - - The new template will be visible in the Templates section when the template creation process has been completed. The template is then available when creating a new VM + Creating a Template from an Existing Virtual Machine + Once you have at least one VM set up in the way you want, you can use it as the prototype for other VMs. + + Create and start a virtual machine using any of the techniques given in . + Make any desired configuration changes on the running VM, then click Stop. + Wait for the VM to stop. When the status shows Stopped, go to the next step. + Click Create Template and provide the following: + + Name and Display Text. These will be shown in the UI, so + choose something descriptive. + OS Type. This helps &PRODUCT; and the hypervisor perform + certain operations and make assumptions that improve the performance of the + guest. Select one of the following. + + If the operating system of the stopped VM is listed, choose it. + If the OS type of the stopped VM is not listed, choose Other. + If you want to boot from this template in PV mode, choose Other PV (32-bit) or Other PV (64-bit). This choice is available only for XenServere: + Note: Generally you should not choose an older version of the OS than the version in the image. For example, choosing CentOS 5.4 to support a CentOS 6.2 image will in general not work. In those cases you should choose Other. + + + Public. Choose Yes to make this template accessible to all + users of this &PRODUCT; installation. The template will appear in the + Community Templates list. See . + Password Enabled. Choose Yes if your template has the + &PRODUCT; password change script installed. See . + + Click Add. + + The new template will be visible in the Templates section when the template creation process + has been completed. The template is then available when creating a new VM.
diff --git a/docs/en-US/create-template-from-snapshot.xml b/docs/en-US/create-template-from-snapshot.xml index 30750326c9f..b212adcfba5 100644 --- a/docs/en-US/create-template-from-snapshot.xml +++ b/docs/en-US/create-template-from-snapshot.xml @@ -5,25 +5,27 @@ ]> -
Creating a Template from a Snapshot - Not supported by Oracle VM - If you do not want to stop the VM in order to use the Create Template menu item (as described in ), you can create a template directly from any snapshot through the &PRODUCT; UI. + Not supported by Oracle VM. + + If you do not want to stop the VM to use the Create Template menu item, as described in + ), you can create a template directly + from any snapshot through the &PRODUCT; UI.
diff --git a/docs/en-US/create-templates-overview.xml b/docs/en-US/create-templates-overview.xml index 818b42d1068..900165f482f 100644 --- a/docs/en-US/create-templates-overview.xml +++ b/docs/en-US/create-templates-overview.xml @@ -5,31 +5,33 @@ ]> -
- Creating Templates: Overview - &PRODUCT; ships with a default template for the CentOS operating system. There are a variety of ways to add more templates. Administrators and end users can add templates. The typical sequence of events is: - - Launch a VM instance that has the operating system you want. Make any other desired configuration changes to the VM. - Stop the VM. - Convert the volume into a template. - - There are other ways to add templates to &PRODUCT;. For example, you can take a snapshot of the VM's volume and create a template from the snapshot, or import a VHD from another system into &PRODUCT; - The various techniques for creating templates are described in the next few sections. + Creating Templates: Overview + &PRODUCT; ships with a default template for the CentOS operating system. There are a variety of ways to add more templates. Administrators and end users can add templates. The typical sequence of events is: + + Launch a VM instance that has the operating system you want. Make any other desired configuration changes to the VM. + Stop the VM. + Convert the volume into a template. + + There are other ways to add templates to &PRODUCT;. For example, you can take a snapshot + of the VM's volume and create a template from the snapshot, or import a VHD from another + system into &PRODUCT;. + The various techniques for creating templates are described in the next few sections. +
diff --git a/docs/en-US/create-windows-template.xml b/docs/en-US/create-windows-template.xml index f8dbc79bce9..d02f0678444 100644 --- a/docs/en-US/create-windows-template.xml +++ b/docs/en-US/create-windows-template.xml @@ -5,34 +5,36 @@ ]>
- Creating a Windows Template - Windows templates must be prepared with Sysprep before they can be provisioned on multiple machines. Sysprep allows you to create a generic Windows template and avoid any possible SID conflicts. - (XenServer) Windows VMs running on XenServer require PV drivers, which may be provided in the template or added after the VM is created. The PV drivers are necessary for essential management functions such as mounting additional volumes and ISO images, live migration, and graceful shutdown. - An overview of the procedure is as follows: - - Upload your Windows ISO. For more information, see - Create a VM Instance with this ISO. For more information, see - Follow the steps in Sysprep for Windows Server 2008 R2 (below) or Sysprep for Windows Server 2003 R2, depending on your version of Windows Server - The preparation steps are complete. Now you can actually create the template as described in Creating the Windows Template. - - - -
+ Creating a Windows Template + Windows templates must be prepared with Sysprep before they can be provisioned on multiple machines. Sysprep allows you to create a generic Windows template and avoid any possible SID conflicts. + (XenServer) Windows VMs running on XenServer require PV drivers, which may be provided in the template or added after the VM is created. The PV drivers are necessary for essential management functions such as mounting additional volumes and ISO images, live migration, and graceful shutdown. + + + An overview of the procedure is as follows: + + Upload your Windows ISO. For more information, see . + Create a VM Instance with this ISO. For more information, see . + Follow the steps in Sysprep for Windows Server 2008 R2 (below) or Sysprep for Windows Server 2003 R2, depending on your version of Windows Server + The preparation steps are complete. Now you can actually create the template as described in Creating the Windows Template. + + + +
diff --git a/docs/en-US/creating-compute-offerings.xml b/docs/en-US/creating-compute-offerings.xml index 56679a422f4..31f974196fb 100644 --- a/docs/en-US/creating-compute-offerings.xml +++ b/docs/en-US/creating-compute-offerings.xml @@ -5,23 +5,22 @@ ]> - + 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. +-->
Creating a New Compute Offering To create a new compute offering: @@ -32,19 +31,36 @@ Click Add Compute Offering. In the dialog, make the following choices: - Name. Any desired name for the service offering. - Description. A short description of the offering that can be displayed to users - Storage type. The type of disk that should be allocated. Local allocates from storage attached directly to the host where the system VM is running. Shared allocates from storage accessible via NFS. - # of CPU cores. The number of cores which should be allocated to a system VM with this offering - CPU (in MHz). The CPU speed of the cores that the system VM is allocated. For example, "2000" would provide for a 2 GHz clock. - Memory (in MB). The amount of memory in megabytes that the system VM should be allocated. For example, "2048" would provide for a 2 GB RAM allocation. - Network Rate. Allowed data transfer rate in MB per second. - Offer HA. If yes, the administrator can choose to have the system VM be monitored and as highly available as possible. - Storage Tags. The tags that should be associated with the primary storage used by the system VM. - Host Tags. (Optional) Any tags that you use to organize your hosts - CPU cap. Whether to limit the level of CPU usage even if spare capacity is available. - Public. Indicate whether the service offering should be available all domains or only some domains. Choose Yes to make it available to all domains. Choose No to limit the scope to a subdomain; &PRODUCT; will then prompt for the subdomain's name. + Name: Any desired name for the service offering. + Description: A short description of the offering that can be + displayed to users + Storage type: The type of disk that should be allocated. + Local allocates from storage attached directly to the host where the system + VM is running. Shared allocates from storage accessible via NFS. + # of CPU cores: The number of cores which should be allocated + to a system VM with this offering + CPU (in MHz): The CPU speed of the cores that the system VM + is allocated. For example, “2000” would provide for a 2 GHz clock. + Memory (in MB): The amount of memory in megabytes that the + system VM should be allocated. For example, “2048” would provide for a 2 GB + RAM allocation. + Network Rate: Allowed data transfer rate in MB per + second. + Offer HA: If yes, the administrator can choose to have the + system VM be monitored and as highly available as possible. + Storage Tags: The tags that should be associated with the + primary storage used by the system VM. + Host Tags: (Optional) Any tags that you use to organize your + hosts + CPU cap: Whether to limit the level of CPU usage even if + spare capacity is available. + Public: Indicate whether the service offering should be + available all domains or only some domains. Choose Yes to make it available + to all domains. Choose No to limit the scope to a subdomain; &PRODUCT; + will then prompt for the subdomain's name. Click Add. + +
diff --git a/docs/en-US/creating-network-offerings.xml b/docs/en-US/creating-network-offerings.xml index ab569200641..d733924ba70 100644 --- a/docs/en-US/creating-network-offerings.xml +++ b/docs/en-US/creating-network-offerings.xml @@ -5,23 +5,22 @@ ]> -
Creating a New Network Offering To create a network offering: @@ -32,13 +31,23 @@ Click Add Network Offering. In the dialog, make the following choices: - Name. Any desired name for the network offering - Description. A short description of the offering that can be displayed to users - Network Rate. Allowed data transfer rate in MB per second - Traffic Type. The type of network traffic that will be carried on the network - Guest Type. Choose whether the guest network is isolated or shared. For a description of these terms, see - Specify VLAN. (Isolated guest networks only) Indicate whether a VLAN should be specified when this offering is used - Supported Services. Select one or more of the possible network services. For some services, you must also choose the service provider; for example, if you select Load Balancer, you can choose the &PRODUCT; virtual router or any other load balancers that have been configured in the cloud. Depending on which services you choose, additional fields may appear in the rest of the dialog box.Based on the guest network type selected, you can see the following supported services: + Name. Any desired name for the network offering + Description. A short description of the offering that can be + displayed to users + Network Rate. Allowed data transfer rate in MB per + second + Guest Type. Choose whether the guest network is isolated or + shared. For a description of these terms, see + + Specify VLAN. (Isolated guest networks only) Indicate whether + a VLAN should be specified when this offering is used + Supported Services. Select one or more of the possible + network services. For some services, you must also choose the service + provider; for example, if you select Load Balancer, you can choose the + &PRODUCT; virtual router or any other load balancers that have been + configured in the cloud. Depending on which services you choose, additional + fields may appear in the rest of the dialog box.Based on the guest network type selected, you can see the following supported services: @@ -51,55 +60,68 @@ DHCP - + For more information, see . Supported Supported DNS - + For more information, see . Supported Supported Load Balancer - If you select Load Balancer, you can choose the &PRODUCT; virtual router or any other load balancers that have been configured in the cloud. + If you select Load Balancer, you can choose the &PRODUCT; virtual router or any other load + balancers that have been configured in the cloud. Supported Supported Source NAT - If you select Source NAT, you can choose the &PRODUCT; virtual router or any other Source NAT providers that have been configured in the cloud. + If you select Source NAT, you can choose the &PRODUCT; virtual router or any other Source + NAT providers that have been configured in the + cloud. Supported Supported Static NAT - If you select Static NAT, you can choose the &PRODUCT; virtual router or any other Static NAT providers that have been configured in the cloud. + If you select Static NAT, you can choose the &PRODUCT; virtual router or any other Static + NAT providers that have been configured in the + cloud. Supported Supported Port Forwarding - If you select Port Forwarding, you can choose the &PRODUCT; virtual router or any other Port Forwarding providers that have been configured in the cloud. + If you select Port Forwarding, you can choose the &PRODUCT; virtual router or any other + Port Forwarding providers that have been configured in + the cloud. Supported Not Supported VPN - + For more information, see . Supported Not Supported User Data - + For more information, see . Not Supported Supported + + Network ACL + For more information, see . + Supported + Not Supported + Security Groups - See . + For more information, see . Not Supported Supported @@ -107,11 +129,39 @@ - System Offering. If the service provider for any of the services selected in Supported Services is a virtual router, the System Offering field appears. Choose the system service offering that you want virtual routers to use in this network. For example, if you selected Load Balancer in Supported Services and selected a virtual router to provide load balancing, the System Offering field appears so you can choose between the &PRODUCT; default system service offering and any custom system service offerings that have been defined by the &PRODUCT; root administrator. For more information, see System Service Offerings. - Redundant router capability. (v3.0.3 and greater) Available only when Virtual Router is selected as the Source NAT provider. Select this option if you want to use two virtual routers in the network for uninterrupted connection: one operating as the master virtual router and the other as the backup. The master virtual router receives requests from and sends responses to the user’s VM. The backup virtual router is activated only when the master is down. After the failover, the backup becomes the master virtual router. &PRODUCT; deploys the routers on different hosts to ensure reliability if one host is down. - Conserve mode. Indicate whether to use conserve mode. In this mode, network resources are allocated only when the first virtual machine starts in the network - Tags. Network tag to specify which physical network to use + System Offering. If the service provider for any of the + services selected in Supported Services is a virtual router, the System + Offering field appears. Choose the system service offering that you want + virtual routers to use in this network. For example, if you selected Load + Balancer in Supported Services and selected a virtual router to provide load + balancing, the System Offering field appears so you can choose between the + &PRODUCT; default system service offering and any custom system service + offerings that have been defined by the &PRODUCT; root administrator. + For more information, see System Service Offerings. + Redundant router capability. (v3.0.3 and greater) Available + only when Virtual Router is selected as the Source NAT provider. Select this + option if you want to use two virtual routers in the network for + uninterrupted connection: one operating as the master virtual router and the + other as the backup. The master virtual router receives requests from and + sends responses to the user’s VM. The backup virtual router is activated + only when the master is down. After the failover, the backup becomes the + master virtual router. &PRODUCT; deploys the routers on different hosts + to ensure reliability if one host is down. + Conserve mode. Indicate whether to use conserve mode. In this + mode, network resources are allocated only when the first virtual machine + starts in the network. When the conservative mode is off, the public IP can + only be used for a single service. For example, a public IP used for a port + forwarding rule cannot be used for defining other services, such as SaticNAT + or load balancing. When the conserve mode is on, you can define more than + one service on the same public IP. + If StaticNAT is enabled, irrespective of the status of the conserve mode, no port forwarding + or load balancing rule can be created for the IP. However, you can add + the firewall rules by using the createFirewallRule command. + Tags. Network tag to specify which physical network to + use. Click Add. + +
diff --git a/docs/en-US/creating-new-volumes.xml b/docs/en-US/creating-new-volumes.xml index 62181b9ea36..5a12d7f5783 100644 --- a/docs/en-US/creating-new-volumes.xml +++ b/docs/en-US/creating-new-volumes.xml @@ -5,37 +5,59 @@ ]> - + 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. +-->
- Creating a New Volume - You can add more data disk volumes to a guest VM at any time, up to the limits of your storage capacity. Both &PRODUCT; administrators and users can add volumes to VM instances. When you create a new volume, it is stored as an entity in &PRODUCT;, but the actual storage resources are not allocated on the physical storage device until you attach the volume. This optimization allows the &PRODUCT; to provision the volume nearest to the guest that will use it when the first attachment is made. - - Log in to the &PRODUCT; UI as a user or admin. - In the left navigation bar, click Storage. - In Select View, choose Volumes. - To create a new volume, click Add Volume, provide the following details, and click OK. - - Name. Give the volume a unique name so you can find it later. - Availability Zone. Where do you want the storage to reside? This should be close to the VM that will use the volume. - Disk Offering. Choose the characteristics of the storage. - - The new volume appears in the list of volumes with the state “Allocated.” The volume data is stored in &PRODUCT;, but the volume is not yet ready for use - To start using the volume, continue to Attaching a Volume - -
+ Creating a New Volume + You can add more data disk volumes to a guest VM at any time, up to the limits of your storage capacity. Both &PRODUCT; administrators and users can add volumes to VM instances. When you create a new volume, it is stored as an entity in &PRODUCT;, but the actual storage resources are not allocated on the physical storage device until you attach the volume. This optimization allows the &PRODUCT; to provision the volume nearest to the guest that will use it when the first attachment is made. +
+ Using Local Storage for Data Volumes + You can create data volumes on local storage (supported with XenServer, KVM, and VMware). + The data volume is placed on the same + host as the VM instance that is attached to the data volume. These + local data volumes can be attached to virtual machines, detached, re-attached, + and deleted just as with the other types of data volume. + Local storage is ideal for scenarios where persistence of data volumes and HA + is not required. Some of the benefits include reduced disk I/O latency and cost + reduction from using inexpensive local disks. + In order for local volumes to be used, the feature must be enabled for the + zone. + You can create a data disk offering for local storage. When a user creates a + new VM, they can select this disk offering in order to cause the data disk + volume to be placed in local storage. + You can not migrate a VM that has a volume in local storage to a different + host, nor migrate the volume itself away to a different host. If you want to put + a host into maintenance mode, you must first stop any VMs with local data + volumes on that host. +
+
+ To Create a New Volume + + Log in to the &PRODUCT; UI as a user or admin. + In the left navigation bar, click Storage. + In Select View, choose Volumes. + To create a new volume, click Add Volume, provide the following details, and click OK. + + Name. Give the volume a unique name so you can find it later. + Availability Zone. Where do you want the storage to reside? This should be close to the VM that will use the volume. + Disk Offering. Choose the characteristics of the storage. + + The new volume appears in the list of volumes with the state “Allocated.” The volume data is stored in &PRODUCT;, but the volume is not yet ready for use + To start using the volume, continue to Attaching a Volume + +
+
diff --git a/docs/en-US/creating-vms.xml b/docs/en-US/creating-vms.xml index dc37dbb38c3..beb528f3908 100644 --- a/docs/en-US/creating-vms.xml +++ b/docs/en-US/creating-vms.xml @@ -3,47 +3,53 @@ %BOOK_ENTITIES; ]> - -
- Creating VMs - Virtual machines are usually created from a template. Users can also create blank virtual machines. A blank virtual machine is a virtual machine without an OS template. Users can attach an ISO file and install the OS from the CD/DVD-ROM. - To create a VM from a template: - - Log in to the &PRODUCT; UI as an administrator or user. - In the left navigation bar, click Instances. - Click Add Instance. - Select a template, then follow the steps in the wizard. (For more information about how the templates came to be in this list, see Working with Templates. - Be sure that the hardware you have allows starting the selected service offering. - Click Submit and your VM will be created and started. - For security reason, the internal name of the VM is visible only to the root admin. - - Starting with v3.0.3, you can create a VM without starting it. You can determine whether the VM needs to be started as part of the VM deployment. A new request parameter, startVM, is introduced in the deployVm API to support this feature. For more information, see the Developer's Guide - To create a VM from an ISO: - (XenServer) Windows VMs running on XenServer require PV drivers, which may be provided in the template or added after the VM is created. The PV drivers are necessary for essential management functions such as mounting additional volumes and ISO images, live migration, and graceful shutdown. - - Log in to the &PRODUCT; UI as an administrator or user. - In the left navigation bar, click Instances. - Click Add Instance. - Select ISO Boot, and follow the steps in the wizard. - Click Submit and your VM will be created and started. - (Oracle VM only) After ISO installation, the installer reboots into the operating system. Due to a known issue in OVM, the reboot will place the VM in the Stopped state. In the &PRODUCT; UI, detach the ISO from the VM (so that the VM will not boot from the ISO again), then click the Start button to restart the VM. - + Creating VMs + Virtual machines are usually created from a template. Users can also create blank virtual machines. A blank virtual machine is a virtual machine without an OS template. Users can attach an ISO file and install the OS from the CD/DVD-ROM. + Starting with v3.0.3, you can create a VM without starting it. You can determine whether the VM needs to be started as part of the VM deployment. A new request parameter, startVM, is introduced in the deployVm API to support this feature. For more information, see the Developer's Guide + To create a VM from a template: + + Log in to the &PRODUCT; UI as an administrator or user. + In the left navigation bar, click Instances. + + Click Add Instance. + + + Select a zone. + + Select a template, then follow the steps in the wizard. For more information about how the templates came to be in this list, see . + Be sure that the hardware you have allows starting the selected service offering. + Click Submit and your VM will be created and started. + For security reason, the internal name of the VM is visible only to the root admin. + + + To create a VM from an ISO: + (XenServer) Windows VMs running on XenServer require PV drivers, which may be provided in the template or added after the VM is created. The PV drivers are necessary for essential management functions such as mounting additional volumes and ISO images, live migration, and graceful shutdown. + + Log in to the &PRODUCT; UI as an administrator or user. + In the left navigation bar, click Instances. + Click Add Instance. + Select a zone. + Select ISO Boot, and follow the steps in the wizard. + Click Submit and your VM will be created and started. + (Oracle VM only) After ISO installation, the installer reboots into the operating system. Due to a known issue in OVM, the reboot will place the VM in the Stopped state. In the &PRODUCT; UI, detach the ISO from the VM (so that the VM will not boot from the ISO again), then click the Start button to restart the VM. +
+ diff --git a/docs/en-US/default-account-resource-limit.xml b/docs/en-US/default-account-resource-limit.xml index abc313f46bf..5134e508c11 100644 --- a/docs/en-US/default-account-resource-limit.xml +++ b/docs/en-US/default-account-resource-limit.xml @@ -5,36 +5,41 @@ ]> -
Default Account Resource Limits - You can limit resource use by accounts. The default limits are set using global configuration parameters, and they affect all accounts within a cloud. The relevant parameters are those beginning with max.account (max.account.snapshots, etc.).. + You can limit resource use by accounts. The default limits are set by using global + configuration parameters, and they affect all accounts within a cloud. The relevant + parameters are those beginning with max.account, for example: max.account.snapshots. To override a default limit for a particular account, set a per-account resource limit. Log in to the &PRODUCT; UI. In the left navigation tree, click Accounts. - Select the account you want to modify. The current limits are displayed. A value of -1 shows that there is no limit in place - Click the Edit button - - - - editbutton.png: edits the settings. - + Select the account you want to modify. The current limits are displayed. A value of -1 shows + that there is no limit in place. + Click the Edit button. + + + + + editbutton.png: edits the settings + + +
diff --git a/docs/en-US/deleting-vms.xml b/docs/en-US/deleting-vms.xml index 1f1ee959f57..97245c81ef4 100644 --- a/docs/en-US/deleting-vms.xml +++ b/docs/en-US/deleting-vms.xml @@ -5,37 +5,39 @@ ]> -
- Deleting VMs - Users can delete their own virtual machines. A running virtual machine will be abruptly stopped before it is deleted. Administrators can delete any virtual machines. - To delete a virtual machine: - - Log in to the &PRODUCT; UI as a user or admin. - In the left navigation, click Instances. - Choose the VM that you want to delete. - Click the Destroy Instance button - - - - Destroyinstance.png: button to destroy an instance - - - -
+ Deleting VMs + Users can delete their own virtual machines. A running virtual machine will be abruptly stopped before it is deleted. Administrators can delete any virtual machines. + To delete a virtual machine: + + Log in to the &PRODUCT; UI as a user or admin. + In the left navigation, click Instances. + Choose the VM that you want to delete. + Click the Destroy Instance button. + + + + + Destroyinstance.png: button to destroy an instance + + + + + + diff --git a/docs/en-US/deployment-architecture-overview.xml b/docs/en-US/deployment-architecture-overview.xml index 6a67a2ce589..1df0a5291fb 100644 --- a/docs/en-US/deployment-architecture-overview.xml +++ b/docs/en-US/deployment-architecture-overview.xml @@ -1,44 +1,43 @@ - %BOOK_ENTITIES; ]> -
- Deployment Architecture Overview - - A &PRODUCT; installation consists of two parts: the Management Server and the cloud infrastructure that it manages. When you set up and manage a &PRODUCT; cloud, you provision resources such as hosts, storage devices, and IP addresses into the Management Server, and the Management Server manages those resources. - - - The minimum production installation consists of one machine running the &PRODUCT; Management Server and another machine to act as the cloud infrastructure (in this case, a very simple infrastructure consisting of one host running hypervisor software). In a trial installation, a single machine can act as both the Management Server and the hypervisor host (using the KVM hypervisor). - - - - - - basic-deployment.png: Basic two-machine deployment - - A more full-featured installation consists of a highly-available multi-node Management Server installation and up to thousands of hosts using any of several advanced networking setups. For information about deployment options, see Choosing a Deployment Architecture. - - - - + Deployment Architecture Overview + + A &PRODUCT; installation consists of two parts: the Management Server and the cloud infrastructure that it manages. When you set up and manage a &PRODUCT; cloud, you provision resources such as hosts, storage devices, and IP addresses into the Management Server, and the Management Server manages those resources. + + + The minimum production installation consists of one machine running the &PRODUCT; Management Server and another machine to act as the cloud infrastructure (in this case, a very simple infrastructure consisting of one host running hypervisor software). In a trial installation, a single machine can act as both the Management Server and the hypervisor host (using the KVM hypervisor). + + + + + + basic-deployment.png: Basic two-machine deployment + + A more full-featured installation consists of a highly-available multi-node Management Server installation and up to thousands of hosts using any of several advanced networking setups. For information about deployment options, see Choosing a Deployment Architecture. + + + +
diff --git a/docs/en-US/detach-move-volumes.xml b/docs/en-US/detach-move-volumes.xml index a00e15f6cee..a902fdba432 100644 --- a/docs/en-US/detach-move-volumes.xml +++ b/docs/en-US/detach-move-volumes.xml @@ -5,39 +5,42 @@ ]> -
- Attaching a Volume - This procedure is different from moving disk volumes from one storage pool to another. See VM Storage Migration - A volume can be detached from a guest VM and attached to another guest. Both &PRODUCT; administrators and users can detach volumes from VMs and move them to other VMs. - If the two VMs are in different clusters, and the volume is large, it may take several minutes for the volume to be moved to the new VM. - If the destination VM is running in the OVM hypervisor, the VM must be stopped before a new volume can be attached to it. - - Log in to the &PRODUCT; UI as a user or admin. - In the left navigation bar, click Storage, and choose Volumes in Select View. Alternatively, if you know which VM the volume is attached to, you can click Instances, click the VM name, and click View Volumes. - Click the name of the volume you want to detach, then click the Detach Disk button - - - - DetachDiskButton.png: button to detach a volume - - - To move the volume to another VM, follow the steps in Attaching a Volume . - -
+ Detaching and Moving Volumes + This procedure is different from moving disk volumes from one storage pool to another. See VM Storage Migration + A volume can be detached from a guest VM and attached to another guest. Both &PRODUCT; administrators and users can detach volumes from VMs and move them to other VMs. + If the two VMs are in different clusters, and the volume is large, it may take several minutes for the volume to be moved to the new VM. + If the destination VM is running in the OVM hypervisor, the VM must be stopped before a new volume can be attached to it. + + Log in to the &PRODUCT; UI as a user or admin. + In the left navigation bar, click Storage, and choose Volumes in Select View. Alternatively, if you know which VM the volume is attached to, you can click Instances, click the VM name, and click View Volumes. + Click the name of the volume you want to detach, then click the Detach Disk button. + + + + + DetachDiskButton.png: button to detach a volume + + + + To move the volume to another VM, follow the steps in . + + + diff --git a/docs/en-US/developer-guide.xml b/docs/en-US/developer-guide.xml index c4bdf39d6fc..4d4a9d60ae9 100644 --- a/docs/en-US/developer-guide.xml +++ b/docs/en-US/developer-guide.xml @@ -5,26 +5,25 @@ ]> - - Using the API - + Using the API + @@ -32,7 +31,5 @@ - - - + diff --git a/docs/en-US/enable-disable-static-nat.xml b/docs/en-US/enable-disable-static-nat.xml index f25327a54b3..0154dca2732 100644 --- a/docs/en-US/enable-disable-static-nat.xml +++ b/docs/en-US/enable-disable-static-nat.xml @@ -5,40 +5,42 @@ ]> -
- Enabling or Disabling Static NAT - If port forwarding rules are already in effect for an IP address, you cannot enable static NAT to that IP. - If a guest VM is part of more than one network, static NAT rules will function only if they are defined on the default network. - - Log in to the &PRODUCT; UI as an administrator or end user. - In the left navigation, choose Network. - Click the name of the network where you want to work with. - Click View IP Addresses. - Click the IP address you want to work with. - - Click the Static NAT button. - - - - ReleaseIPButton.png: button to release an IP - The button toggles between Enable and Disable, depending on whether static NAT is currently enabled for the IP address. - If you are enabling static NAT, a dialog appears where you can choose the destination VM and click Apply - + Enabling or Disabling Static NAT + If port forwarding rules are already in effect for an IP address, you cannot enable static NAT to that IP. + If a guest VM is part of more than one network, static NAT rules will function only if they are defined on the default network. + + Log in to the &PRODUCT; UI as an administrator or end user. + In the left navigation, choose Network. + Click the name of the network where you want to work with. + Click View IP Addresses. + Click the IP address you want to work with. + + Click the Static NAT + + + + + ReleaseIPButton.png: button to release an IP + + button.The button toggles between Enable and Disable, depending on whether static NAT is currently enabled for the IP address. + If you are enabling static NAT, a dialog appears where you can choose the destination VM and + click Apply. +
diff --git a/docs/en-US/enable-security-groups.xml b/docs/en-US/enable-security-groups.xml index 27f69d2cef2..c957310f9d6 100644 --- a/docs/en-US/enable-security-groups.xml +++ b/docs/en-US/enable-security-groups.xml @@ -5,25 +5,28 @@ ]> -
- Enabling Security Groups - In order for security groups to function in a zone, the security groups feature must first be enabled for the zone. The administrator can do this when creating a new zone, by selecting a network offering that includes security groups. The procedure is described in Basic Zone Configuration in the Advanced Installation Guide. + Enabling Security Groups + In order for security groups to function in a zone, the security groups feature must first be + enabled for the zone. The administrator can do this when creating a new zone, by selecting a + network offering that includes security groups. The procedure is described in Basic Zone + Configuration in the Advanced Installation Guide. The administrator can not enable security + groups for an existing zone, only when creating a new zone.
diff --git a/docs/en-US/end-user-ui-overview.xml b/docs/en-US/end-user-ui-overview.xml index dc95ce064b9..6ec1a25fc55 100644 --- a/docs/en-US/end-user-ui-overview.xml +++ b/docs/en-US/end-user-ui-overview.xml @@ -1,28 +1,27 @@ - %BOOK_ENTITIES; ]> -
- End User's UI Overview - The &PRODUCT; UI helps users of cloud infrastructure to view and use their cloud resources, including virtual machines, templates and ISOs, data volumes and snapshots, guest networks, and IP addresses. If the user is a member or administrator of one or more &PRODUCT; projects, the UI can provide a project-oriented view. + End User's UI Overview + The &PRODUCT; UI helps users of cloud infrastructure to view and use their cloud resources, including virtual machines, templates and ISOs, data volumes and snapshots, guest networks, and IP addresses. If the user is a member or administrator of one or more &PRODUCT; projects, the UI can provide a project-oriented view.
diff --git a/docs/en-US/event-log-queries.xml b/docs/en-US/event-log-queries.xml index 32a1612ce6c..a0dcaa607fb 100644 --- a/docs/en-US/event-log-queries.xml +++ b/docs/en-US/event-log-queries.xml @@ -5,23 +5,22 @@ ]> -
Event Log Queries Database logs can be queried from the user interface. The list of events captured by the system includes: @@ -34,4 +33,4 @@ Storage volume creation and deletion User login and logout -
+ diff --git a/docs/en-US/event-types.xml b/docs/en-US/event-types.xml index 9a710559b15..56059e1a54c 100644 --- a/docs/en-US/event-types.xml +++ b/docs/en-US/event-types.xml @@ -5,216 +5,215 @@ ]> - -
- Event Types - - - - - - - VM.CREATE - TEMPLATE.EXTRACT - SG.REVOKE.INGRESS - - - VM.DESTROY - TEMPLATE.UPLOAD - HOST.RECONNECT - - - VM.START - TEMPLATE.CLEANUP - MAINT.CANCEL - - - VM.STOP - VOLUME.CREATE - MAINT.CANCEL.PS - - - VM.REBOOT - VOLUME.DELETE - MAINT.PREPARE - - - VM.UPGRADE - VOLUME.ATTACH - MAINT.PREPARE.PS - - - VM.RESETPASSWORD - VOLUME.DETACH - VPN.REMOTE.ACCESS.CREATE - - - ROUTER.CREATE - VOLUME.UPLOAD - VPN.USER.ADD - - - ROUTER.DESTROY - SERVICEOFFERING.CREATE - VPN.USER.REMOVE - - - ROUTER.START - SERVICEOFFERING.UPDATE - NETWORK.RESTART - - - ROUTER.STOP - SERVICEOFFERING.DELETE - UPLOAD.CUSTOM.CERTIFICATE - - - ROUTER.REBOOT - DOMAIN.CREATE - UPLOAD.CUSTOM.CERTIFICATE - - - ROUTER.HA - DOMAIN.DELETE - STATICNAT.DISABLE - - - PROXY.CREATE - DOMAIN.UPDATE - SSVM.CREATE - - - PROXY.DESTROY - SNAPSHOT.CREATE - SSVM.DESTROY - - - PROXY.START - SNAPSHOT.DELETE - SSVM.START - - - PROXY.STOP - SNAPSHOTPOLICY.CREATE - SSVM.STOP - - - PROXY.REBOOT - SNAPSHOTPOLICY.UPDATE - SSVM.REBOOT - - - PROXY.HA - SNAPSHOTPOLICY.DELETE - SSVM.H - - - VNC.CONNECT - VNC.DISCONNECT - NET.IPASSIGN - - - NET.IPRELEASE - NET.RULEADD - NET.RULEDELETE - - - NET.RULEMODIFY - NETWORK.CREATE - NETWORK.DELETE - - - LB.ASSIGN.TO.RULE - LB.REMOVE.FROM.RULE - LB.CREATE - - - LB.DELETE - LB.UPDATE - USER.LOGIN - - - USER.LOGOUT - USER.CREATE - USER.DELETE - - - USER.UPDATE - USER.DISABLE - TEMPLATE.CREATE - - - TEMPLATE.DELETE - TEMPLATE.UPDATE - TEMPLATE.COPY - - - TEMPLATE.DOWNLOAD.START - TEMPLATE.DOWNLOAD.SUCCESS - TEMPLATE.DOWNLOAD.FAILED - - - ISO.CREATE - ISO.DELETE - ISO.COPY - - - ISO.ATTACH - ISO.DETACH - ISO.EXTRACT - - - ISO.UPLOAD - SERVICE.OFFERING.CREATE - SERVICE.OFFERING.EDIT - - - SERVICE.OFFERING.DELETE - DISK.OFFERING.CREATE - DISK.OFFERING.EDIT - - - DISK.OFFERING.DELETE - NETWORK.OFFERING.CREATE - NETWORK.OFFERING.EDIT - - - NETWORK.OFFERING.DELETE - POD.CREATE - POD.EDIT - - - POD.DELETE - ZONE.CREATE - ZONE.EDIT - - - ZONE.DELETE - VLAN.IP.RANGE.CREATE - VLAN.IP.RANGE.DELETE - - - CONFIGURATION.VALUE.EDIT - SG.AUTH.INGRESS - - - - - -
+ 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. +--> + + Event Types + + + + + + + VM.CREATE + TEMPLATE.EXTRACT + SG.REVOKE.INGRESS + + + VM.DESTROY + TEMPLATE.UPLOAD + HOST.RECONNECT + + + VM.START + TEMPLATE.CLEANUP + MAINT.CANCEL + + + VM.STOP + VOLUME.CREATE + MAINT.CANCEL.PS + + + VM.REBOOT + VOLUME.DELETE + MAINT.PREPARE + + + VM.UPGRADE + VOLUME.ATTACH + MAINT.PREPARE.PS + + + VM.RESETPASSWORD + VOLUME.DETACH + VPN.REMOTE.ACCESS.CREATE + + + ROUTER.CREATE + VOLUME.UPLOAD + VPN.USER.ADD + + + ROUTER.DESTROY + SERVICEOFFERING.CREATE + VPN.USER.REMOVE + + + ROUTER.START + SERVICEOFFERING.UPDATE + NETWORK.RESTART + + + ROUTER.STOP + SERVICEOFFERING.DELETE + UPLOAD.CUSTOM.CERTIFICATE + + + ROUTER.REBOOT + DOMAIN.CREATE + UPLOAD.CUSTOM.CERTIFICATE + + + ROUTER.HA + DOMAIN.DELETE + STATICNAT.DISABLE + + + PROXY.CREATE + DOMAIN.UPDATE + SSVM.CREATE + + + PROXY.DESTROY + SNAPSHOT.CREATE + SSVM.DESTROY + + + PROXY.START + SNAPSHOT.DELETE + SSVM.START + + + PROXY.STOP + SNAPSHOTPOLICY.CREATE + SSVM.STOP + + + PROXY.REBOOT + SNAPSHOTPOLICY.UPDATE + SSVM.REBOOT + + + PROXY.HA + SNAPSHOTPOLICY.DELETE + SSVM.H + + + VNC.CONNECT + VNC.DISCONNECT + NET.IPASSIGN + + + NET.IPRELEASE + NET.RULEADD + NET.RULEDELETE + + + NET.RULEMODIFY + NETWORK.CREATE + NETWORK.DELETE + + + LB.ASSIGN.TO.RULE + LB.REMOVE.FROM.RULE + LB.CREATE + + + LB.DELETE + LB.UPDATE + USER.LOGIN + + + USER.LOGOUT + USER.CREATE + USER.DELETE + + + USER.UPDATE + USER.DISABLE + TEMPLATE.CREATE + + + TEMPLATE.DELETE + TEMPLATE.UPDATE + TEMPLATE.COPY + + + TEMPLATE.DOWNLOAD.START + TEMPLATE.DOWNLOAD.SUCCESS + TEMPLATE.DOWNLOAD.FAILED + + + ISO.CREATE + ISO.DELETE + ISO.COPY + + + ISO.ATTACH + ISO.DETACH + ISO.EXTRACT + + + ISO.UPLOAD + SERVICE.OFFERING.CREATE + SERVICE.OFFERING.EDIT + + + SERVICE.OFFERING.DELETE + DISK.OFFERING.CREATE + DISK.OFFERING.EDIT + + + DISK.OFFERING.DELETE + NETWORK.OFFERING.CREATE + NETWORK.OFFERING.EDIT + + + NETWORK.OFFERING.DELETE + POD.CREATE + POD.EDIT + + + POD.DELETE + ZONE.CREATE + ZONE.EDIT + + + ZONE.DELETE + VLAN.IP.RANGE.CREATE + VLAN.IP.RANGE.DELETE + + + CONFIGURATION.VALUE.EDIT + SG.AUTH.INGRESS + + + + + + \ No newline at end of file diff --git a/docs/en-US/events-log.xml b/docs/en-US/events-log.xml index 9de679ea130..fa97db45959 100644 --- a/docs/en-US/events-log.xml +++ b/docs/en-US/events-log.xml @@ -5,24 +5,31 @@ ]> -
Event Logs - There are two types of events logged in the &PRODUCT; Event Log. Standard events log the success or failure of an event and can be used to identify jobs or processes that have failed. There are also long running job events. Events for asynchronous jobs log when a job is scheduled, when it starts, and when it completes. Other long running synchronous jobs log when a job starts, and when it completes. Long running synchronous and asynchronous event logs can be used to gain more information on the status of a pending job or can be used to identify a job that is hanging or has not started. The following sections provide more information on these events.. -
+ There are two types of events logged in the &PRODUCT; Event Log. Standard events log + the success or failure of an event and can be used to identify jobs or processes that have + failed. There are also long running job events. Events for asynchronous jobs log when a job + is scheduled, when it starts, and when it completes. Other long running synchronous jobs log + when a job starts, and when it completes. Long running synchronous and asynchronous event + logs can be used to gain more information on the status of a pending job or can be used to + identify a job that is hanging or has not started. The following sections provide more + information on these events.. + + diff --git a/docs/en-US/events.xml b/docs/en-US/events.xml index cbefc544b60..242ff4511ff 100644 --- a/docs/en-US/events.xml +++ b/docs/en-US/events.xml @@ -5,24 +5,25 @@ ]>
+ Events diff --git a/docs/en-US/external-firewalls-and-load-balancers.xml b/docs/en-US/external-firewalls-and-load-balancers.xml index 1452804885d..64f5ac3551d 100644 --- a/docs/en-US/external-firewalls-and-load-balancers.xml +++ b/docs/en-US/external-firewalls-and-load-balancers.xml @@ -5,24 +5,28 @@ ]> - + 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. +-->
External Firewalls and Load Balancers &PRODUCT; is capable of replacing its Virtual Router with an external Juniper SRX device and an optional external NetScaler or F5 load balancer for gateway and load balancing services. In this case, the VMs use the SRX as their gateway. + + + + +
diff --git a/docs/en-US/feature-overview.xml b/docs/en-US/feature-overview.xml index 236d78b026b..f0739cad327 100644 --- a/docs/en-US/feature-overview.xml +++ b/docs/en-US/feature-overview.xml @@ -1,68 +1,67 @@ - %BOOK_ENTITIES; ]> -
- What Can &PRODUCT; Do? - - Multiple Hypervisor Support - - - &PRODUCT; works with a variety of hypervisors. A single cloud deployment can contain multiple hypervisor implementations. You have the complete freedom to choose the right hypervisor for your workload. - - - &PRODUCT; is designed to work with open source Xen and KVM hypervisors as well as enterprise-grade hypervisors such as Citrix XenServer, VMware vSphere, and Oracle VM (OVM). You can also provision “bare metal” hosts with no hypervisor (Beta feature. Untested in &PRODUCT; 3.0.x.) - - - Massively Scalable Infrastructure Management - - - &PRODUCT; can manage tens of thousands of servers installed in multiple geographically distributed datacenters. The centralized management server scales linearly, eliminating the need for intermediate cluster-level management servers. No single component failure can cause cloud-wide outage. Periodic maintenance of the management server can be performed without affecting the functioning of virtual machines running in the cloud. - - - Automatic Configuration Management - - &PRODUCT; automatically configures each guest virtual machine’s networking and storage settings. - - &PRODUCT; internally manages a pool of virtual appliances to support the cloud itself. These appliances offer services such as firewalling, routing, DHCP, VPN access, console proxy, storage access, and storage replication. The extensive use of virtual appliances simplifies the installation, configuration, and ongoing management of a cloud deployment. - - - Graphical User Interface - - &PRODUCT; offers an administrator's Web interface, used for provisioning and managing the cloud, as well as an end-user's Web interface, used for running VMs and managing VM templates. The UI can be customized to reflect the desired service provider or enterprise look and feel. - - - API and Extensibility - - - &PRODUCT; provides an API that gives programmatic access to all the management features available in the UI. The API is maintained and documented. This API enables the creation of command line tools and new user interfaces to suit particular needs. See the Developer’s Guide and API Reference, both available at http://docs.cloudstack.org/Apache_CloudStack_Documentation. - - - The &PRODUCT; pluggable allocation architecture allows the creation of new types of allocators for the selection of storage and Hosts. See the Allocator Implementation Guide (http://docs.cloudstack.org/CloudStack_Documentation/Allocator_Implementation_Guide). - - - High Availability - - &PRODUCT; has a number of features to increase the availability of the system. The Management Server itself may be deployed in a multi-node installation where the servers are load balanced. MySQL may be configured to use replication to provide for a manual failover in the event of database loss. For the hosts, &PRODUCT; supports NIC bonding and the use of separate networks for storage as well as iSCSI Multipath. - + What Can &PRODUCT; Do? + + Multiple Hypervisor Support + + + &PRODUCT; works with a variety of hypervisors. A single cloud deployment can contain multiple hypervisor implementations. You have the complete freedom to choose the right hypervisor for your workload. + + &PRODUCT; is designed to work with open source Xen and KVM hypervisors as well as + enterprise-grade hypervisors such as Citrix XenServer, VMware vSphere, and Oracle VM + (OVM). + + Massively Scalable Infrastructure Management + + + &PRODUCT; can manage tens of thousands of servers installed in multiple geographically distributed datacenters. The centralized management server scales linearly, eliminating the need for intermediate cluster-level management servers. No single component failure can cause cloud-wide outage. Periodic maintenance of the management server can be performed without affecting the functioning of virtual machines running in the cloud. + + + Automatic Configuration Management + + &PRODUCT; automatically configures each guest virtual machine’s networking and storage settings. + + &PRODUCT; internally manages a pool of virtual appliances to support the cloud itself. These appliances offer services such as firewalling, routing, DHCP, VPN access, console proxy, storage access, and storage replication. The extensive use of virtual appliances simplifies the installation, configuration, and ongoing management of a cloud deployment. + + + Graphical User Interface + + &PRODUCT; offers an administrator's Web interface, used for provisioning and managing the cloud, as well as an end-user's Web interface, used for running VMs and managing VM templates. The UI can be customized to reflect the desired service provider or enterprise look and feel. + + + API and Extensibility + + + &PRODUCT; provides an API that gives programmatic access to all the management features available in the UI. The API is maintained and documented. This API enables the creation of command line tools and new user interfaces to suit particular needs. See the Developer’s Guide and API Reference, both available at http://docs.cloud.com/CloudStack_Documentation. + + + The &PRODUCT; pluggable allocation architecture allows the creation of new types of allocators for the selection of storage and Hosts. See the Allocator Implementation Guide (http://docs.cloudstack.org/CloudStack_Documentation/Allocator_Implementation_Guide). + + + High Availability + + &PRODUCT; has a number of features to increase the availability of the system. The Management Server itself may be deployed in a multi-node installation where the servers are load balanced. MySQL may be configured to use replication to provide for a manual failover in the event of database loss. For the hosts, &PRODUCT; supports NIC bonding and the use of separate networks for storage as well as iSCSI Multipath. +
diff --git a/docs/en-US/firewall-rules.xml b/docs/en-US/firewall-rules.xml index 388bf7e2885..01d072bbcc4 100644 --- a/docs/en-US/firewall-rules.xml +++ b/docs/en-US/firewall-rules.xml @@ -5,52 +5,51 @@ ]> -
- Firewall Rules - By default, all incoming traffic to the public IP address is rejected by the firewall. To allow external traffic, you can open firewall ports by specifying firewall rules. You can optionally specify one or more CIDRs to filter the source IPs. This is useful when you want to allow only incoming requests from certain IP addresses. - You cannot use firewall rules to open ports for an elastic IP address. When elastic IP is used, outside access is instead controlled through the use of security groups. See . - Firewall rules can be created using the Firewall tab in the Management Server UI. This tab is not displayed by default when &PRODUCT; is installed. To display the Firewall tab, the &PRODUCT; administrator must set the global configuration parameter firewall.rule.ui.enabled to "true." - To create a firewall rule: - - Log in to the &PRODUCT; UI as an administrator or end user. - In the left navigation, choose Network. - Click the name of the network where you want to work with. - Click View IP Addresses. - Click the IP address you want to work with. - - Click the Configuration tab and fill in the following values. - - Source CIDR. (Optional) To accept only traffic from IP - addresses within a particular address block, enter a CIDR or a - comma-separated list of CIDRs. Example: 192.168.0.0/22. Leave empty to allow - all CIDRs. - Protocol. The communication protocol in use on the opened - port(s). - Start Port and End Port. The port(s) you want to open on the - firewall. If you are opening a single port, use the same number in both - fields - ICMP Type and ICMP Code. Used only if Protocol is set to - ICMP. Provide the type and code required by the ICMP protocol to fill out - the ICMP header. Refer to ICMP documentation for more details if you are not - sure what to enter - - Click Add - + Firewall Rules + By default, all incoming traffic to the public IP address is rejected by the firewall. To allow external traffic, you can open firewall ports by specifying firewall rules. You can optionally specify one or more CIDRs to filter the source IPs. This is useful when you want to allow only incoming requests from certain IP addresses. + You cannot use firewall rules to open ports for an elastic IP address. When elastic IP is used, outside access is instead controlled through the use of security groups. See . + Firewall rules can be created using the Firewall tab in the Management Server UI. This tab is not displayed by default when &PRODUCT; is installed. To display the Firewall tab, the &PRODUCT; administrator must set the global configuration parameter firewall.rule.ui.enabled to "true." + To create a firewall rule: + + Log in to the &PRODUCT; UI as an administrator or end user. + In the left navigation, choose Network. + Click the name of the network where you want to work with. + Click View IP Addresses. + Click the IP address you want to work with. + + Click the Configuration tab and fill in the following values. + + Source CIDR. (Optional) To accept only traffic from IP + addresses within a particular address block, enter a CIDR or a + comma-separated list of CIDRs. Example: 192.168.0.0/22. Leave empty to allow + all CIDRs. + Protocol. The communication protocol in use on the opened + port(s). + Start Port and End Port. The port(s) you want to open on the + firewall. If you are opening a single port, use the same number in both + fields + ICMP Type and ICMP Code. Used only if Protocol is set to + ICMP. Provide the type and code required by the ICMP protocol to fill out + the ICMP header. Refer to ICMP documentation for more details if you are not + sure what to enter + + Click Add. +
diff --git a/docs/en-US/globally-configured-limits.xml b/docs/en-US/globally-configured-limits.xml index ac71112b310..2445d1a7600 100644 --- a/docs/en-US/globally-configured-limits.xml +++ b/docs/en-US/globally-configured-limits.xml @@ -5,96 +5,96 @@ ]>
- Globally Configured Limits - In a zone, the guest virtual network has a 24 bit CIDR by default. This limits the guest virtual network to 254 running instances. It can be adjusted as needed, but this must be done before any instances are created in the zone. For example, 10.1.1.0/22 would provide for ~1000 addresses. - The following table lists limits set in the Global Configuration: - - - - - Parameter Name - Definition - - - - - - max.account.public.ips - Number of public IP addresses that can be owned by an account - - - - max.account.snapshots - Number of snapshots that can exist for an account - - - - - max.account.templates - Number of templates that can exist for an account - - - - max.account.user.vms - Number of virtual machine instances that can exist for an account - - - - max.account.volumes - Number of disk volumes that can exist for an account - - - - max.template.iso.size - Maximum size for a downloaded template or ISO in GB - - - - max.volume.size.gb - Maximum size for a volume in GB - - - network.throttling.rate - Default data transfer rate in megabits per second allowed per user (supported on XenServer) - - - snapshot.max.hourly - Maximum recurring hourly snapshots to be retained for a volume. If the limit is reached, early snapshots from the start of the hour are deleted so that newer ones can be saved. This limit does not apply to manual snapshots. If set to 0, recurring hourly snapshots can not be scheduled - - - - snapshot.max.daily - Maximum recurring daily snapshots to be retained for a volume. If the limit is reached, snapshots from the start of the day are deleted so that newer ones can be saved. This limit does not apply to manual snapshots. If set to 0, recurring daily snapshots can not be scheduled - - - snapshot.max.weekly - Maximum recurring weekly snapshots to be retained for a volume. If the limit is reached, snapshots from the beginning of the week are deleted so that newer ones can be saved. This limit does not apply to manual snapshots. If set to 0, recurring weekly snapshots can not be scheduled - - - - snapshot.max.monthly - Maximum recurring monthly snapshots to be retained for a volume. If the limit is reached, snapshots from the beginning of the month are deleted so that newer ones can be saved. This limit does not apply to manual snapshots. If set to 0, recurring monthly snapshots can not be scheduled. - - - - - To modify global configuration parameters, use the global configuration screen in the &PRODUCT; UI. See Setting Global Configuration Parameters + Globally Configured Limits + In a zone, the guest virtual network has a 24 bit CIDR by default. This limits the guest virtual network to 254 running instances. It can be adjusted as needed, but this must be done before any instances are created in the zone. For example, 10.1.1.0/22 would provide for ~1000 addresses. + The following table lists limits set in the Global Configuration: + + + + + Parameter Name + Definition + + + + + + max.account.public.ips + Number of public IP addresses that can be owned by an account + + + + max.account.snapshots + Number of snapshots that can exist for an account + + + + + max.account.templates + Number of templates that can exist for an account + + + + max.account.user.vms + Number of virtual machine instances that can exist for an account + + + + max.account.volumes + Number of disk volumes that can exist for an account + + + + max.template.iso.size + Maximum size for a downloaded template or ISO in GB + + + + max.volume.size.gb + Maximum size for a volume in GB + + + network.throttling.rate + Default data transfer rate in megabits per second allowed per user (supported on XenServer) + + + snapshot.max.hourly + Maximum recurring hourly snapshots to be retained for a volume. If the limit is reached, early snapshots from the start of the hour are deleted so that newer ones can be saved. This limit does not apply to manual snapshots. If set to 0, recurring hourly snapshots can not be scheduled + + + + snapshot.max.daily + Maximum recurring daily snapshots to be retained for a volume. If the limit is reached, snapshots from the start of the day are deleted so that newer ones can be saved. This limit does not apply to manual snapshots. If set to 0, recurring daily snapshots can not be scheduled + + + snapshot.max.weekly + Maximum recurring weekly snapshots to be retained for a volume. If the limit is reached, snapshots from the beginning of the week are deleted so that newer ones can be saved. This limit does not apply to manual snapshots. If set to 0, recurring weekly snapshots can not be scheduled + + + + snapshot.max.monthly + Maximum recurring monthly snapshots to be retained for a volume. If the limit is reached, snapshots from the beginning of the month are deleted so that newer ones can be saved. This limit does not apply to manual snapshots. If set to 0, recurring monthly snapshots can not be scheduled. + + + + + To modify global configuration parameters, use the global configuration screen in the &PRODUCT; UI. See Setting Global Configuration Parameters
diff --git a/docs/en-US/guest-traffic.xml b/docs/en-US/guest-traffic.xml index 96f9c062db8..ebee6986857 100644 --- a/docs/en-US/guest-traffic.xml +++ b/docs/en-US/guest-traffic.xml @@ -5,34 +5,33 @@ ]> -
- Guest Traffic - A network can carry guest traffic only between VMs within one zone. Virtual machines in different zones cannot communicate with each other using their IP addresses; they must communicate with each other by routing through a public IP address. - Figure 1 illustrates a typical guest traffic setup: - - - - - guesttraffic.png: Depicts a guest traffic setup - - The Management Server automatically creates a virtual router for each network. A virtual router is a special virtual machine that runs on the hosts. Each virtual router has three network interfaces. Its eth0 interface serves as the gateway for the guest traffic and has the IP address of 10.1.1.1. Its eth1 interface is used by the system to configure the virtual router. Its eth2 interface is assigned a public IP address for public traffic. - The virtual router provides DHCP and will automatically assign an IP address for each guest VM within the IP range assigned for the network. The user can manually reconfigure guest VMs to assume different IP addresses. - Source NAT is automatically configured in the virtual router to forward outbound traffic for all guest VMs + Guest Traffic + A network can carry guest traffic only between VMs within one zone. Virtual machines in different zones cannot communicate with each other using their IP addresses; they must communicate with each other by routing through a public IP address. + See a typical guest traffic setup given below: + + + + + guesttraffic.png: Depicts a guest traffic setup + + The Management Server automatically creates a virtual router for each network. A virtual router is a special virtual machine that runs on the hosts. Each virtual router has three network interfaces. Its eth0 interface serves as the gateway for the guest traffic and has the IP address of 10.1.1.1. Its eth1 interface is used by the system to configure the virtual router. Its eth2 interface is assigned a public IP address for public traffic. + The virtual router provides DHCP and will automatically assign an IP address for each guest VM within the IP range assigned for the network. The user can manually reconfigure guest VMs to assume different IP addresses. + Source NAT is automatically configured in the virtual router to forward outbound traffic for all guest VMs
diff --git a/docs/en-US/ha-for-hosts.xml b/docs/en-US/ha-for-hosts.xml index e395d22e58a..15b5fa73f0b 100644 --- a/docs/en-US/ha-for-hosts.xml +++ b/docs/en-US/ha-for-hosts.xml @@ -1,29 +1,30 @@ - %BOOK_ENTITIES; ]>
HA for Hosts The user can specify a virtual machine as HA-enabled. By default, all virtual router VMs and Elastic Load Balancing VMs are automatically configured as HA-enabled. When an HA-enabled VM crashes, &PRODUCT; detects the crash and restarts the VM automatically within the same Availability Zone. HA is never performed across different Availability Zones. &PRODUCT; has a conservative policy towards restarting VMs and ensures that there will never be two instances of the same VM running at the same time. The Management Server attempts to start the VM on another Host in the same cluster. HA features work with iSCSI or NFS primary storage. HA with local storage is not supported. -
+ +
diff --git a/docs/en-US/host-add.xml b/docs/en-US/host-add.xml index 2a984fd02ba..b112d079d66 100644 --- a/docs/en-US/host-add.xml +++ b/docs/en-US/host-add.xml @@ -5,24 +5,38 @@ ]>
- Adding a Host - TODO + Adding a Host + + Before adding a host to the &PRODUCT; configuration, you must first install your chosen hypervisor on the host. &PRODUCT; can manage hosts running VMs under a variety of hypervisors. + The &PRODUCT; Installation Guide provides instructions on how to install each supported hypervisor + and configure it for use with &PRODUCT;. See the Installation Guide for information about which version of your chosen hypervisor is supported, as well as crucial additional steps to configure the hosts for use with &PRODUCT;. + Be sure you have performed the additional &PRODUCT;-specific configuration steps described in the hypervisor installation section for your particular hypervisor. + + Now add the hypervisor host to &PRODUCT;. The technique to use varies depending on the hypervisor. + + + + + + + +
diff --git a/docs/en-US/host-allocation.xml b/docs/en-US/host-allocation.xml index 8a362e6e99c..f5bc53c7fbf 100644 --- a/docs/en-US/host-allocation.xml +++ b/docs/en-US/host-allocation.xml @@ -1,25 +1,25 @@ - %BOOK_ENTITIES; ]>
@@ -28,4 +28,5 @@ &PRODUCT; administrators can specify that certain hosts should have a preference for particular types of guest instances. For example, an administrator could state that a host should have a preference to run Windows guests. The default host allocator will attempt to place guests of that OS type on such hosts first. If no such host is available, the allocator will place the instance wherever there is sufficient physical capacity. Both vertical and horizontal allocation is allowed. Vertical allocation consumes all the resources of a given host before allocating any guests on a second host. This reduces power consumption in the cloud. Horizontal allocation places a guest on each host in a round-robin fashion. This may yield better performance to the guests in some cases. &PRODUCT; also allows an element of CPU over-provisioning as configured by the administrator. Over-provisioning allows the administrator to commit more CPU cycles to the allocated guests than are actually available from the hardware. &PRODUCT; also provides a pluggable interface for adding new allocators. These custom allocators can provide any policy the administrator desires. +
diff --git a/docs/en-US/hypervisor-support-for-primarystorage.xml b/docs/en-US/hypervisor-support-for-primarystorage.xml index ca266a43013..23c8eb5cd88 100644 --- a/docs/en-US/hypervisor-support-for-primarystorage.xml +++ b/docs/en-US/hypervisor-support-for-primarystorage.xml @@ -5,98 +5,95 @@ ]> -
- Hypervisor Support for Primary Storage - The following table shows storage options and parameters for different hypervisors. - - - - - - - - - - - - - VMware vSphere - Citrix XenServer - KVM - Oracle VM - - - - - Format for Disks, Templates, and - Snapshots - VMDK - VHD - QCOW2 - RAW - - - iSCSI support - VMFS - Clustered LVM - Yes, via Shared Mountpoint - Yes, via OCFS2M - - - Fiber Channel support - VMFS - Yes, via Existing SR - Yes, via Shared Mountpoint - No - - - NFS support - Y - Y - Y - Y - - - - Local storage support - Y - Y - Y - Y - - - - Storage over-provisioning - NFS and iSCSI - NFS - NFS - No - - - - - - XenServer uses a clustered LVM system to store VM images on iSCSI and Fiber Channel volumes and does not support over-provisioning in the hypervisor. The storage server itself, however, can support thin-provisioning. As a result the &PRODUCT; can still support storage over-provisioning by running on thin-provisioned storage volumes. - KVM supports "Shared Mountpoint" storage. A shared mountpoint is a file system path local to each server in a given cluster. The path must be the same across all Hosts in the cluster, for example /mnt/primary1. This shared mountpoint is assumed to be a clustered filesystem such as OCFS2. In this case the &PRODUCT; does not attempt to mount or unmount the storage as is done with NFS. The &PRODUCT; requires that the administrator insure that the storage is available - Oracle VM supports both iSCSI and NFS storage. When iSCSI is used with OVM, the &PRODUCT; administrator is responsible for setting up iSCSI on the host, including re-mounting the storage after the host recovers from a failure such as a network outage. With other hypervisors, &PRODUCT; takes care of mounting the iSCSI target on the host whenever it discovers a connection with an iSCSI server and unmounting the target when it discovers the connection is down. - With NFS storage, &PRODUCT; manages the overprovisioning. In this case the global configuration parameter storage.overprovisioning.factor controls the degree of overprovisioning. This is independent of hypervisor type. - Local storage is an option for primary storage for vSphere, XenServer, Oracle VM, and KVM. When the local disk option is enabled, a local disk storage pool is automatically created on each host. To use local storage for the System Virtual Machines (such as the Virtual Router), set system.vm.use.local.storage to true in global configuration. - &PRODUCT; supports multiple primary storage pools in a Cluster. For example, you could provision 2 NFS servers in primary storage. Or you could provision 1 iSCSI LUN initially and then add a second iSCSI LUN when the first approaches capacity. -
+ Hypervisor Support for Primary Storage + The following table shows storage options and parameters for different hypervisors. + + + + + + + + + + + VMware vSphere + Citrix XenServer + KVM + Oracle VM + + + + + Format for Disks, Templates, and + Snapshots + VMDK + VHD + QCOW2 + RAW + + + iSCSI support + VMFS + Clustered LVM + Yes, via Shared Mountpoint + Yes, via OCFS2M + + + Fiber Channel support + VMFS + Yes, via Existing SR + Yes, via Shared Mountpoint + No + + + NFS support + Y + Y + Y + Y + + + + Local storage support + Y + Y + Y + Y + + + + Storage over-provisioning + NFS and iSCSI + NFS + NFS + No + + + + + + XenServer uses a clustered LVM system to store VM images on iSCSI and Fiber Channel volumes and does not support over-provisioning in the hypervisor. The storage server itself, however, can support thin-provisioning. As a result the &PRODUCT; can still support storage over-provisioning by running on thin-provisioned storage volumes. + KVM supports "Shared Mountpoint" storage. A shared mountpoint is a file system path local to each server in a given cluster. The path must be the same across all Hosts in the cluster, for example /mnt/primary1. This shared mountpoint is assumed to be a clustered filesystem such as OCFS2. In this case the &PRODUCT; does not attempt to mount or unmount the storage as is done with NFS. The &PRODUCT; requires that the administrator insure that the storage is available + Oracle VM supports both iSCSI and NFS storage. When iSCSI is used with OVM, the &PRODUCT; administrator is responsible for setting up iSCSI on the host, including re-mounting the storage after the host recovers from a failure such as a network outage. With other hypervisors, &PRODUCT; takes care of mounting the iSCSI target on the host whenever it discovers a connection with an iSCSI server and unmounting the target when it discovers the connection is down. + With NFS storage, &PRODUCT; manages the overprovisioning. In this case the global configuration parameter storage.overprovisioning.factor controls the degree of overprovisioning. This is independent of hypervisor type. + Local storage is an option for primary storage for vSphere, XenServer, Oracle VM, and KVM. When the local disk option is enabled, a local disk storage pool is automatically created on each host. To use local storage for the System Virtual Machines (such as the Virtual Router), set system.vm.use.local.storage to true in global configuration. + &PRODUCT; supports multiple primary storage pools in a Cluster. For example, you could provision 2 NFS servers in primary storage. Or you could provision 1 iSCSI LUN initially and then add a second iSCSI LUN when the first approaches capacity. + diff --git a/docs/en-US/images/cluster-overview.png b/docs/en-US/images/cluster-overview.png index 33f1a0477ef48b7af9475da0d148085f36d480c7..18a86c39afee65199030cc700089535e70bef6f9 100644 GIT binary patch literal 6080 zcmd5=WmHt}w;m7#BxWQBr3SN!)xKogOGOrqRqmY!u~wE9|vk7|Qr1MvP@c5{2ZuiFELKe!U8@v=Q z=s!`tUsH2eT~is5!|{M`(6>WXwVe;T!^1y3WO)Fl*Uu0$CIb{IZsrBS$Jt3|XDO~Y;G!7|8CS}nS4glNW z@x)w%aL8!I=rLLl0Ll|isL#v_Kwb%;|F;+6L5+!*wX>7QqLFNj4u`J^x|4c)y|#-# zOo!IQ-YelC6QwWd2L0x!SDp%F#k6*^U7a6Cm{2@X#1|Us#8ARxOv(5z4&|#DZi3Ih znt$0z^y@Oi?yoYw;`M;t#}&KPZ$F(PvQJOEyG+3hv)9g9%hH|CaMJhcl{m5<@(AkE zOHPeyHruM&{8LZub$E~;f11j0_MYrzvxHnYSmF8ccM$NXh z3%u=Nb9-x7fI*)rmshP+Am+K1!Yacv+l!=ypjf^eLX<&8`U(jGNWt}3Db@`kXW&`Vc1m>2g z2H*VL;l2K}IxK$Q@>t)@;2)=%&K|WUd=(x+hEtmIv>)ZvoRn~FN>ArmE)Vbl2Q~;h zmX?TdMI{Px3A|Ayz;~qXUM{i>C5#FfPzAWf^NDStCuWG@Oj~;=J^q_GKK4RXiSku( zMD@Ocx4YvuXA@L>PnQjV^p^@2fJxve?H)4~QHI+G8AdrUKLehCvP3_+dj<#1r(k|d zmk0o}GT3-;IO3qX(ZE4cH2~Q|3PGt85gfFvk7yf#t3@0QX7qoABm2x|)M+oS)*I+s z3Yi4l2lbyWV}V>(S_|19hrx*L<_ywug$aDt!+f~7^WFx zi+FLmvnTAjq{79D1nF{Y>McQb^?Dswj5zC|RI6}xlAfQ7qUjpSBsRU5ei@oM^!|bA zlg7^*^2?|7+VY1DZF|EZtoUY6@}`2`mAikDrTeWHw}DTdZqM&p5m+IoN6-`wu~0IR zVHa^}`O_EmcwN50Vl%y0gF(tDrQ^Ha>hz1%`o=FxmLwaY;gA&wO{x3qi_PYlc;$DL z%uDWU z50TUA^SVvb$^)@p@E9tLa$|?@_V{e9r2bOKN59J^?V!*Vhh@ih>mf1kqDOa|Z2^-} zY%MRFkM+fNOF>;0JBSi(S?{nYuuX$t_74U4)_a^4_|`;lDU+LKDDx% zkb&*~_9p}P3W|ss>+=wGW|FyA=D0k9Xf-56oULOwFIc-ipduiy^pE}u3aK2JHRAEh zP9M=88cB2b@C;`B4Uy>O4suwFfbhi$@ooai)OML=6sPPsxkMv815d8RtyF44$NsKy zgKaoz2SA;^SPB};Z9`HcziNKEvm`yi70|lcpCwTvL;Wr6H}{>fI#Wf)NJwP3Po-~Q zXzYH?I;=yRv-D$Su4Vrez)p zm`LXOdVVkm;(m23S2Q}KO4bc}T+mt*D~l{?JqD+>i}!%uE3YKevw~BGSe8!V)z{`D+7V~_qdpkm7O+m; z?d-PoTfGbPhZ$>eO>};%m435)NPD|bGx&qVB6o)K_JJyrT5_$au3>7DY2_oM#@oz_ zUqyt62r}KxxI|Kn76Nb_txlsO(Z`4<@J6~skAns$RYsd{gjaCN)B=5gFn|D%|Bn*r z1WN*}Zs2YX?|KG|OHZ+DHSaD7TiVDG3Iz%T7X3;1yiHG<9z7txXkvCmeJAc!V2KUi zAyX`m2!|5L3?|JE9x-3~PQe0~)^7?+ZUzmPE`z?b$w_}N;E3pxeFmP*?yK9H*v(yM z-m-nCogIzw8`L>ZfN8vm+=XL?MyVJI zJk~?~Lk~9;JU<&|NVGa-sQXB!Yh7<_3@66WJ_*l`jDZWj9NZWN1-a*_u4>GQ8pB$`v;CKW+{sjBZfCk_h~*yRY1pt# zTZ7Nb0#51RI!@6FWj=%>DldET6(eWWpoR5iijWVUtfb51!@;8bA149!ADI%gxiy2# zHQ!z~iE{kbY9@nO(SxPjp9&R=c!QswX6PqZ^aSrHuY)Y5DKH5Lzau7@&JM{OKReCC zmA%3!N_G%T5JLtXO+%OU3EIuOhG65k%2V6YPUt>y!7pVoq_!c(da>FQ6`*gt-#8*Z z2EyC}Ug$D(f4SCqLdk87gQBGNyAg{Q(9?QF%aXWSr}Tuxd;?!68pM}18mo4$_%()1 zJ=D{|QfqF|2%EIzPzFI`6s;sWyZ273pduE5l}@%sHH@%oV__ZG>@;2d(s@s$5?^&Z z+o#&J{rQDrCw<>3vkWJ}X|e|KBViv+^s~HbSi4Y}Zs+U(nTq*{-g`V6JJwdQ;m(Tq ziSG&ajiM>OXUa4>=8^x59Jls+25(=?$bOrNolQgWp^@pQ&P!^B11}243PeYehxqOw2pZ}cM zjYIMoOf;cpiP9Gzp3i0E0QrqgT?eN+nr1~Wod)c68-y6d*0c?t?qYHpnvTlsw%CTK zeB9h_Hoq8YBl#Qz;a88dHRfjC8CDqocW+39wn3Ctrn3^;*S13WX#ZuEhbb%4c|Yso(_bM zjU9q2`m^5!?_X2K=i);j#PZmBvLpqjzIO9dO;4XXKD+v4FdtkmEbv-cMcj$;?tjnk*9jsa#G^i+8GK!w&w9W>qe40JUX-Vu~7>+x9m-2?DeEuNXD+aATX zVjt9#y?N+6K%k$RmH6skXEnbW{re-%lzjv#cF*HtCxv{jxC($w5J8OJ`LDn8x!P>! z#0edzGU!AU7i;@~Kecg!_YC)Msl~+-@~+c8dFOC9>96n@7qrEy0CulS*vpL}@mCr` zT=hj91K5Uy4@mM{e3tXtP!q*HExo`yZh|=pRxkX#7_`uB)K>5lx@CR^7Q30^iTyR1 zDxkG2nk(lR^qYWc{owK8P|jqr{-|qH5J>jCMu=DCUEzEGW6i~h2p8EJ7y3e%dFEeF z3P-6~m+>!@GA@FN!3G?67aL-;d@+#kZgbV0RDB{p5*`M?q?4Z*?~j|AUJl32u+_0=Jj><9;)wcO-3+aLp)k#{!m%Qe3P*xt!j?Z6_Q(&MI)Fuq-1nE9S2~YlGHF@uVX@ND}iz3<9 zoo0&MLsHp~RbO$SDi0;Dn%U_aS&Gm8qmkECv*OD4E$1(P!QCVj7oWBHXcbROaUw%6 zqk$yNvpK&Bb8%8=C9;Zx5I+Y+u;^RMr}8A9QR;mvB{ zhoguO+Z?#mk--2a5&JR@UNnQiB=o4XVl9aO?ml!yFfzcr$2IVYn5X@7Y#*|$&u|@_ z{I`+H^l-F6jaHf_toHR1->DgY&v??^u4^%(z2j#E@HZ&mVQG@xl_}-Lm_dT3rP=KK z>ls*1wohP^9g~g4qkKKO$l2I9lW@_HWPci`!JPH8Oxt@>GfypcAvn&A+Yt5(Dt}sC zMA>(KllYxuV>W<*l-I}63&~^BEr63I{<3vFLHXS*(P{qQN7JChqiIr_`k0^#cEv0$ z3OuMLWt(kTieO2f{ zXej>ElqAaNl3-pXy)DqrFQ!dS4}V`V7oIx86yJ56(~h@?6Vri@xc}TV^&d-I_!QXD z5=cS!X(<*A&fei>!zJF1SoPXwznWLU0f}XiN z!(45ko!X!JU!6-2O-dN}xS}V1cD4UdCw#=MIbRia&VOU&s|2hI;$v0S0bTiC-?bLz z6ekDiq+K=fmL{@UF6Y_56zD&K#(+JoZTFWFq+P|oi(YiBpicFMw2s>LTVMRQ1#d}N zL=1Ixi3wx6!dfrgP5tfH4p}~j^44wH*LJCsZKCnOy$`?IlozF){kS?jaS*xiF9l;; zJAnz{Bk2Qw_5_i4J)n7D1jBuuyOWKjgtnK4q<1{sO5bu|%bk+nEyl!O+D4Ki{nH_; zZLz%TI{d1yn5V<`)`eQqHv2yAdtUeSjMF*6Tq_}g)Zf$uN*wg)YS}9LMS3So2HLc& z(-_Jlm*_tg%9~}fBB_CjP+hpX2AuzO*%I`2Q^7B=<`L z%eb0OZl`1gK_Zizyv5H)#^Yp)PHgzFF^CB34HDM^Frpumn#YwaohVpc-L{v$0$oVs zGrb)CDn1qSs9uQude8mquPLo_`C!EkUyDpa9)^b}v{0MpLocf|w{KPx2zqv|R-SFD ze;2*H^bMIiXrbk5S5w!F2rt`(m`$y>V7+x`71q%|WM=>NFZ4u|(-!Q89AWeD*zI~j z(qT_;HBhH?9p`Kz#m|lEX7$hwP;zhjJ9i`OaG)baeb|2Qw;B81pGMUq4fMa0vNlho z-*1h4D|iy}89d-=svdH*cP!Pa(^Azo`60eO()vCWGKJZEs`Pm%Z&JyU( zY>>i<0YP68@#)9Xpo7^J1RdPQEFHcL#i)C?Vq2P>J~v}IsJ@1Nj?_+HV?esjO*>|4V;-~t{(GH z+^4wo?qH6y2O5k~s^eYgRa*C|v$Q%MF(RLRt@A9eJ0*9~Z{(Z&1luEeDwMlytP4%G zWLexYE~)s(9{ai3T$;weI6*%W8E-O8a8R}Qx2VoB>bN5aRis7Y+a!S1bmq!~yv@R3 zTW6dHgY~ra7W*??^{q6wmyK>JI+%~^B&4|}71PxN4k1F!A*seT5@#$M^vE|urm_VI zL1K40>m?^M9sx35dmlG#S%G>!81ClklgfMZi<_=Qd4G1B=3v&thw3)Sq{I!h#kI&w zo3|!1QF)(`g}rP)y$5VK_^e`eWnLlw;gr;)L{IKcUKf58g{GIzn#ET5R%Ti^W>*vJ zWJf=_VwMgY5U}Q$?7=^(i-}tAm+b{L_D|d6FAYDI>C97oLf)ACR!J+z_dxiU%ek5C zHhOaAc`zSSrLNU&g;S_GyKT|vsE55FO);A%=ch*+Rj;#<1EgJV*fx82>y&T5Z|ZC|TwEgzj0MikEJ))Nd1D2(PHN z-A&<@w`ACJM;qQ7rL3+OB)&+@`8^*M$YNVcpW@3@+H_vRrEN0shAb{YI_2e(~)?tS_ TK79u_bq8pu=qT4H!6W|*A7MQ3 literal 6973 zcmd^kXFOcd*X|fS+UPCXj1tjfL~n!9dxQ`YeS{!-i{1wzdL2fO-bIg==tc-pLl7lI z@8zBU{cykBZ})z>@B87Lv-h)p`}aF%t-aTJo^@jMbX3V6Fg*YO0A%WF$_4-c4jFd* zkB9(!-`Wll!#;4_4OC%(>hXu$*a@D!qP8LcQ1^l4#u6VpCw5hP;SKslD#E~$?JJwL;WiOxTb(VS?C`s1)UsRzH-d->}+lN5Xr}Xx2PCOY% zGKt`puAP1Nw(FC_ZMl6-&-3o0!tmd10jJlW?yGA)EgC)Lqv8kw5CsQo0w-EWqny|Q zKz4Rw1*kAc0e~k%8I17hjTps(AhI|d5CBIPZ}=}sf#Ym-u~7HTlp)tQQXqTcLtstU z)noHk*MiqkN6Lkjm2tHNA9HYm^MZqofdf#$YK$@Z8wHS;2Y^w#1Sp&<_VD3EM;crG zPs1qJirRbYh$U;#eu*%Vi1sBe^AR=#U{+c; zI!s&o{D+BQWJ}Wo?asbqaZmVfxiDXB&>U;-XHQxaKR#mSd;n241B_FLp@8d0?rGafr0Sss4I;~%n493PU* zH?51&f%6NWB9zh?<8vZ1U|b8PvHU`hlkYbIOdNSPYx{2>qA4>qYbN!&5gqSoFXd4Z zin8GKf@Qv+uBCfRtX7%6ziWwt68=%$&+-OVMko!&ZSD~6hUbG=#3R%@8`DkqdJiym z^IBh<+9vjhd+xsFghrZ!f)TC3G&X7D%|F;HW_LGT{|JxC7Dy^~&o2nUxZLIR_vvA; zudcVc`FHEvw_3&W9u!a@V6;F`e6%b^-h&H3vYg-IFI^twQgMwxQIYPTXL5wG+Z9Zp z8=jl0u2R8!6f9VvVM~N{rn?GXlV|K8p%9_loz+I3`;!2Pt`U>=$=+nE7cqH_{nn^4`En7RFg7zjY}7wP zZZUWXI`{aVNsXo~STWwe^rq4eCna{u=5X^yPfEr=&qD{CIG^R<|7lXD?7+3EJ{V4% zT6PQ&v*BB<8r$ex45T$&X&)$ za_m#HYOsFpG&a83_4x^3KX*3jcvwoy*M`wB7yP%D^LS!RexzYwYMGZtOwFQ_0UDV3#3|mD#}$38xB1a8B24(P3c#nv&+lGzpNH z3wuh-tT6&0qF8`3Y{2qQQxV>)GfF5pkwqtpy1xEeh<9u<^+M zhPD8yJ;GXHEJ)`N1wHJ(Q%q9nWKYz?TEnI2mVhDo*f@lOk$#Ho1z0PwCx070P!XGA z@KoqdLlt1yEl;&$;z5EJ3IT_{F2M7Wp!{}u$ z4q2D0#M+DRmA`+;n_RzDt#@Bp4ph+1Gp%0Jum7$s^h~3j&R9+rNiVA^2GcV!Nt+Qw z+oO05r|eqbiqOT6Fu4`t#V&b>@@fGnobfU<@WdpxAHqSWuEWp7&nlz2`tt$u!GrFV0i9M_+(n&IYbSsxg2mV;%1&t>Sqs)z{?m4>RMkKa{CFr4(28a-?8PlWb;s z>XF>Yr*hbbW2Bb=N1SRqY1CYqbiQQ2IuGGk*M{CI@u{NhK)0C>{;E z>T8Hb&hl)p#jCG1Jt*2DK8Uj(8xcDZ7ie-z=l+I=A^PatyR(_ukE(vJOMiDG+e@MH zeq?n-*OA1eCO&545gHBu@&g@xoytjh|FYX zvYdKeDIjP61sy`;0!(*a=C}(_#iB{iYjf|JyQ=bygv)7wmRD40{n#ifgUAnl5Uwx) z+bRX0BD5D=^;(*io`;wI{??mL3A-shp z;ej`IA6BBz6`rN&QK>uw*V^by=3cB|CbdEl;gP0ek%9hq1mQ~Bv#s^9_`kb_;->mC z50>?T7}t%gb-T4MKhA#&8$~cs^Q7Cg%KCSG$_YG=%JvXn@20@6-?g_jyPmjXJ{ph| zvtkFAYX{rYdzad6$&V+5OZ5qtDL|)L*$Pa*`rp2{V%J&p4^QNJcC^oA2FA;Mm3fiv z4)M6#-6G$>Zn;Z7qt9KfN4cagBKuK;?sN6Ei&ts;&%Q*rHf)gOagi(e&|NTdY@uE~ zM9zW1(eQOaz1d(h>hJxQBQ6swDGeXEQaAd;78>_8G#w^IhP?6CRmYS)Cr%nh(`Pb109>O$l zI|AbitVjyx+>C7lTr_iSJOJ7Eg^Duuq*ge=mNI=gQl*_S7s zAvIm)7fp(3Y#4BX>R^y2hG+q&VQ&vsB!y75o)ajP1?hdj`au@e0|x13Dg3Ndvm-&8 z4?Wj#x#_z5(3iYi&Fgpni#=C_v43?)n()WuQ3LMDkMi=rx^~RQlLdKpZ=P(hT� zif3H+=6$`myxP}pbZKguEo{Ehw6qd3lnw}o!{Ik&!=5Z*ke2fD_YkrBCHc>SVR1WD zM7ySg{YZi+I+U{`dxILo3L{0gxszRatk=GC0do{of9l8>gXzQd;G`bS-(LC*_P|^W z)Cf(kwXx}|oKC%#iZE5e7S0UZmZ#qzb@xmCp8zo?aJeH59-w+AcKxfH$5m$){8;=kuON->q8YWff@)C!!U|9 zhn0z1vSN#?uJr|+@#^9)jhN?QH7T9UE!+6r%(sRfmUeMW-4b8f&+a$+$%H@=Ix_lB zr%LpOyInS#xh*d)hbeLG_^$Zz{4#`~xG$|5NtZOhh4XeHM>1P(X)ez#Mrg`uh%SDV zW{Jv2dj5#;cVsgGI>w>Rxi6^XALm<18Cc=8LhfGD758PlZrr5B`;tfYF%`2kxr!+m z8Wu@TyY#4PjM@<~@6SGEWF)0mB17D@Hn7K$rUUZiAoJAq0#=?ZRpB-wOsXs2b2{1n_I#<6* z`(8Rc@2u%uTEy=jeh)QIPYKjSA1_MXm} z;|CHyf2B-pOAB=!Kx$rDKl;+n6Zjg=@(J`SYX9vryc=pIO#<;6a$49(czS#lo%ca0 zH&8^BGwNTKg~RB6+rd@pC5YYjiAP|s1KFrum{M0-vmfPDf`0dQPyS=4+h)k&YRpQH z9_j<$PFDFW5%EBbITg>_y+00HQ>`1*H6N-By{>=MDmt~e(3_q34%y)f4d&fygd0@s zZm?;)$(q;H{=&DfK;7oKn1kXksgy6Lh%>x&C7#va{1EDVZp_tW*bU?CH}G*Lv=2^* z&5X>32E0+uA%2tZe23f_g!^^&__B+84hT>vL!4Q|I`2TjtRC+P#~h2{ME$Gd1mxP` zfWVy4$#6+UXh#Cwx-J1ul&B1I8%a11z8}9XEfVC2GC?xlK2FYZhk)X3WPn={sz4dT z3of>`-?+9{S%Y$Ik96?-%Mh+66!s-sH;JC@b4mhrBe4R;Dla!@y)x7Hl|OIn4Cojg zoBmLtkto=iW#~<-_yi&M8bI~P%&M$C0IaINlqGD3@YGt$cF*y$*o%(Vaxf)P$TEP8 zfdLXu6?=Q{-t8gj+c}sl5FA28!GPwMA_Q28+d{bK z!63D0LcNa znHyXcjV|OebdgwBPb$5bzqH0L!JT35LHu-}upo(km7Epx|eII15d9kxM`MaJ5)O1Wz_=;wpey zTJmhd=8`?HMx-txq}BwPyJ$4KQWpc4LiCsIRK2)U&OJLQyB=-zl-)W+fwBGt0 zhM;_JnUn^WOK~s<-yM(3MzF<6gyR9`^>yR5c0Y;lfLZ4U)^T$U+qr7l#DId-Q~SZN zH+00mr5kETJzovKJkPPgw+4Gp#6C|q5{6!v)`QW*BR)4wN*d9T=^=3)tCZ0i&?9@& z=ZCITWTk}jQqn`Rb2=1l)JFcfgZ$B2qV(+oI=(hR4~WctmN_ryVe$qdn4YXiwiNv+ zd!QSO(o3^^^Ja6E1^=TO$;RiOsv<~9ZI9+Z3SH28cGz^`{#YgdxOSeiSZdZh@^M{d z)e7#>hiKMc+~(^Nd38KQQNi`>Pzz##&(3ssWV}{sdpIYsKhO0pO09JJ<9amJ&8jJGhg_@i1zoE0EnLnJ~+?L-TP!^TKiyuZnUw z&Z(s6<#5P{i6f(EM?|*+y!Z5wd`O{A^TXnzJNVeOtZ3!QKi7p0OI1T-={?~HrL#a4 z0*UZQrJu6I1#Ad39#CH(eA7$UqmZSUZ_KPlr=9Eb{^q|P2D9ojf6L=$#{sX3#WdQ5 zhMZX<%d{Y`kIUa(H2E4u*Gee3T5T*;dQFKU5Thg7hk_4N5oH=>hhlh>?{#uFepr^%0ekf=#_0$3LemWZ_}HFU;z>huMJ48 zzGb^_j|B@q;XBW~+HCyaOSz7` zqo=$#sg7}kai|hD$xC~wtIHghpC=8H(;K)U+BJ8yx4WBc*MbcHOAlWB>L_}4cv>ax zvA!LA&molI22+P)|dBTETO*YimwgmEnU#+xhLafg>f-YCoB8aD-r&FT_ z%}>{;I6#`=dee_1NYDi-(o@!?QKFHF2Yza%-Znlgp?&d2+M4T8-f||;XF4FV)XwB5 z3wEsX#UoZ`>9fj_qUR27Z{Ukla@y9(6#aiJ`5kHj&>17j`#sgZW0Lai2o2r`{N(&} z@3gS`)=yyI>G6vsw(wS0D-Oo?!k8fn-MryUq@?=cAuo-og|WKW3~kz#S(=fdQN-D= z*=MQLe?&gM;fO#f5ujIjw5RcbyzF{f(1R8pUIx4^FwuoN;D6)T)$W*|=?lKmGCw&{q1>eCYy1!G$m_&RWU#U5Rtuh43FRaNoOkh=VWf;qO+ zDFW6rG*rUY(m+bXJVbw)i!d#o0y_{$qzevC;8tWG$JT^*XRJV_EB$|h9VARj z__$bwpRu;V`<|&tdwWlwwE^PD3*!N!@YGdmwXa%XY|&vn4iy(pl0HcUn|&{897n$3 zNJ)vHV)f|o*3{W)(IQtyk#LXu6#Ym!IcZv5mx0Nh5M7VDI~)GUAAL4FKweNhuarDg zrD0m_x}BLTY_;GWlYpnpw3y+)5bcxgkl@~MgFToeh$u$kXcii0()kXbWv9HTD=f@o zer&#{7}?k)l+nXcDz!k_!guP3%)VQwq~Aks_oO{TqO z?U| zp9LT8_+0{qSKQpb+J>i{)1c^Fww@k6!|cAzQaA_}FFDgboiPo|QRId@7YAMQ0%oT`)71P z6!&HmP#}RGwZzv5QW<5xA_;#q2rlvEINtEHHvNafjmsKsDEJGs_wPK`37I>4Z%AMN z(#K%^Aj=|hfmu>4KMLBhYgi`q8N~M$93-whzJ7xLis$)=ryZP?&ie5{;C)izAQds^ zb7u!|tLa)`*Q-;$59zq|nIDmu#5u-Bpg1u{R43jhEB diff --git a/docs/en-US/import-ami.xml b/docs/en-US/import-ami.xml index 2f093b178c8..16fe78a1579 100644 --- a/docs/en-US/import-ami.xml +++ b/docs/en-US/import-ami.xml @@ -5,49 +5,51 @@ ]> -
- Importing Amazon Machine Images - The following procedures describe how to import an Amazon Machine Image (AMI) into &PRODUCT; when using the XenServer hypervisor. - Assume you have an AMI file and this file is called CentOS_6.2_x64. Assume further that you are working on a CentOS host. If the AMI is a Fedora image, you need to be working on a Fedora host initially. - You need to have a XenServer host with a file-based storage repository (either a local ext3 SR or an NFS SR) to convert to a VHD once the image file has been customized on the Centos/Fedora host. - When copying and pasting a command, be sure the command has pasted as a single line before executing. Some document viewers may introduce unwanted line breaks in copied text. - - Set up loopback on image file:# mkdir -p /mnt/loop/centos62 + Importing Amazon Machine Images + The following procedures describe how to import an Amazon Machine Image (AMI) into &PRODUCT; when using the XenServer hypervisor. + Assume you have an AMI file and this file is called CentOS_6.2_x64. Assume further that you are working on a CentOS host. If the AMI is a Fedora image, you need to be working on a Fedora host initially. + You need to have a XenServer host with a file-based storage repository (either a local ext3 SR or an NFS SR) to convert to a VHD once the image file has been customized on the Centos/Fedora host. + When copying and pasting a command, be sure the command has pasted as a single line before executing. Some document viewers may introduce unwanted line breaks in copied text. + + + To import an AMI: + + Set up loopback on image file:# mkdir -p /mnt/loop/centos62 # mount -o loop CentOS_6.2_x64 /mnt/loop/centos54 - Install the kernel-xen package into the image. This downloads the PV kernel and ramdisk to the image.# yum -c /mnt/loop/centos54/etc/yum.conf --installroot=/mnt/loop/centos62/ -y install kernel-xen - Create a grub entry in /boot/grub/grub.conf.# mkdir -p /mnt/loop/centos62/boot/grub + Install the kernel-xen package into the image. This downloads the PV kernel and ramdisk to the image.# yum -c /mnt/loop/centos54/etc/yum.conf --installroot=/mnt/loop/centos62/ -y install kernel-xen + Create a grub entry in /boot/grub/grub.conf.# mkdir -p /mnt/loop/centos62/boot/grub # touch /mnt/loop/centos62/boot/grub/grub.conf -# echo "" > /mnt/loop/centos62/boot/grub/grub.conf +# echo "" > /mnt/loop/centos62/boot/grub/grub.conf - Determine the name of the PV kernel that has been installed into the image. - # cd /mnt/loop/centos62 + Determine the name of the PV kernel that has been installed into the image. + # cd /mnt/loop/centos62 # ls lib/modules/ 2.6.16.33-xenU 2.6.16-xenU 2.6.18-164.15.1.el5xen 2.6.18-164.6.1.el5.centos.plus 2.6.18-xenU-ec2-v1.0 2.6.21.7-2.fc8xen 2.6.31-302-ec2 # ls boot/initrd* boot/initrd-2.6.18-164.6.1.el5.centos.plus.img boot/initrd-2.6.18-164.15.1.el5xen.img # ls boot/vmlinuz* boot/vmlinuz-2.6.18-164.15.1.el5xen boot/vmlinuz-2.6.18-164.6.1.el5.centos.plus boot/vmlinuz-2.6.18-xenU-ec2-v1.0 boot/vmlinuz-2.6.21-2952.fc8xen - - Xen kernels/ramdisk always end with "xen". For the kernel version you choose, there has to be an entry for that version under lib/modules, there has to be an initrd and vmlinuz corresponding to that. Above, the only kernel that satisfies this condition is 2.6.18-164.15.1.el5xen. - Based on your findings, create an entry in the grub.conf file. Below is an example entry.default=0 + + Xen kernels/ramdisk always end with "xen". For the kernel version you choose, there has to be an entry for that version under lib/modules, there has to be an initrd and vmlinuz corresponding to that. Above, the only kernel that satisfies this condition is 2.6.18-164.15.1.el5xen. + Based on your findings, create an entry in the grub.conf file. Below is an example entry.default=0 timeout=5 hiddenmenu title CentOS (2.6.18-164.15.1.el5xen) @@ -55,58 +57,58 @@ title CentOS (2.6.18-164.15.1.el5xen) kernel /boot/vmlinuz-2.6.18-164.15.1.el5xen ro root=/dev/xvda initrd /boot/initrd-2.6.18-164.15.1.el5xen.img - Edit etc/fstab, changing “sda1” to “xvda” and changing “sdb” to “xvdb”. - # cat etc/fstab + Edit etc/fstab, changing “sda1” to “xvda” and changing “sdb” to “xvdb”. + # cat etc/fstab /dev/xvda / ext3 defaults 1 1 /dev/xvdb /mnt ext3 defaults 0 0 none /dev/pts devpts gid=5,mode=620 0 0 none /proc proc defaults 0 0 none /sys sysfs defaults 0 0 - Enable login via the console. The default console device in a XenServer system is xvc0. Ensure that etc/inittab and etc/securetty have the following lines respectively: - # grep xvc0 etc/inittab + Enable login via the console. The default console device in a XenServer system is xvc0. Ensure that etc/inittab and etc/securetty have the following lines respectively: + # grep xvc0 etc/inittab co:2345:respawn:/sbin/agetty xvc0 9600 vt100-nav # grep xvc0 etc/securetty xvc0 - Ensure the ramdisk supports PV disk and PV network. Customize this for the kernel version you have determined above. - # chroot /mnt/loop/centos54 + Ensure the ramdisk supports PV disk and PV network. Customize this for the kernel version you have determined above. + # chroot /mnt/loop/centos54 # cd /boot/ # mv initrd-2.6.18-164.15.1.el5xen.img initrd-2.6.18-164.15.1.el5xen.img.bak # mkinitrd -f /boot/initrd-2.6.18-164.15.1.el5xen.img --with=xennet --preload=xenblk --omit-scsi-modules 2.6.18-164.15.1.el5xen - Change the password. - # passwd + Change the password. + # passwd Changing password for user root. New UNIX password: Retype new UNIX password: passwd: all authentication tokens updated successfully. - Exit out of chroot.# exit - Check etc/ssh/sshd_config for lines allowing ssh login using a password. - # egrep "PermitRootLogin|PasswordAuthentication" /mnt/loop/centos54/etc/ssh/sshd_config + Exit out of chroot.# exit + Check etc/ssh/sshd_config for lines allowing ssh login using a password. + # egrep "PermitRootLogin|PasswordAuthentication" /mnt/loop/centos54/etc/ssh/sshd_config PermitRootLogin yes PasswordAuthentication yes - If you need the template to be enabled to reset passwords from the &PRODUCT; UI or API, + If you need the template to be enabled to reset passwords from the &PRODUCT; UI or API, install the password change script into the image at this point. See - . - Unmount and delete loopback mount.# umount /mnt/loop/centos54 + . + Unmount and delete loopback mount.# umount /mnt/loop/centos54 # losetup -d /dev/loop0 - Copy the image file to your XenServer host's file-based storage repository. In the example below, the Xenserver is "xenhost". This XenServer has an NFS repository whose uuid is a9c5b8c8-536b-a193-a6dc-51af3e5ff799. - # scp CentOS_6.2_x64 xenhost:/var/run/sr-mount/a9c5b8c8-536b-a193-a6dc-51af3e5ff799/ - Log in to the Xenserver and create a VDI the same size as the image. - [root@xenhost ~]# cd /var/run/sr-mount/a9c5b8c8-536b-a193-a6dc-51af3e5ff799 + Copy the image file to your XenServer host's file-based storage repository. In the example below, the Xenserver is "xenhost". This XenServer has an NFS repository whose uuid is a9c5b8c8-536b-a193-a6dc-51af3e5ff799. + # scp CentOS_6.2_x64 xenhost:/var/run/sr-mount/a9c5b8c8-536b-a193-a6dc-51af3e5ff799/ + Log in to the Xenserver and create a VDI the same size as the image. + [root@xenhost ~]# cd /var/run/sr-mount/a9c5b8c8-536b-a193-a6dc-51af3e5ff799 [root@xenhost a9c5b8c8-536b-a193-a6dc-51af3e5ff799]# ls -lh CentOS_6.2_x64 -rw-r--r-- 1 root root 10G Mar 16 16:49 CentOS_6.2_x64 [root@xenhost a9c5b8c8-536b-a193-a6dc-51af3e5ff799]# xe vdi-create virtual-size=10GiB sr-uuid=a9c5b8c8-536b-a193-a6dc-51af3e5ff799 type=user name-label="Centos 6.2 x86_64" cad7317c-258b-4ef7-b207-cdf0283a7923 - Import the image file into the VDI. This may take 10–20 minutes.[root@xenhost a9c5b8c8-536b-a193-a6dc-51af3e5ff799]# xe vdi-import filename=CentOS_6.2_x64 uuid=cad7317c-258b-4ef7-b207-cdf0283a7923 - Locate a the VHD file. This is the file with the VDI’s UUID as its name. Compress it and upload it to your web server. - [root@xenhost a9c5b8c8-536b-a193-a6dc-51af3e5ff799]# bzip2 -c cad7317c-258b-4ef7-b207-cdf0283a7923.vhd > CentOS_6.2_x64.vhd.bz2 + Import the image file into the VDI. This may take 10–20 minutes.[root@xenhost a9c5b8c8-536b-a193-a6dc-51af3e5ff799]# xe vdi-import filename=CentOS_6.2_x64 uuid=cad7317c-258b-4ef7-b207-cdf0283a7923 + Locate a the VHD file. This is the file with the VDI’s UUID as its name. Compress it and upload it to your web server. + [root@xenhost a9c5b8c8-536b-a193-a6dc-51af3e5ff799]# bzip2 -c cad7317c-258b-4ef7-b207-cdf0283a7923.vhd > CentOS_6.2_x64.vhd.bz2 [root@xenhost a9c5b8c8-536b-a193-a6dc-51af3e5ff799]# scp CentOS_6.2_x64.vhd.bz2 webserver:/var/www/html/templates/ - +
diff --git a/docs/en-US/initialize-and-test.xml b/docs/en-US/initialize-and-test.xml index cf0c04ecea6..2dd6e259176 100644 --- a/docs/en-US/initialize-and-test.xml +++ b/docs/en-US/initialize-and-test.xml @@ -1,53 +1,77 @@ - %BOOK_ENTITIES; ]> -
- Initialize and Test + Initialize and Test After everything is configured, &PRODUCT; will perform its initialization. This can take 30 minutes or more, depending on the speed of your network. When the initialization has completed successfully, the administrator's Dashboard should be displayed in the &PRODUCT; UI. + - Verify that the system is ready. In the left navigation bar, select Templates. Click on the CentOS 5.5 (64bit) no Gui (KVM) template. Check to be sure that the status is "Download Complete." Do not proceed to the next step until this status is displayed. - Go to the Instances tab, and filter by My Instances. - Click Add Instance and follow the steps in the wizard. - - Choose the zone you just added. - In the template selection, choose the template to use in the VM. If this is a fresh installation, likely only the provided CentOS template is available. - Select a service offering. Be sure that the hardware you have allows starting the selected service offering. - In data disk offering, if desired, add another data disk. This is a second volume that will be available to but not mounted in the guest. For example, in Linux on XenServer you will see /dev/xvdb in the guest after rebooting the VM. A reboot is not required if you have a PV-enabled OS kernel in use. - In default network, choose the primary network for the guest. In a trial installation, you would have only one option here. - Optionally give your VM a name and a group. Use any descriptive text you would like. - Click Launch VM. Your VM will be created and started. It might take some time to download the template and complete the VM startup. You can watch the VM’s progress in the Instances screen. - - - - To use the VM, click the View Console button. - - - ConsoleButton.png: button to launch a console - - - + + Verify that the system is ready. In the left navigation bar, select Templates. Click on the CentOS 5.5 (64bit) no Gui (KVM) template. Check to be sure that the status is "Download Complete." Do not proceed to the next step until this status is displayed. + + Go to the Instances tab, and filter by My Instances. + + Click Add Instance and follow the steps in the wizard. + + + + Choose the zone you just added. + + In the template selection, choose the template to use in the VM. If this is a fresh installation, likely only the provided CentOS template is available. + + Select a service offering. Be sure that the hardware you have allows starting the selected service offering. + + In data disk offering, if desired, add another data disk. This is a second volume that will be available to but not mounted in the guest. For example, in Linux on XenServer you will see /dev/xvdb in the guest after rebooting the VM. A reboot is not required if you have a PV-enabled OS kernel in use. + + In default network, choose the primary network for the guest. In a trial installation, you would have only one option here. + Optionally give your VM a name and a group. Use any descriptive text you would like. + + Click Launch VM. Your VM will be created and started. It might take some time to download the template and complete the VM startup. You can watch the VM’s progress in the Instances screen. + + + + + + + + To use the VM, click the View Console button. + + + + + + ConsoleButton.png: button to launch a console + + + + + + For more information about using VMs, including instructions for how to allow incoming network traffic to the VM, start, stop, and delete VMs, and move a VM from one host to another, see Working With Virtual Machines in the Administrator’s Guide. + + + Congratulations! You have successfully completed a &PRODUCT; Installation. + If you decide to grow your deployment, you can add more hosts, primary storage, zones, pods, and clusters.
diff --git a/docs/en-US/ip-forwarding-firewalling.xml b/docs/en-US/ip-forwarding-firewalling.xml index 61aa6ad7e71..c154b078da3 100644 --- a/docs/en-US/ip-forwarding-firewalling.xml +++ b/docs/en-US/ip-forwarding-firewalling.xml @@ -5,26 +5,26 @@ ]> -
IP Forwarding and Firewalling By default, all incoming traffic to the public IP address is rejected. All outgoing traffic from the guests is translated via NAT to the public IP address and is allowed. To allow incoming traffic, users may set up firewall rules and/or port forwarding rules. For example, you can use a firewall rule to open a range of ports on the public IP address, such as 33 through 44. Then use port forwarding rules to direct traffic from individual ports within that range to specific ports on user VMs. For example, one port forwarding rule could route incoming traffic on the public IP's port 33 to port 100 on one user VM's private IP. - For the steps to implement these rules, see Firewall Rules and Port Forwarding. + +
diff --git a/docs/en-US/isolated-networks.xml b/docs/en-US/isolated-networks.xml index 13f8aa1d4ca..671591d161c 100644 --- a/docs/en-US/isolated-networks.xml +++ b/docs/en-US/isolated-networks.xml @@ -5,23 +5,22 @@ ]> -
Isolated Networks An isolated network can be accessed only by virtual machines of a single account. Isolated networks have the following properties. @@ -30,4 +29,6 @@ There is one network offering for the entire network The network offering can be upgraded or downgraded but it is for the entire network + +
diff --git a/docs/en-US/linux-installation.xml b/docs/en-US/linux-installation.xml index 60d389c0ef4..b560ee0d5bd 100644 --- a/docs/en-US/linux-installation.xml +++ b/docs/en-US/linux-installation.xml @@ -5,43 +5,49 @@ ]> -
- Linux OS Installation - Use the following steps to begin the Linux OS installation: - - Download the script file cloud-set-guest-password: - - Linux: - Windows: - - - Copy this file to /etc/init.d. - On some Linux distributions, copy the file to /etc/rc.d/init.d. - - Run the following command to make the script executable:chmod +x /etc/init.d/cloud-set-guest-password - - Depending on the Linux distribution, continue with the appropriate step.On Fedora, CentOS/RHEL, and Debian, run:chkconfig --add cloud-set-guest-password - On Ubuntu with VMware tools, link the script file to the /etc/network/if-up and /etc/network/if-down folders, and run the script: - #ln -s /etc/init.d/cloud-set-guest-password /etc/network/if-up/cloud-set-guest-password - #ln -s /etc/init.d/cloud-set-guest-password /etc/network/if-down/cloud-set-guest-password - If you are using Ubuntu 11.04, start by creating a directory called /var/lib/dhcp3 on your Ubuntu machine (works around a known issue with this version of Ubuntu). On all Ubuntu versions: Run “sudo update-rc.d cloud-set-guest-password defaults 98”. To test, run "mkpasswd" and check that it is generating a new password. If the “mkpasswd” command does not exist, run "sudo apt-get install whois" (or sudo apt-get install mkpasswd, depending on your Ubuntu version) and repeat. - - -
+ Linux OS Installation + Use the following steps to begin the Linux OS installation: + + Download the script file cloud-set-guest-password: + + Linux: + + Windows: + + + + Copy this file to /etc/init.d.On some Linux distributions, copy the file to /etc/rc.d/init.d. + + Run the following command to make the script executable:chmod +x /etc/init.d/cloud-set-guest-password + + Depending on the Linux distribution, continue with the appropriate step.On Fedora, CentOS/RHEL, and Debian, run:chkconfig --add cloud-set-guest-password + On Ubuntu with VMware tools, link the script file to the /etc/network/if-up and + /etc/network/if-down folders, and run the script: + #ln -s /etc/init.d/cloud-set-guest-password /etc/network/if-up/cloud-set-guest-password +#ln -s /etc/init.d/cloud-set-guest-password /etc/network/if-down/cloud-set-guest-password + If you are using Ubuntu 11.04, start by creating a directory called /var/lib/dhcp3 on your Ubuntu machine (works around a known issue with this version of Ubuntu). On all Ubuntu versions: Run “sudo update-rc.d cloud-set-guest-password defaults 98”. To test, run "mkpasswd" and check that it is generating a new password. If the “mkpasswd” command does not exist, run "sudo apt-get install whois" (or sudo apt-get install mkpasswd, depending on your Ubuntu version) and repeat. + + + + diff --git a/docs/en-US/load-balancer-rules.xml b/docs/en-US/load-balancer-rules.xml index 8dd7d3b47ba..1ce5cd09c5d 100644 --- a/docs/en-US/load-balancer-rules.xml +++ b/docs/en-US/load-balancer-rules.xml @@ -5,25 +5,28 @@ ]> -
Load Balancer Rules A &PRODUCT; user or administrator may create load balancing rules that balance traffic received at a public IP to one or more VMs. A user creates a rule, specifies an algorithm, and assigns the rule to a set of VMs. - If you create load balancing rules while using a network service offering that includes an external load balancer device such as NetScaler, and later change the network service offering to one that uses the &PRODUCT; virtual router, you must create a firewall rule on the virtual router for each of your existing load balancing rules so that they continue to function. + If you create load balancing rules while using a network service offering that includes an external load balancer device such as NetScaler, and later change the network service offering to one that uses the &PRODUCT; virtual router, you must create a firewall rule on the virtual router for each of your existing load balancing rules so that they continue to function. + + + +
diff --git a/docs/en-US/log-in-root-admin.xml b/docs/en-US/log-in-root-admin.xml index c0a340a4ea9..b8f8204193e 100644 --- a/docs/en-US/log-in-root-admin.xml +++ b/docs/en-US/log-in-root-admin.xml @@ -5,23 +5,22 @@ ]> -
Logging In as the Root Administrator After the Management Server software is installed and running, you can run the &PRODUCT; user interface. This UI is there to help you provision, view, and manage your cloud infrastructure. @@ -35,7 +34,7 @@ Continue with basic setup. Choose this if you're just trying &PRODUCT;, and you want a guided walkthrough of the simplest possible configuration so that you can get started right away. We'll help you set up a cloud with the following features: a single machine that runs &PRODUCT; software and uses NFS to provide storage; a single machine running VMs under the XenServer or KVM hypervisor; and a shared public network. The prompts in this guided tour should give you all the information you need, but if you want just a bit more detail, you can follow along in the Trial Installation Guide. - I have used &PRODUCT; before. Choose this if you have already gone through a design phase and planned a more sophisticated deployment, or you are ready to start scaling up a trial cloud that you set up earlier with the basic setup screens. In the Administrator UI, you can start using the more powerful features of CloudPlatform, such as advanced VLAN networking, high availability, additional network elements such as load balancers and firewalls, and support for multiple hypervisors including Citrix XenServer, KVM, and VMware vSphere. + I have used &PRODUCT; before. Choose this if you have already gone through a design phase and planned a more sophisticated deployment, or you are ready to start scaling up a trial cloud that you set up earlier with the basic setup screens. In the Administrator UI, you can start using the more powerful features of &PRODUCT;, such as advanced VLAN networking, high availability, additional network elements such as load balancers and firewalls, and support for multiple hypervisors including Citrix XenServer, KVM, and VMware vSphere. The root administrator Dashboard appears. @@ -43,4 +42,5 @@ You should set a new root administrator password. If you chose basic setup, you’ll be prompted to create a new password right away. If you chose experienced user, use the steps in . You are logging in as the root administrator. This account manages the &PRODUCT; deployment, including physical infrastructure. The root administrator can modify configuration settings to change basic functionality, create or delete user accounts, and take many actions that should be performed only by an authorized person. Please change the default password to a new, unique password. +
diff --git a/docs/en-US/log-in.xml b/docs/en-US/log-in.xml index e72d27bf61b..84328ce4d45 100644 --- a/docs/en-US/log-in.xml +++ b/docs/en-US/log-in.xml @@ -5,27 +5,26 @@ ]> -
- Log In to the UI - &PRODUCT; provides a web-based UI that can be used by both administrators and end users. The appropriate version of the UI is displayed depending on the credentials used to log in. The UI is available in popular browsers including IE7, IE8, IE9, Firefox 3.5+, Firefox 4, Safari 4, and Safari 5. The URL is: (substitute your own management server IP address) - http://<management-server-ip-address>:8080/client + Log In to the UI + &PRODUCT; provides a web-based UI that can be used by both administrators and end users. The appropriate version of the UI is displayed depending on the credentials used to log in. The UI is available in popular browsers including IE7, IE8, IE9, Firefox 3.5+, Firefox 4, Safari 4, and Safari 5. The URL is: (substitute your own management server IP address) + http://<management-server-ip-address>:8080/client On a fresh Management Server installation, a guided tour splash screen appears. On later visits, you’ll see a login screen where you specify the following to proceed to your Dashboard: Username @@ -42,7 +41,8 @@ If you are a user in the sub-domains, enter the full path to the domain, excluding the root domain. For example, suppose multiple levels are created under the root domain, such as Comp1/hr. The users in the Comp1 domain should enter Comp1 in the Domain field, whereas the users in the Comp1/sales domain should enter Comp1/sales. For more guidance about the choices that appear when you log in to this UI, see Logging In as the Root Administrator. - - - + + + +
diff --git a/docs/en-US/maintain-hypervisors-on-hosts.xml b/docs/en-US/maintain-hypervisors-on-hosts.xml index 213f078ea2b..43f3f790733 100644 --- a/docs/en-US/maintain-hypervisors-on-hosts.xml +++ b/docs/en-US/maintain-hypervisors-on-hosts.xml @@ -5,26 +5,25 @@ ]> -
Maintaining Hypervisors on Hosts When running hypervisor software on hosts, be sure all the hotfixes provided by the hypervisor vendor are applied. Track the release of hypervisor patches through your hypervisor vendor’s support channel, and apply patches as soon as possible after they are released. &PRODUCT; will not track or notify you of required hypervisor patches. It is essential that your hosts are completely up to date with the provided hypervisor patches. The hypervisor vendor is likely to refuse to support any system that is not up to date with patches. The lack of up-do-date hotfixes can lead to data corruption and lost VMs. - (XenServer) For more information, see Highly Recommended Hotfixes for XenServer in the &PRODUCT; Knowledge Base + (XenServer) For more information, see Highly Recommended Hotfixes for XenServer in the &PRODUCT; Knowledge Base.
diff --git a/docs/en-US/manage-cloud.xml b/docs/en-US/manage-cloud.xml index c4c4d6be248..06d4e3ff85e 100644 --- a/docs/en-US/manage-cloud.xml +++ b/docs/en-US/manage-cloud.xml @@ -5,27 +5,28 @@ ]> - -
+ Managing the Cloud - vCenter Maintenance Mode - XenServer and Maintenance Mode - vCenter Maintenance Mode - XenServer and Maintenance Mode -
+ + + + + + + diff --git a/docs/en-US/manual-live-migration.xml b/docs/en-US/manual-live-migration.xml index 390b41768c8..677cfc46527 100644 --- a/docs/en-US/manual-live-migration.xml +++ b/docs/en-US/manual-live-migration.xml @@ -5,48 +5,47 @@ ]> -
- Moving VMs Between Hosts (Manual Live Migration) - The CloudPlatform administrator can move a running VM from one host to another without interrupting service to users or going into maintenance mode. This is called manual live migration, and can be done under the following conditions: - - The root administrator is logged in. Domain admins and users can not perform manual live migration of VMs. - The VM is running. Stopped VMs can not be live migrated. - The destination host must be in the same cluster as the original host. - The VM must not be using local disk storage. - The destination host must have enough available capacity. If not, the VM will remain in the "migrating" state until memory becomes available. - (OVM) If the VM is running on the OVM hypervisor, it must not have an ISO attached. Live migration of a VM with attached ISO is not supported in OVM. - - To manually live migrate a virtual machine - - Log in to the CloudPlatform UI as a user or admin. - In the left navigation, click Instances. - Choose the VM that you want to migrate. - Click the Migrate Instance button - - - - Migrateinstance.png: button to migrate an instance - - - From the list of hosts, choose the one to which you want to move the VM. - Click OK. - -
+ Moving VMs Between Hosts (Manual Live Migration) + The &PRODUCT; administrator can move a running VM from one host to another without interrupting service to users or going into maintenance mode. This is called manual live migration, and can be done under the following conditions: + + The root administrator is logged in. Domain admins and users can not perform manual live migration of VMs. + The VM is running. Stopped VMs can not be live migrated. + The destination host must be in the same cluster as the original host. + The VM must not be using local disk storage. + The destination host must have enough available capacity. If not, the VM will remain in the "migrating" state until memory becomes available. + (OVM) If the VM is running on the OVM hypervisor, it must not have an ISO attached. Live migration of a VM with attached ISO is not supported in OVM. + + To manually live migrate a virtual machine + + Log in to the &PRODUCT; UI as a user or admin. + In the left navigation, click Instances. + Choose the VM that you want to migrate. + Click the Migrate Instance button. + + + + Migrateinstance.png: button to migrate an instance + + + From the list of hosts, choose the one to which you want to move the VM. + Click OK. + + diff --git a/docs/en-US/migrate-vm-rootvolume-volume-new-storage-pool.xml b/docs/en-US/migrate-vm-rootvolume-volume-new-storage-pool.xml index 67fe2f58920..d615cfe7a5b 100644 --- a/docs/en-US/migrate-vm-rootvolume-volume-new-storage-pool.xml +++ b/docs/en-US/migrate-vm-rootvolume-volume-new-storage-pool.xml @@ -5,33 +5,33 @@ ]> -
- Migrating a VM Root Volume to a New Storage Pool - When migrating the root disk volume, the VM must first be stopped, and users can not access the VM. After migration is complete, the VM can be restarted. - - Log in to the &PRODUCT; UI as a user or admin. - Detach the data disk from the VM. See Detaching and Moving Volumes (but skip the “reattach” step at the end. You will do that after migrating to new storage). - Stop the VM. - Call the &PRODUCT; API command migrateVirtualMachine with the ID of the VM to migrate and the IDs of a destination host and destination storage pool in the same zone. - Watch for the VM status to change to Migrating, then back to Stopped. - Restart the VM. - -
+ Migrating a VM Root Volume to a New Storage Pool + When migrating the root disk volume, the VM must first be stopped, and users can not access the VM. After migration is complete, the VM can be restarted. + + Log in to the &PRODUCT; UI as a user or admin. + Detach the data disk from the VM. See Detaching and Moving Volumes (but skip the “reattach” step at the end. You will do that after migrating to new storage). + Stop the VM. + Use the &PRODUCT; API command, migrateVirtualMachine, with the ID of the VM to migrate and + the IDs of a destination host and destination storage pool in the same zone. + Watch for the VM status to change to Migrating, then back to Stopped. + Restart the VM. + + diff --git a/docs/en-US/minimum-system-requirements.xml b/docs/en-US/minimum-system-requirements.xml index 0043a26dba8..1bbe1e2db85 100644 --- a/docs/en-US/minimum-system-requirements.xml +++ b/docs/en-US/minimum-system-requirements.xml @@ -1,90 +1,79 @@ - %BOOK_ENTITIES; ]> -
- Minimum System Requirements -
- Management Server, Database, and Storage System Requirements - The machines that will run the Management Server and MySQL database must meet the following requirements. The same machines can also be used to provide primary and secondary storage, such as via localdisk or NFS. The Management Server may be placed on a virtual machine. - - Operating system: - - Preferred: CentOS/RHEL 6.2+ or Ubuntu 12.04(.1) - Also supported: CentOS/RHEL 5.5 or Ubuntu 10.04 - - - 64-bit x86 CPU (more cores results in better performance) - 4 GB of memory - 50 GB of local disk (When running secondary storage on the management server 500GB is recommended) - At least 1 NIC - Statically allocated IP address - Fully qualified domain name as returned by the hostname command - -
-
- Host/Hypervisor System Requirements - The host is where the cloud services run in the form of guest virtual machines. Each host is one machine that meets the following requirements: - - Must be 64-bit and must support HVM (Intel-VT or AMD-V enabled). - 64-bit x86 CPU (more cores results in better performance) - Hardware virtualization support required - 4 GB of memory - 36 GB of local disk - At least 1 NIC - Statically allocated IP Address - Latest hotfixes applied to hypervisor software - When you deploy &PRODUCT;, the hypervisor host must not have any VMs already running - - Hosts have additional requirements depending on the hypervisor. See the requirements listed at the top of the Installation section for your chosen hypervisor: - - Be sure you fulfill the additional hypervisor requirements and installation steps provided in this Guide. Hypervisor hosts must be properly prepared to work with CloudStack. For example, the requirements for XenServer are listed under Citrix XenServer Installation. - -
- Citrix XenServer requirements - To be determined -
-
- VMware vSphere requirements - To be determined -
-
- KVM requirements - For running a KVM hypervisor the main requirement is the Linux distribution it is running. Although you are not required to run these distributions, it is recommended. - Recommended distributions: - - CentOS / RHEL: 6.2 and 6.3 - Ubuntu: 12.04(.1) - - The main requirement for KVM hypervisors is the libvirt and Qemu version. If you whish to run on a different distribution, make sure you meet the following requirements: - - libvirt: 0.9.4 or higher - Qemu/KVM: 1.0 or higher - -
-
- Oracle VM (OVM) requirements - To be determined -
-
-
+ Minimum System Requirements +
+ Management Server, Database, and Storage System Requirements + + The machines that will run the Management Server and MySQL database must meet the following requirements. + The same machines can also be used to provide primary and secondary storage, such as via localdisk or NFS. + The Management Server may be placed on a virtual machine. + + + Operating system: + + Preferred: RHEL 6.2+ 64-bit (https://access.redhat.com/downloads) or CentOS 6.2+ 64-bit (http://isoredirect.centos.org/centos/6/isos/x86_64/). + Also supported (v3.0.3 and greater): RHEL and CentOS 5.4-5.x 64-bit + It is highly recommended that you purchase a RHEL support license. + Citrix support can not be responsible for helping fix issues with the underlying OS. + + + 64-bit x86 CPU (more cores results in better performance) + 4 GB of memory + 250 GB of local disk (more results in better capability; 500 GB recommended) + At least 1 NIC + Statically allocated IP address + Fully qualified domain name as returned by the hostname command + +
+
+ Host/Hypervisor System Requirements + The host is where the cloud services run in the form of guest virtual machines. Each host is one machine that meets the following requirements: + + Must be 64-bit and must support HVM (Intel-VT or AMD-V enabled). + 64-bit x86 CPU (more cores results in better performance) + Hardware virtualization support required + 4 GB of memory + 36 GB of local disk + At least 1 NIC + Statically allocated IP Address + Latest hotfixes applied to hypervisor software + When you deploy &PRODUCT;, the hypervisor host must not have any VMs already running + + Hosts have additional requirements depending on the hypervisor. See the requirements listed at the top of the Installation section for your chosen hypervisor: + + Citrix XenServer Installation + VMware vSphere Installation and Configuration + KVM Installation and Configuration + Oracle VM (OVM) Installation and Configuration + + + + Be sure you fulfill the additional hypervisor requirements and installation steps provided in this Guide. Hypervisor hosts must be properly prepared to work with CloudStack. For example, the requirements for XenServer are listed under Citrix XenServer Installation. + + +
+ + + diff --git a/docs/en-US/network-offerings.xml b/docs/en-US/network-offerings.xml index ccfb93cc4cc..0713be845db 100644 --- a/docs/en-US/network-offerings.xml +++ b/docs/en-US/network-offerings.xml @@ -5,26 +5,26 @@ ]> -
Network Offerings - For the most up-to-date list of supported network services, see the CloudPlatform UI or call listNetworkServices. + For the most up-to-date list of supported network services, see the &PRODUCT; UI or call listNetworkServices. + A network offering is a named set of network services, such as: DHCP @@ -39,9 +39,11 @@ (Optional) Network tag to specify which physical network to use When creating a new VM, the user chooses one of the available network offerings, and that determines which network services the VM can use. - The CloudPlatform administrator can create any number of custom network offerings, in addition to the default network offerings provided by CloudPlatform. By creating multiple custom network offerings, you can set up your cloud to offer different classes of service on a single multi-tenant physical network. For example, while the underlying physical wiring may be the same for two tenants, tenant A may only need simple firewall protection for their website, while tenant B may be running a web server farm and require a scalable firewall solution, load balancing solution, and alternate networks for accessing the database backend. - If you create load balancing rules while using a network service offering that includes an external load balancer device such as NetScaler, and later change the network service offering to one that uses the CloudPlatform virtual router, you must create a firewall rule on the virtual router for each of your existing load balancing rules so that they continue to function. - When creating a new virtual network, the CloudPlatform administrator chooses which network offering to enable for that network. Each virtual network is associated with one network offering. A virtual network can be upgraded or downgraded by changing its associated network offering. If you do this, be sure to reprogram the physical network to match. - CloudPlatform also has internal network offerings for use by CloudPlatform system VMs. These network offerings are not visible to users but can be modified by administrators. - + The &PRODUCT; administrator can create any number of custom network offerings, in addition to the default network offerings provided by &PRODUCT;. By creating multiple custom network offerings, you can set up your cloud to offer different classes of service on a single multi-tenant physical network. For example, while the underlying physical wiring may be the same for two tenants, tenant A may only need simple firewall protection for their website, while tenant B may be running a web server farm and require a scalable firewall solution, load balancing solution, and alternate networks for accessing the database backend. + If you create load balancing rules while using a network service offering that includes an external load balancer device such as NetScaler, and later change the network service offering to one that uses the &PRODUCT; virtual router, you must create a firewall rule on the virtual router for each of your existing load balancing rules so that they continue to function. + + When creating a new virtual network, the &PRODUCT; administrator chooses which network offering to enable for that network. Each virtual network is associated with one network offering. A virtual network can be upgraded or downgraded by changing its associated network offering. If you do this, be sure to reprogram the physical network to match. + &PRODUCT; also has internal network offerings for use by &PRODUCT; system VMs. These network offerings are not visible to users but can be modified by administrators. + +
diff --git a/docs/en-US/network-service-providers.xml b/docs/en-US/network-service-providers.xml index af570977259..cf86b24667a 100644 --- a/docs/en-US/network-service-providers.xml +++ b/docs/en-US/network-service-providers.xml @@ -5,31 +5,128 @@ ]>
Network Service Providers - For the most up-to-date list of supported network service providers, see the CloudPlatform UI or call listNetworkServiceProviders. + For the most up-to-date list of supported network service providers, see the &PRODUCT; UI or call listNetworkServiceProviders. A service provider (also called a network element) is hardware or virtual appliance that makes a network service possible; for example, a firewall appliance can be installed in the cloud to provide firewall service. On a single network, multiple providers can provide the same network service. For example, a firewall service may be provided by Cisco or Juniper devices in the same physical network. You can have multiple instances of the same service provider in a network (say, more than one Juniper SRX device). - If different providers are set up to provide the same service on the network, the administrator can create network offerings so users can specify which network service provider they prefer (along with the other choices offered in network offerings). Otherwise, CloudPlatform will choose which provider to use whenever the service is called for. + If different providers are set up to provide the same service on the network, the administrator can create network offerings so users can specify which network service provider they prefer (along with the other choices offered in network offerings). Otherwise, &PRODUCT; will choose which provider to use whenever the service is called for. Supported Network Service Providers - CloudPlatform ships with an internal list of the supported service providers, and you can choose from this list when creating a network offering. + &PRODUCT; ships with an internal list of the supported service providers, and you can choose from this list when creating a network offering. + + + + + + + + + + + + Virtual Router + Citrix NetScaler + Juniper SRX + F5 BigIP + Host based (KVM/Xen) + + + + + + Remote Access VPN + Yes + No + No + No + No + + + + DNS/DHCP/User Data + Yes + No + No + No + No + + + + Firewall + Yes + No + Yes + No + No + + + Load Balancing + Yes + Yes + No + Yes + No + + + Elastic IP + No + Yes + No + No + No + + + Elastic LB + No + Yes + No + No + No + + + Source NAT + Yes + No + Yes + No + No + + + Static NAT + Yes + Yes + Yes + No + No + + + Port Forwarding + Yes + No + Yes + No + No + + + +
diff --git a/docs/en-US/networking-in-a-pod.xml b/docs/en-US/networking-in-a-pod.xml index 81f08271874..5a569bf4d1f 100644 --- a/docs/en-US/networking-in-a-pod.xml +++ b/docs/en-US/networking-in-a-pod.xml @@ -5,37 +5,42 @@ ]> -
- Networking in a Pod - Figure 2 illustrates network setup within a single pod. The hosts are connected to a pod-level switch. At a minimum, the hosts should have one physical uplink to each switch. Bonded NICs are supported as well. The pod-level switch is a pair of redundant gigabit switches with 10 G uplinks. - - - - - networking-in-a-pod.png: Network setup in a pod - - Servers are connected as follows: - - Storage devices are connected to only the network that carries management traffic. - Hosts are connected to networks for both management traffic and public traffic. - Hosts are also connected to one or more networks carrying guest traffic. - - We recommend the use of multiple physical Ethernet cards to implement each network interface as well as redundant switch fabric in order to maximize throughput and improve reliability. -
+ Networking in a Pod + The figure below illustrates network setup within a single pod. The hosts are connected to a + pod-level switch. At a minimum, the hosts should have one physical uplink to each switch. + Bonded NICs are supported as well. The pod-level switch is a pair of redundant gigabit + switches with 10 G uplinks. + + + + + + networksinglepod.png: diagram showing logical view of network in a pod + + + Servers are connected as follows: + + Storage devices are connected to only the network that carries management traffic. + Hosts are connected to networks for both management traffic and public traffic. + Hosts are also connected to one or more networks carrying guest traffic. + + We recommend the use of multiple physical Ethernet cards to implement each network interface as well as redundant switch fabric in order to maximize throughput and improve reliability. + + diff --git a/docs/en-US/networking-in-a-zone.xml b/docs/en-US/networking-in-a-zone.xml index c380c33dd94..e50efbac9ab 100644 --- a/docs/en-US/networking-in-a-zone.xml +++ b/docs/en-US/networking-in-a-zone.xml @@ -5,32 +5,34 @@ ]> -
- Networking in a Zone - Figure 3 illustrates the network setup within a single zone. - - - - - networking-in-a-zone.png: Network setup in a single zone - - A firewall for management traffic operates in the NAT mode. The network typically is assigned IP addresses in the 192.168.0.0/16 Class B private address space. Each pod is assigned IP addresses in the 192.168.*.0/24 Class C private address space. - Each zone has its own set of public IP addresses. Public IP addresses from different zones do not overlap. -
+ Networking in a Zone + The following figure illustrates the network setup within a single zone. + + + + + + networksetupzone.png: Depicts network setup in a single zone + + + A firewall for management traffic operates in the NAT mode. The network typically is assigned IP addresses in the 192.168.0.0/16 Class B private address space. Each pod is assigned IP addresses in the 192.168.*.0/24 Class C private address space. + Each zone has its own set of public IP addresses. Public IP addresses from different zones do not overlap. + + diff --git a/docs/en-US/networking-overview.xml b/docs/en-US/networking-overview.xml index 798fd7a8bd8..a71fe95a864 100644 --- a/docs/en-US/networking-overview.xml +++ b/docs/en-US/networking-overview.xml @@ -5,31 +5,30 @@ ]> -
- Networking Overview - - &PRODUCT; offers two types of networking scenario: - - - Basic. For AWS-style networking. Provides a single network where guest isolation can be provided through layer-3 means such as security groups (IP address source filtering). - Advanced. For more sophisticated network topologies. This network model provides the most flexibility in defining guest networks. - - For more details, see Network Setup. -
+ Networking Overview + &PRODUCT; offers two types of networking scenario: + + + Basic. For AWS-style networking. Provides a single network where guest isolation can be provided through layer-3 means such as security groups (IP address source filtering). + Advanced. For more sophisticated network topologies. This network model provides the most flexibility in defining guest networks. + + For more details, see Network Setup. + + diff --git a/docs/en-US/pod-add.xml b/docs/en-US/pod-add.xml index 419e333272e..2a2b08753a9 100644 --- a/docs/en-US/pod-add.xml +++ b/docs/en-US/pod-add.xml @@ -1,28 +1,43 @@ - %BOOK_ENTITIES; ]>
- Adding a Pod - TODO + Adding a Pod + When you created a new zone, &PRODUCT; adds the first pod for you. You can add more pods at any time using the procedure in this section. + + Log in to the &PRODUCT; UI. See . + In the left navigation, choose Infrastructure. In Zones, click View More, then click the zone to which you want to add a pod. + Click the Compute and Storage tab. In the Pods node of the diagram, click View All. + Click Add Pod. + Enter the following details in the dialog. + + Name. The name of the pod. + Gateway. The gateway for the hosts in that pod. + Netmask. The network prefix that defines the pod's subnet. Use CIDR notation. + Start/End Reserved System IP. The IP range in the management network that &PRODUCT; uses to manage various system VMs, such as Secondary Storage VMs, Console Proxy VMs, and DHCP. For more information, see System Reserved IP Addresses. + + + Click OK. +
diff --git a/docs/en-US/port-forwarding.xml b/docs/en-US/port-forwarding.xml index b7786936c4b..1bbba45e3b8 100644 --- a/docs/en-US/port-forwarding.xml +++ b/docs/en-US/port-forwarding.xml @@ -5,45 +5,47 @@ ]> -
- Port Forwarding - A port forward service is a set of port forwarding rules that define a policy. A port forward service is then applied to one or more guest VMs. The guest VM then has its inbound network access managed according to the policy defined by the port forwarding service. You can optionally specify one or more CIDRs to filter the source IPs. This is useful when you want to allow only incoming requests from certain IP addresses to be forwarded. - A guest VM can be in any number of port forward services. Port forward services can be defined but have no members. If a guest VM is part of more than one network, port forwarding rules will function only if they are defined on the default network - You cannot use port forwarding to open ports for an elastic IP address. When elastic IP is used, outside access is instead controlled through the use of security groups. See Security Groups. - To set up port forwarding: - - Log in to the CloudPlatform UI as an administrator or end user. - If you have not already done so, add a public IP address range to a zone in CloudPlatform. See Adding a Zone and Pod in the Installation Guide. - Add one or more VM instances to CloudPlatform. - In the left navigation bar, click Network. - Click the name of the guest network where the VMs are running. - - Choose an existing IP address or acquire a new IP address. (See Acquiring a New IP Address on page 73.) Click the name of the IP address in the list. - Click the Configuration tab. - In the Port Forwarding node of the diagram, click View All. - Fill in the following: - - Public Port. The port to which public traffic will be addressed on the IP address you acquired in the previous step. - Private Port. The port on which the instance is listening for forwarded public traffic. - Protocol. The communication protocol in use between the two ports. - - Click Add. - + Port Forwarding + A port forward service is a set of port forwarding rules that define a policy. A port forward service is then applied to one or more guest VMs. The guest VM then has its inbound network access managed according to the policy defined by the port forwarding service. You can optionally specify one or more CIDRs to filter the source IPs. This is useful when you want to allow only incoming requests from certain IP addresses to be forwarded. + A guest VM can be in any number of port forward services. Port forward services can be defined but have no members. If a guest VM is part of more than one network, port forwarding rules will function only if they are defined on the default network + You cannot use port forwarding to open ports for an elastic IP address. When elastic IP is used, outside access is instead controlled through the use of security groups. See Security Groups. + To set up port forwarding: + + Log in to the &PRODUCT; UI as an administrator or end user. + If you have not already done so, add a public IP address range to a zone in &PRODUCT;. See Adding a Zone and Pod in the Installation Guide. + Add one or more VM instances to &PRODUCT;. + In the left navigation bar, click Network. + Click the name of the guest network where the VMs are running. + + Choose an existing IP address or acquire a new IP address. See . Click the name of the IP address in the list. + Click the Configuration tab. + In the Port Forwarding node of the diagram, click View All. + Fill in the following: + + Public Port. The port to which public traffic will be + addressed on the IP address you acquired in the previous step. + Private Port. The port on which the instance is listening for + forwarded public traffic. + Protocol. The communication protocol in use between the two + ports + + Click Add. +
diff --git a/docs/en-US/primary-storage-add.xml b/docs/en-US/primary-storage-add.xml index 588d491a07a..401588c1880 100644 --- a/docs/en-US/primary-storage-add.xml +++ b/docs/en-US/primary-storage-add.xml @@ -5,24 +5,50 @@ ]>
- Adding Primary Storage - TODO + Adding Primary Storage + Ensure that nothing stored on the server. Adding the server to &PRODUCT; will destroy any existing data. + When you create a new zone, the first primary storage is added as part of that procedure. You can add primary storage servers at any time, such as when adding a new cluster or adding more servers to an existing cluster. + + Log in to the &PRODUCT; UI. + In the left navigation, choose Infrastructure. In Zones, click View More, then click the zone in which you want to add the primary storage. + Click the Compute tab. + In the Primary Storage node of the diagram, click View All. + Click Add Primary Storage. + Provide the following information in the dialog. The information required varies depending on your choice in Protocol. + + Pod. The pod for the storage device. + Cluster. The cluster for the storage device. + Name. The name of the storage device + Protocol. For XenServer, choose either NFS, iSCSI, or PreSetup. For KVM, choose NFS or SharedMountPoint. For vSphere choose either VMFS (iSCSI or FiberChannel) or NFS + Server (for NFS, iSCSI, or PreSetup). The IP address or DNS name of the storage device + Server (for VMFS). The IP address or DNS name of the vCenter server. + Path (for NFS). In NFS this is the exported path from the server. + Path (for VMFS). In vSphere this is a combination of the datacenter name and the datastore name. The format is "/" datacenter name "/" datastore name. For example, "/cloud.dc.VM/cluster1datastore". + Path (for SharedMountPoint). With KVM this is the path on each host that is where this primary storage is mounted. For example, "/mnt/primary". + SR Name-Label (for PreSetup). Enter the name-label of the SR that has been set up outside &PRODUCT;. + Target IQN (for iSCSI). In iSCSI this is the IQN of the target. For example, iqn.1986-03.com.sun:02:01ec9bb549-1271378984 + Lun # (for iSCSI). In iSCSI this is the LUN number. For example, 3. + Tags (optional). The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings + + The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2. + Click OK. +
diff --git a/docs/en-US/primary-storage.xml b/docs/en-US/primary-storage.xml index 4860488fb29..de4005e38d8 100644 --- a/docs/en-US/primary-storage.xml +++ b/docs/en-US/primary-storage.xml @@ -5,24 +5,30 @@ ]>
- Primary Storage - This section gives concepts and technical details about CloudPlatform primary storage. For information about how to install and configure primary storage through the CloudPlatform UI, see the Advanced Installation Guide. -
+ Primary Storage + This section gives concepts and technical details about &PRODUCT; primary storage. For information about how to install and configure primary storage through the &PRODUCT; UI, see the Advanced Installation Guide. + + + + + + + diff --git a/docs/en-US/projects.xml b/docs/en-US/projects.xml index 0390f528f3f..f26248f8264 100644 --- a/docs/en-US/projects.xml +++ b/docs/en-US/projects.xml @@ -5,27 +5,36 @@ ]> -
- Projects - Projects are used to organize people and resources. &PRODUCT; users within a single domain can group themselves into project teams so they can collaborate and share virtual resources such as VMs, snapshots, templates, data disks, and IP addresses. &PRODUCT; tracks resource usage per project as well as per user, so the usage can be billed to either a user account or a project. For example, a private cloud within a software company might have all members of the QA department assigned to one project, so the company can track the resources used in testing while the project members can more easily isolate their efforts from other users of the same cloud - You can configure &PRODUCT; to allow any user to create a new project, or you can restrict that ability to just &PRODUCT; administrators. Once you have created a project, you become that project’s administrator, and you can add others within your domain to the project. &PRODUCT; can be set up either so that you can add people directly to a project, or so that you have to send an invitation which the recipient must accept. Project members can view and manage all virtual resources created by anyone in the project (for example, share VMs). A user can be a member of any number of projects and can switch views in the &PRODUCT; UI to show only project-related information, such as project VMs, fellow project members, project-related alerts, and so on. - The project administrator can pass on the role to another project member. The project administrator can also add more members, remove members from the project, set new resource limits (as long as they are below the global defaults set by the &PRODUCT; administrator), and delete the project. When the administrator removes a member from the project, resources created by that user, such as VM instances, remain with the project. This brings us to the subject of resource ownership and which resources can be used by a project. - Resources created within a project are owned by the project, not by any particular &PRODUCT; account, and they can be used only within the project. A user who belongs to one or more projects can still create resources outside of those projects, and those resources belong to the user’s account; they will not be counted against the project’s usage or resource limits. You can create project-level networks to isolate traffic within the project and provide network services such as port forwarding, load balancing, VPN, and static NAT. A project can also make use of certain types of resources from outside the project, if those resources are shared. For example, a shared network or public template is available to any project in the domain. A project can get access to a private template if the template’s owner will grant permission. A project can use any service offering or disk offering available in its domain; however, you can not create private service and disk offerings at the project level.. -
+ + Using Projects to Organize Users and Resources + + + + + + + + + + + + + + diff --git a/docs/en-US/provisioning-steps-overview.xml b/docs/en-US/provisioning-steps-overview.xml index 1da4485ff39..daf2cfc9d9b 100644 --- a/docs/en-US/provisioning-steps-overview.xml +++ b/docs/en-US/provisioning-steps-overview.xml @@ -5,42 +5,40 @@ ]> -
- Overview of Provisioning Steps - After the Management Server is installed and running, you can add the compute resources for it to manage. For an overview of how a &PRODUCT; cloud infrastructure is organized, see . - To provision the cloud infrastructure, or to scale it up at any time, follow these procedures: - - Change the root password. See . - Add a zone. See . - Add more pods (optional). See . - Add more clusters (optional). See . - Add more hosts (optional). See . - Add primary storage. See . - Add secondary storage. See . - Initialize and test the new cloud. See . - - When you have finished these steps, you will have a deployment with the following basic structure: - - - - - provisioning-overview.png: Conceptual overview of a basic deployment - + Overview of Provisioning Steps + After the Management Server is installed and running, you can add the compute resources for it to manage. For an overview of how a &PRODUCT; cloud infrastructure is organized, see . + To provision the cloud infrastructure, or to scale it up at any time, follow these procedures: + + Add a zone. See . + Add more pods (optional). See . + Add more clusters (optional). See . + Add more hosts (optional). See . + Add primary storage. See . + Add secondary storage. See . + Initialize and test the new cloud. See . + + When you have finished these steps, you will have a deployment with the following basic structure: + + + + + provisioning-overview.png: Conceptual overview of a basic deployment +
diff --git a/docs/en-US/provisioning-steps.xml b/docs/en-US/provisioning-steps.xml index fda3e177f15..8777b02df13 100644 --- a/docs/en-US/provisioning-steps.xml +++ b/docs/en-US/provisioning-steps.xml @@ -5,28 +5,26 @@ ]> - -
+ Steps to Provisioning Your Cloud Infrastructure This section tells how to add zones, pods, clusters, hosts, storage, and networks to your cloud. If you are unfamiliar with these entities, please begin by looking through . - @@ -34,4 +32,4 @@ -
+ diff --git a/docs/en-US/release-ip-address.xml b/docs/en-US/release-ip-address.xml index 87b53007cdb..9fdccd740fc 100644 --- a/docs/en-US/release-ip-address.xml +++ b/docs/en-US/release-ip-address.xml @@ -5,37 +5,39 @@ ]> -
- Releasing an IP Address - - Log in to the CloudPlatform UI as an administrator or end user. - In the left navigation, choose Network. - Click the name of the network where you want to work with. - Click View IP Addresses. - Click the IP address you want to release. - - Click the Release IP button - - - - ReleaseIPButton.png: button to release an IP - . - + Releasing an IP Address + When the last rule for an IP address is removed, you can release that IP address. The IP address still belongs to the VPC; however, it can be picked up for any guest network again. + + Log in to the &PRODUCT; UI as an administrator or end user. + In the left navigation, choose Network. + Click the name of the network where you want to work with. + Click View IP Addresses. + Click the IP address you want to release. + + Click the Release IP button. + + + + + ReleaseIPButton.png: button to release an IP + + +
diff --git a/docs/en-US/removing-vsphere-hosts.xml b/docs/en-US/removing-vsphere-hosts.xml index 16830b7c17e..3f819f06641 100644 --- a/docs/en-US/removing-vsphere-hosts.xml +++ b/docs/en-US/removing-vsphere-hosts.xml @@ -1,25 +1,25 @@ - %BOOK_ENTITIES; ]>
diff --git a/docs/en-US/runtime-allocation-virtual-network-resources.xml b/docs/en-US/runtime-allocation-virtual-network-resources.xml index 696ea9b9d6d..479f069680f 100644 --- a/docs/en-US/runtime-allocation-virtual-network-resources.xml +++ b/docs/en-US/runtime-allocation-virtual-network-resources.xml @@ -5,24 +5,27 @@ ]> -
Runtime Allocation of Virtual Network Resources - When you define a new virtual network, all your settings for that network are stored in &PRODUCT;. The actual network resources are activated only when the first virtual machine starts in the network. When all virtual machines have left the virtual network, the network resources are garbage collected so they can be allocated again. This helps to conserve network resources.. + When you define a new virtual network, all your settings for that network are stored in + &PRODUCT;. The actual network resources are activated only when the first virtual + machine starts in the network. When all virtual machines have left the virtual network, the + network resources are garbage collected so they can be allocated again. This helps to + conserve network resources.
diff --git a/docs/en-US/scheduled-maintenance-maintenance-mode-hosts.xml b/docs/en-US/scheduled-maintenance-maintenance-mode-hosts.xml index 6364e8b0c78..6b736e4eb11 100644 --- a/docs/en-US/scheduled-maintenance-maintenance-mode-hosts.xml +++ b/docs/en-US/scheduled-maintenance-maintenance-mode-hosts.xml @@ -1,28 +1,30 @@ - %BOOK_ENTITIES; ]>
Scheduled Maintenance and Maintenance Mode for Hosts You can place a host into maintenance mode. When maintenance mode is activated, the host becomes unavailable to receive new guest VMs, and the guest VMs already running on the host are seamlessly migrated to another host not in maintenance mode. This migration uses live migration technology and does not interrupt the execution of the guest. + +
diff --git a/docs/en-US/secondary-storage-add.xml b/docs/en-US/secondary-storage-add.xml index 15e8c742657..de7b69af13d 100644 --- a/docs/en-US/secondary-storage-add.xml +++ b/docs/en-US/secondary-storage-add.xml @@ -5,24 +5,31 @@ ]>
- Adding Secondary Storage - TODO + Adding Secondary Storage + Be sure there is nothing stored on the server. Adding the server to &PRODUCT; will destroy any existing data. + When you create a new zone, the first secondary storage is added as part of that procedure. You can add secondary storage servers at any time to add more servers to an existing zone. + + If you are going to use Swift for cloud-wide secondary storage, you must add the Swift storage to &PRODUCT; before you add the local zone secondary storage servers. + To prepare for local zone secondary storage, you should have created and mounted an NFS share during Management Server installation. + Make sure you prepared the system VM template during Management Server installation. + 4. Now that the secondary storage server for per-zone storage is prepared, add it to &PRODUCT;. Secondary storage is added as part of the procedure for adding a new zone. +
diff --git a/docs/en-US/secondary-storage-vm.xml b/docs/en-US/secondary-storage-vm.xml index 792644432d2..34015c32a91 100644 --- a/docs/en-US/secondary-storage-vm.xml +++ b/docs/en-US/secondary-storage-vm.xml @@ -5,28 +5,29 @@ ]>
- Secondary Storage VM + Secondary Storage VM In addition to the hosts, &PRODUCT;’s Secondary Storage VM mounts and writes to secondary storage. - Submissions to secondary storage go through the Secondary Storage VM. The Secondary Storage VM can retrieve templates and ISO images from URLs using a variety of protocols. - The secondary storage VM provides a background task that takes care of a variety of secondary storage activities: downloading a new template to a Zone, copying templates between Zones, and snapshot backups. - The administrator can log in to the secondary storage VM if needed. -
+ Submissions to secondary storage go through the Secondary Storage VM. The Secondary Storage VM can retrieve templates and ISO images from URLs using a variety of protocols. + The secondary storage VM provides a background task that takes care of a variety of secondary storage activities: downloading a new template to a Zone, copying templates between Zones, and snapshot backups. + The administrator can log in to the secondary storage VM if needed. + +
diff --git a/docs/en-US/secondary-storage.xml b/docs/en-US/secondary-storage.xml index e755b56734d..98ea0dc236b 100644 --- a/docs/en-US/secondary-storage.xml +++ b/docs/en-US/secondary-storage.xml @@ -1,29 +1,33 @@ - %BOOK_ENTITIES; ]>
Secondary Storage - This section gives concepts and technical details about &PRODUCT; secondary storage. For information about how to install and configure secondary storage through the &PRODUCT; UI, see the Advanced Installation Guide. + This section gives concepts and technical details about &PRODUCT; secondary storage. For information about how to install and configure secondary storage through the &PRODUCT; UI, see the Advanced Installation Guide. + + + +
diff --git a/docs/en-US/security-groups.xml b/docs/en-US/security-groups.xml index fdb4ee90a09..074581542c9 100644 --- a/docs/en-US/security-groups.xml +++ b/docs/en-US/security-groups.xml @@ -1,29 +1,31 @@ - %BOOK_ENTITIES; ]>
- + Using Security Groups to Control Traffic to VMs + +
diff --git a/docs/en-US/set-up-invitations.xml b/docs/en-US/set-up-invitations.xml index e6a22dba1af..c1303cf5e92 100644 --- a/docs/en-US/set-up-invitations.xml +++ b/docs/en-US/set-up-invitations.xml @@ -5,69 +5,76 @@ ]> -
Setting Up Invitations &PRODUCT; can be set up either so that project administrators can add people directly to a project, or so that it is necessary to send an invitation which the recipient must accept. The invitation can be sent by email or through the user’s &PRODUCT; account. If you want administrators to use invitations to add members to projects, turn on and set up the invitations feature in &PRODUCT;. - + Log in as administrator to the &PRODUCT; UI. In the left navigation, click Global Settings. - In the search box, type project and click the search button. In the search box, type project and click the search button. searchbutton.png: Searches projects - In the search results, you will see a few other parameters you need to set to control how invitations behave. The table below shows global configuration parameters related to project invitations. Click the edit button to set each parameter + In the search results, you can see a few other parameters you need to set to control how + invitations behave. The table below shows global configuration parameters related to + project invitations. Click the edit button to set each parameter. Configuration Parameters - Description + Description project.invite.required Set to true to turn on the invitations feature. + + project.email.sender The email address to show in the From field of invitation emails. + project.invite.timeout Amount of time to allow for a new member to respond to the invitation. + project.smtp.host Name of the host that acts as an email server to handle invitations. + project.smtp.password (Optional) Password required by the SMTP server. You must also set project.smtp.username and set project.smtp.useAuth to true. + project.smtp.port SMTP server’s listening port. + project.smtp.useAuth @@ -81,7 +88,9 @@ - Restart the Management Server + Restart the Management Server: service cloud-management restart - + +
+ diff --git a/docs/en-US/set-up-network-for-users.xml b/docs/en-US/set-up-network-for-users.xml index 4e2be48e312..c91565a5456 100644 --- a/docs/en-US/set-up-network-for-users.xml +++ b/docs/en-US/set-up-network-for-users.xml @@ -5,31 +5,27 @@ ]> -
+ Setting Up Networking for Users - People using cloud infrastructure have a variety of needs and preferences when it comes to the networking services provided by the cloud. As a &PRODUCT; administrator, you can do the following things to set up networking for your users: - - Set up physical networks in zones - Set up several different providers for the same service on a single physical network (for example, both Cisco and Juniper firewalls) - Bundle different types of network services into network offerings, so users can choose the desired network services for any given virtual machine - Add new network offerings as time goes on so end users can upgrade to a better class of service on their network - Provide more ways for a network to be accessed by a user, such as through a project of which the user is a member - -
+ + + + + diff --git a/docs/en-US/set-usage-limit.xml b/docs/en-US/set-usage-limit.xml index 3ef528a690c..5e2d770c7e0 100644 --- a/docs/en-US/set-usage-limit.xml +++ b/docs/en-US/set-usage-limit.xml @@ -5,29 +5,25 @@ ]> -
Setting Usage Limits &PRODUCT; provides several administrator control points for capping resource usage by users. Some of these limits are global configuration parameters. Others are applied at the ROOT domain and may be overridden on a per-account basis. Aggregate limits may be set on a per-domain basis. For example, you may limit a domain and all subdomains to the creation of 100 VMs. This section covers the following topics: - Globally Configured Limits - Default Account Resource Limits - Per Domain Limits -
+ diff --git a/docs/en-US/shared-networks.xml b/docs/en-US/shared-networks.xml index d505fed97b1..d5a7ede9bdb 100644 --- a/docs/en-US/shared-networks.xml +++ b/docs/en-US/shared-networks.xml @@ -5,26 +5,28 @@ ]> -
Shared Networks - A shared network can be accessed by virtual machines that belong to many different accounts. Network Isolation on shared networks is accomplished using techniques such as security groups (supported only in basic zones in &PRODUCT; 3.0.3). + A shared network can be accessed by virtual machines that belong to many different + accounts. Network Isolation on shared networks is accomplished using techniques such as + security groups (supported only in basic zones in &PRODUCT; 3.0.3 and later + versions). Shared Networks are created by the administrator Shared Networks can be designated to a certain domain @@ -32,4 +34,6 @@ Shared Networks are isolated by security groups Public Network is a shared network that is not shown to the end users + +
diff --git a/docs/en-US/site-to-site-vpn.xml b/docs/en-US/site-to-site-vpn.xml index 034fb42fdd8..9fb9eb7fb36 100644 --- a/docs/en-US/site-to-site-vpn.xml +++ b/docs/en-US/site-to-site-vpn.xml @@ -5,41 +5,45 @@ ]> -
- Site-to-Site VPN - - To add a Virtual Private Cloud (VPC): + Setting Up a Site-to-Site VPN Connection + A Site-to-Site VPN connection helps you establish a secure connection from an enterprise + datacenter to the cloud infrastructure. This allows users to access the guest VMs by + establishing a VPN connection to the virtual router of the account from a device in the + datacenter of the enterprise. Having this facility eliminates the need to establish VPN + connections to individual VMs. + The supported endpoints on the remote datacenters are: + + Cisco ISR with IOS 12.4 or later + Juniper J-Series routers with JunOS 9.5 or later + In addition to the specific Cisco and Juniper devices listed above, the expectation is that + any Cisco or Juniper device running on the supported operating systems are able to + establish VPN connections. + To set up a Site-to-Site VPN connection, perform the following: - Log in to the &PRODUCT; UI as an administrator or end user. - In the left navigation, choose Network - In the Select view, select site-to-site VPN. - Click Add site-to-site VPN. Provide the following information: - - IP Address:. - Gateway: The IP address of the remote gateway. - CIDR list: The guest CIDR list of the remote subnets. Enter a CIDR or a comma-separated list of CIDRs. - IPsec Preshared Key: The preshared key of the remote gateway. - IKE Policy: Internet Key Exchange (IKE) policy for phase 1. Specify it as a combination of the encryption algorithm(aes,3des,des) and hash algorithm(sha1,md5). For example: aes-sha1, 3des-sha1. - ESP Policy: Encapsulating Security Payload (ESP) policy for phase 2. Specify it as a combination of the encryption algorithm(aes,3des,des) and hash algorithm(sha1,md5). For example: aes-sha1, 3des-sha1. - Lifetime (seconds): Lifetime of SA in seconds. Default is 86400 seconds(1day). - - Click OK. + Create a Virtual Private Cloud (VPC).See . + Create a VPN Customer Gateway. + Create a VPN gateway for the VPC that you created. + Create VPN connection from the VPC VPN gateway to the customer VPN gateway. -
+ + + + + diff --git a/docs/en-US/standard-events.xml b/docs/en-US/standard-events.xml index b4a4c68a6cb..9c10f873044 100644 --- a/docs/en-US/standard-events.xml +++ b/docs/en-US/standard-events.xml @@ -5,23 +5,22 @@ ]> -
Standard Events The events log records three types of standard events. @@ -36,4 +35,6 @@ ERROR. This event is generated when an operation has not been successfully performed -
+ + + diff --git a/docs/en-US/static-nat.xml b/docs/en-US/static-nat.xml index ef9e2fc9167..4225d6eecad 100644 --- a/docs/en-US/static-nat.xml +++ b/docs/en-US/static-nat.xml @@ -5,24 +5,24 @@ ]> -
Static NAT - A static NAT rule maps a public IP address to the private IP address of a VM in order to allow Internet traffic into the VM. The public IP address always remains the same, which is why it is called "static" NAT. This section tells how to enable or disable static NAT for a particular IP address. + A static NAT rule maps a public IP address to the private IP address of a VM in order to allow Internet traffic into the VM. The public IP address always remains the same, which is why it is called “static” NAT. This section tells how to enable or disable static NAT for a particular IP address. +
diff --git a/docs/en-US/stop-restart-management-server.xml b/docs/en-US/stop-restart-management-server.xml index 2edc23332c0..5c1bcecbc00 100644 --- a/docs/en-US/stop-restart-management-server.xml +++ b/docs/en-US/stop-restart-management-server.xml @@ -5,27 +5,26 @@ ]> -
Stopping and Restarting the Management Server The root administrator will need to stop and restart the Management Server from time to time. - For example, after changing a global configuration parameter, a restart is required. If you have multiple Management Server nodes, restart all of them to put the new parameter value into effect consistently throughout the cloud. + For example, after changing a global configuration parameter, a restart is required. If you have multiple Management Server nodes, restart all of them to put the new parameter value into effect consistently throughout the cloud.. To stop the Management Server, issue the following command at the operating system prompt on the Management Server node: # service cloud-management stop To start the Management Server: diff --git a/docs/en-US/stopping-and-starting-vms.xml b/docs/en-US/stopping-and-starting-vms.xml index 8b294af0b90..1c8bd808394 100644 --- a/docs/en-US/stopping-and-starting-vms.xml +++ b/docs/en-US/stopping-and-starting-vms.xml @@ -1,5 +1,5 @@ - %BOOK_ENTITIES; ]> @@ -23,6 +23,7 @@ -->
- Stopping and Starting VMs - Any user can access their own virtual machines. The administrator can access all VMs running in the cloud. + Stopping and Starting VMs + Once a VM instance is created, you can stop, restart, or delete it as needed. In the &PRODUCT; UI, click Instances, select the VM, and use the Stop, Start, Reboot, and Destroy links.
+ diff --git a/docs/en-US/storage.xml b/docs/en-US/storage.xml index c4df50f6a8f..49ebed9c42a 100644 --- a/docs/en-US/storage.xml +++ b/docs/en-US/storage.xml @@ -5,26 +5,29 @@ ]> -
- Deleting VMs - &PRODUCT; defines two types of storage: primary and secondary. Primary storage can be accessed by either iSCSI or NFS. Additionally, direct attached storage may be used for primary storage. Secondary storage is always accessed using NFS. - There is no ephemeral storage in &PRODUCT;. All volumes on all nodes are persistent -
+ + Working With Storage + + + + + + diff --git a/docs/en-US/suspend-project.xml b/docs/en-US/suspend-project.xml index bfaa12a03d9..93d50664f13 100644 --- a/docs/en-US/suspend-project.xml +++ b/docs/en-US/suspend-project.xml @@ -5,23 +5,22 @@ ]> -
Suspending or Deleting a Project When a project is suspended, it retains the resources it owns, but they can no longer be used. No new resources or members can be added to a suspended project. @@ -32,17 +31,22 @@ In the left navigation, click Projects. In Select View, choose Projects. Click the name of the project. - Click one of the buttons: + Click one of the buttons:To delete, use - deletebutton.png: Removes a member - - + + deletebutton.png: Removes a project + + + To suspend, use - deletebutton.png: Removes a member + + deletebutton.png: suspends a project + -
+
+ diff --git a/docs/en-US/sys-reliability-and-ha.xml b/docs/en-US/sys-reliability-and-ha.xml index bdb36d0fa46..94385ff683d 100644 --- a/docs/en-US/sys-reliability-and-ha.xml +++ b/docs/en-US/sys-reliability-and-ha.xml @@ -1,31 +1,32 @@ - %BOOK_ENTITIES; ]> -
+ System Reliability and High Availability - vCenter Maintenance Mode - XenServer and Maintenance Mode - vCenter Maintenance Mode - XenServer and Maintenance Mode -
+ + + + + + diff --git a/docs/en-US/sysprep-for-windows-server-2003R2.xml b/docs/en-US/sysprep-for-windows-server-2003R2.xml index 86e1667a1c5..5f8a3890705 100644 --- a/docs/en-US/sysprep-for-windows-server-2003R2.xml +++ b/docs/en-US/sysprep-for-windows-server-2003R2.xml @@ -5,53 +5,53 @@ ]> -
- Sysprep for Windows Server 2003 R2 - Earlier versions of Windows have a different sysprep tool. Follow these steps for Windows Server 2003 R2. - - Extract the content of \support\tools\deploy.cab on the Windows installation CD into a directory called c:\sysprep on the Windows 2003 R2 VM. - Run c:\sysprep\setupmgr.exe to create the sysprep.inf file. - - Select Create New to create a new Answer File. - Enter “Sysprep setup” for the Type of Setup. - Select the appropriate OS version and edition. - On the License Agreement screen, select “Yes fully automate the installation”. - Provide your name and organization. - Leave display settings at default. - Set the appropriate time zone. - Provide your product key. - Select an appropriate license mode for your deployment - Select “Automatically generate computer name”. - Type a default administrator password. If you enable the password reset feature, the users will not actually use this password. This password will be reset by the instance manager after the guest boots up. - Leave Network Components at “Typical Settings”. - Select the “WORKGROUP” option. - Leave Telephony options at default. - Select appropriate Regional Settings. - Select appropriate language settings. - Do not install printers. - Do not specify “Run Once commands”. - You need not specify an identification string. - Save the Answer File as c:\sysprep\sysprep.inf. - - - Run the following command to sysprep the image:c:\sysprep\sysprep.exe -reseal -mini -activated - After this step the machine will automatically shut down - -
+ System Preparation for Windows Server 2003 R2 + Earlier versions of Windows have a different sysprep tool. Follow these steps for Windows Server 2003 R2. + + Extract the content of \support\tools\deploy.cab on the Windows installation CD into a directory called c:\sysprep on the Windows 2003 R2 VM. + Run c:\sysprep\setupmgr.exe to create the sysprep.inf file. + + Select Create New to create a new Answer File. + Enter “Sysprep setup” for the Type of Setup. + Select the appropriate OS version and edition. + On the License Agreement screen, select “Yes fully automate the installation”. + Provide your name and organization. + Leave display settings at default. + Set the appropriate time zone. + Provide your product key. + Select an appropriate license mode for your deployment + Select “Automatically generate computer name”. + Type a default administrator password. If you enable the password reset feature, the users will not actually use this password. This password will be reset by the instance manager after the guest boots up. + Leave Network Components at “Typical Settings”. + Select the “WORKGROUP” option. + Leave Telephony options at default. + Select appropriate Regional Settings. + Select appropriate language settings. + Do not install printers. + Do not specify “Run Once commands”. + You need not specify an identification string. + Save the Answer File as c:\sysprep\sysprep.inf. + + + + Run the following command to sysprep the image:c:\sysprep\sysprep.exe -reseal -mini -activated + After this step the machine will automatically shut down + + diff --git a/docs/en-US/sysprep-windows-server-2008R2.xml b/docs/en-US/sysprep-windows-server-2008R2.xml index af36d15a2c1..49e7477c6b4 100644 --- a/docs/en-US/sysprep-windows-server-2008R2.xml +++ b/docs/en-US/sysprep-windows-server-2008R2.xml @@ -5,34 +5,35 @@ ]> -
- System Preparation for Windows Server 2008 R2 - For Windows 2008 R2, you run Windows System Image Manager to create a custom sysprep response XML file. Windows System Image Manager is installed as part of the Windows Automated Installation Kit (AIK). Windows AIK can be downloaded from the Microsoft Download Center at the following location: - Microsoft Download Center. - Use the following steps to run sysprep for Windows 2008 R2:The steps outlined here are derived from the excellent guide by Charity Shelbourne, originally published at Windows Server 2008 Sysprep Mini-Setup + System Preparation for Windows Server 2008 R2 + For Windows 2008 R2, you run Windows System Image Manager to create a custom sysprep response XML file. Windows System Image Manager is installed as part of the Windows Automated Installation Kit (AIK). Windows AIK can be downloaded from Microsoft Download Center. + Use the following steps to run sysprep for Windows 2008 R2:The steps outlined here are derived from the excellent guide by Charity Shelbourne, originally published at Windows Server 2008 Sysprep Mini-Setup. + + Download and install the Windows AIKWindows AIK should not be installed on the Windows 2008 R2 VM you just created. Windows AIK should not be part of the template you create. It is only used to create the sysprep answer file. Copy the install.wim file in the \sources directory of the Windows 2008 R2 installation DVD to the hard disk. This is a very large file and may take a long time to copy. Windows AIK requires the WIM file to be writable. Start the Windows System Image Manager, which is part of the Windows AIK. - In the Windows Image pane, right click “Select a Windows image or catalog file” to load the install.wim file you just copied. - Select the Windows 2008 R2 EditionYou may be prompted with a warning that the catalog file cannot be opened. Click Yes to create a new catalog file. + In the Windows Image pane, right click the Select a Windows image or catalog file option to + load the install.wim file you just copied. + Select the Windows 2008 R2 Edition.You may be prompted with a warning that the catalog file cannot be opened. Click Yes to create a new catalog file. In the Answer File pane, right click to create a new answer file. Generate the answer file from the Windows System Image Manager using the following steps: @@ -63,5 +64,8 @@ cd c:\Windows\System32\sysprep sysprep.exe /oobe /generalize /shutdown The Windows 2008 R2 VM will automatically shut down after sysprep is complete. + + +
diff --git a/docs/en-US/system-reserved-ip-addresses.xml b/docs/en-US/system-reserved-ip-addresses.xml index 2f4922553fa..7f4981726ea 100644 --- a/docs/en-US/system-reserved-ip-addresses.xml +++ b/docs/en-US/system-reserved-ip-addresses.xml @@ -5,23 +5,22 @@ ]> -
System Reserved IP Addresses In each zone, you need to configure a range of reserved IP addresses for the management network. This network carries communication between the &PRODUCT; Management Server and various system VMs, such as Secondary Storage VMs, Console Proxy VMs, and DHCP. @@ -35,5 +34,8 @@ For vSphere with advanced networking, we recommend provisioning enough private IPs for your total number of customers, plus enough for the required &PRODUCT; System VMs. Typically, about 10 additional IPs are required for the System VMs. For more information about System VMs, see Working with System Virtual Machines in the Administrator's Guide. When advanced networking is being used, the number of private IP addresses available in each pod varies depending on which hypervisor is running on the nodes in that pod. Citrix XenServer and KVM use link-local addresses, which in theory provide more than 65,000 private IP addresses within the address block. As the pod grows over time, this should be more than enough for any reasonable number of hosts as well as IP addresses for guest virtual routers. VMWare ESXi, by contrast uses any administrator-specified subnetting scheme, and the typical administrator provides only 255 IPs per pod. Since these are shared by physical machines, the guest virtual router, and other entities, it is possible to run out of private IPs when scaling up a pod whose nodes are running ESXi. To ensure adequate headroom to scale private IP space in an ESXi pod that uses advanced networking, use one or more of the following techniques: - TODO + + Specify a larger CIDR block for the subnet. A subnet mask with a /20 suffix will provide more than 4,000 IP addresses. + Create multiple pods, each with its own subnet. For example, if you create 10 pods and each pod has 255 IPs, this will provide 2,550 IP addresses. +
diff --git a/docs/en-US/system-service-offerings.xml b/docs/en-US/system-service-offerings.xml index 75aa128d4c8..1e4f8f966a6 100644 --- a/docs/en-US/system-service-offerings.xml +++ b/docs/en-US/system-service-offerings.xml @@ -5,25 +5,27 @@ ]>
System Service Offerings System service offerings provide a choice of CPU speed, number of CPUs, tags, and RAM size, just as other service offerings do. But rather than being used for virtual machine instances and exposed to users, system service offerings are used to change the default properties of virtual routers, console proxies, and other system VMs. System service offerings are visible only to the &PRODUCT; root administrator. &PRODUCT; provides default system service offerings. The &PRODUCT; root administrator can create additional custom system service offerings. When &PRODUCT; creates a virtual router for a guest network, it uses default settings which are defined in the system service offering associated with the network offering. You can upgrade the capabilities of the virtual router by applying a new network offering that contains a different system service offering. All virtual routers in that network will begin using the settings from the new service offering. -
+ + + diff --git a/docs/en-US/time-zones.xml b/docs/en-US/time-zones.xml index d6d4bc75df1..c187ad397d7 100644 --- a/docs/en-US/time-zones.xml +++ b/docs/en-US/time-zones.xml @@ -1,137 +1,138 @@ - %BOOK_ENTITIES; ]> -
- Time Zones - The following time zone identifiers are accepted by the &PRODUCT; API. There are several places that have a time zone as a required or optional parameter. These include scheduling recurring snapshots, creating a user, and specifying the usage time zone in the Configuration table. . - - - - - - - - Etc/GMT+12 - Etc/GMT+11 - Pacific/Samoa - - - Pacific/Honolulu - US/Alaska - America/Los_Angeles - - - Mexico/BajaNorte - US/Arizona - US/Mountain - - - America/Chihuahua - America/Chicago - America/Costa_Rica - - - America/Mexico_City - Canada/Saskatchewan - America/Bogota - - - America/New_York - America/Caracas - America/Asuncion - - - America/Cuiaba - America/Halifax - America/La_Paz - - - America/Santiago - America/St_Johns - America/Araguaina - - - America/Argentina/Buenos_Aires - America/Cayenne - America/Godthab - - - America/Montevideo - Etc/GMT+2 - Atlantic/Azores - - - Atlantic/Cape_Verde - Africa/Casablanca - Etc/UTC - - - Atlantic/Reykjavik - Europe/London - CET - - - Europe/Bucharest - Africa/Johannesburg - Asia/Beirut - - - Africa/Cairo - Asia/Jerusalem - Europe/Minsk - - - Europe/Moscow - Africa/Nairobi - Asia/Karachi - - - Asia/Kolkata - Asia/Bangkok - Asia/Shanghai - - - Asia/Kuala_Lumpur - Australia/Perth - Asia/Taipei - - - Asia/Tokyo - Asia/Seoul - Australia/Adelaide - - - Australia/Darwin - Australia/Brisbane - Australia/Canberra - - - Pacific/Guam - Pacific/Auckland - - - - - -
+ + Time Zones + The following time zone identifiers are accepted by &PRODUCT;. There are several places that have a time zone as a required or optional parameter. These include scheduling recurring snapshots, creating a user, and specifying the usage time zone in the Configuration table. . + + + + + + + + Etc/GMT+12 + Etc/GMT+11 + Pacific/Samoa + + + Pacific/Honolulu + US/Alaska + America/Los_Angeles + + + Mexico/BajaNorte + US/Arizona + US/Mountain + + + America/Chihuahua + America/Chicago + America/Costa_Rica + + + America/Mexico_City + Canada/Saskatchewan + America/Bogota + + + America/New_York + America/Caracas + America/Asuncion + + + America/Cuiaba + America/Halifax + America/La_Paz + + + America/Santiago + America/St_Johns + America/Araguaina + + + America/Argentina/Buenos_Aires + America/Cayenne + America/Godthab + + + America/Montevideo + Etc/GMT+2 + Atlantic/Azores + + + Atlantic/Cape_Verde + Africa/Casablanca + Etc/UTC + + + Atlantic/Reykjavik + Europe/London + CET + + + Europe/Bucharest + Africa/Johannesburg + Asia/Beirut + + + Africa/Cairo + Asia/Jerusalem + Europe/Minsk + + + Europe/Moscow + Africa/Nairobi + Asia/Karachi + + + Asia/Kolkata + Asia/Bangkok + Asia/Shanghai + + + Asia/Kuala_Lumpur + Australia/Perth + Asia/Taipei + + + Asia/Tokyo + Asia/Seoul + Australia/Adelaide + + + Australia/Darwin + Australia/Brisbane + Australia/Canberra + + + Pacific/Guam + Pacific/Auckland + + + + + + + diff --git a/docs/en-US/troubleshooting.xml b/docs/en-US/troubleshooting.xml index f3dc7d37da3..1fe03475528 100644 --- a/docs/en-US/troubleshooting.xml +++ b/docs/en-US/troubleshooting.xml @@ -5,30 +5,30 @@ ]> - -
- Alert Type Numbers - Data Loss on Exported Primary Storage - Load balancer rules fail after changing network offering - Maintenance mode not working on vCenter - Recovering a Lost Virtual Router - Unable to deploy VMs from uploaded vSphere template - Unable to power on virtual machine on VMware - Working with Server Logs -
+ + Troubleshooting + + + + + + + + + diff --git a/docs/en-US/tuning.xml b/docs/en-US/tuning.xml index bcaaaa1afbe..4f9dd01549f 100644 --- a/docs/en-US/tuning.xml +++ b/docs/en-US/tuning.xml @@ -1,28 +1,28 @@ - %BOOK_ENTITIES; ]> -
+ Tuning This section provides tips on how to improve the performance of your cloud. @@ -30,4 +30,4 @@ -
+ diff --git a/docs/en-US/ui.xml b/docs/en-US/ui.xml index 4f7f327d700..94ea4eaf95c 100644 --- a/docs/en-US/ui.xml +++ b/docs/en-US/ui.xml @@ -5,24 +5,25 @@ ]> - User Interface - + User Interface + + diff --git a/docs/en-US/upload-template.xml b/docs/en-US/upload-template.xml index 51aeb5a63c9..9f0ae019ccd 100644 --- a/docs/en-US/upload-template.xml +++ b/docs/en-US/upload-template.xml @@ -5,49 +5,63 @@ ]> -
- Uploading Templates - If you are uploading a template that was created using vSphere Client, be sure the OVA file does not contain an ISO. If it does, the deployment of VMs from the template will fail. - Templates are uploaded based on a URL. HTTP is the supported access protocol. Templates are frequently large files. You can optionally gzip them to decrease upload times. - To upload a template: - - In the left navigation bar, click Templates. - Click Create Template. - Provide the following: - - Name and Display Text. These will be shown in the UI, so choose something descriptive. - URL. The Management Server will download the file from the specified URL, such as http://my.web.server/filename.vhd.gz. - Zone. Choose the zone where you want the template to be available, or All Zones to make it available throughout &PRODUCT;. - OS Type: This helps &PRODUCT; and the hypervisor perform certain operations and make assumptions that improve the performance of the guest. Select one of the following: - - If the operating system of the stopped VM is listed, choose it. - If the OS type of the stopped VM is not listed, choose Other. - Generally you should not choose an older version of the OS than the version in the image. For example, choosing CentOS 5.4 to support a CentOS 6.2 image will in general not work. In those cases you should choose Other. - - - Hypervisor - Format. The format of the template upload file, such as VHD or OVA. - Password Enabled. Choose Yes if your template has the &PRODUCT; password change script installed. See Adding Password Management to Your Templates - Extractable. Choose Yes if the template is available for extraction. If this option is selected, end users can download a full image of a template. - Public. Choose Yes to make this template accessible to all users of this &PRODUCT; installation. The template will appear in the Community Templates list. See - Featured. Choose Yes if you would like this template to be more prominent for users to select. The template will appear in the Featured Templates list. Only an administrator can make a template Featured. - - + Uploading Templates + If you are uploading a template that was created using vSphere Client, be sure the OVA file does not contain an ISO. If it does, the deployment of VMs from the template will fail. + Templates are uploaded based on a URL. HTTP is the supported access protocol. Templates are frequently large files. You can optionally gzip them to decrease upload times. + To upload a template: + + In the left navigation bar, click Templates. + Click Register Template. + Provide the following: + + Name and Description. These will be shown in the UI, so + choose something descriptive. + URL. The Management Server will download the file from the + specified URL, such as http://my.web.server/filename.vhd.gz. + Zone. Choose the zone where you want the template to be + available, or All Zones to make it available throughout + &PRODUCT;. + OS Type: This helps &PRODUCT; and the hypervisor perform + certain operations and make assumptions that improve the performance of the + guest. Select one of the following: + + If the operating system of the stopped VM is listed, choose it. + If the OS type of the stopped VM is not listed, choose Other. + Generally you should not choose an older version of the OS than the version in the image. For example, choosing CentOS 5.4 to support a CentOS 6.2 image will in general not work. In those cases you should choose Other. + + + Hypervisor: The supported hypervisors are listed. Select the desired one. + Format. The format of the template upload file, such as VHD + or OVA. + Password Enabled. Choose Yes if your template has the + &PRODUCT; password change script installed. See Adding Password + Management to Your Templates + Extractable. Choose Yes if the template is available for extraction. If this option is selected, end users can + download a full image of a template. + Public. Choose Yes to make this template accessible to all + users of this &PRODUCT; installation. The template will appear in the + Community Templates list. See . + Featured. Choose Yes if you would like this template to be + more prominent for users to select. The template will appear in the Featured + Templates list. Only an administrator can make a template Featured. + + +
diff --git a/docs/en-US/user-services-overview.xml b/docs/en-US/user-services-overview.xml index f9e38c09209..95761217fbf 100644 --- a/docs/en-US/user-services-overview.xml +++ b/docs/en-US/user-services-overview.xml @@ -5,94 +5,35 @@ ]> -
- User Services Overview - In addition to the physical and logical infrastructure of your cloud, and the &PRODUCT; software and servers, you also need a layer of user services so that people can actually make use of the cloud. This means not just a user UI, but a set of options and resources that users can choose from, such as templates for creating virtual machines, disk storage, and more. If you are running a commercial service, you will be keeping track of what services and resources users are consuming and charging them for that usage. Even if you do not charge anything for people to use your cloud – say, if the users are strictly internal to your organization, or just friends who are sharing your cloud – you can still keep track of what services they use and how much of them. -
- Service Offerings, Disk Offerings, Network Offerings, and Templates - A user creating a new instance can make a variety of choices about its characteristics and capabilities. &PRODUCT; provides several ways to present users with choices when creating a new instance: - - Service Offerings, defined by the &PRODUCT; administrator, provide a choice of CPU speed, number of CPUs, RAM size, tags on the root disk, and other choices. See Creating a New Compute Offering. - Disk Offerings, defined by the &PRODUCT; administrator, provide a choice of disk size for primary data storage. See Creating a New Disk Offering. - Network Offerings, defined by the &PRODUCT; administrator, describe the feature set that is available to end users from the virtual router or external networking devices on a given guest network. See Network Offerings. - Templates, defined by the &PRODUCT; administrator or by any &PRODUCT; user, are the base OS images that the user can choose from when creating a new instance. For example, &PRODUCT; includes CentOS as a template. See Working with Templates. - - In addition to these choices that are provided for users, there is another type of service offering which is available only to the &PRODUCT; root administrator, and is used for configuring virtual infrastructure resources. For more information, see Upgrading a Virtual Router with System Service Offerings. -
-
- Accounts, Users, and Domains - An account typically represents a customer of the service provider or a department in a large organization. Multiple users can exist in an account. Users are like aliases in the account. Users in the same account are not isolated from each other, but they are isolated from users in other accounts. Most installations need not surface the notion of users; they just have one user per account. - Accounts are grouped by domains. Domains usually contain accounts that have some logical relationship to each other and a set of delegated administrators with some authority over the domain and its subdomains. For example, a service provider with several resellers could create a domain for each reseller. - Administrators are accounts with special privileges in the system. There may be multiple administrators in the system. Administrators can create or delete other administrators, and change the password for any user in the system. Root administrators have complete access to the system, including managing templates, service offerings, customer care administrators, and domains. Domain administrators can perform administrative operations for users who belong to that domain. Domain administrators do not have visibility into physical servers or other domains. -
-
- Using an LDAP Server for User Authentication - You can use an external LDAP server such as Microsoft Active Directory or ApacheDS to authenticate &PRODUCT; end-users. Just map &PRODUCT; accounts to the corresponding LDAP accounts using a query filter. The query filter is written using the query syntax of the particular LDAP server, and can include special wildcard characters provided by &PRODUCT; for matching common values such as the user’s email address and name. &PRODUCT; will search the external LDAP directory tree starting at a specified base directory and return the distinguished name (DN) and password of the matching user. This information along with the given password is used to authenticate the user. - To set up LDAP authentication in &PRODUCT;, call the &PRODUCT; API command ldapConfig and provide the following: - - Hostname or IP address and listening port of the LDAP server - Base directory and query filter - Search user DN credentials, which give &PRODUCT; permission to search on the LDAP server - SSL keystore and password, if SSL is used - -
- Example LDAP Configuration Commands - To understand the examples in this section, you need to know the basic concepts behind calling the &PRODUCT; API, which are explained in the Developer’s Guide. - The following shows an example invocation of ldapConfig with an ApacheDS LDAP server. - http://127.0.0.1:8080/client/api?command=ldapConfig&hostname=127.0.0.1&searchbase=ou%3Dtesting%2Co%3Dproject&queryfilter=%28%26%28uid%3D%25u%29%29&binddn=cn%3DJohn+Singh%2Cou%3Dtesting%2Co%project&bindpass=secret&port=10389&ssl=true&truststore=C%3A%2Fcompany%2Finfo%2Ftrusted.ks&truststorepass=secret&response=json&apiKey=YourAPIKey&signature=YourSignatureHash - - The command must be URL-encoded. Here is the same example without the URL encoding: - -http://127.0.0.1:8080/client/api?command=ldapConfig -&hostname=127.0.0.1 -&searchbase=ou=testing,o=project -&queryfilter=(&(%uid=%u)) -&binddn=cn=John+Singh,ou=testing,o=project -&bindpass=secret -&port=10389 -&ssl=true -&truststore=C:/company/info/trusted.ks -&truststorepass=secret -&response=json -&apiKey=YourAPIKey -&signature=YourSignatureHash - - The following shows a similar command for Active Directory. Here, the search base is the testing group within a company, and the users are matched up based on email address. - http://10.147.29.101:8080/client/api?command=ldapConfig&hostname=10.147.28.250&searchbase=OU%3Dtesting%2CDC%3Dcompany&queryfilter=%28%26%28mail%3D%25e%29%29&binddn=CN%3DAdministrator%2COU%3Dtesting%2CDC%3Dcompany&bindpass=1111_aaaa&port=389&response=json&apiKey=YourAPIKey&signature=YourSignatureHash - The next few sections explain some of the concepts you will need to know when filling out the ldapConfig parameters. -
-
- Search Base - Coming soon: TODO -
-
- Query Filter - Coming soon: TODO -
-
- Search User Bind DN - Coming soon: TODO -
-
- SSL Keystore Path and Password - Coming soon: TODO -
-
-
+ + User Services Overview + In addition to the physical and logical infrastructure of your cloud, and the &PRODUCT; software and servers, you also need a layer of user services so that people can actually make use of the cloud. This means not just a user UI, but a set of options and resources that users can choose from, such as templates for creating virtual machines, disk storage, and more. If you are running a commercial service, you will be keeping track of what services and resources users are consuming and charging them for that usage. Even if you do not charge anything for people to use your cloud – say, if the users are strictly internal to your organization, or just friends who are sharing your cloud – you can still keep track of what services they use and how much of them. +
+ Service Offerings, Disk Offerings, Network Offerings, and Templates + A user creating a new instance can make a variety of choices about its characteristics and capabilities. &PRODUCT; provides several ways to present users with choices when creating a new instance: + + Service Offerings, defined by the &PRODUCT; administrator, provide a choice of CPU speed, number of CPUs, RAM size, tags on the root disk, and other choices. See Creating a New Compute Offering. + Disk Offerings, defined by the &PRODUCT; administrator, provide a choice of disk size for primary data storage. See Creating a New Disk Offering. + Network Offerings, defined by the &PRODUCT; administrator, describe the feature set that is available to end users from the virtual router or external networking devices on a given guest network. See Network Offerings. + Templates, defined by the &PRODUCT; administrator or by any &PRODUCT; user, are the base OS images that the user can choose from when creating a new instance. For example, &PRODUCT; includes CentOS as a template. See Working with Templates. + + In addition to these choices that are provided for users, there is another type of service offering which is available only to the &PRODUCT; root administrator, and is used for configuring virtual infrastructure resources. For more information, see Upgrading a Virtual Router with System Service Offerings. +
+ \ No newline at end of file diff --git a/docs/en-US/using-multiple-guest-networks.xml b/docs/en-US/using-multiple-guest-networks.xml index ce71caaf276..7a8ea48e975 100644 --- a/docs/en-US/using-multiple-guest-networks.xml +++ b/docs/en-US/using-multiple-guest-networks.xml @@ -5,27 +5,28 @@ ]> -
- Using Multiple Guest Networks - In zones that use advanced networking, additional networks for guest traffic may be added at any time after the initial installation. You can also customize the domain name associated with the network by specifying a DNS suffix for each network. - A VM's networks are defined at VM creation time. A VM cannot add or remove networks after it has been created, although the user can go into the guest and remove the IP address from the NIC on a particular network. - Each VM has just one default network. The virtual router's DHCP reply will set the guest's default gateway as that for the default network. Multiple non-default networks may be added to a guest in addition to the single, required default network. The administrator can control which networks are available as the default network. - Additional networks can either be available to all accounts or be assigned to a specific account. Networks that are available to all accounts are zone-wide. Any user with access to the zone can create a VM with access to that network. These zone-wide networks provide little or no isolation between guests.Networks that are assigned to a specific account provide strong isolation. + Using Multiple Guest Networks + In zones that use advanced networking, additional networks for guest traffic may be added at any time after the initial installation. You can also customize the domain name associated with the network by specifying a DNS suffix for each network. + A VM's networks are defined at VM creation time. A VM cannot add or remove networks after it has been created, although the user can go into the guest and remove the IP address from the NIC on a particular network. + Each VM has just one default network. The virtual router's DHCP reply will set the guest's default gateway as that for the default network. Multiple non-default networks may be added to a guest in addition to the single, required default network. The administrator can control which networks are available as the default network. + Additional networks can either be available to all accounts or be assigned to a specific account. Networks that are available to all accounts are zone-wide. Any user with access to the zone can create a VM with access to that network. These zone-wide networks provide little or no isolation between guests. Networks that are assigned to a specific account provide strong isolation. + +
diff --git a/docs/en-US/using-sshkeys.xml b/docs/en-US/using-sshkeys.xml index b51569d1134..43b5e883d13 100644 --- a/docs/en-US/using-sshkeys.xml +++ b/docs/en-US/using-sshkeys.xml @@ -5,34 +5,40 @@ ]> -
- Using the SSH Keys for Authentication on Cloud - In addition to the username and password authentication, CloudStack supports using SSH keys to log in to the cloud infrastructure for additional security for your cloud infrastructure. You can use the createSSHKeyPair API to generate the SSH keys. - Because each cloud user has their own ssh key, one cloud user cannot log in to another cloud user's instances unless they share their ssh key files. Using a single SSH key pair, you can manage multiple instances. - Creating an Instance Template that Supports SSH Keys - - Create a instance template that supports SSH Keys. - Create a new instance by using the template provided by cloudstack. - For more information on creating a new instance, see - Download the cloudstack script from The SSH Key Gen Scriptto the instance you have created. - wget http://downloads.sourceforge.net/project/cloudstack/SSH%20Key%20Gen%20Script/cloud-set-guest-sshkey.in?r=http%3A%2F%2Fsourceforge.net%2Fprojects%2Fcloudstack%2Ffiles%2FSSH%2520Key%2520Gen%2520Script%2F&ts=1331225219&use_mirror=iweb + Using SSH Keys for Authentication + In addition to the username and password authentication, &PRODUCT; supports using SSH + keys to log in to the cloud infrastructure for additional security for your cloud + infrastructure. You can use the createSSHKeyPair API to generate the SSH keys. + Because each cloud user has their own ssh key, one cloud user cannot log in to another + cloud user's instances unless they share their ssh key files. Using a single SSH key pair, + you can manage multiple instances. +
+ Creating an Instance from Template that Supports SSH Keys + Perform the following: + + Create a new instance by using the template provided by &PRODUCT;. + For more information on creating a new instance, see . + Download the &PRODUCT; script from The SSH Key Gen Script to the instance you have created. + wget http://sourceforge.net/projects/cloudstack/files/SSH%20Key%20Gen%20Script/cloud-set-guest-sshkey.in/download Copy the file to /etc/init.d. cp cloud-set-guest-sshkey.in /etc/init.d/ Give the necessary permissions on the script: @@ -40,15 +46,18 @@ Run the script while starting up the operating system: chkconfig --add cloud-set-guest-sshkey.in Stop the instance. - - - Creating the SSH Keypair - You must make a call to the createSSHKeyPair api method. You can either use the cloudstack python api library or the curl commands to make the call to the cloudstack api. - For example, make a call from the cloudstack server to create a SSH keypair called "keypair-doc" for the admin account in the root domain: - Ensure that you adjust these values to meet your needs. If you are making the API call from a different server, your URL/PORT will be different, and you will need to use the API keys. + +
+
+ Creating the SSH Keypair + You must make a call to the createSSHKeyPair api method. You can either use the &PRODUCT; python api library or the curl commands to make the call to the &PRODUCT; api. + For example, make a call from the &PRODUCT; server to create a SSH keypair called "keypair-doc" for the admin account in the root domain: + Ensure that you adjust these values to meet your needs. If you are making the API call from a + different server, your URL or port number will be different, and you will need to use + the API keys. Run the following curl command: - curl --globoff "http://localhost:8096/?command=createSSHKeyPair&name=keypair-doc&account=admin&domainid=5163440e-c44b-42b5-9109-ad75cae8e8a2" + curl --globoff "http://localhost:8096/?command=createSSHKeyPair&name=keypair-doc&account=admin&domainid=1" The output is something similar to what is given below: <?xml version="1.0" encoding="ISO-8859-1"?><createsshkeypairresponse cloud-stack-version="3.0.0.20120228045507"><keypair><name>keypair-doc</name><fingerprint>f6:77:39:d5:5e:77:02:22:6a:d8:7f:ce:ab:cd:b3:56</fingerprint><privatekey>-----BEGIN RSA PRIVATE KEY----- MIICXQIBAAKBgQCSydmnQ67jP6lNoXdX3noZjQdrMAWNQZ7y5SrEu4wDxplvhYci @@ -78,15 +87,21 @@ KfEEuzcCUIxtJYTahJ1pvlFkQ8anpuxjSEDp8x/18bq3 -----END RSA PRIVATE KEY----- Save the file. - Creating an Instance - After you save the SSH keypair file, you must create an instance by using the template that you created at . Ensure that you use the same SSH key name that you created at . +
+
+ Creating an Instance + Ensure that you use the same SSH key name that you created. You cannot create the instance by using the GUI at this time and associate the instance with the newly created SSH keypair. A sample curl command to create a new instance is: - curl --globoff http://localhost:<port numbet>/?command=deployVirtualMachine\&zoneId=1\&serviceOfferingId=18727021-7556-4110-9322-d625b52e0813\&templateId=e899c18a-ce13-4bbf-98a9-625c5026e0b5\&securitygroupids=ff03f02f-9e3b-48f8-834d-91b822da40c5\&account=admin\&domainid=1\&keypair=keypair-doc + curl --globoff http://localhost:<port number>/?command=deployVirtualMachine&zoneId=1&serviceOfferingId=18727021-7556-4110-9322-d625b52e0813&templateId=e899c18a-ce13-4bbf-98a9-625c5026e0b5&securitygroupids=ff03f02f-9e3b-48f8-834d-91b822da40c5&account=admin\&domainid=1&keypair=keypair-doc Substitute the template, service offering and security group IDs (if you are using the security group feature) that are in your cloud environment. - Logging In Using the SSH Keypair +
+
+ Logging In Using the SSH Keypair To test your SSH key generation is successful, check whether you can log in to the cloud setup. - For exaple, from a Linux OS, run: + For example, from a Linux OS, run: ssh -i ~/.ssh/keypair-doc <ip address> - The -i parameter tells the ssh client to use a ssh key found at ~/.ssh/keypair-doc. -
+ The -i parameter directs the ssh client to use a ssh key found at ~/.ssh/keypair-doc. +
+ + diff --git a/docs/en-US/vcenter-maintenance-mode.xml b/docs/en-US/vcenter-maintenance-mode.xml index a07300eee58..2ed71625def 100644 --- a/docs/en-US/vcenter-maintenance-mode.xml +++ b/docs/en-US/vcenter-maintenance-mode.xml @@ -5,23 +5,22 @@ ]> -
vCenter and Maintenance Mode To enter maintenance mode on a vCenter host, both vCenter and &PRODUCT; must be used in concert. &PRODUCT; and vCenter have separate maintenance modes that work closely together. @@ -34,8 +33,9 @@ First use vCenter to exit the vCenter maintenance mode. This makes the host ready for &PRODUCT; to reactivate it. - Then use &PRODUCT;'s administrator UI to cancel the &PRODUCT; maintenance mode + Then use &PRODUCT;'s administrator UI to cancel the &PRODUCT; maintenance mode. When the host comes back online, the VMs that were migrated off of it are migrated back to it and new VMs can be added. - + +
diff --git a/docs/en-US/virtual-router.xml b/docs/en-US/virtual-router.xml index 775d4740a91..c9b403b1e3e 100644 --- a/docs/en-US/virtual-router.xml +++ b/docs/en-US/virtual-router.xml @@ -5,25 +5,28 @@ ]>
Virtual Router The virtual router is a type of System Virtual Machine. The virtual router is one of the most frequently used service providers in &PRODUCT;. The end user has no direct access to the virtual router. Users can ping the virtual router and take actions that affect it (such as setting up port forwarding), but users do not have SSH access into the virtual router. - There is no mechanism for the administrator to log in to the virtual router. Virtual routers can be restarted by administrators, but this will interrupt public network access and other services for end users. A basic test in debugging networking issues is to attempt to ping the virtual router from a guest VM. Some of the characteristics of the virtual router are determined by its associated system service offering. + There is no mechanism for the administrator to log in to the virtual router. Virtual routers can be restarted by administrators, but this will interrupt public network access and other services for end users. A basic test in debugging networking issues is to attempt to ping the virtual router from a guest VM. Some of the characteristics of the virtual router are determined by its associated system service offering.. + + +
diff --git a/docs/en-US/vm-lifecycle.xml b/docs/en-US/vm-lifecycle.xml index f5696ced12c..da526a5193b 100644 --- a/docs/en-US/vm-lifecycle.xml +++ b/docs/en-US/vm-lifecycle.xml @@ -5,38 +5,39 @@ ]>
- VM Lifecycle - Virtual machines can be in the following states: - - - - - basic-deployment.png: Basic two-machine CloudStack deployment - - Once a virtual machine is destroyed, it cannot be recovered. All the resources used by the virtual machine will be reclaimed by the system. This includes the virtual machine’s IP address. - A stop will attempt to gracefully shut down the operating system, which typically involves terminating all the running applications. If the operation system cannot be stopped, it will be forcefully terminated. This has the same effect as pulling the power cord to a physical machine. - A reboot is a stop followed by a start. - CloudPlatform preserves the state of the virtual machine hard disk until the machine is destroyed. - A running virtual machine may fail because of hardware or network issues. A failed virtual machine is in the down state. - The system places the virtual machine into the down state if it does not receive the heartbeat from the hypervisor for three minutes. - The user can manually restart the virtual machine from the down state. - The system will start the virtual machine from the down state automatically if the virtual machine is marked as HA-enabled. + VM Lifecycle + Virtual machines can be in the following states: + + + + + basic_deployment.png: Basic two-machine CloudStack deployment + + Once a virtual machine is destroyed, it cannot be recovered. All the resources used by the virtual machine will be reclaimed by the system. This includes the virtual machine’s IP address. + A stop will attempt to gracefully shut down the operating system, which typically involves terminating all the running applications. If the operation system cannot be stopped, it will be forcefully terminated. This has the same effect as pulling the power cord to a physical machine. + A reboot is a stop followed by a start. + &PRODUCT; preserves the state of the virtual machine hard disk until the machine is destroyed. + A running virtual machine may fail because of hardware or network issues. A failed virtual machine is in the down state. + The system places the virtual machine into the down state if it does not receive the heartbeat from the hypervisor for three minutes. + The user can manually restart the virtual machine from the down state. + The system will start the virtual machine from the down state automatically if the virtual machine is marked as HA-enabled.
+ diff --git a/docs/en-US/vm-storage-migration.xml b/docs/en-US/vm-storage-migration.xml index 4b09ffdb220..7c3824b4817 100644 --- a/docs/en-US/vm-storage-migration.xml +++ b/docs/en-US/vm-storage-migration.xml @@ -5,29 +5,31 @@ ]> -
VM Storage Migration - Supported in XenServer, KVM, and VMware. - This procedure is different from moving disk volumes from one VM to another. See Detaching and Moving Volumes . - You can migrate a virtual machine’s root disk volume or any additional data disk volume from one storage pool to another in the same zone. - You can use the storage migration feature to achieve some commonly desired administration goals, such as balancing the load on storage pools and increasing the reliability of virtual machines by moving them away from any storage pool that is experiencing issues. + Supported in XenServer, KVM, and VMware. + This procedure is different from moving disk volumes from one VM to another. See Detaching and Moving Volumes . + + + You can migrate a virtual machine’s root disk volume or any additional data disk volume from one storage pool to another in the same zone. + You can use the storage migration feature to achieve some commonly desired administration goals, such as balancing the load on storage pools and increasing the reliability of virtual machines by moving them away from any storage pool that is experiencing issues. -
+ + diff --git a/docs/en-US/vpc.xml b/docs/en-US/vpc.xml index 389910007da..53953ad2bc0 100644 --- a/docs/en-US/vpc.xml +++ b/docs/en-US/vpc.xml @@ -5,38 +5,132 @@ ]> -
- Virtual Private Cloud - - To add a Virtual Private Cloud (VPC): - - Log in to the &PRODUCT; UI as an administrator or end user. - In the left navigation, choose Network - In the Select view, select VPC. - Click Add VPC. Provide the following information: - - Name: A short name for the VPC that you are creating. - Description: A brief description of the VPC. - Zone: Choose the zone where you want the VPC to be available. - CIDR: To accept the traffic only from the IP addresses within a particular address block, enter a CIDR or a comma-separated list of CIDRs. The CIDR is the base IP address of the incoming traffic. For example, 192.168.0.0/22. To allow all CIDRs, set to 0.0.0.0/0. - Network Domain: If you want to assign a special domain name to this network, specify the DNS suffix. - - -
+ About Virtual Private Clouds + &PRODUCT; Virtual Private Cloud is a private, isolated part of &PRODUCT;. A VPC + can have its own virtual network topology that resembles a traditional physical network. You + can launch VMs in the virtual network that can have private addresses in the range of your + choice, for example: 10.0.0.0/16. You can define network tiers within your VPC network + range, which in turn enables you to group similar kinds of instances based on IP address + range. + For example, if a VPC has the private range 10.0.0.0/16, its guest networks can have the network ranges 10.0.1.0/24, 10.0.2.0/24, 10.0.3.0/24, and so on. + + Major Components of a VPC: + A VPC is comprised of the following network components: + + + VPC: A VPC acts as a container for multiple isolated + networks that can communicate with each other via its virtual router. + Network Tiers: Each tier acts as an isolated network with its + own VLANs and CIDR list, where you can place groups of resources, such as VMs. The + tiers are segmented by means of VLANs. The NIC of each tier acts as its + gateway. + Virtual Router: A virtual router is automatically created and + started when you create a VPC. The virtual router connect the tiers and direct + traffic among the public gateway, the VPN gateways, and the NAT instances. For each + tier, a corresponding NIC and IP exist in the virtual router. The virtual router + provides DNS and DHCP services through its IP. + Public Gateway: The traffic to and from the Internet routed + to the VPC through the public gateway. In a VPC, the public gateway is not exposed + to the end user; therefore, static routes are not support for the public + gateway. + Private Gateway: All the traffic to and from a private network routed to the VPC through the private gateway. For more information, see . + VPN Gateway: The VPC side of a VPN connection. + Site-to-Site VPN Connection: A hardware-based VPN connection + between your VPC and your datacenter, home network, or co-location facility. For + more information, see . + Customer Gateway: The customer side of a VPN Connection. For + more information, see . + NAT Instance: An instance that provides Port Address + Translation for instances to access the Internet via the public gateway. For more + information, see . + + + Network Architecture in a VPC + In a VPC, the following four basic options of network architectures are + present: + + + VPC with a public gateway only + VPC with public and private gateways + VPC with public and private gateways and site-to-site VPN access + VPC with a private gateway only and site-to-site VPN access + + + Connectivity Options for a VPC + You can connect your VPC to: + + The Internet through the public gateway. + The corporate datacenter by using a site-to-site VPN connection through the VPN gateway. + Both the Internet and your corporate datacenter by using both the public gateway and a VPN gateway. + + VPC Network Considerations + Consider the following before you create a VPC: + + A VPC, by default, is created in the enabled state. + + + A VPC can be created in Advance zone only, and can't belong to more than one zone at a time. + + + The default number of VPCs an account can create is 20. However, you can change it + by using the max.account.vpcs global parameter, which controls the maximum number of + VPCs an account is allowed to create. + + + The default number of tiers an account can create within a VPC is 3. You can + configure this number by using the vpc.max.networks parameter. + + + Each tier should have an unique CIDR in the VPC. Ensure that the tier's CIDR + should be within the VPC CIDR range. + + + A tier belongs to only one VPC. + + + All network tiers inside the VPC should belong to the same account. + + + When a VPC is created, by default, a SourceNAT IP is allocated to it. The Source + NAT IP is released only when the VPC is removed. + + A public IP can be used for only one purpose at a time. If the IP is a sourceNAT, it cannot be used for StaticNAT or port forwarding. + + The instances only have a private IP address that you provision. To communicate with the Internet, enable NAT to an instance that you launch in your VPC. + + + Only new networks can be added to a VPC. The maximum number of networks per VPC is + limited by the value you specify in the vpc.max.networks parameter. The default + value is three. + + + The load balancing service can be supported by only one tier inside the + VPC. + + If an IP address is assigned to a tier: + That IP can't be used by more than one tier at a time in the VPC. For example, if you have + tiers A and B, and a public IP1, you can create a port forwarding rule by + using the IP either for A or B, but not for both. + That IP can't be used for StaticNAT, load balancing, or port forwarding rules for another + guest network inside the VPC. + + + Remote access VPN is not supported in VPC networks. + diff --git a/docs/en-US/vpn.xml b/docs/en-US/vpn.xml index a4599873856..ccb3e861310 100644 --- a/docs/en-US/vpn.xml +++ b/docs/en-US/vpn.xml @@ -5,29 +5,41 @@ ]> -
- VPN - &PRODUCT; account owners can create virtual private networks (VPN) to access their virtual machines. If the guest network is instantiated from a network offering that offers the Remote Access VPN service, the virtual router (based on the System VM) is used to provide the service. &PRODUCT; provides a L2TP-over-IPsec-based remote access VPN service to guest virtual networks. Since each network gets its own virtual router, VPNs are not shared across the networks. VPN clients native to Windows, Mac OS X and iOS can be used to connect to the guest networks. The account owner can create and manage users for their VPN. &PRODUCT; does not use its account database for this purpose but uses a separate table. The VPN user database is shared across all the VPNs created by the account owner. All VPN users get access to all VPNs created by the account owner. - Make sure that not all traffic goes through the VPN. That is, the route installed by the VPN should be only for the guest network and not for all traffic. - - Road Warrior / Remote Access. Users want to be able to connect securely from a home or office to a private network in the cloud. Typically, the IP address of the connecting client is dynamic and cannot be preconfigured on the VPN server. - Site to Site. In this scenario, two private subnets are connected over the public Internet with a secure VPN tunnel. The cloud user’s subnet (for example, an office network) is connected through a gateway to the network in the cloud. The address of the user’s gateway must be preconfigured on the VPN server in the cloud. Note that although L2TP-over-IPsec can be used to set up Site-to-Site VPNs, this is not the primary intent of this feature. - + VPN + &PRODUCT; account owners can create virtual private networks (VPN) to access their virtual machines. If the guest network is instantiated from a network offering that offers the Remote Access VPN service, the virtual router (based on the System VM) is used to provide the service. &PRODUCT; provides a L2TP-over-IPsec-based remote access VPN service to guest virtual networks. Since each network gets its own virtual router, VPNs are not shared across the networks. VPN clients native to Windows, Mac OS X and iOS can be used to connect to the guest networks. The account owner can create and manage users for their VPN. &PRODUCT; does not use its account database for this purpose but uses a separate table. The VPN user database is shared across all the VPNs created by the account owner. All VPN users get access to all VPNs created by the account owner. + Make sure that not all traffic goes through the VPN. That is, the route installed by the VPN should be only for the guest network and not for all traffic. + + + Road Warrior / Remote Access. Users want to be able to + connect securely from a home or office to a private network in the cloud. Typically, + the IP address of the connecting client is dynamic and cannot be preconfigured on + the VPN server. + Site to Site. In this scenario, two private subnets are + connected over the public Internet with a secure VPN tunnel. The cloud user’s subnet + (for example, an office network) is connected through a gateway to the network in + the cloud. The address of the user’s gateway must be preconfigured on the VPN server + in the cloud. Note that although L2TP-over-IPsec can be used to set up Site-to-Site + VPNs, this is not the primary intent of this feature. For more information, see + + + + +
diff --git a/docs/en-US/windows-installation.xml b/docs/en-US/windows-installation.xml index b6e0632b785..27f90f374d2 100644 --- a/docs/en-US/windows-installation.xml +++ b/docs/en-US/windows-installation.xml @@ -5,24 +5,25 @@ ]> -
- Windows OS Installation - Download the installer, CloudInstanceManager.msi, from Download page and run the installer in the newly created Windows VM. + Windows OS Installation + Download the installer, CloudInstanceManager.msi, from the Download page and run the installer in + the newly created Windows VM.
diff --git a/docs/en-US/work-with-usage.xml b/docs/en-US/work-with-usage.xml index e9fb1d8d7ef..40130c88212 100644 --- a/docs/en-US/work-with-usage.xml +++ b/docs/en-US/work-with-usage.xml @@ -5,24 +5,31 @@ ]> - -
- Changing the Database Configuration - The &PRODUCT; Management Server stores database configuration information (e.g., hostname, port, credentials) in the file /etc/cloud/management/db.properties. To effect a change, edit this file on each Management Server, then restart the Management Server. -
+ + Working with Usage + The Usage Server is an optional, separately-installed part of &PRODUCT; that provides aggregated usage records which you can use to create billing integration for &PRODUCT;. The Usage Server works by taking data from the events log and creating summary usage records that you can access using the listUsageRecords API call. + The usage records show the amount of resources, such as VM run time or template storage + space, consumed by guest instances. + The Usage Server runs at least once per day. It can be configured to run multiple times per day. + + + + + + diff --git a/docs/en-US/working-with-hosts.xml b/docs/en-US/working-with-hosts.xml index fb4364b3cae..9bb524dd74a 100644 --- a/docs/en-US/working-with-hosts.xml +++ b/docs/en-US/working-with-hosts.xml @@ -1,28 +1,39 @@ - %BOOK_ENTITIES; ]> -
- Removing Hosts - Hosts can be removed from the cloud as needed. The procedure to remove a host depends on the hypervisor type. -
+ + Working With Hosts +
+ Adding Hosts + Additional hosts can be added at any time to provide more capacity for guest VMs. For requirements and instructions, see the Installation Guide. +
+ + + + + + + + + diff --git a/docs/en-US/working-with-iso.xml b/docs/en-US/working-with-iso.xml index efe5fb50e5e..03e18ee3535 100644 --- a/docs/en-US/working-with-iso.xml +++ b/docs/en-US/working-with-iso.xml @@ -5,29 +5,28 @@ ]> -
- Working with ISOs - &PRODUCT; supports ISOs and their attachment to guest VMs. An ISO is a read-only file that has an ISO/CD-ROM style file system. Users can upload their own ISOs and mount them on their guest VMs. - ISOs are uploaded based on a URL. HTTP is the supported protocol. Once the ISO is available via HTTP specify an upload URL such as http://my.web.server/filename.iso. - ISOs may be public or private, like templates.ISOs are not hypervisor-specific. That is, a guest on vSphere can mount the exact same image that a guest on KVM can mount. - ISO images may be stored in the system and made available with a privacy level similar to templates. ISO images are classified as either bootable or not bootable. A bootable ISO image is one that contains an OS image. &PRODUCT; allows a user to boot a guest VM off of an ISO image. Users can also attach ISO images to guest VMs. For example, this enables installing PV drivers into Windows. ISO images are not hypervisor-specific. + Working with ISOs + &PRODUCT; supports ISOs and their attachment to guest VMs. An ISO is a read-only file that has an ISO/CD-ROM style file system. Users can upload their own ISOs and mount them on their guest VMs. + ISOs are uploaded based on a URL. HTTP is the supported protocol. Once the ISO is available via HTTP specify an upload URL such as http://my.web.server/filename.iso. + ISOs may be public or private, like templates.ISOs are not hypervisor-specific. That is, a guest on vSphere can mount the exact same image that a guest on KVM can mount. + ISO images may be stored in the system and made available with a privacy level similar to templates. ISO images are classified as either bootable or not bootable. A bootable ISO image is one that contains an OS image. &PRODUCT; allows a user to boot a guest VM off of an ISO image. Users can also attach ISO images to guest VMs. For example, this enables installing PV drivers into Windows. ISO images are not hypervisor-specific. - +
diff --git a/docs/en-US/working-with-snapshots.xml b/docs/en-US/working-with-snapshots.xml index 6145ffd8de1..1d8dbd97369 100644 --- a/docs/en-US/working-with-snapshots.xml +++ b/docs/en-US/working-with-snapshots.xml @@ -5,28 +5,33 @@ ]> -
- Working with Snapshots - (Supported for the following hypervisors: XenServer, VMware vSphere, and KVM) - &PRODUCT; supports snapshots of disk volumes. Snapshots are a point-in-time capture of virtual machine disks. Memory and CPU states are not captured. If you are using the Oracle VM hypervisor, you can not take snapshots, since OVM does not support them. - Snapshots may be taken for volumes, including both root and data disks (except when the Oracle VM hypervisor is used, which does not support snapshots). The administrator places a limit on the number of stored snapshots per user. Users can create new volumes from the snapshot for recovery of particular files and they can create templates from snapshots to boot from a restored disk. - Users can create snapshots manually or by setting up automatic recurring snapshot policies. Users can also create disk volumes from snapshots, which may be attached to a VM like any other disk volume. Snapshots of both root disks and data disks are supported. However, &PRODUCT; does not currently support booting a VM from a recovered root disk. A disk recovered from snapshot of a root disk is treated as a regular data disk; the data on recovered disk can be accessed by attaching the disk to a VM. - A completed snapshot is copied from primary storage to secondary storage, where it is stored until deleted or purged by newer snapshot. + Working with Snapshots + (Supported for the following hypervisors: XenServer, + VMware vSphere, and KVM) + &PRODUCT; supports snapshots of disk volumes. Snapshots are a point-in-time capture of virtual machine disks. Memory and CPU states are not captured. If you are using the Oracle VM hypervisor, you can not take snapshots, since OVM does not support them. + Snapshots may be taken for volumes, including both root and data disks (except when the Oracle VM hypervisor is used, which does not support snapshots). The administrator places a limit on the number of stored snapshots per user. Users can create new volumes from the snapshot for recovery of particular files and they can create templates from snapshots to boot from a restored disk. + Users can create snapshots manually or by setting up automatic recurring snapshot policies. Users can also create disk volumes from snapshots, which may be attached to a VM like any other disk volume. Snapshots of both root disks and data disks are supported. However, &PRODUCT; does not currently support booting a VM from a recovered root disk. A disk recovered from snapshot of a root disk is treated as a regular data disk; the data on recovered disk can be accessed by attaching the disk to a VM. + A completed snapshot is copied from primary storage to secondary storage, where it is stored until deleted or purged by newer snapshot. + + + +
diff --git a/docs/en-US/working-with-system-vm.xml b/docs/en-US/working-with-system-vm.xml index 016d57977cc..97459f947bf 100644 --- a/docs/en-US/working-with-system-vm.xml +++ b/docs/en-US/working-with-system-vm.xml @@ -5,24 +5,29 @@ ]> -
+ Working with System Virtual Machines &PRODUCT; uses several types of system virtual machines to perform tasks in the cloud. In general &PRODUCT; manages these system VMs and creates, starts, and stops them as needed based on scale and immediate needs. However, the administrator should be aware of them and their roles to assist in debugging issues. -
+ + + + + + diff --git a/docs/en-US/working-with-templates.xml b/docs/en-US/working-with-templates.xml index 57a0a58ee7f..9f4e7509d30 100644 --- a/docs/en-US/working-with-templates.xml +++ b/docs/en-US/working-with-templates.xml @@ -5,28 +5,28 @@ ]> -
- Working with Templates - A template is a reusable configuration for virtual machines. When users launch VMs, they can choose from a list of templates in &PRODUCT;. - Specifically, a template is a virtual disk image that includes one of a variety of operating systems, optional additional software such as office applications, and settings such as access control to determine who can use the template. Each template is associated with a particular type of hypervisor, which is specified when the template is added to &PRODUCT;. - &PRODUCT; ships with a default template. In order to present more choices to users, &PRODUCT; administrators and users can create templates and add them to &PRODUCT;. + + Working with Templates + A template is a reusable configuration for virtual machines. When users launch VMs, they can choose from a list of templates in &PRODUCT;. + Specifically, a template is a virtual disk image that includes one of a variety of operating systems, optional additional software such as office applications, and settings such as access control to determine who can use the template. Each template is associated with a particular type of hypervisor, which is specified when the template is added to &PRODUCT;. + &PRODUCT; ships with a default template. In order to present more choices to users, &PRODUCT; administrators and users can create templates and add them to &PRODUCT;. @@ -38,7 +38,7 @@ - + -
+ diff --git a/docs/en-US/working-with-volumes.xml b/docs/en-US/working-with-volumes.xml index f4fce71c854..1a9d297265a 100644 --- a/docs/en-US/working-with-volumes.xml +++ b/docs/en-US/working-with-volumes.xml @@ -5,26 +5,34 @@ ]>
- Using Swift for Secondary Storage - A volume provides storage to a guest VM. The volume can provide for a root disk or an additional data disk. &PRODUCT; supports additional volumes for guest VMs. - Volumes are created for a specific hypervisor type. A volume that has been attached to guest using one hypervisor type (e.g, XenServer) may not be attached to a guest that is using another hypervisor type (e.g. vSphere, Oracle VM, KVM). This is because the different hypervisors use different disk image formats. - &PRODUCT; defines a volume as a unit of storage available to a guest VM. Volumes are either root disks or data disks. The root disk has "/" in the file system and is usually the boot device. Data disks provide for additional storage (e.g. As "/opt" or "D:"). Every guest VM has a root disk, and VMs can also optionally have a data disk. End users can mount multiple data disks to guest VMs. Users choose data disks from the disk offerings created by administrators. The user can create a template from a volume as well; this is the standard procedure for private template creation. Volumes are hypervisor-specific: a volume from one hypervisor type may not be used on a guest of another hypervisor type. + Working With Volumes + A volume provides storage to a guest VM. The volume can provide for a root disk or an additional data disk. &PRODUCT; supports additional volumes for guest VMs. + Volumes are created for a specific hypervisor type. A volume that has been attached to guest using one hypervisor type (e.g, XenServer) may not be attached to a guest that is using another hypervisor type (e.g. vSphere, Oracle VM, KVM). This is because the different hypervisors use different disk image formats. + &PRODUCT; defines a volume as a unit of storage available to a guest VM. Volumes are either root disks or data disks. The root disk has “/” in the file system and is usually the boot device. Data disks provide for additional storage (e.g. As “/opt” or “D:”). Every guest VM has a root disk, and VMs can also optionally have a data disk. End users can mount multiple data disks to guest VMs. Users choose data disks from the disk offerings created by administrators. The user can create a template from a volume as well; this is the standard procedure for private template creation. Volumes are hypervisor-specific: a volume from one hypervisor type may not be used on a guest of another hypervisor type. + + + + + + +
+ diff --git a/docs/en-US/xenserver-maintenance-mode.xml b/docs/en-US/xenserver-maintenance-mode.xml index 4dfa43ebe05..b947278a9bb 100644 --- a/docs/en-US/xenserver-maintenance-mode.xml +++ b/docs/en-US/xenserver-maintenance-mode.xml @@ -5,23 +5,22 @@ ]> -
XenServer and Maintenance Mode For XenServer, you can take a server offline temporarily by using the Maintenance Mode feature in XenCenter. When you place a server into Maintenance Mode, all running VMs are automatically migrated from it to another host in the same pool. If the server is the pool master, a new master will also be selected for the pool. While a server is Maintenance Mode, you cannot create or start any VMs on it. @@ -31,10 +30,10 @@ Right-click, then click Enter Maintenance Mode on the shortcut menu. - On the Server menu, click Enter Maintenance Mode + On the Server menu, click Enter Maintenance Mode. - Click Enter Maintenance Mode + Click Enter Maintenance Mode. The server's status in the Resources pane shows when all running VMs have been successfully migrated off the server. To take a server out of Maintenance Mode: @@ -43,9 +42,10 @@ Right-click, then click Exit Maintenance Mode on the shortcut menu. - On the Server menu, click Exit Maintenance Mode + On the Server menu, click Exit Maintenance Mode. - Click Exit Maintenance Mode + Click Exit Maintenance Mode. +