Patch from Joe Brockmeier - Adding Apache license headers to all b*xml files, fixing the DTD to remove local C:/ drive reference, adding &product; entity to replace CloudPlatform. Also some misc fixes.
Project: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/commit/81be0638 Tree: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/tree/81be0638 Diff: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/diff/81be0638 Branch: refs/heads/master Commit: 81be0638826ace49fcf826782a209b9ff40a1d08 Parents: 0d339c9 Author: Chip Childers <[email protected]> Authored: Thu Aug 2 16:05:41 2012 -0400 Committer: Chip Childers <[email protected]> Committed: Thu Aug 2 16:05:41 2012 -0400 ---------------------------------------------------------------------- docs/en-US/Book_Info.xml | 29 ++++++++++++--- docs/en-US/basic-zone-configuration.xml | 25 +++++++++++-- .../basic-zone-physical-network-configuration.xml | 21 ++++++++++- docs/en-US/best-practices-for-vms.xml | 19 +++++++++- docs/en-US/best-practices-primary-storage.xml | 22 ++++++++++- docs/en-US/best-practices-secondary-storage.xml | 22 ++++++++++- docs/en-US/best-practices-templates.xml | 21 ++++++++++- docs/en-US/best-practices-virtual-router.xml | 23 +++++++++++- 8 files changed, 165 insertions(+), 17 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/81be0638/docs/en-US/Book_Info.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/Book_Info.xml b/docs/en-US/Book_Info.xml index 155a20b..6ff42f2 100644 --- a/docs/en-US/Book_Info.xml +++ b/docs/en-US/Book_Info.xml @@ -1,18 +1,37 @@ <?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [ +<!DOCTYPE bookinfo 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. +--> + <bookinfo id="book-release-notes-3.0.4"> - <title>CloudPlatform (powered by Apache CloudStack) version 3.0.4 Release Notes</title> + <title>&PRODUCT; version 3.0.4 Release Notes</title> <subtitle>Revised June 14, 2012 5:48 pm Pacific</subtitle> - <productname>Citrix CloudPlatform 3.0.4 Powered by Apache CloudStack</productname> + <productname>Citrix &PRODUCT; 3.0.4 Powered by Apache CloudStack</productname> <productnumber></productnumber> <edition>1</edition> <pubsnumber></pubsnumber> <abstract> <para> - Release notes for patch release of CloudPlatform to support the XenServer patch XS602E003. + Release notes for patch release of &PRODUCT; to support the XenServer patch XS602E003. </para> </abstract> <corpauthor> @@ -24,4 +43,4 @@ </corpauthor> <xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> -</bookinfo> \ No newline at end of file +</bookinfo> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/81be0638/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 5c5d176..bbfd6ec 100644 --- a/docs/en-US/basic-zone-configuration.xml +++ b/docs/en-US/basic-zone-configuration.xml @@ -1,8 +1,27 @@ <?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [ +<!DOCTYPE bookinfo 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="basic-zone-configuration"> <title>Basic Zone Configuration</title> <orderedlist> @@ -47,7 +66,7 @@ <listitem><para>Choose which traffic types will be carried by the physical network.</para> <para>The traffic types are management, public, guest, and storage traffic. For more information about the types, roll over the icons to display their tool tips, or see Basic Zone Network Traffic Types. This screen starts out with some traffic types already assigned. To add more, drag and drop traffic types onto the network. You can also change the network name if desired.</para> </listitem> - <listitem><para>3. (Introduced in version 3.0.1) Assign a network traffic label to each traffic type on the physical network. These labels must match the labels you have already defined on the hypervisor host. To assign each label, click the Edit button under the traffic type icon. A popup dialog appears where you can type the label, then click OK.</para> + <listitem><para>(Introduced in version 3.0.1) Assign a network traffic label to each traffic type on the physical network. These labels must match the labels you have already defined on the hypervisor host. To assign each label, click the Edit button under the traffic type icon. A popup dialog appears where you can type the label, then click OK.</para> <para>These traffic labels will be defined only for the hypervisor selected for the first cluster. For all other hypervisors, the labels can be configured after the zone is created.</para> <para>(VMware only) If you have enabled Nexus dvSwitch in the environment, you must specify the corresponding Ethernet port profile names as network traffic label for each traffic type on the physical network. For more information on Nexus dvSwitch, see Configuring a vSphere Cluster with Nexus 1000v Virtual Switch.</para> </listitem> @@ -125,4 +144,4 @@ </itemizedlist> </listitem> </orderedlist> -</section> \ No newline at end of file +</section> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/81be0638/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 dac86b3..a9b8f55 100644 --- a/docs/en-US/basic-zone-physical-network-configuration.xml +++ b/docs/en-US/basic-zone-physical-network-configuration.xml @@ -1,8 +1,27 @@ <?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [ +<!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="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> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/81be0638/docs/en-US/best-practices-for-vms.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/best-practices-for-vms.xml b/docs/en-US/best-practices-for-vms.xml index 000f676..59e2708 100644 --- a/docs/en-US/best-practices-for-vms.xml +++ b/docs/en-US/best-practices-for-vms.xml @@ -1,6 +1,23 @@ +<!-- 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="vm-lifecycle"> <title>VM Lifecycle</title> <para>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..</para> </section> - http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/81be0638/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 4b4ef9a..c02501b 100644 --- a/docs/en-US/best-practices-primary-storage.xml +++ b/docs/en-US/best-practices-primary-storage.xml @@ -1,8 +1,27 @@ <?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [ +<!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="best-practices-primary-storage"> <title>Best Practices for Primary Storage</title> <itemizedlist> @@ -10,4 +29,3 @@ <listitem><para>Ensure that nothing is stored on the server. Adding the server to CloudPlatform will destroy any existing data</para></listitem> </itemizedlist> </section> - http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/81be0638/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 27b889d..5c08f9d 100644 --- a/docs/en-US/best-practices-secondary-storage.xml +++ b/docs/en-US/best-practices-secondary-storage.xml @@ -1,8 +1,27 @@ <?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [ +<!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="best-practices-secondary-storage"> <title>Best Practices for Secondary Storage</title> <itemizedlist> @@ -11,4 +30,3 @@ <listitem><para>Ensure that nothing is stored on the server. Adding the server to CloudPlatform will destroy any existing data.</para></listitem> </itemizedlist> </section> - http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/81be0638/docs/en-US/best-practices-templates.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/best-practices-templates.xml b/docs/en-US/best-practices-templates.xml index 71bc97b..411ae3a 100644 --- a/docs/en-US/best-practices-templates.xml +++ b/docs/en-US/best-practices-templates.xml @@ -1,8 +1,27 @@ <?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [ +<!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="best-practices-templates"> <title>Best Practices for Templates</title> <para>If you plan to use large templates (100 GB or larger), be sure you have a 10-gigabit network to support the large templates. A slower network can lead to timeouts and other errors when large templates are used.</para> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/81be0638/docs/en-US/best-practices-virtual-router.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/best-practices-virtual-router.xml b/docs/en-US/best-practices-virtual-router.xml index 07324e8..060d868 100644 --- a/docs/en-US/best-practices-virtual-router.xml +++ b/docs/en-US/best-practices-virtual-router.xml @@ -1,12 +1,31 @@ <?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [ +<!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="best-practices-virtual-router"> <title>Best Practices for Virtual Routers</title> <itemizedlist> - <listitem><para>WARNING: Restarting a virtual router from a hypervisor console deletes all the iptables rules. To work around this issue, stop the virtual router and start it from the CloudPlatform UI.</para></listitem> + <listitem><para>WARNING: Restarting a virtual router from a hypervisor console deletes all the iptables rules. To work around this issue, stop the virtual router and start it from the &PRODUCT; UI.</para></listitem> <listitem><para>WARNING: Do not use the destroyRouter API when only one router is available in the network, because restartNetwork API with the cleanup=false parameter can't recreate it later. If you want to destroy and recreate the single router available in the network, use the restartNetwork API with the cleanup=true parameter.</para></listitem> </itemizedlist>
