From 1b0e40c3c8157cc76f679899751f374cfa2f2fe0 Mon Sep 17 00:00:00 2001 From: Jessica Tomechak Date: Tue, 9 Oct 2012 00:08:52 -0700 Subject: [PATCH] Fix the docs builds for Admin, Developer's, and Installation guides. Remove unneeded files. Add new files. Reorganize chapter structure. Can also build all together with publican-all.cfg. --- docs/en-US/API_Developers_Guide.xml | 8 +- docs/en-US/Admin_Guide.xml | 27 +- docs/en-US/Installation_Guide.xml | 1 + docs/en-US/about-virtual-networks.xml | 10 +- docs/en-US/accounts.xml | 5 +- docs/en-US/added-API-commands.xml | 19 +- docs/en-US/alerts.xml | 12 +- .../{developer-guide.xml => api-calls.xml} | 10 +- docs/en-US/appendix-a-time-zones.xml | 143 ------- docs/en-US/best-practices-for-vms.xml | 26 +- docs/en-US/change-database-config.xml | 28 ++ docs/en-US/cloudstack.xml | 45 +- docs/en-US/configure-usage-server.xml | 4 +- docs/en-US/developer-introduction.xml | 4 +- docs/en-US/developer_guide.xml | 39 -- docs/en-US/event-types.xml | 392 +++++++++--------- docs/en-US/global-config.xml | 4 +- docs/en-US/globally-configured-limit.xml | 100 ----- docs/en-US/globally-configured-limits.xml | 2 +- docs/en-US/installation.xml | 1 - docs/en-US/manage-cloud.xml | 15 +- docs/en-US/networks-for-users-overview.xml | 35 ++ docs/en-US/networks.xml | 2 +- docs/en-US/offerings.xml | 31 ++ docs/en-US/removing-hosts.xml | 30 ++ docs/en-US/set-up-network-for-users.xml | 16 +- docs/en-US/storage.xml | 14 +- docs/en-US/sys-reliability-and-ha.xml | 15 +- docs/en-US/tagging-resources.xml | 69 +++ docs/en-US/time-zones.xml | 6 +- docs/en-US/troubleshooting.xml | 21 +- docs/en-US/tuning.xml | 4 +- docs/en-US/user-services-overview.xml | 4 +- docs/en-US/using-multiple-guest-networks.xml | 2 + docs/en-US/vpn.xml | 4 + docs/en-US/whats-new.xml | 27 +- docs/en-US/work-with-usage.xml | 16 +- docs/en-US/working-with-hosts.xml | 19 +- docs/en-US/working-with-system-vm.xml | 13 +- docs/en-US/working-with-templates.xml | 6 +- docs/en-US/working-with-usage-data.xml | 4 +- 41 files changed, 626 insertions(+), 607 deletions(-) rename docs/en-US/{developer-guide.xml => api-calls.xml} (71%) delete mode 100644 docs/en-US/appendix-a-time-zones.xml create mode 100644 docs/en-US/change-database-config.xml delete mode 100644 docs/en-US/developer_guide.xml delete mode 100644 docs/en-US/globally-configured-limit.xml create mode 100644 docs/en-US/networks-for-users-overview.xml create mode 100644 docs/en-US/offerings.xml create mode 100644 docs/en-US/removing-hosts.xml create mode 100644 docs/en-US/tagging-resources.xml diff --git a/docs/en-US/API_Developers_Guide.xml b/docs/en-US/API_Developers_Guide.xml index 7d55e0dd890..daf7897db5a 100644 --- a/docs/en-US/API_Developers_Guide.xml +++ b/docs/en-US/API_Developers_Guide.xml @@ -45,7 +45,13 @@ - + + + + + + + diff --git a/docs/en-US/Admin_Guide.xml b/docs/en-US/Admin_Guide.xml index b8b90ee62e5..3728b106ef6 100644 --- a/docs/en-US/Admin_Guide.xml +++ b/docs/en-US/Admin_Guide.xml @@ -24,7 +24,7 @@ - &PRODUCT; Admin Guide + &PRODUCT; Administrator's Guide Apache CloudStack 4.0 1 @@ -45,7 +45,30 @@ - + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/en-US/Installation_Guide.xml b/docs/en-US/Installation_Guide.xml index 773fffb5815..c945020bce0 100644 --- a/docs/en-US/Installation_Guide.xml +++ b/docs/en-US/Installation_Guide.xml @@ -49,6 +49,7 @@ + diff --git a/docs/en-US/about-virtual-networks.xml b/docs/en-US/about-virtual-networks.xml index 2fc6ba9ddd5..2797423d24d 100644 --- a/docs/en-US/about-virtual-networks.xml +++ b/docs/en-US/about-virtual-networks.xml @@ -24,8 +24,8 @@
About Virtual Networks - A virtual network is a logical construct that enables multi-tenancy on a single physical network. In &PRODUCT;, a virtual network can be shared or isolated. - XenServer and Maintenance Mode - Working with Usage - XenServer and Maintenance Mode -
+ A virtual network is a logical construct that enables multi-tenancy on a single physical network. In &PRODUCT; a virtual network can be shared or isolated. + + + + diff --git a/docs/en-US/accounts.xml b/docs/en-US/accounts.xml index f8683e8ff40..e5056866801 100644 --- a/docs/en-US/accounts.xml +++ b/docs/en-US/accounts.xml @@ -22,9 +22,8 @@ under the License. --> -
+ Accounts - -
+ diff --git a/docs/en-US/added-API-commands.xml b/docs/en-US/added-API-commands.xml index 237c524b75f..eefb30b18a8 100644 --- a/docs/en-US/added-API-commands.xml +++ b/docs/en-US/added-API-commands.xml @@ -20,7 +20,8 @@ -->
Added API commands - Added in 4.0 +
+ Added in 4.0 createCounter (Adds metric counter) @@ -148,9 +149,6 @@ listVpnConnections (Lists site to site vpn connection gateways) - - Added in 3.0.3: - enableCiscoNexusVSM (Enables Nexus 1000v dvSwitch in &PRODUCT;.) @@ -165,7 +163,9 @@ as the IP address of the Nexus 1000v dvSwitch.) - Added in 3.0.2: +
+
+ Added in 3.0.2 changeServiceForSystemVm @@ -173,7 +173,9 @@ system VM must be in a "Stopped" state for this command to take effect. - Added in 3.0.1: +
+
+ Added in 3.0.1 changeServiceForSystemVm @@ -181,7 +183,9 @@ system VM must be in a "Stopped" state for this command to take effect. - Added in 3.0.0: +
+
+ Added in 3.0.0 @@ -331,4 +335,5 @@ +
diff --git a/docs/en-US/alerts.xml b/docs/en-US/alerts.xml index f9030238d43..b7f34d02a56 100644 --- a/docs/en-US/alerts.xml +++ b/docs/en-US/alerts.xml @@ -1,3 +1,8 @@ + + +%BOOK_ENTITIES; +]> -
- Alerts + + Alerts The following is the list of alert type numbers. The current alerts can be found by calling listAlerts. MEMORY = 0 CPU = 1 @@ -45,5 +50,4 @@ DIRECT_ATTACHED_PUBLIC_IP = 23; LOCAL_STORAGE = 24; RESOURCE_LIMIT_EXCEEDED = 25; //Generated when the resource limit exceeds the limit. Currently used for recurring snapshots only -
- + \ No newline at end of file diff --git a/docs/en-US/developer-guide.xml b/docs/en-US/api-calls.xml similarity index 71% rename from docs/en-US/developer-guide.xml rename to docs/en-US/api-calls.xml index c4bdf39d6fc..1fe6f02678b 100644 --- a/docs/en-US/developer-guide.xml +++ b/docs/en-US/api-calls.xml @@ -22,17 +22,11 @@ under the License. --> - - Using the API - - + + Calling the &PRODUCT; API - - - - diff --git a/docs/en-US/appendix-a-time-zones.xml b/docs/en-US/appendix-a-time-zones.xml deleted file mode 100644 index 595e7b5cbf5..00000000000 --- a/docs/en-US/appendix-a-time-zones.xml +++ /dev/null @@ -1,143 +0,0 @@ - - -%BOOK_ENTITIES; -]> - - - -
- Appendix A—Time Zones - The following time zone identifiers are accepted by &PRODUCT;. There are several places that have a time zone as a required or optional parameter. These include scheduling recurring snapshots, creating a user, and specifying the usage time zone in the Configuration table. - - - - - Etc/GMT+12 - America/La_Paz - Asia/Jerusalem - - - - Etc/GMT+11 - America/Santiago - Europe/Minsk - - - - Pacific/Samoa - America/St_Johns - Europe/Moscow - - - Pacific/Honolulu - America/Araguaina - Africa/Nairobi - - - US/Alaska - America/Los_Angeles - Mexico/BajaNorte - - - US/Arizona - US/Mountain - America/Chihuahua - - - - America/Chicago - America/Costa_Rica - America/Mexico_City - - - - Canada/Saskatchewan - America/Bogota - America/New_York - - - America/Caracas - America/Asuncion - America/Cuiaba - - - America/Halifax - America/Argentina/Buenos_Aires - America/Cayenne - - - America/Godthab - America/Montevideo - Etc/GMT+2 - - - - Atlantic/Azores - Atlantic/Cape_Verde - Africa/Casablanca - - - - Etc/UTC - Atlantic/Reykjavik - Europe/London - - - CET - Europe/Bucharest - Africa/Johannesburg - - - Asia/Beirut - Africa/Cairo - Asia/Karachi - - - Asia/Kolkata - Asia/Bangkok - Asia/Shanghai - - - Asia/Kuala_Lumpur - Australia/Perth - Asia/Taipei - - - - Asia/Tokyo - Asia/Seoul - Australia/Adelaide - - - - Australia/Darwin - Australia/Brisbane - Australia/Canberra - - - Pacific/Guam - Pacific/Auckland - - - - - - -
diff --git a/docs/en-US/best-practices-for-vms.xml b/docs/en-US/best-practices-for-vms.xml index a67add4edeb..04c3c0aa276 100644 --- a/docs/en-US/best-practices-for-vms.xml +++ b/docs/en-US/best-practices-for-vms.xml @@ -1,3 +1,8 @@ + + +%BOOK_ENTITIES; +]> -
- VM Lifecycle - The CloudPlatform administrator should monitor the total number of VM instances in each cluster, and disable allocation to the cluster if the total is approaching the maximum that the hypervisor can handle. Be sure to leave a safety margin to allow for the possibility of one or more hosts failing, which would increase the VM load on the other hosts as the VMs are automatically redeployed. Consult the documentation for your chosen hypervisor to find the maximum permitted number of VMs per host, then use CloudPlatform global configuration settings to set this as the default limit. Monitor the VM activity in each cluster at all times. Keep the total number of VMs below a safe level that allows for the occasional host failure. For example, if there are N hosts in the cluster, and you want to allow for one host in the cluster to be down at any given time, the total number of VM instances you can permit in the cluster is at most (N-1) * (per-host-limit). Once a cluster reaches this number of VMs, use the CloudPlatform UI to disable allocation of more VMs to the cluster.. - -
+
+ Best Practices for Virtual Machines + The &PRODUCT; administrator should monitor the total number of VM instances in each + cluster, and disable allocation to the cluster if the total is approaching the maximum that + the hypervisor can handle. Be sure to leave a safety margin to allow for the possibility of + one or more hosts failing, which would increase the VM load on the other hosts as the VMs + are automatically redeployed. Consult the documentation for your chosen hypervisor to find + the maximum permitted number of VMs per host, then use &PRODUCT; global configuration + settings to set this as the default limit. Monitor the VM activity in each cluster at all + times. Keep the total number of VMs below a safe level that allows for the occasional host + failure. For example, if there are N hosts in the cluster, and you want to allow for one + host in the cluster to be down at any given time, the total number of VM instances you can + permit in the cluster is at most (N-1) * (per-host-limit). Once a cluster reaches this + number of VMs, use the &PRODUCT; UI to disable allocation of more VMs to the + cluster. +
\ No newline at end of file diff --git a/docs/en-US/change-database-config.xml b/docs/en-US/change-database-config.xml new file mode 100644 index 00000000000..fadb64c27e7 --- /dev/null +++ b/docs/en-US/change-database-config.xml @@ -0,0 +1,28 @@ + + +%BOOK_ENTITIES; +]> + + + +
+ Changing the Database Configuration + The &PRODUCT; Management Server stores database configuration information (e.g., hostname, port, credentials) in the file /etc/cloud/management/db.properties. To effect a change, edit this file on each Management Server, then restart the Management Server. +
\ No newline at end of file diff --git a/docs/en-US/cloudstack.xml b/docs/en-US/cloudstack.xml index 906eadc24a6..d9dca66bc57 100644 --- a/docs/en-US/cloudstack.xml +++ b/docs/en-US/cloudstack.xml @@ -23,20 +23,40 @@ --> - + + &PRODUCT; Complete Documentation + Apache CloudStack + 4.0 + 1 + + + + Complete documentation for &PRODUCT;. + + + + + + + + + + + + - - + - - - - - - - + + + + + + + + @@ -49,7 +69,10 @@ - + + + + diff --git a/docs/en-US/configure-usage-server.xml b/docs/en-US/configure-usage-server.xml index d167a497b16..af7bd4522f6 100644 --- a/docs/en-US/configure-usage-server.xml +++ b/docs/en-US/configure-usage-server.xml @@ -58,13 +58,13 @@ usage.execution.timezone = PST usage.aggregation.timezone = GMT - Valid values for the time zone are specified in + Valid values for the time zone are specified in Default: GMT usage.execution.timezone - The time zone of usage.stats.job.exec.time. Valid values for the time zone are specified in + The time zone of usage.stats.job.exec.time. Valid values for the time zone are specified in Default: The time zone of the management server. diff --git a/docs/en-US/developer-introduction.xml b/docs/en-US/developer-introduction.xml index 5b9964e5380..bb5251b4f26 100644 --- a/docs/en-US/developer-introduction.xml +++ b/docs/en-US/developer-introduction.xml @@ -22,9 +22,9 @@ under the License. --> -
+ Introduction for Developers -
+ diff --git a/docs/en-US/developer_guide.xml b/docs/en-US/developer_guide.xml deleted file mode 100644 index 18ef88a4c68..00000000000 --- a/docs/en-US/developer_guide.xml +++ /dev/null @@ -1,39 +0,0 @@ - - -%BOOK_ENTITIES; -]> - - - - - Developer Guide - - - - - - - - - - - - - diff --git a/docs/en-US/event-types.xml b/docs/en-US/event-types.xml index 9a710559b15..2ccd55335df 100644 --- a/docs/en-US/event-types.xml +++ b/docs/en-US/event-types.xml @@ -22,199 +22,199 @@ under the License. --> -
- Event Types - - - - - - - VM.CREATE - TEMPLATE.EXTRACT - SG.REVOKE.INGRESS - - - VM.DESTROY - TEMPLATE.UPLOAD - HOST.RECONNECT - - - VM.START - TEMPLATE.CLEANUP - MAINT.CANCEL - - - VM.STOP - VOLUME.CREATE - MAINT.CANCEL.PS - - - VM.REBOOT - VOLUME.DELETE - MAINT.PREPARE - - - VM.UPGRADE - VOLUME.ATTACH - MAINT.PREPARE.PS - - - VM.RESETPASSWORD - VOLUME.DETACH - VPN.REMOTE.ACCESS.CREATE - - - ROUTER.CREATE - VOLUME.UPLOAD - VPN.USER.ADD - - - ROUTER.DESTROY - SERVICEOFFERING.CREATE - VPN.USER.REMOVE - - - ROUTER.START - SERVICEOFFERING.UPDATE - NETWORK.RESTART - - - ROUTER.STOP - SERVICEOFFERING.DELETE - UPLOAD.CUSTOM.CERTIFICATE - - - ROUTER.REBOOT - DOMAIN.CREATE - UPLOAD.CUSTOM.CERTIFICATE - - - ROUTER.HA - DOMAIN.DELETE - STATICNAT.DISABLE - - - PROXY.CREATE - DOMAIN.UPDATE - SSVM.CREATE - - - PROXY.DESTROY - SNAPSHOT.CREATE - SSVM.DESTROY - - - PROXY.START - SNAPSHOT.DELETE - SSVM.START - - - PROXY.STOP - SNAPSHOTPOLICY.CREATE - SSVM.STOP - - - PROXY.REBOOT - SNAPSHOTPOLICY.UPDATE - SSVM.REBOOT - - - PROXY.HA - SNAPSHOTPOLICY.DELETE - SSVM.H - - - VNC.CONNECT - VNC.DISCONNECT - NET.IPASSIGN - - - NET.IPRELEASE - NET.RULEADD - NET.RULEDELETE - - - NET.RULEMODIFY - NETWORK.CREATE - NETWORK.DELETE - - - LB.ASSIGN.TO.RULE - LB.REMOVE.FROM.RULE - LB.CREATE - - - LB.DELETE - LB.UPDATE - USER.LOGIN - - - USER.LOGOUT - USER.CREATE - USER.DELETE - - - USER.UPDATE - USER.DISABLE - TEMPLATE.CREATE - - - TEMPLATE.DELETE - TEMPLATE.UPDATE - TEMPLATE.COPY - - - TEMPLATE.DOWNLOAD.START - TEMPLATE.DOWNLOAD.SUCCESS - TEMPLATE.DOWNLOAD.FAILED - - - ISO.CREATE - ISO.DELETE - ISO.COPY - - - ISO.ATTACH - ISO.DETACH - ISO.EXTRACT - - - ISO.UPLOAD - SERVICE.OFFERING.CREATE - SERVICE.OFFERING.EDIT - - - SERVICE.OFFERING.DELETE - DISK.OFFERING.CREATE - DISK.OFFERING.EDIT - - - DISK.OFFERING.DELETE - NETWORK.OFFERING.CREATE - NETWORK.OFFERING.EDIT - - - NETWORK.OFFERING.DELETE - POD.CREATE - POD.EDIT - - - POD.DELETE - ZONE.CREATE - ZONE.EDIT - - - ZONE.DELETE - VLAN.IP.RANGE.CREATE - VLAN.IP.RANGE.DELETE - - - CONFIGURATION.VALUE.EDIT - SG.AUTH.INGRESS - - - - - -
+ + Event Types + + + + + + + VM.CREATE + TEMPLATE.EXTRACT + SG.REVOKE.INGRESS + + + VM.DESTROY + TEMPLATE.UPLOAD + HOST.RECONNECT + + + VM.START + TEMPLATE.CLEANUP + MAINT.CANCEL + + + VM.STOP + VOLUME.CREATE + MAINT.CANCEL.PS + + + VM.REBOOT + VOLUME.DELETE + MAINT.PREPARE + + + VM.UPGRADE + VOLUME.ATTACH + MAINT.PREPARE.PS + + + VM.RESETPASSWORD + VOLUME.DETACH + VPN.REMOTE.ACCESS.CREATE + + + ROUTER.CREATE + VOLUME.UPLOAD + VPN.USER.ADD + + + ROUTER.DESTROY + SERVICEOFFERING.CREATE + VPN.USER.REMOVE + + + ROUTER.START + SERVICEOFFERING.UPDATE + NETWORK.RESTART + + + ROUTER.STOP + SERVICEOFFERING.DELETE + UPLOAD.CUSTOM.CERTIFICATE + + + ROUTER.REBOOT + DOMAIN.CREATE + UPLOAD.CUSTOM.CERTIFICATE + + + ROUTER.HA + DOMAIN.DELETE + STATICNAT.DISABLE + + + PROXY.CREATE + DOMAIN.UPDATE + SSVM.CREATE + + + PROXY.DESTROY + SNAPSHOT.CREATE + SSVM.DESTROY + + + PROXY.START + SNAPSHOT.DELETE + SSVM.START + + + PROXY.STOP + SNAPSHOTPOLICY.CREATE + SSVM.STOP + + + PROXY.REBOOT + SNAPSHOTPOLICY.UPDATE + SSVM.REBOOT + + + PROXY.HA + SNAPSHOTPOLICY.DELETE + SSVM.H + + + VNC.CONNECT + VNC.DISCONNECT + NET.IPASSIGN + + + NET.IPRELEASE + NET.RULEADD + NET.RULEDELETE + + + NET.RULEMODIFY + NETWORK.CREATE + NETWORK.DELETE + + + LB.ASSIGN.TO.RULE + LB.REMOVE.FROM.RULE + LB.CREATE + + + LB.DELETE + LB.UPDATE + USER.LOGIN + + + USER.LOGOUT + USER.CREATE + USER.DELETE + + + USER.UPDATE + USER.DISABLE + TEMPLATE.CREATE + + + TEMPLATE.DELETE + TEMPLATE.UPDATE + TEMPLATE.COPY + + + TEMPLATE.DOWNLOAD.START + TEMPLATE.DOWNLOAD.SUCCESS + TEMPLATE.DOWNLOAD.FAILED + + + ISO.CREATE + ISO.DELETE + ISO.COPY + + + ISO.ATTACH + ISO.DETACH + ISO.EXTRACT + + + ISO.UPLOAD + SERVICE.OFFERING.CREATE + SERVICE.OFFERING.EDIT + + + SERVICE.OFFERING.DELETE + DISK.OFFERING.CREATE + DISK.OFFERING.EDIT + + + DISK.OFFERING.DELETE + NETWORK.OFFERING.CREATE + NETWORK.OFFERING.EDIT + + + NETWORK.OFFERING.DELETE + POD.CREATE + POD.EDIT + + + POD.DELETE + ZONE.CREATE + ZONE.EDIT + + + ZONE.DELETE + VLAN.IP.RANGE.CREATE + VLAN.IP.RANGE.DELETE + + + CONFIGURATION.VALUE.EDIT + SG.AUTH.INGRESS + + + + + + diff --git a/docs/en-US/global-config.xml b/docs/en-US/global-config.xml index 8bc08035d9b..2f6ad105c0d 100644 --- a/docs/en-US/global-config.xml +++ b/docs/en-US/global-config.xml @@ -18,7 +18,7 @@ specific language governing permissions and limitations under the License. --> -
+ Setting Global Configuration Parameters &PRODUCT; provides parameters that you can set to control many aspects of the cloud. When &PRODUCT; is first installed, and periodically thereafter, you might need to modify these @@ -51,4 +51,4 @@ must click the name of the hypervisor first to display the editing screen. -
+ diff --git a/docs/en-US/globally-configured-limit.xml b/docs/en-US/globally-configured-limit.xml deleted file mode 100644 index ac71112b310..00000000000 --- a/docs/en-US/globally-configured-limit.xml +++ /dev/null @@ -1,100 +0,0 @@ - - -%BOOK_ENTITIES; -]> - - - -
- Globally Configured Limits - In a zone, the guest virtual network has a 24 bit CIDR by default. This limits the guest virtual network to 254 running instances. It can be adjusted as needed, but this must be done before any instances are created in the zone. For example, 10.1.1.0/22 would provide for ~1000 addresses. - The following table lists limits set in the Global Configuration: - - - - - Parameter Name - Definition - - - - - - max.account.public.ips - Number of public IP addresses that can be owned by an account - - - - max.account.snapshots - Number of snapshots that can exist for an account - - - - - max.account.templates - Number of templates that can exist for an account - - - - max.account.user.vms - Number of virtual machine instances that can exist for an account - - - - max.account.volumes - Number of disk volumes that can exist for an account - - - - max.template.iso.size - Maximum size for a downloaded template or ISO in GB - - - - max.volume.size.gb - Maximum size for a volume in GB - - - network.throttling.rate - Default data transfer rate in megabits per second allowed per user (supported on XenServer) - - - snapshot.max.hourly - Maximum recurring hourly snapshots to be retained for a volume. If the limit is reached, early snapshots from the start of the hour are deleted so that newer ones can be saved. This limit does not apply to manual snapshots. If set to 0, recurring hourly snapshots can not be scheduled - - - - snapshot.max.daily - Maximum recurring daily snapshots to be retained for a volume. If the limit is reached, snapshots from the start of the day are deleted so that newer ones can be saved. This limit does not apply to manual snapshots. If set to 0, recurring daily snapshots can not be scheduled - - - snapshot.max.weekly - Maximum recurring weekly snapshots to be retained for a volume. If the limit is reached, snapshots from the beginning of the week are deleted so that newer ones can be saved. This limit does not apply to manual snapshots. If set to 0, recurring weekly snapshots can not be scheduled - - - - snapshot.max.monthly - Maximum recurring monthly snapshots to be retained for a volume. If the limit is reached, snapshots from the beginning of the month are deleted so that newer ones can be saved. This limit does not apply to manual snapshots. If set to 0, recurring monthly snapshots can not be scheduled. - - - - - To modify global configuration parameters, use the global configuration screen in the &PRODUCT; UI. See Setting Global Configuration Parameters -
diff --git a/docs/en-US/globally-configured-limits.xml b/docs/en-US/globally-configured-limits.xml index ac71112b310..48a91f1b01e 100644 --- a/docs/en-US/globally-configured-limits.xml +++ b/docs/en-US/globally-configured-limits.xml @@ -22,7 +22,7 @@ under the License. --> -
+
Globally Configured Limits In a zone, the guest virtual network has a 24 bit CIDR by default. This limits the guest virtual network to 254 running instances. It can be adjusted as needed, but this must be done before any instances are created in the zone. For example, 10.1.1.0/22 would provide for ~1000 addresses. The following table lists limits set in the Global Configuration: diff --git a/docs/en-US/installation.xml b/docs/en-US/installation.xml index 35f1c681dc8..5fc550edad6 100644 --- a/docs/en-US/installation.xml +++ b/docs/en-US/installation.xml @@ -29,5 +29,4 @@ - diff --git a/docs/en-US/manage-cloud.xml b/docs/en-US/manage-cloud.xml index c4c4d6be248..3e29d09cdc1 100644 --- a/docs/en-US/manage-cloud.xml +++ b/docs/en-US/manage-cloud.xml @@ -22,10 +22,11 @@ under the License. --> -
- Managing the Cloud - vCenter Maintenance Mode - XenServer and Maintenance Mode - vCenter Maintenance Mode - XenServer and Maintenance Mode -
+ + Managing the Cloud + + + + + + \ No newline at end of file diff --git a/docs/en-US/networks-for-users-overview.xml b/docs/en-US/networks-for-users-overview.xml new file mode 100644 index 00000000000..19602c48b2a --- /dev/null +++ b/docs/en-US/networks-for-users-overview.xml @@ -0,0 +1,35 @@ + + +%BOOK_ENTITIES; +]> + + + +
+ Overview of Setting Up Networking for Users + People using cloud infrastructure have a variety of needs and preferences when it comes to the networking services provided by the cloud. As a &PRODUCT; administrator, you can do the following things to set up networking for your users: + + Set up physical networks in zones + Set up several different providers for the same service on a single physical network (for example, both Cisco and Juniper firewalls) + Bundle different types of network services into network offerings, so users can choose the desired network services for any given virtual machine + Add new network offerings as time goes on so end users can upgrade to a better class of service on their network + Provide more ways for a network to be accessed by a user, such as through a project of which the user is a member + +
diff --git a/docs/en-US/networks.xml b/docs/en-US/networks.xml index d4ed76d4d0c..a7b9ea12466 100644 --- a/docs/en-US/networks.xml +++ b/docs/en-US/networks.xml @@ -45,4 +45,4 @@ - + \ No newline at end of file diff --git a/docs/en-US/offerings.xml b/docs/en-US/offerings.xml new file mode 100644 index 00000000000..10252fd8af4 --- /dev/null +++ b/docs/en-US/offerings.xml @@ -0,0 +1,31 @@ + + +%BOOK_ENTITIES; +]> + + + + + Service Offerings + In this chapter we discuss compute, disk, and system service offerings. Network offerings + are discussed in the section on setting up networking for users. + + + diff --git a/docs/en-US/removing-hosts.xml b/docs/en-US/removing-hosts.xml new file mode 100644 index 00000000000..468f36ecd3f --- /dev/null +++ b/docs/en-US/removing-hosts.xml @@ -0,0 +1,30 @@ + + +%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/set-up-network-for-users.xml b/docs/en-US/set-up-network-for-users.xml index 4e2be48e312..2b409232037 100644 --- a/docs/en-US/set-up-network-for-users.xml +++ b/docs/en-US/set-up-network-for-users.xml @@ -22,14 +22,10 @@ under the License. --> -
+ Setting Up Networking for Users - People using cloud infrastructure have a variety of needs and preferences when it comes to the networking services provided by the cloud. As a &PRODUCT; administrator, you can do the following things to set up networking for your users: - - Set up physical networks in zones - Set up several different providers for the same service on a single physical network (for example, both Cisco and Juniper firewalls) - Bundle different types of network services into network offerings, so users can choose the desired network services for any given virtual machine - Add new network offerings as time goes on so end users can upgrade to a better class of service on their network - Provide more ways for a network to be accessed by a user, such as through a project of which the user is a member - -
+ + + + + diff --git a/docs/en-US/storage.xml b/docs/en-US/storage.xml index c4df50f6a8f..86d3f53e766 100644 --- a/docs/en-US/storage.xml +++ b/docs/en-US/storage.xml @@ -22,9 +22,11 @@ under the License. --> -
- Deleting VMs - &PRODUCT; defines two types of storage: primary and secondary. Primary storage can be accessed by either iSCSI or NFS. Additionally, direct attached storage may be used for primary storage. Secondary storage is always accessed using NFS. - There is no ephemeral storage in &PRODUCT;. All volumes on all nodes are persistent -
- + + Working With Storage + + + + + + diff --git a/docs/en-US/sys-reliability-and-ha.xml b/docs/en-US/sys-reliability-and-ha.xml index bdb36d0fa46..5c544af0e10 100644 --- a/docs/en-US/sys-reliability-and-ha.xml +++ b/docs/en-US/sys-reliability-and-ha.xml @@ -22,10 +22,11 @@ under the License. --> -
- System Reliability and High Availability - vCenter Maintenance Mode - XenServer and Maintenance Mode - vCenter Maintenance Mode - XenServer and Maintenance Mode -
+ + System Reliability and High Availability + + + + + + \ No newline at end of file diff --git a/docs/en-US/tagging-resources.xml b/docs/en-US/tagging-resources.xml new file mode 100644 index 00000000000..31ee3825e4a --- /dev/null +++ b/docs/en-US/tagging-resources.xml @@ -0,0 +1,69 @@ + + +%BOOK_ENTITIES; +]> + + + +
+ Using Tags to Organize Resources in the Cloud + A tag is a key-value pair that stores metadata about a resource in the cloud. Tags are + useful for categorizing resources. For example, you can tag a user VM with a + value that indicates the user's city of residence. In this case, the key would + be "city" and the value might be "Toronto" or "Tokyo." You can then request + &PRODUCT; to find all resources that have a given tag; for example, VMs for + users in a given city. + You can tag a user virtual machine, volume, snapshot, guest network, template, + ISO, firewall rule, port forwarding rule, public IP address, security group, + load balancer rule, project, VPC, network ACL, or static route. You can not tag + a remote access VPN. + You can work with tags through the UI or through the API commands createTags, + deleteTags, and listTags. You can define multiple tags for each resource. There + is no limit on the number of tags you can define. Each tag can be up to 255 + characters long. Users can define tags on the resources they own, and + administrators can define tags on any resources in the cloud. + An optional input parameter, "tags," exists on many of the list* API commands. + The following example shows how to use this new parameter to find all the volumes + having tag region=canada OR tag city=Toronto: + command=listVolumes + &listAll=true + &tags[0].key=region + &tags[0].value=canada + &tags[1].key=city + &tags[1].value=Toronto + The following API commands have the "tags" input parameter: + + listVirtualMachines + listVolumes + listSnapshots + listNetworks + listTemplates + listIsos + listFirewallRules + listPortForwardingRules + listPublicIpAddresses + listSecurityGroups + listLoadBalancerRules + listProjects + listVPCs + listNetworkACLs + listStaticRoutes + +
diff --git a/docs/en-US/time-zones.xml b/docs/en-US/time-zones.xml index d6d4bc75df1..aa8eefb7c59 100644 --- a/docs/en-US/time-zones.xml +++ b/docs/en-US/time-zones.xml @@ -22,9 +22,9 @@ under the License. --> -
+ Time Zones - The following time zone identifiers are accepted by the &PRODUCT; API. There are several places that have a time zone as a required or optional parameter. These include scheduling recurring snapshots, creating a user, and specifying the usage time zone in the Configuration table. . + The following time zone identifiers are accepted by &PRODUCT;. There are several places that have a time zone as a required or optional parameter. These include scheduling recurring snapshots, creating a user, and specifying the usage time zone in the Configuration table. @@ -134,4 +134,4 @@ -
+ diff --git a/docs/en-US/troubleshooting.xml b/docs/en-US/troubleshooting.xml index f3dc7d37da3..dd736fe18e0 100644 --- a/docs/en-US/troubleshooting.xml +++ b/docs/en-US/troubleshooting.xml @@ -22,13 +22,14 @@ under the License. --> -
- Alert Type Numbers - Data Loss on Exported Primary Storage - Load balancer rules fail after changing network offering - Maintenance mode not working on vCenter - Recovering a Lost Virtual Router - Unable to deploy VMs from uploaded vSphere template - Unable to power on virtual machine on VMware - Working with Server Logs -
+ + Troubleshooting + + + + + + + + + \ No newline at end of file diff --git a/docs/en-US/tuning.xml b/docs/en-US/tuning.xml index bcaaaa1afbe..18d83ee40bc 100644 --- a/docs/en-US/tuning.xml +++ b/docs/en-US/tuning.xml @@ -22,7 +22,7 @@ under the License. --> -
+ Tuning This section provides tips on how to improve the performance of your cloud. @@ -30,4 +30,4 @@ -
+ \ No newline at end of file diff --git a/docs/en-US/user-services-overview.xml b/docs/en-US/user-services-overview.xml index f8514b7c04c..12504e6ca4e 100644 --- a/docs/en-US/user-services-overview.xml +++ b/docs/en-US/user-services-overview.xml @@ -22,7 +22,7 @@ under the License. --> -
+ User Services Overview In addition to the physical and logical infrastructure of your cloud, and the &PRODUCT; software and servers, you also need a layer of user @@ -69,4 +69,4 @@ System Service Offerings.
-
+ diff --git a/docs/en-US/using-multiple-guest-networks.xml b/docs/en-US/using-multiple-guest-networks.xml index ce71caaf276..9076a816640 100644 --- a/docs/en-US/using-multiple-guest-networks.xml +++ b/docs/en-US/using-multiple-guest-networks.xml @@ -28,4 +28,6 @@ A VM's networks are defined at VM creation time. A VM cannot add or remove networks after it has been created, although the user can go into the guest and remove the IP address from the NIC on a particular network. Each VM has just one default network. The virtual router's DHCP reply will set the guest's default gateway as that for the default network. Multiple non-default networks may be added to a guest in addition to the single, required default network. The administrator can control which networks are available as the default network. Additional networks can either be available to all accounts or be assigned to a specific account. Networks that are available to all accounts are zone-wide. Any user with access to the zone can create a VM with access to that network. These zone-wide networks provide little or no isolation between guests.Networks that are assigned to a specific account provide strong isolation. + +
diff --git a/docs/en-US/vpn.xml b/docs/en-US/vpn.xml index a4599873856..724e4800f94 100644 --- a/docs/en-US/vpn.xml +++ b/docs/en-US/vpn.xml @@ -30,4 +30,8 @@ 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/whats-new.xml b/docs/en-US/whats-new.xml index 44ec5183d6a..01b56ff0dea 100644 --- a/docs/en-US/whats-new.xml +++ b/docs/en-US/whats-new.xml @@ -22,13 +22,20 @@ under the License. --> -
- What's New in 3.0.x? - The following describes any new major features of each CloudPlatform version as it applies to API usage. - - - - - - -
+ + What's New in the API? + The following describes any new major features of each &PRODUCT; version as it applies to API usage. +
+ What's New in the API for 4.0 + TODO +
+
+ What's New in the API for 3.0 + + + + + + +
+ \ No newline at end of file diff --git a/docs/en-US/work-with-usage.xml b/docs/en-US/work-with-usage.xml index e9fb1d8d7ef..939ba6378a4 100644 --- a/docs/en-US/work-with-usage.xml +++ b/docs/en-US/work-with-usage.xml @@ -22,7 +22,15 @@ under the License. --> -
- Changing the Database Configuration - The &PRODUCT; Management Server stores database configuration information (e.g., hostname, port, credentials) in the file /etc/cloud/management/db.properties. To effect a change, edit this file on each Management Server, then restart the Management Server. -
+ + Working with Usage + The Usage Server is an optional, separately-installed part of &PRODUCT; that provides aggregated usage records which you can use to create billing integration for &PRODUCT;. The Usage Server works by taking data from the events log and creating summary usage records that you can access using the listUsageRecords API call. + The usage records show the amount of resources, such as VM run time or template storage + space, consumed by guest instances. + The Usage Server runs at least once per day. It can be configured to run multiple times per day. + + + + + + \ No newline at end of file diff --git a/docs/en-US/working-with-hosts.xml b/docs/en-US/working-with-hosts.xml index fb4364b3cae..4dcb8521ae2 100644 --- a/docs/en-US/working-with-hosts.xml +++ b/docs/en-US/working-with-hosts.xml @@ -22,7 +22,18 @@ under the License. --> -
- Removing Hosts - Hosts can be removed from the cloud as needed. The procedure to remove a host depends on the hypervisor type. -
+ + Working With Hosts +
+ Adding Hosts + Additional hosts can be added at any time to provide more capacity for guest VMs. For requirements and instructions, see . +
+ + + + + + + + + \ No newline at end of file diff --git a/docs/en-US/working-with-system-vm.xml b/docs/en-US/working-with-system-vm.xml index 016d57977cc..ed2bdcded41 100644 --- a/docs/en-US/working-with-system-vm.xml +++ b/docs/en-US/working-with-system-vm.xml @@ -22,7 +22,12 @@ under the License. --> -
- Working with System Virtual Machines - &PRODUCT; uses several types of system virtual machines to perform tasks in the cloud. In general &PRODUCT; manages these system VMs and creates, starts, and stops them as needed based on scale and immediate needs. However, the administrator should be aware of them and their roles to assist in debugging issues. -
+ + Working with System Virtual Machines + &PRODUCT; uses several types of system virtual machines to perform tasks in the cloud. In general &PRODUCT; manages these system VMs and creates, starts, and stops them as needed based on scale and immediate needs. However, the administrator should be aware of them and their roles to assist in debugging issues. + + + + + + \ No newline at end of file diff --git a/docs/en-US/working-with-templates.xml b/docs/en-US/working-with-templates.xml index 57a0a58ee7f..a01c1814a21 100644 --- a/docs/en-US/working-with-templates.xml +++ b/docs/en-US/working-with-templates.xml @@ -22,7 +22,7 @@ under the License. --> -
+ Working with Templates A template is a reusable configuration for virtual machines. When users launch VMs, they can choose from a list of templates in &PRODUCT;. Specifically, a template is a virtual disk image that includes one of a variety of operating systems, optional additional software such as office applications, and settings such as access control to determine who can use the template. Each template is associated with a particular type of hypervisor, which is specified when the template is added to &PRODUCT;. @@ -38,7 +38,7 @@ - + -
+ diff --git a/docs/en-US/working-with-usage-data.xml b/docs/en-US/working-with-usage-data.xml index 95d83640e34..56a929fd6c1 100644 --- a/docs/en-US/working-with-usage-data.xml +++ b/docs/en-US/working-with-usage-data.xml @@ -22,7 +22,7 @@ under the License. --> -
+ Working With Usage Data 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. @@ -31,4 +31,4 @@ -
+