Updated Branches: refs/heads/4.0 626ade99e -> d9f11b5b0
CS-547 Signed-off-by: Gavin Lee <[email protected]> Conflicts: docs/en-US/primary-storage.xml Project: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/commit/d9f11b5b Tree: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/tree/d9f11b5b Diff: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/diff/d9f11b5b Branch: refs/heads/4.0 Commit: d9f11b5b09cbbe6dae5aefeee6d6616f6a634e92 Parents: 626ade9 Author: Sebastien Goasguen <[email protected]> Authored: Tue Nov 27 10:07:10 2012 +0100 Committer: Gavin Lee <[email protected]> Committed: Wed Nov 28 11:16:25 2012 +0800 ---------------------------------------------------------------------- docs/en-US/add-clusters-ovm.xml | 2 +- docs/en-US/admin-guide.xml | 2 +- docs/en-US/aws-ec2-configuration.xml | 2 +- docs/en-US/basic-zone-configuration.xml | 2 +- docs/en-US/basic-zone-guest-ip-addresses.xml | 2 +- .../basic-zone-physical-network-configuration.xml | 2 +- docs/en-US/best-practices-primary-storage.xml | 2 +- docs/en-US/best-practices-secondary-storage.xml | 2 +- docs/en-US/cloudplatform-api.xml | 31 --------------- docs/en-US/configuring-projects.xml | 2 +- docs/en-US/log-in-root-admin.xml | 2 +- docs/en-US/manual-live-migration.xml | 4 +- docs/en-US/network-offerings.xml | 10 ++-- docs/en-US/network-service-providers.xml | 6 +- docs/en-US/port-forwarding.xml | 6 +- docs/en-US/primary-storage.xml | 11 ++++- docs/en-US/query-filter.xml | 8 ++-- docs/en-US/release-ip-address.xml | 2 +- docs/en-US/roles.xml | 2 +- docs/en-US/troubleshooting-lb-rules-fails.xml | 2 +- ...ing-maintenance-mode-not-working-on-vCenter.xml | 2 +- docs/en-US/using-swift-for-secondary-storage.xml | 2 +- docs/en-US/vm-lifecycle.xml | 4 +- 23 files changed, 42 insertions(+), 68 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d9f11b5b/docs/en-US/add-clusters-ovm.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/add-clusters-ovm.xml b/docs/en-US/add-clusters-ovm.xml index 11e1a13..aa07dfa 100644 --- a/docs/en-US/add-clusters-ovm.xml +++ b/docs/en-US/add-clusters-ovm.xml @@ -26,7 +26,7 @@ <title>Add Cluster: OVM</title> <para>To add a Cluster of hosts that run Oracle VM (OVM):</para> <orderedlist> - <listitem><para>Add a companion non-OVM cluster to the Pod. This cluster provides an environment where the CloudPlatform System VMs can run. You should have already installed a non-OVM hypervisor on at least one Host to prepare for this step. Depending on which hypervisor you used:</para> + <listitem><para>Add a companion non-OVM cluster to the Pod. This cluster provides an environment where the &PRODUCT; System VMs can run. You should have already installed a non-OVM hypervisor on at least one Host to prepare for this step. Depending on which hypervisor you used:</para> <itemizedlist> <listitem><para>For VMWare, follow the steps in Add Cluster: vSphere. When finished, return here and continue with the next step.</para></listitem> <listitem><para>For KVM or XenServer, follow the steps in <xref linkend="add-clusters-kvm-xenserver"/>. When finished, return here and continue with the next step</para></listitem> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d9f11b5b/docs/en-US/admin-guide.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/admin-guide.xml b/docs/en-US/admin-guide.xml index 512f7a9..f1b0327 100644 --- a/docs/en-US/admin-guide.xml +++ b/docs/en-US/admin-guide.xml @@ -88,5 +88,5 @@ <xi:include href="add-password-management-to-templates.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> <xi:include href="configure-vpn.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> <xi:include href="tuning.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="cloudplatform-api.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="cloudstack-api.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> </chapter> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d9f11b5b/docs/en-US/aws-ec2-configuration.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/aws-ec2-configuration.xml b/docs/en-US/aws-ec2-configuration.xml index b8966c1..d6c4066 100644 --- a/docs/en-US/aws-ec2-configuration.xml +++ b/docs/en-US/aws-ec2-configuration.xml @@ -25,7 +25,7 @@ <section id="aws-ec2-configuration"> <title>Enabling the AWS API Compatible Interface</title> <para> - The software that provides AWS API compatibility is installed along with CloudPlatform. However, you must enable the feature and perform some setup steps. + The software that provides AWS API compatibility is installed along with &PRODUCT;. However, you must enable the feature and perform some setup steps. </para> <orderedlist> <listitem><para>Set the global configuration parameter enable.ec2.api to true. See <xref linkend="global-config" />.</para></listitem> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d9f11b5b/docs/en-US/basic-zone-configuration.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/basic-zone-configuration.xml b/docs/en-US/basic-zone-configuration.xml index e27c914..e0c67d8 100644 --- a/docs/en-US/basic-zone-configuration.xml +++ b/docs/en-US/basic-zone-configuration.xml @@ -135,7 +135,7 @@ <listitem><para><emphasis role="bold">Host Tags.</emphasis> (Optional) Any labels that you use to categorize hosts for ease of maintenance. For example, you can set this to the cloud's HA tag (set in the ha.tag global configuration parameter) if you want this host to be used only for VMs with the "high availability" feature enabled. For more information, see HA-Enabled Virtual Machines as well as HA for Hosts.</para></listitem> </itemizedlist> </listitem> - <listitem><para>In a new cluster, CloudPlatform adds the first primary storage server for you. You can always add more servers later. For an overview of what primary storage is, see About Primary Storage.</para> + <listitem><para>In a new cluster, &PRODUCT; adds the first primary storage server for you. You can always add more servers later. For an overview of what primary storage is, see About Primary Storage.</para> <para>To configure the first primary storage server, enter the following, then click Next:</para> <itemizedlist> <listitem><para><emphasis role="bold">Name.</emphasis> The name of the storage device.</para></listitem> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d9f11b5b/docs/en-US/basic-zone-guest-ip-addresses.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/basic-zone-guest-ip-addresses.xml b/docs/en-US/basic-zone-guest-ip-addresses.xml index d1d9135..57ef9e7 100644 --- a/docs/en-US/basic-zone-guest-ip-addresses.xml +++ b/docs/en-US/basic-zone-guest-ip-addresses.xml @@ -24,5 +24,5 @@ <section id="basic-zone-guest-ip-addresses"> <title>Basic Zone Guest IP Addresses</title> - <para>When basic networking is used, CloudPlatform will assign IP addresses in the CIDR of the pod to the guests in that pod. The administrator must add a Direct IP range on the pod for this purpose. These IPs are in the same VLAN as the hosts.</para> + <para>When basic networking is used, &PRODUCT; will assign IP addresses in the CIDR of the pod to the guests in that pod. The administrator must add a Direct IP range on the pod for this purpose. These IPs are in the same VLAN as the hosts.</para> </section> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d9f11b5b/docs/en-US/basic-zone-physical-network-configuration.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/basic-zone-physical-network-configuration.xml b/docs/en-US/basic-zone-physical-network-configuration.xml index 83833a7..32aeb84 100644 --- a/docs/en-US/basic-zone-physical-network-configuration.xml +++ b/docs/en-US/basic-zone-physical-network-configuration.xml @@ -24,6 +24,6 @@ <section id="basic-zone-physical-network-configuration"> <title>Basic Zone Physical Network Configuration</title> - <para>In a basic network, configuring the physical network is fairly straightforward. You only need to configure one guest network to carry traffic that is generated by guest VMs. When you first add a zone to CloudPlatform, you set up the guest network through the Add Zone screens.</para> + <para>In a basic network, configuring the physical network is fairly straightforward. You only need to configure one guest network to carry traffic that is generated by guest VMs. When you first add a zone to &PRODUCT;, you set up the guest network through the Add Zone screens.</para> </section> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d9f11b5b/docs/en-US/best-practices-primary-storage.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/best-practices-primary-storage.xml b/docs/en-US/best-practices-primary-storage.xml index 2f639b1..0c9a22f 100644 --- a/docs/en-US/best-practices-primary-storage.xml +++ b/docs/en-US/best-practices-primary-storage.xml @@ -26,6 +26,6 @@ <title>Best Practices for Primary Storage</title> <itemizedlist> <listitem><para>The speed of primary storage will impact guest performance. If possible, choose smaller, higher RPM drives for primary storage.</para></listitem> - <listitem><para>Ensure that nothing is stored on the server. Adding the server to CloudPlatform will destroy any existing data</para></listitem> + <listitem><para>Ensure that nothing is stored on the server. Adding the server to &PRODUCT; will destroy any existing data</para></listitem> </itemizedlist> </section> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d9f11b5b/docs/en-US/best-practices-secondary-storage.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/best-practices-secondary-storage.xml b/docs/en-US/best-practices-secondary-storage.xml index c2da7d8..3d535c3 100644 --- a/docs/en-US/best-practices-secondary-storage.xml +++ b/docs/en-US/best-practices-secondary-storage.xml @@ -27,6 +27,6 @@ <itemizedlist> <listitem><para>Each Zone can have one or more secondary storage servers. Multiple secondary storage servers provide increased scalability to the system.</para></listitem> <listitem><para>Secondary storage has a high read:write ratio and is expected to consist of larger drives with lower IOPS than primary storage.</para></listitem> - <listitem><para>Ensure that nothing is stored on the server. Adding the server to CloudPlatform will destroy any existing data.</para></listitem> + <listitem><para>Ensure that nothing is stored on the server. Adding the server to &PRODUCT; will destroy any existing data.</para></listitem> </itemizedlist> </section> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d9f11b5b/docs/en-US/cloudplatform-api.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/cloudplatform-api.xml b/docs/en-US/cloudplatform-api.xml deleted file mode 100644 index 3c4a914..0000000 --- a/docs/en-US/cloudplatform-api.xml +++ /dev/null @@ -1,31 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<section id="cloudplatform-api"> - <title>&PRODUCT; API</title> - <para>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.</para> - <para>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.</para> - <para>The API has a REST-like query basis and returns results in XML or JSON.</para> - <para>See <ulink url="http://support.citrix.com/product/cs";>the Developerâs Guide</ulink> and <ulink url="http://docs.cloudstack.org/CloudStack_Documentation/API_Reference%3A_CloudStack";>the API Reference</ulink>.</para> - </section> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d9f11b5b/docs/en-US/configuring-projects.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/configuring-projects.xml b/docs/en-US/configuring-projects.xml index 0f84dd8..af1fc53 100644 --- a/docs/en-US/configuring-projects.xml +++ b/docs/en-US/configuring-projects.xml @@ -22,7 +22,7 @@ ]> <section id="configuring-projects"> <title>Configuring Projects</title> - <para>Before CloudPlatform users start using projects, the CloudPlatform administrator must set + <para>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.</para> <xi:include href="set-up-invitations.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d9f11b5b/docs/en-US/log-in-root-admin.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/log-in-root-admin.xml b/docs/en-US/log-in-root-admin.xml index c0a340a..058c5b4 100644 --- a/docs/en-US/log-in-root-admin.xml +++ b/docs/en-US/log-in-root-admin.xml @@ -35,7 +35,7 @@ <listitem><para><emphasis role="bold">Continue with basic setup.</emphasis> Choose this if you're just trying &PRODUCT;, and you want a guided walkthrough of the simplest possible configuration so that you can get started right away. We'll help you set up a cloud with the following features: a single machine that runs &PRODUCT; software and uses NFS to provide storage; a single machine running VMs under the XenServer or KVM hypervisor; and a shared public network.</para> <para>The prompts in this guided tour should give you all the information you need, but if you want just a bit more detail, you can follow along in the Trial Installation Guide.</para> </listitem> - <listitem><para><emphasis role="bold">I have used &PRODUCT; before.</emphasis> Choose this if you have already gone through a design phase and planned a more sophisticated deployment, or you are ready to start scaling up a trial cloud that you set up earlier with the basic setup screens. In the Administrator UI, you can start using the more powerful features of CloudPlatform, such as advanced VLAN networking, high availability, additional network elements such as load balancers and firewalls, and support for multiple hypervisors including Citrix XenServer, KVM, and VMware vSphere.</para> + <listitem><para><emphasis role="bold">I have used &PRODUCT; before.</emphasis> Choose this if you have already gone through a design phase and planned a more sophisticated deployment, or you are ready to start scaling up a trial cloud that you set up earlier with the basic setup screens. In the Administrator UI, you can start using the more powerful features of &PRODUCT;, such as advanced VLAN networking, high availability, additional network elements such as load balancers and firewalls, and support for multiple hypervisors including Citrix XenServer, KVM, and VMware vSphere.</para> <para>The root administrator Dashboard appears.</para> </listitem> </itemizedlist> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d9f11b5b/docs/en-US/manual-live-migration.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/manual-live-migration.xml b/docs/en-US/manual-live-migration.xml index 30a5c11..52de4c4 100644 --- a/docs/en-US/manual-live-migration.xml +++ b/docs/en-US/manual-live-migration.xml @@ -24,7 +24,7 @@ <section id="manual-live-migration"> <title>Moving VMs Between Hosts (Manual Live Migration)</title> - <para>The CloudPlatform administrator can move a running VM from one host to another without interrupting service to users or going into maintenance mode. This is called manual live migration, and can be done under the following conditions:</para> + <para>The &PRODUCT; administrator can move a running VM from one host to another without interrupting service to users or going into maintenance mode. This is called manual live migration, and can be done under the following conditions:</para> <itemizedlist> <listitem><para>The root administrator is logged in. Domain admins and users can not perform manual live migration of VMs.</para></listitem> <listitem><para>The VM is running. Stopped VMs can not be live migrated.</para></listitem> @@ -35,7 +35,7 @@ </itemizedlist> <para>To manually live migrate a virtual machine</para> <orderedlist> - <listitem><para>Log in to the CloudPlatform UI as a user or admin.</para></listitem> + <listitem><para>Log in to the &PRODUCT; UI as a user or admin.</para></listitem> <listitem><para>In the left navigation, click Instances.</para></listitem> <listitem><para>Choose the VM that you want to migrate.</para></listitem> <listitem><para>Click the Migrate Instance button <inlinemediaobject> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d9f11b5b/docs/en-US/network-offerings.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/network-offerings.xml b/docs/en-US/network-offerings.xml index ccfb93c..c1fd79d 100644 --- a/docs/en-US/network-offerings.xml +++ b/docs/en-US/network-offerings.xml @@ -24,7 +24,7 @@ <section id="network-offerings"> <title>Network Offerings</title> - <note><para>For the most up-to-date list of supported network services, see the CloudPlatform UI or call listNetworkServices.</para></note> + <note><para>For the most up-to-date list of supported network services, see the &PRODUCT; UI or call listNetworkServices.</para></note> <para>A network offering is a named set of network services, such as:</para> <itemizedlist> <listitem><para>DHCP</para></listitem> @@ -39,9 +39,9 @@ <listitem><para>(Optional) Network tag to specify which physical network to use</para></listitem> </itemizedlist> <para>When creating a new VM, the user chooses one of the available network offerings, and that determines which network services the VM can use.</para> - <para>The CloudPlatform administrator can create any number of custom network offerings, in addition to the default network offerings provided by CloudPlatform. By creating multiple custom network offerings, you can set up your cloud to offer different classes of service on a single multi-tenant physical network. For example, while the underlying physical wiring may be the same for two tenants, tenant A may only need simple firewall protection for their website, while tenant B may be running a web server farm and require a scalable firewall solution, load balancing solution, and alternate networks for accessing the database backend.</para> - <note><para>If you create load balancing rules while using a network service offering that includes an external load balancer device such as NetScaler, and later change the network service offering to one that uses the CloudPlatform virtual router, you must create a firewall rule on the virtual router for each of your existing load balancing rules so that they continue to function.</para></note> - <para>When creating a new virtual network, the CloudPlatform administrator chooses which network offering to enable for that network. Each virtual network is associated with one network offering. A virtual network can be upgraded or downgraded by changing its associated network offering. If you do this, be sure to reprogram the physical network to match.</para> - <para>CloudPlatform also has internal network offerings for use by CloudPlatform system VMs. These network offerings are not visible to users but can be modified by administrators.</para> + <para>The &PRODUCT; administrator can create any number of custom network offerings, in addition to the default network offerings provided by &PRODUCT;. By creating multiple custom network offerings, you can set up your cloud to offer different classes of service on a single multi-tenant physical network. For example, while the underlying physical wiring may be the same for two tenants, tenant A may only need simple firewall protection for their website, while tenant B may be running a web server farm and require a scalable firewall solution, load balancing solution, and alternate networks for accessing the database backend.</para> + <note><para>If you create load balancing rules while using a network service offering that includes an external load balancer device such as NetScaler, and later change the network service offering to one that uses the &PRODUCT; virtual router, you must create a firewall rule on the virtual router for each of your existing load balancing rules so that they continue to function.</para></note> + <para>When creating a new virtual network, the &PRODUCT; administrator chooses which network offering to enable for that network. Each virtual network is associated with one network offering. A virtual network can be upgraded or downgraded by changing its associated network offering. If you do this, be sure to reprogram the physical network to match.</para> + <para>&PRODUCT; also has internal network offerings for use by &PRODUCT; system VMs. These network offerings are not visible to users but can be modified by administrators.</para> </section> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d9f11b5b/docs/en-US/network-service-providers.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/network-service-providers.xml b/docs/en-US/network-service-providers.xml index af57097..82eaff1 100644 --- a/docs/en-US/network-service-providers.xml +++ b/docs/en-US/network-service-providers.xml @@ -24,12 +24,12 @@ <section id="network-service-providers"> <title>Network Service Providers</title> - <note><para>For the most up-to-date list of supported network service providers, see the CloudPlatform UI or call listNetworkServiceProviders.</para></note> + <note><para>For the most up-to-date list of supported network service providers, see the &PRODUCT; UI or call listNetworkServiceProviders.</para></note> <para>A service provider (also called a network element) is hardware or virtual appliance that makes a network service possible; for example, a firewall appliance can be installed in the cloud to provide firewall service. On a single network, multiple providers can provide the same network service. For example, a firewall service may be provided by Cisco or Juniper devices in the same physical network.</para> <para>You can have multiple instances of the same service provider in a network (say, more than one Juniper SRX device).</para> - <para>If different providers are set up to provide the same service on the network, the administrator can create network offerings so users can specify which network service provider they prefer (along with the other choices offered in network offerings). Otherwise, CloudPlatform will choose which provider to use whenever the service is called for. </para> + <para>If different providers are set up to provide the same service on the network, the administrator can create network offerings so users can specify which network service provider they prefer (along with the other choices offered in network offerings). Otherwise, &PRODUCT; will choose which provider to use whenever the service is called for. </para> <formalpara> <title>Supported Network Service Providers</title> - <para>CloudPlatform ships with an internal list of the supported service providers, and you can choose from this list when creating a network offering.</para> + <para>&PRODUCT; ships with an internal list of the supported service providers, and you can choose from this list when creating a network offering.</para> </formalpara> </section> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d9f11b5b/docs/en-US/port-forwarding.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/port-forwarding.xml b/docs/en-US/port-forwarding.xml index b778693..b2843eb 100644 --- a/docs/en-US/port-forwarding.xml +++ b/docs/en-US/port-forwarding.xml @@ -29,9 +29,9 @@ <para>You cannot use port forwarding to open ports for an elastic IP address. When elastic IP is used, outside access is instead controlled through the use of security groups. See Security Groups.</para> <para>To set up port forwarding:</para> <orderedlist> - <listitem><para>Log in to the CloudPlatform UI as an administrator or end user.</para></listitem> - <listitem><para>If you have not already done so, add a public IP address range to a zone in CloudPlatform. See Adding a Zone and Pod in the Installation Guide.</para></listitem> - <listitem><para>Add one or more VM instances to CloudPlatform.</para></listitem> + <listitem><para>Log in to the &PRODUCT; UI as an administrator or end user.</para></listitem> + <listitem><para>If you have not already done so, add a public IP address range to a zone in &PRODUCT;. See Adding a Zone and Pod in the Installation Guide.</para></listitem> + <listitem><para>Add one or more VM instances to &PRODUCT;.</para></listitem> <listitem><para>In the left navigation bar, click Network.</para></listitem> <listitem><para>Click the name of the guest network where the VMs are running.</para> </listitem> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d9f11b5b/docs/en-US/primary-storage.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/primary-storage.xml b/docs/en-US/primary-storage.xml index 4860488..7010868 100644 --- a/docs/en-US/primary-storage.xml +++ b/docs/en-US/primary-storage.xml @@ -23,6 +23,11 @@ --> <section id="primary-storage"> - <title>Primary Storage</title> - <para>This section gives concepts and technical details about CloudPlatform primary storage. For information about how to install and configure primary storage through the CloudPlatform UI, see the Advanced Installation Guide.</para> - </section> + <title>Primary Storage</title> + <para>This section gives concepts and technical details about &PRODUCT; primary storage. For information about how to install and configure primary storage through the &PRODUCT; UI, see the Advanced Installation Guide.</para> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="best-practices-primary-storage.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="runtime-behavior-of-primary-storage.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="hypervisor-support-for-primarystorage.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="storage-tags.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="maintenance-mode-for-primary-storage.xml"/> +</section> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d9f11b5b/docs/en-US/query-filter.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/query-filter.xml b/docs/en-US/query-filter.xml index fa5ea63..1c0e493 100644 --- a/docs/en-US/query-filter.xml +++ b/docs/en-US/query-filter.xml @@ -24,8 +24,8 @@ <section id="query-filter"> <title>Query Filter</title> -<para>The query filter is used to find a mapped user in the external LDAP server. The query filter should uniquely map the CloudPlatform user to LDAP user for a meaningful authentication. For more information about query filter syntax, consult the documentation for your LDAP server.</para> -<para>The CloudPlatform query filter wildcards are:</para> +<para>The query filter is used to find a mapped user in the external LDAP server. The query filter should uniquely map the &PRODUCT; user to LDAP user for a meaningful authentication. For more information about query filter syntax, consult the documentation for your LDAP server.</para> +<para>The &PRODUCT; query filter wildcards are:</para> <informaltable> <tgroup cols="2" align="left" colsep="1" rowsep="1"> <thead> @@ -51,9 +51,9 @@ </tgroup> </informaltable> <para>The following examples assume you are using Active Directory, and refer to user attributes from the Active Directory schema.</para> -<para>If the CloudPlatform user name is the same as the LDAP user ID:</para> +<para>If the &PRODUCT; user name is the same as the LDAP user ID:</para> <programlisting>(uid=%u)</programlisting> -<para>If the CloudPlatform user name is the LDAP display name:</para> +<para>If the &PRODUCT; user name is the LDAP display name:</para> <programlisting>(displayName=%u)</programlisting> <para>To find a user by email address:</para> <programlisting>(mail=%e)</programlisting> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d9f11b5b/docs/en-US/release-ip-address.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/release-ip-address.xml b/docs/en-US/release-ip-address.xml index 87b5300..c60b73a 100644 --- a/docs/en-US/release-ip-address.xml +++ b/docs/en-US/release-ip-address.xml @@ -25,7 +25,7 @@ <section id="release-ip-address"> <title>Releasing an IP Address</title> <orderedlist> - <listitem><para>Log in to the CloudPlatform UI as an administrator or end user. </para></listitem> + <listitem><para>Log in to the &PRODUCT; UI as an administrator or end user. </para></listitem> <listitem><para>In the left navigation, choose Network.</para></listitem> <listitem><para>Click the name of the network where you want to work with.</para></listitem> <listitem><para>Click View IP Addresses.</para></listitem> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d9f11b5b/docs/en-US/roles.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/roles.xml b/docs/en-US/roles.xml index 473e37b..775e30b 100644 --- a/docs/en-US/roles.xml +++ b/docs/en-US/roles.xml @@ -25,7 +25,7 @@ <section id="roles"> <title>Roles</title> <para> - The CloudPlatform API supports three access roles:</para> + The &PRODUCT; API supports three access roles:</para> <orderedlist> <listitem><para>Root Admin. Access to all features of the cloud, including both virtual and physical resource management.</para></listitem> <listitem><para>Domain Admin. Access to only the virtual resources of the clouds that belong to the administratorâs domain.</para></listitem> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d9f11b5b/docs/en-US/troubleshooting-lb-rules-fails.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/troubleshooting-lb-rules-fails.xml b/docs/en-US/troubleshooting-lb-rules-fails.xml index c507178..6295534 100644 --- a/docs/en-US/troubleshooting-lb-rules-fails.xml +++ b/docs/en-US/troubleshooting-lb-rules-fails.xml @@ -30,7 +30,7 @@ </formalpara> <formalpara> <title>Cause</title> - <para>Load balancing rules were created while using a network service offering that includes an external load balancer device such as NetScaler, and later the network service offering changed to one that uses the CloudPlatform virtual router.</para> + <para>Load balancing rules were created while using a network service offering that includes an external load balancer device such as NetScaler, and later the network service offering changed to one that uses the &PRODUCT; virtual router.</para> </formalpara> <formalpara> <title>Solution</title> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d9f11b5b/docs/en-US/troubleshooting-maintenance-mode-not-working-on-vCenter.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/troubleshooting-maintenance-mode-not-working-on-vCenter.xml b/docs/en-US/troubleshooting-maintenance-mode-not-working-on-vCenter.xml index c4bf37f..764d188 100644 --- a/docs/en-US/troubleshooting-maintenance-mode-not-working-on-vCenter.xml +++ b/docs/en-US/troubleshooting-maintenance-mode-not-working-on-vCenter.xml @@ -30,7 +30,7 @@ </formalpara> <formalpara> <title>Cause</title> - <para>The CloudPlatform administrator UI was used to place the host in scheduled maintenance mode. This mode is separate from vCenter's maintenance mode.</para> + <para>The &PRODUCT; administrator UI was used to place the host in scheduled maintenance mode. This mode is separate from vCenter's maintenance mode.</para> </formalpara> <formalpara> <title>Solution</title> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d9f11b5b/docs/en-US/using-swift-for-secondary-storage.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/using-swift-for-secondary-storage.xml b/docs/en-US/using-swift-for-secondary-storage.xml index bf238ca..329cf81 100644 --- a/docs/en-US/using-swift-for-secondary-storage.xml +++ b/docs/en-US/using-swift-for-secondary-storage.xml @@ -24,6 +24,6 @@ <section id="using-swift-for-secondary-storage"> <title>Using Swift for Secondary Storage</title> - <para>CloudPlatform supports OpenStack Object Storage (<ulink url="http://swift.openstack.org/";> Swift</ulink>) for secondary storage. When using Swift, you configure Swift storage for the entire CloudPlatform, then set up NFS secondary storage for each zone as usual. The NFS storage in each zone acts as a staging area through which all templates and other secondary storage data pass before being forwarded to Swift. The Swift storage acts as a cloud-wide resource, making templates and other data available to any zone in the cloud. There is no hierarchy in the Swift storage, just one Swift container per storage object. Any secondary storage in the whole cloud can pull a container from Swift at need. It is not necessary to copy templates and snapshots from one zone to another, as would be required when using zone NFS alone. Everything is available everywhere</para> + <para>&PRODUCT; supports OpenStack Object Storage (<ulink url="http://swift.openstack.org/";> Swift</ulink>) for secondary storage. When using Swift, you configure Swift storage for the entire &PRODUCT;, then set up NFS secondary storage for each zone as usual. The NFS storage in each zone acts as a staging area through which all templates and other secondary storage data pass before being forwarded to Swift. The Swift storage acts as a cloud-wide resource, making templates and other data available to any zone in the cloud. There is no hierarchy in the Swift storage, just one Swift container per storage object. Any secondary storage in the whole cloud can pull a container from Swift at need. It is not necessary to copy templates and snapshots from one zone to another, as would be required when using zone NFS alone. Everything is available everywhere</para> <para>Swift storage must be set up before you add NFS secondary storage to zones. This is accomplished through some additional configuration steps on a fresh Management Server installation, before you add the first zone. The procedure is described in Adding a Zone in the Advanced Installation Guide.</para> </section> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d9f11b5b/docs/en-US/vm-lifecycle.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/vm-lifecycle.xml b/docs/en-US/vm-lifecycle.xml index f5696ce..ce09b0d 100644 --- a/docs/en-US/vm-lifecycle.xml +++ b/docs/en-US/vm-lifecycle.xml @@ -29,12 +29,12 @@ <imageobject> <imagedata fileref="./images/basic-deployment.png" /> </imageobject> - <textobject><phrase>basic-deployment.png: Basic two-machine CloudStack deployment</phrase></textobject> + <textobject><phrase>basic-deployment.png: Basic two-machine &PRODUCT; deployment</phrase></textobject> </mediaobject> <para>Once a virtual machine is destroyed, it cannot be recovered. All the resources used by the virtual machine will be reclaimed by the system. This includes the virtual machineâs IP address.</para> <para>A stop will attempt to gracefully shut down the operating system, which typically involves terminating all the running applications. If the operation system cannot be stopped, it will be forcefully terminated. This has the same effect as pulling the power cord to a physical machine.</para> <para>A reboot is a stop followed by a start.</para> - <para>CloudPlatform preserves the state of the virtual machine hard disk until the machine is destroyed.</para> + <para>&PRODUCT; preserves the state of the virtual machine hard disk until the machine is destroyed.</para> <para>A running virtual machine may fail because of hardware or network issues. A failed virtual machine is in the down state.</para> <para>The system places the virtual machine into the down state if it does not receive the heartbeat from the hypervisor for three minutes.</para> <para>The user can manually restart the virtual machine from the down state.</para>
