diff --git a/docs/en-US/change-console-proxy-ssl-certificate-domain.xml b/docs/en-US/change-console-proxy-ssl-certificate-domain.xml index 04c341ba38b..46ceaae1a19 100644 --- a/docs/en-US/change-console-proxy-ssl-certificate-domain.xml +++ b/docs/en-US/change-console-proxy-ssl-certificate-domain.xml @@ -1,23 +1,42 @@ - %BOOK_ENTITIES; ]> + + +
Changing the Console Proxy SSL Certificate and Domain If the administrator prefers, it is possible for the URL of the customer's console session to show a domain other than realhostip.com. The administrator can customize the displayed domain by selecting a different domain and uploading a new SSL certificate and private key. The domain must run a DNS service that is capable of resolving queries for addresses of the form aaa-bbb-ccc-ddd.your.domain to an IPv4 IP address in the form aaa.bbb.ccc.ddd, for example, 202.8.44.1. To change the console proxy domain, SSL certificate, and private key: Set up dynamic name resolution or populate all possible DNS names in your public IP range into your existing DNS server with the format aaa-bbb-ccc-ddd.company.com -> aaa.bbb.ccc.ddd. - Generate the private key and certificate signing request (CSR). When you are using openssl to generate private/public key pairs and CSRs, for the private key that you are going to paste into the CloudPlatform UI, be sure to convert it into PKCS#8 format. + Generate the private key and certificate signing request (CSR). When you are using openssl to generate private/public key pairs and CSRs, for the private key that you are going to paste into the &PRODUCT; UI, be sure to convert it into PKCS#8 format. Generate a new 2048-bit private keyopenssl genrsa -des3 -out yourprivate.key 2048 Generate a new certificate CSRopenssl req -new -key yourprivate.key -out yourcertificate.csr Head to the website of your favorite trusted Certificate Authority, purchase an SSL certificate, and submit the CSR. You should receive a valid certificate in return Convert your private key format into PKCS#8 encrypted format.openssl pkcs8 -topk8 -in yourprivate.key -out yourprivate.pkcs8.encryped.key - Convert your PKCS#8 encrypted private key into the PKCS#8 format that is compliant with CloudPlatformopenssl pkcs8 -in yourprivate.pkcs8.encrypted.key -out yourprivate.pkcs8.key + Convert your PKCS#8 encrypted private key into the PKCS#8 format that is compliant with &PRODUCT;openssl pkcs8 -in yourprivate.pkcs8.encrypted.key -out yourprivate.pkcs8.key - In the Update SSL Certificate screen of the CloudPlatform UI, paste the following + In the Update SSL Certificate screen of the &PRODUCT; UI, paste the following Certificate from step 1(c). Private key from step 1(e). diff --git a/docs/en-US/change-host-password.xml b/docs/en-US/change-host-password.xml index 42a852c241a..7221fe62417 100644 --- a/docs/en-US/change-host-password.xml +++ b/docs/en-US/change-host-password.xml @@ -1,15 +1,34 @@ - %BOOK_ENTITIES; ]> + + +
Changing Host Password The password for a XenServer Node, KVM Node, or vSphere Node may be changed in the database. Note that all Nodes in a Cluster must have the same password. To change a Node's password: Identify all hosts in the cluster. - Change the password on all hosts in the cluster. Now the password for the host and the password known to CloudPlatform will not match. Operations on the cluster will fail until the two passwords match. + Change the password on all hosts in the cluster. Now the password for the host and the password known to &PRODUCT; will not match. Operations on the cluster will fail until the two passwords match. Get the list of host IDs for the host in the cluster where you are changing the password. You will need to access the database to determine these host IDs. For each hostname "h" (or vSphere cluster) that you are changing the password for, execute: mysql> select id from cloud.host where name like '%h%'; 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 c2448b947ba..7a9482c760b 100644 --- a/docs/en-US/change-network-offering-on-guest-network.xml +++ b/docs/en-US/change-network-offering-on-guest-network.xml @@ -1,14 +1,33 @@ - %BOOK_ENTITIES; ]> + + +
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 CloudPlatform UI as an administrator or end user. - 2. If you are changing from a network offering that uses the CloudPlatform 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 + 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 @@ -23,4 +42,3 @@
- diff --git a/docs/en-US/change-to-behavior-of-list-commands.xml b/docs/en-US/change-to-behavior-of-list-commands.xml index 2270db2e334..aa5f96595b9 100644 --- a/docs/en-US/change-to-behavior-of-list-commands.xml +++ b/docs/en-US/change-to-behavior-of-list-commands.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + +
Change to Behavior of List Commands There was a major change in how our List* API commands work in CloudStack 3.0 compared to 2.2.x. The rules below apply only for managed resources – those that belong to an account, domain, or project. They are irrelevant for the List* commands displaying unmanaged (system) resources, such as hosts, clusters, and external network resources. @@ -66,5 +85,5 @@ - The CloudPlatform UI on a general view will display all resources that the logged-in user is authorized to see, except for project resources. To see the project resources, select the project view. + The &PRODUCT; UI on a general view will display all resources that the logged-in user is authorized to see, except for project resources. To see the project resources, select the project view.
diff --git a/docs/en-US/changing-root-password.xml b/docs/en-US/changing-root-password.xml index a30b461f3ff..0b8ad0fc2ef 100644 --- a/docs/en-US/changing-root-password.xml +++ b/docs/en-US/changing-root-password.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + +
Changing the Root Password During installation and ongoing cloud administration, you will need to log in to the UI as the root administrator. diff --git a/docs/en-US/changing-secondary-storage-ip.xml b/docs/en-US/changing-secondary-storage-ip.xml index 21ed9771c7f..e39a68effd0 100644 --- a/docs/en-US/changing-secondary-storage-ip.xml +++ b/docs/en-US/changing-secondary-storage-ip.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + +
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: @@ -23,4 +42,3 @@ 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-secondary-storage-servers.xml b/docs/en-US/changing-secondary-storage-servers.xml index 92590f2c124..2ab8836adda 100644 --- a/docs/en-US/changing-secondary-storage-servers.xml +++ b/docs/en-US/changing-secondary-storage-servers.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + +
Changing Secondary Storage Servers You can change the secondary storage NFS mount. Perform the following steps to do so: diff --git a/docs/en-US/changing-secondary-storage-serversp.xml b/docs/en-US/changing-secondary-storage-serversp.xml index 889f8b84f47..2ab8836adda 100644 --- a/docs/en-US/changing-secondary-storage-serversp.xml +++ b/docs/en-US/changing-secondary-storage-serversp.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + +
Changing Secondary Storage Servers You can change the secondary storage NFS mount. Perform the following steps to do so: @@ -11,7 +30,7 @@ Wait 30 minutes. This allows any writes to secondary storage to complete. Copy all files from the old secondary storage mount to the new. Use the procedure above to change the IP address for secondary storage if required. - 5. Start the Management Server. + Start the Management Server.
diff --git a/docs/en-US/changing-service-offering-for-vm.xml b/docs/en-US/changing-service-offering-for-vm.xml index c4748f0ee44..7448b4d47d8 100644 --- a/docs/en-US/changing-service-offering-for-vm.xml +++ b/docs/en-US/changing-service-offering-for-vm.xml @@ -1,13 +1,32 @@ - %BOOK_ENTITIES; ]> + + +
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 CloudPlatform UI as a user or admin. + 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 diff --git a/docs/en-US/changing-vm-name-os-group.xml b/docs/en-US/changing-vm-name-os-group.xml index 810d0e7c63a..3515082837e 100644 --- a/docs/en-US/changing-vm-name-os-group.xml +++ b/docs/en-US/changing-vm-name-os-group.xml @@ -1,14 +1,33 @@ - %BOOK_ENTITIES; ]> + + +
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 CloudPlatform UI: + To access a VM through the &PRODUCT; UI: - Log in to the CloudPlatform UI as a user or admin. + 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 @@ -33,4 +52,3 @@ Click Apply.
- diff --git a/docs/en-US/cloud-infrastructure-concepts.xml b/docs/en-US/cloud-infrastructure-concepts.xml index cdf8ed0c2a9..e423d24df16 100644 --- a/docs/en-US/cloud-infrastructure-concepts.xml +++ b/docs/en-US/cloud-infrastructure-concepts.xml @@ -1,9 +1,28 @@ - %BOOK_ENTITIES; ]> + + +
Cloud Infrastructure Concepts -
\ No newline at end of file +
diff --git a/docs/en-US/cloud-infrastructure-overview.xml b/docs/en-US/cloud-infrastructure-overview.xml index 9c10acf7867..29197157acb 100644 --- a/docs/en-US/cloud-infrastructure-overview.xml +++ b/docs/en-US/cloud-infrastructure-overview.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + +
Cloud Infrastructure Overview @@ -25,4 +44,3 @@ More Information For more information, see .
- diff --git a/docs/en-US/cloud_infrastructure_overview.xml b/docs/en-US/cloud_infrastructure_overview.xml index 89b8f6328e8..6184240ad17 100644 --- a/docs/en-US/cloud_infrastructure_overview.xml +++ b/docs/en-US/cloud_infrastructure_overview.xml @@ -1,3 +1,21 @@ + +
Cloud Infrastructure Overview @@ -18,4 +36,3 @@ infrastructure_overview.png: Nested organization of a zone
- diff --git a/docs/en-US/cloudplatform-api.xml b/docs/en-US/cloudplatform-api.xml index ac96b0cb457..3c4a91481d0 100644 --- a/docs/en-US/cloudplatform-api.xml +++ b/docs/en-US/cloudplatform-api.xml @@ -1,12 +1,31 @@ - %BOOK_ENTITIES; ]> + + +
- CloudPlatform API - The CloudPlatform API is a low level API that has been used to implement the CloudPlatform web UIs. It is also a good basis for implementing other popular APIs such as EC2/S3 and emerging DMTF standards. - Many CloudPlatform API calls are asynchronous. These will return a Job ID immediately when called. This Job ID can be used to query the status of the job later. Also, status calls on impacted resources will provide some indication of their state. + &PRODUCT; API + The &PRODUCT; API is a low level API that has been used to implement the &PRODUCT; web UIs. It is also a good basis for implementing other popular APIs such as EC2/S3 and emerging DMTF standards. + Many &PRODUCT; API calls are asynchronous. These will return a Job ID immediately when called. This Job ID can be used to query the status of the job later. Also, status calls on impacted resources will provide some indication of their state. The API has a REST-like query basis and returns results in XML or JSON. See the Developer’s Guide and the API Reference.
diff --git a/docs/en-US/cloudstack-admin.xml b/docs/en-US/cloudstack-admin.xml index 8b1d0b24021..cfdfcf07d2b 100644 --- a/docs/en-US/cloudstack-admin.xml +++ b/docs/en-US/cloudstack-admin.xml @@ -1,12 +1,30 @@ - %BOOK_ENTITIES; ]> + + + - diff --git a/docs/en-US/cloudstack.ent b/docs/en-US/cloudstack.ent index 4607134bc79..65ecebd8c7a 100644 --- a/docs/en-US/cloudstack.ent +++ b/docs/en-US/cloudstack.ent @@ -1,4 +1,4 @@ - + diff --git a/docs/en-US/cloudstack.xml b/docs/en-US/cloudstack.xml index 143e0a64e22..c64b3c9c4cb 100644 --- a/docs/en-US/cloudstack.xml +++ b/docs/en-US/cloudstack.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + + @@ -13,4 +32,4 @@ - \ No newline at end of file + diff --git a/docs/en-US/cloudstack_admin.xml b/docs/en-US/cloudstack_admin.xml index 8b1d0b24021..e6c392327bc 100644 --- a/docs/en-US/cloudstack_admin.xml +++ b/docs/en-US/cloudstack_admin.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + + diff --git a/docs/en-US/cloudstack_developers.xml b/docs/en-US/cloudstack_developers.xml index 8fc5e2a69da..39817abc907 100644 --- a/docs/en-US/cloudstack_developers.xml +++ b/docs/en-US/cloudstack_developers.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + + diff --git a/docs/en-US/cloudstack_features.xml b/docs/en-US/cloudstack_features.xml index 5cf619e0d47..ae837921d60 100644 --- a/docs/en-US/cloudstack_features.xml +++ b/docs/en-US/cloudstack_features.xml @@ -1,42 +1,60 @@ + +
- What Can CloudStack Do? + What Can &PRODUCT; Do? Multiple Hypervisor Support - CloudStack 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. CloudStack 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 CloudStack 3.0.x0.) + &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.x0.) Massively Scalable Infrastructure Management - CloudStack 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. + &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 - CloudStack automatically configures each guest virtual machine’s networking and storage settings. + &PRODUCT; automatically configures each guest virtual machine’s networking and storage settings. - CloudStack 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. + &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 - CloudStack 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. + &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 - CloudStack 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. + &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 CloudStack platform 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.cloud.com/CloudStack_Documentation/Allocator_Implementation_Guide). + The &PRODUCT; platform 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.cloud.com/CloudStack_Documentation/Allocator_Implementation_Guide). High Availability - The CloudStack platform 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, the CloudStack platform supports NIC bonding and the use of separate networks for storage as well as iSCSI Multipath. + The &PRODUCT; platform 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, the &PRODUCT; platform supports NIC bonding and the use of separate networks for storage as well as iSCSI Multipath. -
\ No newline at end of file +
diff --git a/docs/en-US/cloudstack_installation.xml b/docs/en-US/cloudstack_installation.xml index c57fc478f29..7e06dfd5fcd 100644 --- a/docs/en-US/cloudstack_installation.xml +++ b/docs/en-US/cloudstack_installation.xml @@ -1,12 +1,30 @@ - %BOOK_ENTITIES; ]> + + + - diff --git a/docs/en-US/cloudstack_system_requirements.xml b/docs/en-US/cloudstack_system_requirements.xml index b8ce043dd82..cff8a67a09f 100644 --- a/docs/en-US/cloudstack_system_requirements.xml +++ b/docs/en-US/cloudstack_system_requirements.xml @@ -1,3 +1,21 @@ + +
Minimum System Requirements @@ -27,19 +45,18 @@ At least 1 NIC Statically allocated IP Address Latest hotfixes applied to hypervisor software - When you deploy CloudStack, the hypervisor host must not have any VMs already running + 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 for CloudStack + Citrix XenServer Installation for &PRODUCT; 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 for CloudStack. + Be sure you fulfill the additional hypervisor requirements and installation steps provided in this Guide. Hypervisor hosts must be properly prepared to work with &PRODUCT;. For example, the requirements for XenServer are listed under Citrix XenServer Installation for &PRODUCT;.
- diff --git a/docs/en-US/cloudstack_trial_installation.xml b/docs/en-US/cloudstack_trial_installation.xml index 084c867a835..e3cb0c65079 100644 --- a/docs/en-US/cloudstack_trial_installation.xml +++ b/docs/en-US/cloudstack_trial_installation.xml @@ -1,12 +1,30 @@ - %BOOK_ENTITIES; ]> + + + - diff --git a/docs/en-US/cloudstack_whatis.xml b/docs/en-US/cloudstack_whatis.xml index 00f010a0892..a158f8c9e27 100644 --- a/docs/en-US/cloudstack_whatis.xml +++ b/docs/en-US/cloudstack_whatis.xml @@ -1,25 +1,32 @@ + +
- What Is CloudStack? - - Who Should Read This - - - If you are new to CloudStack or you want to learn more about concepts before installing and running CloudStack, read this overview. - If you just want to get started, you can skip to Overview of Installation Steps. - - - - CloudStack is an open source software platform that pools computing resources to build public, private, and hybrid Infrastructure as a Service (IaaS) clouds. CloudStack manages the network, storage, and compute nodes that make up a cloud infrastructure. Use CloudStack to deploy, manage, and configure cloud computing environments. - Typical users are service providers and enterprises. With CloudStack, you can: + What Is &PRODUCT;? + Who Should Read This + If you are new to &PRODUCT; or you want to learn more about concepts before installing and running &PRODUCT;, read this overview. If you just want to get started, you can skip to Overview of Installation Steps. + &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 CloudStack 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. -
- diff --git a/docs/en-US/cluster-add.xml b/docs/en-US/cluster-add.xml index e269ab10add..d1ba3084e5e 100644 --- a/docs/en-US/cluster-add.xml +++ b/docs/en-US/cluster-add.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + +
Adding a Cluster TODO diff --git a/docs/en-US/compatibility-matrix.xml b/docs/en-US/compatibility-matrix.xml index e96be712742..ac8e838f2f4 100644 --- a/docs/en-US/compatibility-matrix.xml +++ b/docs/en-US/compatibility-matrix.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + +
Compatibility Matrix diff --git a/docs/en-US/compute-disk-service-offerings.xml b/docs/en-US/compute-disk-service-offerings.xml index a5680e45ff7..2469dfe3a15 100644 --- a/docs/en-US/compute-disk-service-offerings.xml +++ b/docs/en-US/compute-disk-service-offerings.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + +
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: @@ -12,7 +31,7 @@ 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, 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: Guest CPU Guest RAM @@ -25,5 +44,3 @@ Tags on the data disk
- - diff --git a/docs/en-US/concepts.xml b/docs/en-US/concepts.xml index 3cd3b720b7a..f49fc3ece00 100644 --- a/docs/en-US/concepts.xml +++ b/docs/en-US/concepts.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + + 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 82204df434a..af7c21bbe41 100644 --- a/docs/en-US/configure-guest-traffic-in-advanced-zone.xml +++ b/docs/en-US/configure-guest-traffic-in-advanced-zone.xml @@ -1,11 +1,30 @@ - %BOOK_ENTITIES; ]> + + +
Configure Guest Traffic in an Advanced Zone - These steps assume you have already logged in to the CloudPlatform UI. To configure the base guest network: + 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. @@ -20,7 +39,7 @@ 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 CloudPlatform 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. + 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. diff --git a/docs/en-US/configure-public-traffic-in-an-advanced-zone.xml b/docs/en-US/configure-public-traffic-in-an-advanced-zone.xml index 2420410d59d..8a9fb4a164f 100644 --- a/docs/en-US/configure-public-traffic-in-an-advanced-zone.xml +++ b/docs/en-US/configure-public-traffic-in-an-advanced-zone.xml @@ -1,10 +1,9 @@ - %BOOK_ENTITIES; ]>
Configure Public Traffic in an Advanced Zone In a zone that uses advanced networking, you need to configure at least one range of IP addresses for Internet traffic. - -
+
diff --git a/docs/en-US/configure-usage-server.xml b/docs/en-US/configure-usage-server.xml index 60973614023..55d3908a544 100644 --- a/docs/en-US/configure-usage-server.xml +++ b/docs/en-US/configure-usage-server.xml @@ -1,14 +1,33 @@ - %BOOK_ENTITIES; ]> + + +
Configuring the Usage Server To configure the usage server: - Be sure the Usage Server has been installed. This requires extra steps beyond just installing the CloudPlatform software. See Installing the Usage Server (Optional) in the Advanced Installation Guide. - Log in to the CloudPlatform UI as administrator. + Be sure the Usage Server has been installed. This requires extra steps beyond just installing the &PRODUCT; software. See Installing the Usage Server (Optional) in the Advanced Installation Guide. + Log in to the &PRODUCT; UI as administrator. Click Global Settings. In Search, type usage. Find the configuration parameter that controls the behavior you want to set. See the table below for a description of the available parameters. In Actions, click the Edit icon. @@ -56,13 +75,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. CloudPlatform 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. CloudPlatform 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. @@ -79,4 +98,4 @@ usage.aggregation.timezone = GMT 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 -
\ No newline at end of file +
diff --git a/docs/en-US/configure-virtual-router.xml b/docs/en-US/configure-virtual-router.xml index 7aab6b369d6..8740c0cef8b 100644 --- a/docs/en-US/configure-virtual-router.xml +++ b/docs/en-US/configure-virtual-router.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + +
Configuring the Virtual Router You can set the following: @@ -11,7 +30,7 @@ Supported network services Default domain name for the network serviced by the virtual router Gateway IP address - How often CloudPlatform fetches network usage statistics from CloudPlatform virtual routers. If you want to collect traffic metering data from the virtual router, set the global configuration parameter router.stats.interval. If you are not using the virtual router to gather network usage statistics, set it to 0. + How often &PRODUCT; fetches network usage statistics from &PRODUCT; virtual routers. If you want to collect traffic metering data from the virtual router, set the global configuration parameter router.stats.interval. If you are not using the virtual router to gather network usage statistics, set it to 0.
diff --git a/docs/en-US/configure-vpn.xml b/docs/en-US/configure-vpn.xml index cab25fd9342..0ab3ef55cae 100644 --- a/docs/en-US/configure-vpn.xml +++ b/docs/en-US/configure-vpn.xml @@ -1,13 +1,32 @@ - %BOOK_ENTITIES; ]> + + +
Configuring VPN To set up VPN for the cloud: - 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, click Global Settings. Set the following global configuration parameters. @@ -17,7 +36,7 @@ To enable VPN for a particular network: - Log in as a user or administrator to the CloudPlatform UI. + 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. diff --git a/docs/en-US/configure-xenserver-dom-memory.xml b/docs/en-US/configure-xenserver-dom-memory.xml index c647cd81330..0a02d3e3818 100644 --- a/docs/en-US/configure-xenserver-dom-memory.xml +++ b/docs/en-US/configure-xenserver-dom-memory.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + +
Configure XenServer dom0 Memory Configure the XenServer dom0 settings to allocate more memory to dom0. This can enable XenServer to handle larger numbers of virtual machines. We recommend 2940 MB of RAM for XenServer dom0. For instructions on how to do this, see Citrix Knowledgebase Article.The article refers to XenServer 5.6, but the same information applies to XenServer 6 diff --git a/docs/en-US/configure-xenserver-dom0-memory.xml b/docs/en-US/configure-xenserver-dom0-memory.xml index c647cd81330..0a02d3e3818 100644 --- a/docs/en-US/configure-xenserver-dom0-memory.xml +++ b/docs/en-US/configure-xenserver-dom0-memory.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + +
Configure XenServer dom0 Memory Configure the XenServer dom0 settings to allocate more memory to dom0. This can enable XenServer to handle larger numbers of virtual machines. We recommend 2940 MB of RAM for XenServer dom0. For instructions on how to do this, see Citrix Knowledgebase Article.The article refers to XenServer 5.6, but the same information applies to XenServer 6 diff --git a/docs/en-US/configuring-projects.xml b/docs/en-US/configuring-projects.xml index 925f3606b9d..e18843d15d6 100644 --- a/docs/en-US/configuring-projects.xml +++ b/docs/en-US/configuring-projects.xml @@ -1,10 +1,29 @@ - %BOOK_ENTITIES; ]> + + +
Configuring Projects - Before CloudPlatform users start using projects, the CloudPlatform administrator must set up various systems to support them, including membership invitations, limits on project resources, and controls on who can create projects + Before &PRODUCT; users start using projects, the &PRODUCT; administrator must set up various systems to support them, including membership invitations, limits on project resources, and controls on who can create projects
diff --git a/docs/en-US/console-proxy.xml b/docs/en-US/console-proxy.xml index bc14445ebbf..df29c428ad2 100644 --- a/docs/en-US/console-proxy.xml +++ b/docs/en-US/console-proxy.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + +
Console Proxy The Console Proxy is a type of System Virtual Machine that has a role in presenting a console view via the web UI. It connects the user’s browser to the VNC port made available via the hypervisor for the console of the guest. Both the administrator and end user web UIs offer a console connection. @@ -12,5 +31,5 @@ The console proxy VM will periodically report its active session count to the Management Server. The default reporting interval is five seconds. This can be changed through standard Management Server configuration with the parameter consoleproxy.loadscan.interval. 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. CloudPlatform includes the realhostip.com SSL certificate in the console proxy VM. Of course, CloudPlatform cannot know about DNS A records for our customers' public IPs prior to shipping the software. CloudPlatform 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. + 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.
diff --git a/docs/en-US/contacting-support.xml b/docs/en-US/contacting-support.xml index ef165b37e45..7fe86b1ddba 100644 --- a/docs/en-US/contacting-support.xml +++ b/docs/en-US/contacting-support.xml @@ -1,5 +1,22 @@ + +
Contacting Support The support team is available to help customers plan and execute their installations. To contact the support team, log in to the support portal at support.citrix.com/cloudsupport by using the account credentials you received when you purchased your support contract.
- diff --git a/docs/en-US/convert-hyperv-vm-to-template.xml b/docs/en-US/convert-hyperv-vm-to-template.xml index 813112c5c74..1ceaa758e32 100644 --- a/docs/en-US/convert-hyperv-vm-to-template.xml +++ b/docs/en-US/convert-hyperv-vm-to-template.xml @@ -1,11 +1,30 @@ - %BOOK_ENTITIES; ]> + + +
Converting a Hyper-V VM to a Template - To convert a Hyper-V VM to a XenServer-compatible CloudPlatform template, you will need a standalone XenServer host with an attached NFS VHD SR. Use whatever XenServer version you are using with CloudPlatform, 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. + 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). @@ -37,14 +56,13 @@ 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 CloudPlatform, create a new template using the following values: + 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-bare-metal-template.xml b/docs/en-US/create-bare-metal-template.xml index 9effd86889f..635e13faade 100644 --- a/docs/en-US/create-bare-metal-template.xml +++ b/docs/en-US/create-bare-metal-template.xml @@ -1,31 +1,46 @@ - %BOOK_ENTITIES; ]> + + +
Creating a Bare Metal Template - Beta feature. Untested in CloudPlatform 3.0.3. Provided without guarantee of performance. + Beta feature. Untested in &PRODUCT; 3.0.3. Provided without guarantee of performance. Before you can create a bare metal template, you must have performed several other installation and setup steps to create a bare metal cluster and environment. See Bare Metal Installation in the Installation Guide. It is assumed you already have a directory named "win7_64bit" on your CIFS server, containing the image for the bare metal instance. This directory and image are set up as part of the Bare Metal Installation procedure. - 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 bar, click Templates. Click Create Template. In the dialog box, enter the following values. Name. Short name for the template. Display Text. Description of the template. - URL. The directory name which contains image file on your - CIFS server. For example, win7_64bit. + URL. The directory name which contains image file on your CIFS server. For example, win7_64bit. Zone. All Zones. - OS Type. Select the OS type of the ISO image. Choose other if - the OS Type of the ISO is not listed or if the ISO is not bootable. + OS Type. Select the OS type of the ISO image. Choose other if the OS Type of the ISO is not listed or if the ISO is not bootable. Hypervisor. BareMetal. Format. BareMetal. Password Enabled. No. Public. No. - Featured. Choose Yes if you would like this template to be - more prominent for users to select. Only administrators may make templates - featured. + Featured. Choose Yes if you would like this template to be more prominent for users to select. Only administrators may make templates featured.
diff --git a/docs/en-US/create-new-projects.xml b/docs/en-US/create-new-projects.xml index 69e836013b7..7696c9ee00f 100644 --- a/docs/en-US/create-new-projects.xml +++ b/docs/en-US/create-new-projects.xml @@ -1,13 +1,32 @@ - %BOOK_ENTITIES; ]> + + +
Creating a New Project - CloudPlatform administrators and domain administrators can create projects. If the global configuration parameter allow.user.create.projects is set to true, end users can also create projects. + &PRODUCT; administrators and domain administrators can create projects. If the global configuration parameter allow.user.create.projects is set to true, end users can also create projects. - Log in as administrator to the CloudPlatform UI. + Log in as administrator to the &PRODUCT; UI. In the left navigation, click Projects. In Select view, click Projects. Click New Project. @@ -16,4 +35,3 @@ Click Save.
- diff --git a/docs/en-US/create-template-from-existing-vm.xml b/docs/en-US/create-template-from-existing-vm.xml index b3b951f9851..d6b6f0db0bd 100644 --- a/docs/en-US/create-template-from-existing-vm.xml +++ b/docs/en-US/create-template-from-existing-vm.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + +
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. @@ -12,11 +31,8 @@ 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 CloudPlatform and the hypervisor perform - certain operations and make assumptions that improve the performance of the - guest. Select one of 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. @@ -24,13 +40,8 @@ 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 CloudPlatform installation. The template will appear in the - Community Templates list. See . - Password Enabled. Choose Yes if your template has the - CloudPlatform password change script installed. See Adding Password - Management to Your Templates . + 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. diff --git a/docs/en-US/create-template-from-snapshot.xml b/docs/en-US/create-template-from-snapshot.xml index 23599da26a4..30750326c9f 100644 --- a/docs/en-US/create-template-from-snapshot.xml +++ b/docs/en-US/create-template-from-snapshot.xml @@ -1,11 +1,29 @@ - %BOOK_ENTITIES; ]> + + +
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 CloudPlatform UI. - + 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.
diff --git a/docs/en-US/create-templates-overview.xml b/docs/en-US/create-templates-overview.xml index 9c8bf37266d..7e41035a733 100644 --- a/docs/en-US/create-templates-overview.xml +++ b/docs/en-US/create-templates-overview.xml @@ -1,17 +1,35 @@ - %BOOK_ENTITIES; ]> + + +
Creating Templates: Overview - CloudPlatform 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: + &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 CloudPlatform. 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 CloudPlatform + 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 70a71af21da..ef36020799a 100644 --- a/docs/en-US/create-windows-template.xml +++ b/docs/en-US/create-windows-template.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + +
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. diff --git a/docs/en-US/creating-compute-offerings.xml b/docs/en-US/creating-compute-offerings.xml index fc0b6a938bb..56679a422f4 100644 --- a/docs/en-US/creating-compute-offerings.xml +++ b/docs/en-US/creating-compute-offerings.xml @@ -1,13 +1,32 @@ - %BOOK_ENTITIES; ]> + + +
Creating a New Compute Offering To create a new compute offering: - Log in with admin privileges to the CloudPlatform UI. + Log in with admin privileges to the &PRODUCT; UI. In the left navigation bar, click Service Offerings. In Select Offering, choose Compute Offering. Click Add Compute Offering. @@ -17,17 +36,15 @@ 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. + 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; CloudPlatform will then prompt for the subdomain's name. + 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-disk-offerings.xml b/docs/en-US/creating-disk-offerings.xml index d455eccc60f..12bb2aca785 100644 --- a/docs/en-US/creating-disk-offerings.xml +++ b/docs/en-US/creating-disk-offerings.xml @@ -1,13 +1,32 @@ - %BOOK_ENTITIES; ]> + + +
Creating a New Disk Offering To create a system service offering: - Log in with admin privileges to the CloudPlatform UI. + Log in with admin privileges to the &PRODUCT; UI. In the left navigation bar, click Service Offerings. In Select Offering, choose Disk Offering. Click Add Disk Offering. @@ -17,11 +36,9 @@ Description. A short description of the offering that can be displayed to users Custom Disk Size. If checked, the user can set their own disk size. If not checked, the root administrator must define a value in Disk Size. Disk Size. Appears only if Custom Disk Size is not selected. Define the volume size in GB. - (Optional)Storage Tags. The tags that should be associated with the primary storage for this disk. Tags are a comma separated list of attributes of the storage. For example "ssd,blue". Tags are also added on Primary Storage. CloudPlatform matches tags on a disk offering to tags on the storage. If a tag is present on a disk offering that tag (or tags) must also be present on Primary Storage for the volume to be provisioned. If no such primary storage exists, allocation from the disk offering will fail.. - 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; CloudPlatform will then prompt for the subdomain's name. + (Optional)Storage Tags. The tags that should be associated with the primary storage for this disk. Tags are a comma separated list of attributes of the storage. For example "ssd,blue". Tags are also added on Primary Storage. &PRODUCT; matches tags on a disk offering to tags on the storage. If a tag is present on a disk offering that tag (or tags) must also be present on Primary Storage for the volume to be provisioned. If no such primary storage exists, allocation from the disk offering will fail.. + 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 5bf32bec2a2..ab569200641 100644 --- a/docs/en-US/creating-network-offerings.xml +++ b/docs/en-US/creating-network-offerings.xml @@ -1,13 +1,32 @@ - %BOOK_ENTITIES; ]> + + +
Creating a New Network Offering To create a network offering: - Log in with admin privileges to the CloudPlatform UI. + Log in with admin privileges to the &PRODUCT; UI. In the left navigation bar, click Service Offerings. In Select Offering, choose Network Offering. Click Add Network Offering. @@ -19,12 +38,7 @@ 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 CloudPlatform 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: + 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: @@ -49,32 +63,25 @@ Load Balancer - If you select Load Balancer, you can choose the CloudPlatform 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 CloudPlatform 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 CloudPlatform 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 CloudPlatform 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 @@ -100,13 +107,11 @@ - 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 CloudPlatform default system service offering and any custom system service offerings that have been defined by the CloudPlatform 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. CloudPlatform deploys the routers on different hosts to ensure reliability if one host is down. + 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 Click Add. - -
diff --git a/docs/en-US/creating-new-volumes.xml b/docs/en-US/creating-new-volumes.xml index 71b4f9bfd5a..995da86d487 100644 --- a/docs/en-US/creating-new-volumes.xml +++ b/docs/en-US/creating-new-volumes.xml @@ -1,13 +1,32 @@ - %BOOK_ENTITIES; ]> + + +
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 CloudPlatform administrators and users can add volumes to VM instances. When you create a new volume, it is stored as an entity in CloudPlatform, but the actual storage resources are not allocated on the physical storage device until you attach the volume. This optimization allows the CloudPlatform to provision the volume nearest to the guest that will use it when the first attachment is made. + 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 CloudPlatform UI as a user or admin. + 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. @@ -16,8 +35,7 @@ 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 CloudPlatform, but the volume is not yet ready for use + 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-system-service-offerings.xml b/docs/en-US/creating-system-service-offerings.xml index 7f9bf524c78..e33d9d07767 100644 --- a/docs/en-US/creating-system-service-offerings.xml +++ b/docs/en-US/creating-system-service-offerings.xml @@ -1,13 +1,32 @@ - %BOOK_ENTITIES; ]> + + +
Creating a New System Service Offering To create a system service offering: - Log in with admin privileges to the CloudPlatform UI. + Log in with admin privileges to the &PRODUCT; UI. In the left navigation bar, click Service Offerings. In Select Offering, choose System Offering. Click Add System Service Offering. @@ -18,14 +37,14 @@ System VM Type. Select the type of system virtual machine that this offering is intended to support. 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. + 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; CloudPlatform will then prompt for the subdomain's name. + 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-vms.xml b/docs/en-US/creating-vms.xml index ea5d0f2c2a4..dd6ec79a5fc 100644 --- a/docs/en-US/creating-vms.xml +++ b/docs/en-US/creating-vms.xml @@ -1,14 +1,33 @@ - %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 CloudPlatform UI as an administrator or user. + 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. @@ -20,12 +39,11 @@ 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 CloudPlatform UI as an administrator or user. + 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 CloudPlatform 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. + (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/customizing-dns.xml b/docs/en-US/customizing-dns.xml index bf9dc419ded..c24bad895f4 100644 --- a/docs/en-US/customizing-dns.xml +++ b/docs/en-US/customizing-dns.xml @@ -1,19 +1,38 @@ - %BOOK_ENTITIES; ]> + + +
Customizing the Network Domain Name - The root administrator can optionally assign a custom DNS suffix at the level of a network, account, domain, zone, or entire CloudPlatform installation, and a domain administrator can do so within their own domain. To specify a custom domain name and put it into effect, follow these steps. + The root administrator can optionally assign a custom DNS suffix at the level of a network, account, domain, zone, or entire &PRODUCT; installation, and a domain administrator can do so within their own domain. To specify a custom domain name and put it into effect, follow these steps. Set the DNS suffix at the desired scope - At the network level, the DNS suffix can be assigned through the UI when creating a new network, as described in or with the updateNetwork command in the CloudPlatform API. - At the account, domain, or zone level, the DNS suffix can be assigned with the appropriate CloudPlatform API commands: createAccount, editAccount, createDomain, editDomain, createZone, or editZone. - At the global level, use the configuration parameter guest.domain.suffix. You can also use the CloudPlatform API command updateConfiguration. After modifying this global configuration, restart the Management Server to put the new setting into effect. + At the network level, the DNS suffix can be assigned through the UI when creating a new network, as described in or with the updateNetwork command in the &PRODUCT; API. + At the account, domain, or zone level, the DNS suffix can be assigned with the appropriate &PRODUCT; API commands: createAccount, editAccount, createDomain, editDomain, createZone, or editZone. + At the global level, use the configuration parameter guest.domain.suffix. You can also use the &PRODUCT; API command updateConfiguration. After modifying this global configuration, restart the Management Server to put the new setting into effect. - To make the new DNS suffix take effect for an existing network, call the CloudPlatform API command updateNetwork. This step is not necessary when the DNS suffix was specified while creating a new network. + To make the new DNS suffix take effect for an existing network, call the &PRODUCT; API command updateNetwork. This step is not necessary when the DNS suffix was specified while creating a new network. The source of the network domain that is used depends on the following rules. @@ -22,5 +41,4 @@ For a domain-specific network, the network domain specified for the domain is used. If none is specified, the system looks for a value in the zone and global configuration, in that order. For a zone-specific network, the network domain specified for the zone is used. If none is specified, the system looks for a value in the global configuration. -