From f572bccc61eb67a725afec12f549a232fc86bfa8 Mon Sep 17 00:00:00 2001 From: Chip Childers Date: Mon, 13 Aug 2012 10:08:45 -0400 Subject: [PATCH] Patch from Joe Brockmeier: Fixes docs v, w, x, z --- docs/en-US/VPN-user-usage-record-format.xml | 25 ++++++++++++- docs/en-US/vcenter-maintenance-mode.xml | 34 +++++++++++++----- .../virtual-machine-usage-record-format.xml | 25 ++++++++++++- docs/en-US/virtual-router.xml | 27 +++++++++++--- docs/en-US/vlan-provisioning.xml | 27 +++++++++++--- docs/en-US/vm-lifecycle.xml | 26 ++++++++++++-- docs/en-US/vm-storage-migration.xml | 24 +++++++++++-- .../volume-deletion-garbage-collection.xml | 24 +++++++++++-- docs/en-US/volume-status.xml | 25 +++++++++++-- docs/en-US/vpc.xml | 25 ++++++++++--- docs/en-US/vpn.xml | 35 ++++++++++++------- docs/en-US/whatis.xml | 33 ++++++++++++----- docs/en-US/whats-in-this-adminguide.xml | 31 +++++++++++++--- docs/en-US/whats-new.xml | 21 ++++++++++- docs/en-US/who-should-read-installation.xml | 31 +++++++++++----- docs/en-US/windows-installation.xml | 21 ++++++++++- docs/en-US/work-with-usage.xml | 23 ++++++++++-- docs/en-US/working-with-hosts.xml | 23 ++++++++++-- docs/en-US/working-with-iso.xml | 25 +++++++++++-- docs/en-US/working-with-snapshots.xml | 31 ++++++++++++---- docs/en-US/working-with-system-vm.xml | 25 +++++++++++-- docs/en-US/working-with-templates.xml | 29 ++++++++++++--- docs/en-US/working-with-usage-data.xml | 27 +++++++++++--- docs/en-US/working-with-volumes.xml | 30 ++++++++++++---- docs/en-US/xenserver-maintenance-mode.xml | 22 ++++++++++-- docs/en-US/zone-add.xml | 27 +++++++++++--- 26 files changed, 588 insertions(+), 108 deletions(-) diff --git a/docs/en-US/VPN-user-usage-record-format.xml b/docs/en-US/VPN-user-usage-record-format.xml index 5db6690bc3c..dd66fb4d0d4 100644 --- a/docs/en-US/VPN-user-usage-record-format.xml +++ b/docs/en-US/VPN-user-usage-record-format.xml @@ -1,3 +1,27 @@ + + +%BOOK_ENTITIES; +]> + + +
VPN User Usage Record Format @@ -14,4 +38,3 @@ startdate, enddate – The range of time for which the usage is aggregated; see Dates in the Usage Record
- diff --git a/docs/en-US/vcenter-maintenance-mode.xml b/docs/en-US/vcenter-maintenance-mode.xml index 90732b06a01..a07300eee58 100644 --- a/docs/en-US/vcenter-maintenance-mode.xml +++ b/docs/en-US/vcenter-maintenance-mode.xml @@ -1,23 +1,41 @@ - %BOOK_ENTITIES; ]> + + +
vCenter and Maintenance Mode - To enter maintenance mode on a vCenter host, both vCenter and CloudPlatform must be used in concert. CloudPlatform and vCenter have separate maintenance modes that work closely together. + 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. - Place the host into CloudPlatform's "scheduled maintenance" mode. This does not invoke the vCenter maintenance mode, but only causes VMs to be migrated off the host - When the CloudPlatform maintenance mode is requested, the host first moves into the Prepare for Maintenance state. In this state it cannot be the target of new guest VM starts. Then all VMs will be migrated off the server. Live migration will be used to move VMs off the host. This allows the guests to be migrated to other hosts with no disruption to the guests. After this migration is completed, the host will enter the Ready for Maintenance mode. + Place the host into &PRODUCT;'s "scheduled maintenance" mode. This does not invoke the vCenter maintenance mode, but only causes VMs to be migrated off the host + When the &PRODUCT; maintenance mode is requested, the host first moves into the Prepare for Maintenance state. In this state it cannot be the target of new guest VM starts. Then all VMs will be migrated off the server. Live migration will be used to move VMs off the host. This allows the guests to be migrated to other hosts with no disruption to the guests. After this migration is completed, the host will enter the Ready for Maintenance mode. Wait for the "Ready for Maintenance" indicator to appear in the UI. Now use vCenter to perform whatever actions are necessary to maintain the host. During this time, the host cannot be the target of new VM allocations. When the maintenance tasks are complete, take the host out of maintenance mode as follows: First use vCenter to exit the vCenter maintenance mode. - This makes the host ready for CloudPlatform to reactivate it. - Then use CloudPlatform's administrator UI to cancel the CloudPlatform maintenance mode + This makes the host ready for &PRODUCT; to reactivate it. + 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-machine-usage-record-format.xml b/docs/en-US/virtual-machine-usage-record-format.xml index 5fe75c9e5e8..ac8fec9a9d2 100644 --- a/docs/en-US/virtual-machine-usage-record-format.xml +++ b/docs/en-US/virtual-machine-usage-record-format.xml @@ -1,3 +1,27 @@ + + +%BOOK_ENTITIES; +]> + + +
Virtual Machine Usage Record Format For running and allocated virtual machine usage, the following fields exist in a usage record: @@ -19,4 +43,3 @@ startdate, enddate – The range of time for which the usage is aggregated; see Dates in the Usage Record
- diff --git a/docs/en-US/virtual-router.xml b/docs/en-US/virtual-router.xml index e2bde355ad1..775d4740a91 100644 --- a/docs/en-US/virtual-router.xml +++ b/docs/en-US/virtual-router.xml @@ -1,10 +1,29 @@ - %BOOK_ENTITIES; ]> + + +
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 CloudPlatform. 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.. -
+ 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. + diff --git a/docs/en-US/vlan-provisioning.xml b/docs/en-US/vlan-provisioning.xml index 5921bb3ae0f..8abd5da0a75 100644 --- a/docs/en-US/vlan-provisioning.xml +++ b/docs/en-US/vlan-provisioning.xml @@ -1,11 +1,30 @@ - %BOOK_ENTITIES; ]> + + +
VLAN Provisioning - CloudPlatform automatically creates and destroys interfaces bridged to VLANs on the hosts. In general the administrator does not need to manage this process. - CloudPlatform manages VLANs differently based on hypervisor type. For XenServer or KVM, the VLANs are created on only the hosts where they will be used and then they are destroyed when all guests that require them have been terminated or moved to another host. . + &PRODUCT; automatically creates and destroys interfaces bridged to VLANs on the hosts. In general the administrator does not need to manage this process. + &PRODUCT; manages VLANs differently based on hypervisor type. For XenServer or KVM, the VLANs are created on only the hosts where they will be used and then they are destroyed when all guests that require them have been terminated or moved to another host. For vSphere the VLANs are provisioned on all hosts in the cluster even if there is no guest running on a particular Host that requires the VLAN. This allows the administrator to perform live migration and other functions in vCenter without having to create the VLAN on the destination Host. Additionally, the VLANs are not removed from the Hosts when they are no longer needed. -
\ No newline at end of file + diff --git a/docs/en-US/vm-lifecycle.xml b/docs/en-US/vm-lifecycle.xml index 3499c4b8c2f..f5696ced12c 100644 --- a/docs/en-US/vm-lifecycle.xml +++ b/docs/en-US/vm-lifecycle.xml @@ -1,3 +1,27 @@ + + +%BOOK_ENTITIES; +]> + + +
VM Lifecycle Virtual machines can be in the following states: @@ -15,6 +39,4 @@ 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 885be2ca6db..4b09ffdb220 100644 --- a/docs/en-US/vm-storage-migration.xml +++ b/docs/en-US/vm-storage-migration.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + +
VM Storage Migration Supported in XenServer, KVM, and VMware. @@ -11,5 +30,4 @@ 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/volume-deletion-garbage-collection.xml b/docs/en-US/volume-deletion-garbage-collection.xml index 80ab0d186d6..d162d848cc3 100644 --- a/docs/en-US/volume-deletion-garbage-collection.xml +++ b/docs/en-US/volume-deletion-garbage-collection.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + +
Volume Deletion and Garbage Collection The deletion of a volume does not delete the snapshots that have been created from the volume @@ -13,5 +32,4 @@ expunge.interval: determines how often to run the garbage collection check Administrators should adjust these values depending on site policies around data retention. -
- + diff --git a/docs/en-US/volume-status.xml b/docs/en-US/volume-status.xml index a0ec10212b7..c2e58a544c6 100644 --- a/docs/en-US/volume-status.xml +++ b/docs/en-US/volume-status.xml @@ -1,10 +1,29 @@ - %BOOK_ENTITIES; ]> + + +
Volume Status - When a snapshot operation is triggered by means of a recurring snapshot policy, a snapshot is skipped if a volume has remained inactive since its last snapshot was taken. A volume is considered to be inactive if it is either detached or attached to a VM that is not running. CloudPlatform ensures that at least one snapshot is taken since the volume last became inactive. + When a snapshot operation is triggered by means of a recurring snapshot policy, a snapshot is skipped if a volume has remained inactive since its last snapshot was taken. A volume is considered to be inactive if it is either detached or attached to a VM that is not running. &PRODUCT; ensures that at least one snapshot is taken since the volume last became inactive. When a snapshot is taken manually, a snapshot is always created regardless of whether a volume has been active or not. -
+ diff --git a/docs/en-US/vpc.xml b/docs/en-US/vpc.xml index cd298a16ecf..389910007da 100644 --- a/docs/en-US/vpc.xml +++ b/docs/en-US/vpc.xml @@ -1,14 +1,33 @@ - %BOOK_ENTITIES; ]> + + +
Virtual Private Cloud To add a Virtual Private Cloud (VPC): - Log in to the CloudPlatform UI as an administrator or end user. + 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: @@ -19,7 +38,5 @@ 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. - -
diff --git a/docs/en-US/vpn.xml b/docs/en-US/vpn.xml index 0eafa94707f..a4599873856 100644 --- a/docs/en-US/vpn.xml +++ b/docs/en-US/vpn.xml @@ -1,22 +1,33 @@ - %BOOK_ENTITIES; ]> + + +
VPN - CloudPlatform 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. CloudPlatform 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. CloudPlatform 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. + &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. + 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.
diff --git a/docs/en-US/whatis.xml b/docs/en-US/whatis.xml index d89d8742561..5103b2ec583 100644 --- a/docs/en-US/whatis.xml +++ b/docs/en-US/whatis.xml @@ -1,21 +1,36 @@ - %BOOK_ENTITIES; ]> + + +
What Is &PRODUCT;? - - &PRODUCT; is an open source software platform that pools computing resources to build public, private, and hybrid Infrastructure as a Service (IaaS) clouds. &PRODUCT; manages the network, storage, and compute nodes that make up a cloud infrastructure. Use &PRODUCT; to deploy, manage, and configure cloud computing environments. - + &PRODUCT; is an open source software platform that pools computing resources to build public, private, and hybrid Infrastructure as a Service (IaaS) clouds. &PRODUCT; manages the network, storage, and compute nodes that make up a cloud infrastructure. Use &PRODUCT; to deploy, manage, and configure cloud computing environments. Typical users are service providers and enterprises. With &PRODUCT;, you can: - Set up an on-demand, elastic cloud computing service. Service providers can sell self service virtual machine instances, storage volumes, and networking configurations over the Internet. - + Set up an on-demand, elastic cloud computing service. Service providers can sell self service virtual machine instances, storage volumes, and networking configurations over the Internet. - Set up an on-premise private cloud for use by employees. Rather than managing virtual machines in the same way as physical machines, with &PRODUCT; an enterprise can offer self-service virtual machines to users without involving IT departments. - + Set up an on-premise private cloud for use by employees. Rather than managing virtual machines in the same way as physical machines, with &PRODUCT; an enterprise can offer self-service virtual machines to users without involving IT departments. @@ -23,4 +38,4 @@ 1000-foot-view.png: Overview of &PRODUCT; -
\ No newline at end of file + diff --git a/docs/en-US/whats-in-this-adminguide.xml b/docs/en-US/whats-in-this-adminguide.xml index e34c17fc1eb..68717dd596e 100644 --- a/docs/en-US/whats-in-this-adminguide.xml +++ b/docs/en-US/whats-in-this-adminguide.xml @@ -1,7 +1,28 @@ + + +%BOOK_ENTITIES; +]> + + +
Who Should Read This - If you have already installed CloudPlatform or you want to learn more about the ongoing - operation and maintenance of a CloudPlatform-powered cloud, read this documentation. It - will help you start using, configuring, and managing the ongoing operation of your cloud. -
- + If you have already installed &PRODUCT; or you want to learn more about the ongoing operation and maintenance of a &PRODUCT;-powered cloud, read this documentation. It will help you start using, configuring, and managing the ongoing operation of your cloud. + diff --git a/docs/en-US/whats-new.xml b/docs/en-US/whats-new.xml index c1a6e0cb1c8..44ec5183d6a 100644 --- a/docs/en-US/whats-new.xml +++ b/docs/en-US/whats-new.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + +
What's New in 3.0.x? The following describes any new major features of each CloudPlatform version as it applies to API usage. diff --git a/docs/en-US/who-should-read-installation.xml b/docs/en-US/who-should-read-installation.xml index a4b5e18c266..eb55ee476ec 100644 --- a/docs/en-US/who-should-read-installation.xml +++ b/docs/en-US/who-should-read-installation.xml @@ -1,15 +1,28 @@ - %BOOK_ENTITIES; ]> + + +
Who Should Read This - - For those who have already gone through a design phase and planned a more sophisticated deployment, - or those who are ready to start scaling up a trial installation. - With the following procedures, 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. - -
\ No newline at end of file + For those who have already gone through a design phase and planned a more sophisticated deployment, or those who are ready to start scaling up a trial installation. With the following procedures, 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. +
diff --git a/docs/en-US/windows-installation.xml b/docs/en-US/windows-installation.xml index 9958c96da1b..b6e0632b785 100644 --- a/docs/en-US/windows-installation.xml +++ b/docs/en-US/windows-installation.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + +
Windows OS Installation Download the installer, CloudInstanceManager.msi, from 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 d5d88021214..e9fb1d8d7ef 100644 --- a/docs/en-US/work-with-usage.xml +++ b/docs/en-US/work-with-usage.xml @@ -1,9 +1,28 @@ - %BOOK_ENTITIES; ]> + + +
Changing the Database Configuration - The CloudPlatform 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. + 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.
diff --git a/docs/en-US/working-with-hosts.xml b/docs/en-US/working-with-hosts.xml index 7f65da3df7a..fb4364b3cae 100644 --- a/docs/en-US/working-with-hosts.xml +++ b/docs/en-US/working-with-hosts.xml @@ -1,9 +1,28 @@ - %BOOK_ENTITIES; ]> + + +
Removing Hosts Hosts can be removed from the cloud as needed. The procedure to remove a host depends on the hypervisor type. -
+
diff --git a/docs/en-US/working-with-iso.xml b/docs/en-US/working-with-iso.xml index 9f1dc238e1d..efe5fb50e5e 100644 --- a/docs/en-US/working-with-iso.xml +++ b/docs/en-US/working-with-iso.xml @@ -1,14 +1,33 @@ - %BOOK_ENTITIES; ]> + + +
Working with ISOs - CloudPlatform 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. + &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. CloudPlatform 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. + 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 fa7602cacb1..6145ffd8de1 100644 --- a/docs/en-US/working-with-snapshots.xml +++ b/docs/en-US/working-with-snapshots.xml @@ -1,15 +1,32 @@ - %BOOK_ENTITIES; ]> + + +
Working with Snapshots - (Supported for the following hypervisors: XenServer, - VMware vSphere, and KVM) - CloudPlatform 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. + (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, CloudPlatform 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. + 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 47b397602e2..016d57977cc 100644 --- a/docs/en-US/working-with-system-vm.xml +++ b/docs/en-US/working-with-system-vm.xml @@ -1,9 +1,28 @@ - %BOOK_ENTITIES; ]> + + +
Working with System Virtual Machines - CloudPlatform uses several types of system virtual machines to perform tasks in the cloud. In general CloudPlatform 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. -
+ &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 f54e3175b4b..57a0a58ee7f 100644 --- a/docs/en-US/working-with-templates.xml +++ b/docs/en-US/working-with-templates.xml @@ -1,13 +1,32 @@ - %BOOK_ENTITIES; ]> + + +
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 CloudPlatform. - 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 CloudPlatform. - CloudPlatform ships with a default template. In order to present more choices to users, CloudPlatform administrators and users can create templates and add them to CloudPlatform. + 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;. @@ -22,4 +41,4 @@ -
+ diff --git a/docs/en-US/working-with-usage-data.xml b/docs/en-US/working-with-usage-data.xml index 006b54bad57..95d83640e34 100644 --- a/docs/en-US/working-with-usage-data.xml +++ b/docs/en-US/working-with-usage-data.xml @@ -1,15 +1,34 @@ - %BOOK_ENTITIES; ]> + + +
Working With Usage Data - The Usage Server provides aggregated usage records which you can use to create billing integration for the CloudStack platform. 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 Server provides aggregated usage records which you can use to create billing integration for the &PRODUCT; platform. 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. In the special case of bare metal instances, no template storage resources are consumed, but records showing zero usage are still included in the Usage Server's output. - The Usage Server runs at least once per day. It can be configured to run multiple times per day. Its behavior is controlled by configuration settings as described in the CloudStack Administration Guide. + The Usage Server runs at least once per day. It can be configured to run multiple times per day. Its behavior is controlled by configuration settings as described in the &PRODUCT; Administration Guide. -
+ diff --git a/docs/en-US/working-with-volumes.xml b/docs/en-US/working-with-volumes.xml index 90990511f71..f4fce71c854 100644 --- a/docs/en-US/working-with-volumes.xml +++ b/docs/en-US/working-with-volumes.xml @@ -1,12 +1,30 @@ - %BOOK_ENTITIES; ]> + + +
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. CloudPlatform 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. - CloudPlatform 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. -
- + 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 f8811bf4a31..4dfa43ebe05 100644 --- a/docs/en-US/xenserver-maintenance-mode.xml +++ b/docs/en-US/xenserver-maintenance-mode.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + +
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. @@ -29,5 +48,4 @@ Click Exit Maintenance Mode -
diff --git a/docs/en-US/zone-add.xml b/docs/en-US/zone-add.xml index 547722c72d9..2a85bb0b432 100644 --- a/docs/en-US/zone-add.xml +++ b/docs/en-US/zone-add.xml @@ -1,15 +1,34 @@ - %BOOK_ENTITIES; ]> + + +
Adding a Zone - These steps assume you have already logged in to the CloudPlatform UI. See . + These steps assume you have already logged in to the &PRODUCT; UI. See . (Optional) If you are going to use Swift for cloud-wide secondary storage, you need to add it before you add zones. - Log in to the CloudPlatform UI as administrator. + Log in to the &PRODUCT; UI as administrator. If this is your first time visiting the UI, you will see the guided tour splash screen. Choose “Experienced user.” The Dashboard appears. In the left navigation bar, click Global Settings. In the search box, type swift.enable and click the search button. @@ -25,7 +44,7 @@ Restart the Management Server. # service cloud-management restart - Refresh the CloudPlatform UI browser tab and log back in. + Refresh the &PRODUCT; UI browser tab and log back in. In the left navigation, choose Infrastructure.