You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by ah...@apache.org on 2012/10/05 01:16:10 UTC
[3/5] Merged over docs from master
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/automatic-snapshot-creation-retention.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/automatic-snapshot-creation-retention.xml b/docs/en-US/automatic-snapshot-creation-retention.xml
index ee4cf73..54fbe68 100644
--- a/docs/en-US/automatic-snapshot-creation-retention.xml
+++ b/docs/en-US/automatic-snapshot-creation-retention.xml
@@ -3,28 +3,34 @@
<!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.
+ 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="automatic-snapshot-creation-retention">
- <title>Automatic Snapshot Creation and Retention</title>
- <para>(Supported for the following hypervisors: <emphasis role="bold">XenServer</emphasis>, <emphasis role="bold">VMware vSphere</emphasis>, and <emphasis role="bold">KVM</emphasis>)</para>
- <para>Users can set up a recurring snapshot policy to automatically create multiple snapshots of a disk at regular intervals. Snapshots can be created on an hourly, daily, weekly, or monthly interval. One snapshot policy can be set up per disk volume. For example, a user can set up a daily snapshot at 02:30.</para>
- <para>With each snapshot schedule, users can also specify the number of scheduled snapshots to be retained. Older snapshots that exceed the retention limit are automatically deleted. This user-defined limit must be equal to or lower than the global limit set by the &PRODUCT; administrator. See <xref linkend="globally-configured-limits"/>. The limit applies only to those snapshots that are taken as part of an automatic recurring snapshot policy. Additional manual snapshots can be created and retained.</para>
- </section>
+ <title>Automatic Snapshot Creation and Retention</title>
+ <para>(Supported for the following hypervisors: <emphasis role="bold">XenServer</emphasis>,
+ <emphasis role="bold">VMware vSphere</emphasis>, and <emphasis role="bold"
+ >KVM</emphasis>)</para>
+ <para>Users can set up a recurring snapshot policy to automatically create multiple snapshots of a
+ disk at regular intervals. Snapshots can be created on an hourly, daily, weekly, or monthly
+ interval. One snapshot policy can be set up per disk volume. For example, a user can set up a
+ daily snapshot at 02:30.</para>
+ <para>With each snapshot schedule, users can also specify the number of scheduled snapshots to be
+ retained. Older snapshots that exceed the retention limit are automatically deleted. This
+ user-defined limit must be equal to or lower than the global limit set by the &PRODUCT;
+ administrator. See <xref linkend="globally-configured-limits"/>. The limit applies only to those
+ snapshots that are taken as part of an automatic recurring snapshot policy. Additional manual
+ snapshots can be created and retained.</para>
+</section>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/change-to-behavior-of-list-commands.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/change-to-behavior-of-list-commands.xml b/docs/en-US/change-to-behavior-of-list-commands.xml
index 4e53590..9065398 100644
--- a/docs/en-US/change-to-behavior-of-list-commands.xml
+++ b/docs/en-US/change-to-behavior-of-list-commands.xml
@@ -1,89 +1,109 @@
<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/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.
+ 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="change-to-behavior-of-list-commands">
- <title>Change to Behavior of List Commands</title>
- <para>There was a major change in how our List* API commands work in CloudStack 3.0 compared to 2.2.x. The rules below apply only for managed resources – those that belong to an account, domain, or project. They are irrelevant for the List* commands displaying unmanaged (system) resources, such as hosts, clusters, and external network resources.</para>
- <para>When no parameters are passed in to the call, the caller sees only resources owned by the caller (even when the caller is the administrator). Previously, the administrator saw everyone else's resources by default.</para>
- <para>When accountName and domainId are passed in:</para>
- <itemizedlist>
- <listitem><para>The caller sees the resources dedicated to the account specified.</para></listitem>
- <listitem><para>If the call is executed by a regular user, the user is authorized to specify only the user's own account and domainId.</para></listitem>
- <listitem><para>If the caller is a domain administrator, CloudStack performs an authorization check to see whether the caller is permitted to view resources for the given account and domainId.</para></listitem>
- </itemizedlist>
- <para>When projectId is passed in, only resources belonging to that project are listed.</para>
- <para>When domainId is passed in, the call returns only resources belonging to the domain specified. To see the resources of subdomains, use the parameter isRecursive=true. Again, the regular user can see only resources owned by that user, the root administrator can list anything, and a domain administrator is authorized to see only resources of the administrator's own domain and subdomains.</para>
- <para>To see all resources the caller is authorized to see, except for Project resources, use the parameter listAll=true.</para>
- <para>To see all Project resources the caller is authorized to see, use the parameter projectId=-1.</para>
- <para>There is one API command that doesn't fall under the rules above completely: the listTemplates command. This command has its own flags defining the list rules:</para>
- <informaltable frame="all">
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" />
- <colspec colname="c2" />
- <thead>
- <row>
- <entry><para>listTemplates Flag</para></entry>
- <entry><para>Description</para></entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><para>featured</para></entry>
- <entry><para>Returns templates that have been marked as featured and public.</para></entry>
- </row>
-
- <row>
- <entry><para>self</para></entry>
- <entry><para>Returns templates that have been registered or created by the calling user.</para></entry>
- </row>
-
- <row>
- <entry><para>selfexecutable</para></entry>
- <entry><para>Same as self, but only returns templates that are ready to be deployed with.</para></entry>
- </row>
-
- <row>
- <entry><para>sharedexecutable</para></entry>
- <entry><para>Ready templates that have been granted to the calling user by another user.</para></entry>
- </row>
-
- <row>
- <entry><para>executable</para></entry>
- <entry><para>Templates that are owned by the calling user, or public templates, that can be used to deploy a new VM.</para></entry>
- </row>
-
- <row>
- <entry><para>community</para></entry>
- <entry><para>Returns templates that have been marked as public but not featured.</para></entry>
- </row>
-
- <row>
- <entry><para>all</para></entry>
- <entry><para>Returns all templates (only usable by admins).</para></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- <para>The &PRODUCT; UI on a general view will display all resources that the logged-in user is authorized to see, except for project resources. To see the project resources, select the project view.</para>
- </section>
+ <title>Change to Behavior of List Commands</title>
+ <para>There was a major change in how our List* API commands work in CloudStack 3.0 compared to
+ 2.2.x. The rules below apply only for managed resources – those that belong to an account,
+ domain, or project. They are irrelevant for the List* commands displaying unmanaged (system)
+ resources, such as hosts, clusters, and external network resources.</para>
+ <para>When no parameters are passed in to the call, the caller sees only resources owned by the
+ caller (even when the caller is the administrator). Previously, the administrator saw everyone
+ else's resources by default.</para>
+ <para>When accountName and domainId are passed in:</para>
+ <itemizedlist>
+ <listitem>
+ <para>The caller sees the resources dedicated to the account specified.</para>
+ </listitem>
+ <listitem>
+ <para>If the call is executed by a regular user, the user is authorized to specify only the
+ user's own account and domainId.</para>
+ </listitem>
+ <listitem>
+ <para>If the caller is a domain administrator, CloudStack performs an authorization check to
+ see whether the caller is permitted to view resources for the given account and
+ domainId.</para>
+ </listitem>
+ </itemizedlist>
+ <para>When projectId is passed in, only resources belonging to that project are listed.</para>
+ <para>When domainId is passed in, the call returns only resources belonging to the domain
+ specified. To see the resources of subdomains, use the parameter isRecursive=true. Again, the
+ regular user can see only resources owned by that user, the root administrator can list
+ anything, and a domain administrator is authorized to see only resources of the administrator's
+ own domain and subdomains.</para>
+ <para>To see all resources the caller is authorized to see, except for Project resources, use the
+ parameter listAll=true.</para>
+ <para>To see all Project resources the caller is authorized to see, use the parameter
+ projectId=-1.</para>
+ <para>There is one API command that doesn't fall under the rules above completely: the
+ listTemplates command. This command has its own flags defining the list rules:</para>
+ <informaltable frame="all">
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1"/>
+ <colspec colname="c2"/>
+ <thead>
+ <row>
+ <entry><para>listTemplates Flag</para></entry>
+ <entry><para>Description</para></entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><para>featured</para></entry>
+ <entry><para>Returns templates that have been marked as featured and
+ public.</para></entry>
+ </row>
+ <row>
+ <entry><para>self</para></entry>
+ <entry><para>Returns templates that have been registered or created by the calling
+ user.</para></entry>
+ </row>
+ <row>
+ <entry><para>selfexecutable</para></entry>
+ <entry><para>Same as self, but only returns templates that are ready to be deployed
+ with.</para></entry>
+ </row>
+ <row>
+ <entry><para>sharedexecutable</para></entry>
+ <entry><para>Ready templates that have been granted to the calling user by another
+ user.</para></entry>
+ </row>
+ <row>
+ <entry><para>executable</para></entry>
+ <entry><para>Templates that are owned by the calling user, or public templates, that can
+ be used to deploy a new VM.</para></entry>
+ </row>
+ <row>
+ <entry><para>community</para></entry>
+ <entry><para>Returns templates that have been marked as public but not
+ featured.</para></entry>
+ </row>
+ <row>
+ <entry><para>all</para></entry>
+ <entry><para>Returns all templates (only usable by admins).</para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>The &PRODUCT; UI on a general view will display all resources that the logged-in user is
+ authorized to see, except for project resources. To see the project resources, select the
+ project view.</para>
+ <xi:include href="changed-apicommands-4.0.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/changed-apicommands-4.0.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/changed-apicommands-4.0.xml b/docs/en-US/changed-apicommands-4.0.xml
new file mode 100644
index 0000000..f851bf7
--- /dev/null
+++ b/docs/en-US/changed-apicommands-4.0.xml
@@ -0,0 +1,268 @@
+<?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="changed-apicommands-4.0">
+ <title>Changed API Commands in 4.0</title>
+ <informaltable>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colwidth="1" colname="1" colnum="1"/>
+ <colspec colwidth="2*" colname="2" colnum="2"/>
+ <thead>
+ <row>
+ <entry><para>API Commands</para></entry>
+ <entry><para>Description</para></entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <para>copyTemplate</para>
+ <para>prepareTemplate</para>
+ <para>registerTemplate</para>
+ <para>updateTemplate</para>
+ <para>createProject</para>
+ <para>activateProject</para>
+ <para>suspendProject</para>
+ <para>updateProject</para>
+ <para>listProjectAccounts</para>
+ <para>createVolume</para>
+ <para>migrateVolume</para>
+ <para>attachVolume</para>
+ <para>detachVolume</para>
+ <para>uploadVolume</para>
+ <para>createSecurityGroup</para>
+ <para>registerIso</para>
+ <para>copyIso</para>
+ <para>updateIso</para>
+ <para>createIpForwardingRule</para>
+ <para>listIpForwardingRules</para>
+ <para>createLoadBalancerRule</para>
+ <para>updateLoadBalancerRule</para>
+ <para>createSnapshot</para>
+ </entry>
+ <entry>
+ <para>The commands in this list have a single new response parameter, and no other
+ changes.</para>
+ <para>New response parameter: tags(*)</para>
+ <note>
+ <para>Many other commands also have the new tags(*) parameter in addition to other
+ changes; those commands are listed separately.</para>
+ </note></entry>
+ </row>
+ <row>
+ <entry>
+ <para>rebootVirtualMachine</para>
+ <para>attachIso</para>
+ <para>detachIso</para>
+ <para>listLoadBalancerRuleInstances</para>
+ <para>resetPasswordForVirtualMachine</para>
+ <para>changeServiceForVirtualMachine</para>
+ <para>recoverVirtualMachine</para>
+ <para>startVirtualMachine</para>
+ <para>migrateVirtualMachine</para>
+ <para>deployVirtualMachine</para>
+ <para>assignVirtualMachine</para>
+ <para>updateVirtualMachine</para>
+ <para>restoreVirtualMachine</para>
+ <para>stopVirtualMachine</para>
+ <para>destroyVirtualMachine</para>
+ </entry>
+ <entry>
+ <para>The commands in this list have two new response parameters, and no other
+ changes.</para>
+ <para>New response parameters: keypair, tags(*)</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>listSecurityGroups</para>
+ <para>listFirewallRules</para>
+ <para>listPortForwardingRules</para>
+ <para>listSnapshots</para>
+ <para>listIsos</para>
+ <para>listProjects</para>
+ <para>listTemplates</para>
+ <para>listLoadBalancerRules</para>
+ </entry>
+ <entry><para>The commands in this list have the following new parameters, and no other
+ changes.</para>
+ <para>New request parameter: tags (optional)</para>
+ <para>New response parameter: tags(*)</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>listF5LoadBalancerNetworks</para>
+ <para>listNetscalerLoadBalancerNetworks</para>
+ <para>listSrxFirewallNetworks</para>
+ <para>updateNetwork</para>
+ </entry>
+ <entry>
+ <para>The commands in this list have three new response parameters, and no other
+ changes.</para>
+ <para>New response parameters: canusefordeploy, vpcid, tags(*)</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>createZone</para>
+ <para>updateZone</para>
+ </entry>
+ <entry><para>The commands in this list have the following new parameters, and no other
+ changes.</para>
+ <para>New request parameter: localstorageenabled (optional)</para>
+ <para>New response parameter: localstorageenabled</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>listZones</para></entry>
+ <entry><para>New response parameter: localstorageenabled</para></entry>
+ </row>
+ <row>
+ <entry>
+ <para>rebootRouter</para>
+ <para>changeServiceForRouter</para>
+ <para>startRouter</para>
+ <para>destroyRouter</para>
+ <para>stopRouter</para>
+ </entry>
+ <entry><para>The commands in this list have two new response parameters, and no other
+ changes.</para>
+ <para>New response parameters: vpcid, nic(*)</para></entry>
+ </row>
+ <row>
+ <entry>
+ <para>updateAccount</para>
+ <para>disableAccount</para>
+ <para>listAccounts</para>
+ <para>markDefaultZoneForAccount</para>
+ <para>enableAccount</para>
+ </entry>
+ <entry><para>The commands in this list have three new response parameters, and no other
+ changes.</para>
+ <para>New response parameters: vpcavailable, vpclimit, vpctotal</para></entry>
+ </row>
+ <row>
+ <entry><para>listRouters</para></entry>
+ <entry>
+ <para>New request parameters: forvpc (optional), vpcid (optional)</para>
+ <para>New response parameters: vpcid, nic(*)</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>listNetworkOfferings</para></entry>
+ <entry>
+ <para>New request parameters: forvpc (optional)</para>
+ <para>New response parameters: forvpc </para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>listVolumes</para></entry>
+ <entry>
+ <para>New request parameters: details (optional), tags (optional)</para>
+ <para>New response parameters: tags(*)</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>addTrafficMonitor</para></entry>
+ <entry>
+ <para>New request parameters: excludezones (optional), includezones (optional)</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>createNetwork</para></entry>
+ <entry>
+ <para>New request parameters: vpcid (optional)</para>
+ <para>New response parameters: canusefordeploy, vpcid, tags(*)</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>listPublicIpAddresses</para></entry>
+ <entry>
+ <para>New request parameters: tags (optional), vpcid (optional)</para>
+ <para>New response parameters: vpcid, tags(*)</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>listNetworks</para></entry>
+ <entry>
+ <para>New request parameters: canusefordeploy (optional), forvpc (optional), tags
+ (optional), vpcid (optional)</para>
+ <para>New response parameters: canusefordeploy, vpcid, tags(*)</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>restartNetwork</para></entry>
+ <entry>
+ <para>New response parameters: vpcid, tags(*)</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>enableStaticNat</para></entry>
+ <entry>
+ <para>New request parameter: networkid (optional)</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>createDiskOffering</para></entry>
+ <entry>
+ <para>New request parameter: storagetype (optional)</para>
+ <para>New response parameter: storagetype</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>listDiskOfferings</para></entry>
+ <entry>
+ <para>New response parameter: storagetype</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>updateDiskOffering</para></entry>
+ <entry>
+ <para>New response parameter: storagetype</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>createFirewallRule</para></entry>
+ <entry>
+ <para>Changed request parameters: ipaddressid (old version - optional, new version -
+ required)</para>
+ <para>New response parameter: tags(*)</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>listVirtualMachines</para></entry>
+ <entry>
+ <para>New request parameters: isoid (optional), tags (optional), templateid
+ (optional)</para>
+ <para>New response parameters: keypair, tags(*)</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>updateStorageNetworkIpRange</para></entry>
+ <entry>
+ <para>New response parameters: id, endip, gateway, netmask, networkid, podid, startip,
+ vlan, zoneid</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/choosing_a_deployment_architecture.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/choosing_a_deployment_architecture.xml b/docs/en-US/choosing_a_deployment_architecture.xml
new file mode 100644
index 0000000..ec59d8b
--- /dev/null
+++ b/docs/en-US/choosing_a_deployment_architecture.xml
@@ -0,0 +1,29 @@
+<!DOCTYPE chapter 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.
+-->
+
+<chapter id="choosing_a_deployment_architecture">
+ <title>Choosing a Deployment Architecture</title>
+ <para>The architecture used in a deployment will vary depending on the size and purpose of the deployment. This section contains examples of deployment architecture, including a small-scale deployment useful for test and trial deployments and a fully-redundant large-scale setup for production deployments.</para>
+ <xi:include href="small_scale_deployment.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="large_scale_redundant_setup.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="separate_storage_network.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="multi_node_management_server.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="multi_site_deployment.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</chapter>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/cloudstack.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/cloudstack.xml b/docs/en-US/cloudstack.xml
index 1e2b6c8..906eadc 100644
--- a/docs/en-US/cloudstack.xml
+++ b/docs/en-US/cloudstack.xml
@@ -1,53 +1,56 @@
<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!DOCTYPE chapter 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.
+ 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.
-->
<book>
- <bookinfo>
- <title>CloudStack Guide</title>
- <subtitle>Revised September 18, 2012 10:48 am Pacific</subtitle>
- <productname>Apache CloudStack (incubating)</productname>
- <productnumber>3.0</productnumber>
- <edition>1</edition>
- <pubsnumber></pubsnumber>
- <abstract>
- <para>Complete technical documentation for Apache CloudStack.</para>
- </abstract>
- <corpauthor>
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" />
- </imageobject>
- </inlinemediaobject>
- </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>
+ <xi:include href="Book_Info_Build_All.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="accounts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="user-services-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="ui.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="cloud-infrastructure-concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="provisioning-steps.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="admin-guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="set-up-network-for-users.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="offerings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="xenserver-install.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="kvm-install.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="vmware-install.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="projects.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="virtual-machines.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="working-with-hosts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="working-with-templates.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="work-with-usage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="working-with-system-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="sys-reliability-and-ha.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="manage-cloud.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="api-overview.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="troubleshooting.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="developer-guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-</book>
+ <xi:include href="time-zones.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="event-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="alerts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</book>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/cloudstack_admin.ent
----------------------------------------------------------------------
diff --git a/docs/en-US/cloudstack_admin.ent b/docs/en-US/cloudstack_admin.ent
deleted file mode 100644
index abb1885..0000000
--- a/docs/en-US/cloudstack_admin.ent
+++ /dev/null
@@ -1,22 +0,0 @@
-<!-- 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.
--->
-
-<!ENTITY PRODUCT "CloudStack">
-<!ENTITY BOOKID "Technical Documentation">
-<!ENTITY YEAR "2012">
-<!ENTITY HOLDER "Apache Software Foundation">
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/cloudstack_admin.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/cloudstack_admin.xml b/docs/en-US/cloudstack_admin.xml
deleted file mode 100644
index b8b90ee..0000000
--- a/docs/en-US/cloudstack_admin.xml
+++ /dev/null
@@ -1,51 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE book 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.
--->
-
-<book>
- <bookinfo id="cloudstack_admin">
- <title>&PRODUCT; Admin Guide</title>
- <productname>Apache CloudStack</productname>
- <productnumber>4.0</productnumber>
- <edition>1</edition>
- <pubsnumber></pubsnumber>
- <abstract>
- <para>
- Administration Guide for &PRODUCT;.
- </para>
- </abstract>
- <corpauthor>
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" />
- </imageobject>
- </inlinemediaobject>
- </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>
- <xi:include href="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="admin-guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-</book>
-
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/cloudstack_developers.ent
----------------------------------------------------------------------
diff --git a/docs/en-US/cloudstack_developers.ent b/docs/en-US/cloudstack_developers.ent
deleted file mode 100644
index abb1885..0000000
--- a/docs/en-US/cloudstack_developers.ent
+++ /dev/null
@@ -1,22 +0,0 @@
-<!-- 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.
--->
-
-<!ENTITY PRODUCT "CloudStack">
-<!ENTITY BOOKID "Technical Documentation">
-<!ENTITY YEAR "2012">
-<!ENTITY HOLDER "Apache Software Foundation">
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/cloudstack_developers.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/cloudstack_developers.xml b/docs/en-US/cloudstack_developers.xml
deleted file mode 100644
index d1d50c4..0000000
--- a/docs/en-US/cloudstack_developers.xml
+++ /dev/null
@@ -1,52 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE book 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.
--->
-
-<book>
- <bookinfo id="book-release-notes-3.0.4">
- <title>&PRODUCT; Guide</title>
- <subtitle>Revised August 9, 2012 10:48 pm Pacific</subtitle>
- <productname>Apache CloudStack</productname>
- <productnumber>4.0</productnumber>
- <edition>1</edition>
- <pubsnumber></pubsnumber>
- <abstract>
- <para>
- Complete technical documentation of &PRODUCT;.
- </para>
- </abstract>
- <corpauthor>
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" />
- </imageobject>
- </inlinemediaobject>
- </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>
- <xi:include href="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="developer-guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-</book>
-
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/cloudstack_installation.ent
----------------------------------------------------------------------
diff --git a/docs/en-US/cloudstack_installation.ent b/docs/en-US/cloudstack_installation.ent
deleted file mode 100644
index abb1885..0000000
--- a/docs/en-US/cloudstack_installation.ent
+++ /dev/null
@@ -1,22 +0,0 @@
-<!-- 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.
--->
-
-<!ENTITY PRODUCT "CloudStack">
-<!ENTITY BOOKID "Technical Documentation">
-<!ENTITY YEAR "2012">
-<!ENTITY HOLDER "Apache Software Foundation">
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/cloudstack_installation.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/cloudstack_installation.xml b/docs/en-US/cloudstack_installation.xml
deleted file mode 100644
index 06ba791..0000000
--- a/docs/en-US/cloudstack_installation.xml
+++ /dev/null
@@ -1,50 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE book 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.
--->
-
-<book>
- <bookinfo id="book-installation">
- <title>&PRODUCT; Installation Guide</title>
- <productname>Apache CloudStack</productname>
- <productnumber>4.0</productnumber>
- <edition>1</edition>
- <pubsnumber></pubsnumber>
- <abstract>
- <para>
- Installation Guide for &PRODUCT;.
- </para>
- </abstract>
- <corpauthor>
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" />
- </imageobject>
- </inlinemediaobject>
- </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>
- <xi:include href="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-</book>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/compute-disk-service-offerings.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/compute-disk-service-offerings.xml b/docs/en-US/compute-disk-service-offerings.xml
index 2469dfe..1fd2a91 100644
--- a/docs/en-US/compute-disk-service-offerings.xml
+++ b/docs/en-US/compute-disk-service-offerings.xml
@@ -5,33 +5,32 @@
]>
<!-- 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.
+ 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="compute-disk-service-offerings">
<title>Compute and Disk Service Offerings</title>
- <para>A service offering is a set of virtual hardware features such as CPU core count and speed, memory, and disk size. The CloudPlatform administrator can set up various offerings, and then end users choose from the available offerings when they create a new VM. A service offering includes the following elements:</para>
+ <para>A service offering is a set of virtual hardware features such as CPU core count and speed, memory, and disk size. The &PRODUCT; administrator can set up various offerings, and then end users choose from the available offerings when they create a new VM. A service offering includes the following elements:</para>
<itemizedlist>
<listitem><para>CPU, memory, and network resource guarantees</para></listitem>
<listitem><para>How resources are metered</para></listitem>
<listitem><para>How the resource usage is charged</para></listitem>
<listitem><para>How often the charges are generated</para></listitem>
</itemizedlist>
- <para>For example, one service offering might allow users to create a virtual machine instance that is equivalent to a 1 GHz Intel Core 2 CPU, with 1 GB memory at $0.20/hour, with network traffic metered at $0.10/GB. Based on the user’s selected offering, CloudPlatform emits usage records that can be integrated with billing systems. CloudPlatform separates service offerings into compute offerings and disk offerings. The computing service offering specifies:</para>
+ <para>For example, one service offering might allow users to create a virtual machine instance that is equivalent to a 1 GHz Intel® Core™ 2 CPU, with 1 GB memory at $0.20/hour, with network traffic metered at $0.10/GB. Based on the user’s selected offering, &PRODUCT; emits usage records that can be integrated with billing systems. &PRODUCT; separates service offerings into compute offerings and disk offerings. The computing service offering specifies:</para>
<itemizedlist>
<listitem><para>Guest CPU</para></listitem>
<listitem><para>Guest RAM</para></listitem>
@@ -43,4 +42,9 @@
<listitem><para>Disk size (optional). An offering without a disk size will allow users to pick their own</para></listitem>
<listitem><para>Tags on the data disk</para></listitem>
</itemizedlist>
+ <xi:include href="creating-compute-offerings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="creating-disk-offerings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="modify-delete-service-offerings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
+
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/configure-acl.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/configure-acl.xml b/docs/en-US/configure-acl.xml
new file mode 100644
index 0000000..299196c
--- /dev/null
+++ b/docs/en-US/configure-acl.xml
@@ -0,0 +1,139 @@
+<?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="configure-acl">
+ <title>Configuring Access Control List</title>
+ <para>Define Network Access Control List (ACL) on the VPC virtual router to control incoming
+ (ingress) and outgoing (egress) traffic between the VPC tiers, and the tiers and Internet. By
+ default, all incoming and outgoing traffic to the guest networks is blocked. To open the ports,
+ you must create a new network ACL. The network ACLs can be created for the tiers only if the
+ NetworkACL service is supported.</para>
+ <orderedlist>
+ <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>In the Select view, select VPC.</para>
+ <para>All the VPCs that you have created for the account is listed in the page.</para>
+ </listitem>
+ <listitem>
+ <para>Click the Settings icon.</para>
+ <para>The following options are displayed.</para>
+ <itemizedlist>
+ <listitem>
+ <para>IP Addresses</para>
+ </listitem>
+ <listitem>
+ <para>Gateways</para>
+ </listitem>
+ <listitem>
+ <para>Site-to-Site VPN</para>
+ </listitem>
+ <listitem>
+ <para>Network ACLs</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>Select Network ACLs.</para>
+ <para>The Network ACLs page is displayed.</para>
+ </listitem>
+ <listitem>
+ <para>Click Add Network ACLs.</para>
+ <para>To add an ACL rule, fill in the following fields to specify what kind of network traffic
+ is allowed in this tier. </para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">CIDR</emphasis>: The CIDR acts as the Source CIDR for the
+ Ingress rules, and Destination CIDR for the Egress rules. To accept traffic only from or
+ to the IP addresses within a particular address block, enter a CIDR or a comma-separated
+ list of CIDRs. The CIDR is the base IP address of the incoming traffic. For example,
+ 192.168.0.0/22. To allow all CIDRs, set to 0.0.0.0/0.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Protocol</emphasis>: The networking protocol that sources use
+ to send traffic to the tier. The TCP and UDP protocols are typically used for data
+ exchange and end-user communications. The ICMP protocol is typically used to send error
+ messages or network monitoring data.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Start Port</emphasis>, <emphasis role="bold">End
+ Port</emphasis> (TCP, UDP only): A range of listening ports that are the destination
+ for the incoming traffic. If you are opening a single port, use the same number in both
+ fields.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Select Tier</emphasis>: Select the tier for which you want to
+ add this ACL rule.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">ICMP Type</emphasis>, <emphasis role="bold">ICMP
+ Code</emphasis> (ICMP only): The type of message and error code that will be
+ sent.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Traffic Type</emphasis>: Select the traffic type you want to
+ apply. </para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Egress</emphasis>: To add an egress rule, select Egress
+ from the Traffic type drop-down box and click Add. This specifies what type of
+ traffic is allowed to be sent out of VM instances in this tier. If no egress rules
+ are specified, all traffic from the tier is allowed out at the VPC virtual router.
+ Once egress rules are specified, only the traffic specified in egress rules and the
+ responses to any traffic that has been allowed in through an ingress rule are
+ allowed out. No egress rule is required for the VMs in a tier to communicate with
+ each other.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Ingress</emphasis>: To add an ingress rule, select Ingress
+ from the Traffic type drop-down box and click Add. This specifies what network
+ traffic is allowed into the VM instances in this tier. If no ingress rules are
+ specified, then no traffic will be allowed in, except for responses to any traffic
+ that has been allowed out through an egress rule.</para>
+ </listitem>
+ </itemizedlist>
+ <note>
+ <para>By default, all incoming and outgoing traffic to the guest networks is blocked. To
+ open the ports, create a new network ACL.</para>
+ </note>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>Click Add. The ACL rule is added.</para>
+ <para>To view the list of ACL rules you have added, click the desired tier from the Network
+ ACLs page, then select the Network ACL tab.</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="./images/network-acl.png"/>
+ </imageobject>
+ <textobject>
+ <phrase>network-acl.png: adding, editing, deleting an ACL rule.</phrase>
+ </textobject>
+ </mediaobject>
+ <para>You can edit the tags assigned to the ACL rules and delete the ACL rules you have
+ created. Click the appropriate button in the Actions column.</para>
+ </listitem>
+ </orderedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/configure-guest-traffic-in-advanced-zone.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/configure-guest-traffic-in-advanced-zone.xml b/docs/en-US/configure-guest-traffic-in-advanced-zone.xml
index 95df473..fb66850 100644
--- a/docs/en-US/configure-guest-traffic-in-advanced-zone.xml
+++ b/docs/en-US/configure-guest-traffic-in-advanced-zone.xml
@@ -3,48 +3,77 @@
<!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.
+ 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="configure-guest-traffic-in-advanced-zone">
- <title>Configure Guest Traffic in an Advanced Zone</title>
- <para>These steps assume you have already logged in to the &PRODUCT; UI. To configure the base guest network:</para>
- <orderedlist>
- <listitem><para>In the left navigation, choose Infrastructure. On Zones, click View More, then click the zone to which you want to add a network.</para></listitem>
- <listitem><para>Click the Network tab.</para></listitem>
- <listitem><para>Click Add network.</para></listitem>
- <listitem><para>Provide the following information:</para>
- <itemizedlist>
- <listitem><para>Name. The name of the network. This will be user-visible</para></listitem>
- <listitem><para>Description: The description of the network. This will be user-visible</para></listitem>
- <listitem><para>VLAN ID: Enter an administrator-configured VLAN ID so you can create different networks for use by different VM users in the zone</para></listitem>
- <listitem><para>Scope: Choose account-specific or domain-specific if you would like to make the network accessible to only a single account or domain. Choose zone-wide if all accounts with access to the zone should be able to access the network.</para></listitem>
- <listitem><para>Domain/Account: If Scope is account-specific, enter the domain and account name for the account</para></listitem>
- <listitem><para>Network offering: If the administrator has configured multiple network offerings, select the one you want to use for this network</para></listitem>
- <listitem><para>Gateway: The gateway that the guests should use</para></listitem>
- <listitem><para>Netmask: The netmask in use on the subnet the guests will use</para></listitem>
- <listitem><para>Start IP/End IP: Enter the first and last IP addresses that define a range that &PRODUCT; can assign to guests. If one NIC is used, these IPs should be in the same CIDR as the pod CIDR. If multiple NICs are used, they may be in a different subnet.</para></listitem>
- <listitem><para>Network Domain: (Optional) If you want to assign a special domain name to this network, specify the DNS suffix.</para></listitem>
- </itemizedlist>
+ <title>Configure Guest Traffic in an Advanced Zone</title>
+ <para>These steps assume you have already logged in to the &PRODUCT; UI. To configure the base
+ guest network:</para>
+ <orderedlist>
+ <listitem>
+ <para>In the left navigation, choose Infrastructure. On Zones, click View More, then click the
+ zone to which you want to add a network.</para>
+ </listitem>
+ <listitem>
+ <para>Click the Network tab.</para>
+ </listitem>
+ <listitem>
+ <para>Click Add guest network.</para>
+ <para>The Add guest network window is displayed:</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="./images/add-guest-network.png"/>
+ </imageobject>
+ <textobject>
+ <phrase>networksetupzone.png: Depicts network setup in a single zone</phrase>
+ </textobject>
+ </mediaobject>
+ </listitem>
+ <listitem>
+ <para>Provide the following information:</para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Name</emphasis>. The name of the network. This will be
+ user-visible</para>
</listitem>
- <listitem><para>Click OK.</para></listitem>
- </orderedlist>
-
-
- </section>
+ <listitem>
+ <para><emphasis role="bold">Display Text</emphasis>: The description of the network. This
+ will be user-visible</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Zone</emphasis>: The zone in which you are configuring the
+ guest network.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Network offering</emphasis>: If the administrator has
+ configured multiple network offerings, select the one you want to use for this
+ network</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Guest Gateway</emphasis>: The gateway that the guests should
+ use</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Guest Netmask</emphasis>: The netmask in use on the subnet the
+ guests will use</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>Click OK.</para>
+ </listitem>
+ </orderedlist>
+</section>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/configure-public-traffic-in-an-advanced-zone.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/configure-public-traffic-in-an-advanced-zone.xml b/docs/en-US/configure-public-traffic-in-an-advanced-zone.xml
index 960a1a3..7a61cd3 100644
--- a/docs/en-US/configure-public-traffic-in-an-advanced-zone.xml
+++ b/docs/en-US/configure-public-traffic-in-an-advanced-zone.xml
@@ -3,7 +3,6 @@
<!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
@@ -11,9 +10,7 @@
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
@@ -21,8 +18,8 @@
specific language governing permissions and limitations
under the License.
-->
-
<section id="configure-public-traffic-in-an-advanced-zone">
- <title>Configure Public Traffic in an Advanced Zone</title>
- <para>In a zone that uses advanced networking, you need to configure at least one range of IP addresses for Internet traffic.</para>
-</section>
+ <title>Configure Public Traffic in an Advanced Zone</title>
+ <para>In a zone that uses advanced networking, you need to configure at least one range of IP
+ addresses for Internet traffic.</para>
+</section>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/configuring-projects.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/configuring-projects.xml b/docs/en-US/configuring-projects.xml
index e18843d..0f84dd8 100644
--- a/docs/en-US/configuring-projects.xml
+++ b/docs/en-US/configuring-projects.xml
@@ -1,9 +1,4 @@
<?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
@@ -21,9 +16,17 @@
specific language governing permissions and limitations
under the License.
-->
-
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
<section id="configuring-projects">
<title>Configuring Projects</title>
- <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>
+ <para>Before CloudPlatform users start using projects, the CloudPlatform administrator must set
+ up various systems to support them, including membership invitations, limits on project
+ resources, and controls on who can create projects.</para>
+ <xi:include href="set-up-invitations.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="set-resource-limits-for-projects.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="set-projects-creator-permissions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/create-vpn-connection-vpc.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/create-vpn-connection-vpc.xml b/docs/en-US/create-vpn-connection-vpc.xml
new file mode 100644
index 0000000..1fba09e
--- /dev/null
+++ b/docs/en-US/create-vpn-connection-vpc.xml
@@ -0,0 +1,103 @@
+<?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="create-vpn-connection-vpc">
+ <title>Creating a VPN Connection</title>
+ <orderedlist>
+ <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>In the Select view, select VPC.</para>
+ <para>All the VPCs that you create for the account are listed in the page.</para>
+ </listitem>
+ <listitem>
+ <para>Click the Configure button of the VPC to which you want to deploy the VMs.</para>
+ <para>The VPC page is displayed where all the tiers you created are listed in a
+ diagram.</para>
+ </listitem>
+ <listitem>
+ <para>Click the Settings icon.</para>
+ <para>The following options are displayed.</para>
+ <itemizedlist>
+ <listitem>
+ <para>IP Addresses</para>
+ </listitem>
+ <listitem>
+ <para>Gateways</para>
+ </listitem>
+ <listitem>
+ <para>Site-to-Site VPN</para>
+ </listitem>
+ <listitem>
+ <para>Network ASLs</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>Select Site-to-Site VPN.</para>
+ <para>The Site-to-Site VPN page is displayed.</para>
+ </listitem>
+ <listitem>
+ <para>From the Select View drop-down, ensure that VPN Connection is selected.</para>
+ </listitem>
+ <listitem>
+ <para>Click Create VPN Connection.</para>
+ <para> The Create VPN Connection dialog is displayed:</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="./images/create-vpn-connection.png"/>
+ </imageobject>
+ <textobject>
+ <phrase>createvpnconnection.png: creating a vpn connection to the customer
+ gateway.</phrase>
+ </textobject>
+ </mediaobject>
+ </listitem>
+ <listitem>
+ <para>Select the desired customer gateway, then click OK to confirm.</para>
+ <para>Within a few moments, the VPN Connection is displayed.</para>
+ <para>The following information on the VPN connection is displayed:</para>
+ <itemizedlist>
+ <listitem>
+ <para>IP Address</para>
+ </listitem>
+ <listitem>
+ <para>Gateway</para>
+ </listitem>
+ <listitem>
+ <para>State</para>
+ </listitem>
+ <listitem>
+ <para>IPSec Preshared Key</para>
+ </listitem>
+ <listitem>
+ <para>IKE Policy</para>
+ </listitem>
+ <listitem>
+ <para>ESP Policy</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </orderedlist>
+</section>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/create-vpn-customer-gateway.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/create-vpn-customer-gateway.xml b/docs/en-US/create-vpn-customer-gateway.xml
new file mode 100644
index 0000000..bf56e36
--- /dev/null
+++ b/docs/en-US/create-vpn-customer-gateway.xml
@@ -0,0 +1,191 @@
+<?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="create-vpn-customer-gateway">
+ <title>Creating and Updating a VPN Customer Gateway</title>
+ <note>
+ <para>A VPN customer gateway can be connected to only one VPN gateway at a time.</para>
+ </note>
+ <para>To add a VPN Customer Gateway:</para>
+ <orderedlist>
+ <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>In the Select view, select VPN Customer Gateway.</para>
+ </listitem>
+ <listitem>
+ <para>Click Add site-to-site VPN.</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="./images/add-vpn-customer-gateway.png"/>
+ </imageobject>
+ <textobject>
+ <phrase>addvpncustomergateway.png: adding a customer gateway.</phrase>
+ </textobject>
+ </mediaobject>
+ <para>Provide the following information:</para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Name</emphasis>: A unique name for the VPN customer gateway
+ you create.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Gateway</emphasis>: The IP address for the remote
+ gateway.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">CIDR list</emphasis>: The guest CIDR list of the remote
+ subnets. Enter a CIDR or a comma-separated list of CIDRs. Ensure that a guest CIDR list
+ is not overlapped with the VPC’s CIDR, or another guest CIDR. The CIDR must be
+ RFC1918-compliant.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">IPsec Preshared Key</emphasis>: Preshared keying is a method
+ where the endpoints of the VPN share a secret key. This key value is used to
+ authenticate the customer gateway and the VPC VPN gateway to each other. </para>
+ <note>
+ <para>The IKE peers (VPN end points) authenticate each other by computing and sending a
+ keyed hash of data that includes the Preshared key. If the receiving peer is able to
+ create the same hash independently by using its Preshared key, it knows that both
+ peers must share the same secret, thus authenticating the customer gateway.</para>
+ </note>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">IKE Encryption</emphasis>: The Internet Key Exchange (IKE)
+ policy for phase-1. The supported encryption algorithms are AES128, AES192, AES256, and
+ 3DES. Authentication is accomplished through the Preshared Keys.</para>
+ <note>
+ <para>The phase-1 is the first phase in the IKE process. In this initial negotiation
+ phase, the two VPN endpoints agree on the methods to be used to provide security for
+ the underlying IP traffic. The phase-1 authenticates the two VPN gateways to each
+ other, by confirming that the remote gateway has a matching Preshared Key.</para>
+ </note>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">IKE Hash</emphasis>: The IKE hash for phase-1. The supported
+ hash algorithms are SHA1 and MD5.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">IKE DH</emphasis>: A public-key cryptography protocol which
+ allows two parties to establish a shared secret over an insecure communications channel.
+ The 1536-bit Diffie-Hellman group is used within IKE to establish session keys. The
+ supported options are None, Group-5 (1536-bit) and Group-2 (1024-bit).</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">ESP Encryption</emphasis>: Encapsulating Security Payload
+ (ESP) algorithm within phase-2. The supported encryption algorithms are AES128, AES192,
+ AES256, and 3DES.</para>
+ <note>
+ <para>The phase-2 is the second phase in the IKE process. The purpose of IKE phase-2 is
+ to negotiate IPSec security associations (SA) to set up the IPSec tunnel. In phase-2,
+ new keying material is extracted from the Diffie-Hellman key exchange in phase-1, to
+ provide session keys to use in protecting the VPN data flow.</para>
+ </note>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">ESP Hash</emphasis>: Encapsulating Security Payload (ESP) hash
+ for phase-2. Supported hash algorithms are SHA1 and MD5.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Perfect Forward Secrecy</emphasis>: Perfect Forward Secrecy
+ (or PFS) is the property that ensures that a session key derived from a set of long-term
+ public and private keys will not be compromised. This property enforces a new
+ Diffie-Hellman key exchange. It provides the keying material that has greater key
+ material life and thereby greater resistance to cryptographic attacks. The available
+ options are None, Group-5 (1536-bit) and Group-2 (1024-bit). The security of the key
+ exchanges increase as the DH groups grow larger, as does the time of the
+ exchanges.</para>
+ <note>
+ <para>When PFS is turned on, for every negotiation of a new phase-2 SA the two gateways
+ must generate a new set of phase-1 keys. This adds an extra layer of protection that
+ PFS adds, which ensures if the phase-2 SA’s have expired, the keys used for new
+ phase-2 SA’s have not been generated from the current phase-1 keying material.</para>
+ </note>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">IKE Lifetime (seconds)</emphasis>: The phase-1 lifetime of the
+ security association in seconds. Default is 86400 seconds (1 day). Whenever the time
+ expires, a new phase-1 exchange is performed.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">ESP Lifetime (seconds)</emphasis>: The phase-2 lifetime of the
+ security association in seconds. Default is 3600 seconds (1 hour). Whenever the value is
+ exceeded, a re-key is initiated to provide a new IPsec encryption and authentication
+ session keys.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Dead Peer Detection</emphasis>: A method to detect an
+ unavailable Internet Key Exchange (IKE) peer. Select this option if you want the virtual
+ router to query the liveliness of its IKE peer at regular intervals. It’s recommended to
+ have the same configuration of DPD on both side of VPN connection.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>Click OK.</para>
+ </listitem>
+ </orderedlist>
+ <formalpara>
+ <title>Updating and Removing a VPN Customer Gateway</title>
+ <para>You can update a customer gateway either with no VPN connection, or related VPN connection
+ is in error state.</para>
+ </formalpara>
+ <orderedlist>
+ <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>In the Select view, select VPN Customer Gateway.</para>
+ </listitem>
+ <listitem>
+ <para>Select the VPN customer gateway you want to work with.</para>
+ </listitem>
+ <listitem>
+ <para>To modify the required parameters, click the Edit VPN Customer Gateway button<inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="./images/edit-icon.png"/>
+ </imageobject>
+ <textobject>
+ <phrase>edit.png: button to edit a VPN customer gateway</phrase>
+ </textobject>
+ </inlinemediaobject></para>
+ </listitem>
+ <listitem>
+ <para>To remove the VPN customer gateway, click the Delete VPN Customer Gateway button<inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="./images/delete-button.png"/>
+ </imageobject>
+ <textobject>
+ <phrase>delete.png: button to remove a VPN customer gateway</phrase>
+ </textobject>
+ </inlinemediaobject></para>
+ </listitem>
+ <listitem>
+ <para>Click OK.</para>
+ </listitem>
+ </orderedlist>
+</section>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/create-vpn-gateway-for-vpc.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/create-vpn-gateway-for-vpc.xml b/docs/en-US/create-vpn-gateway-for-vpc.xml
new file mode 100644
index 0000000..396a7d9
--- /dev/null
+++ b/docs/en-US/create-vpn-gateway-for-vpc.xml
@@ -0,0 +1,80 @@
+<?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="create-vpn-gateway-for-vpc">
+ <title>Creating a VPN gateway for the VPC</title>
+ <orderedlist>
+ <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>In the Select view, select VPC.</para>
+ <para>All the VPCs that you have created for the account is listed in the page.</para>
+ </listitem>
+ <listitem>
+ <para>Click the Configure button of the VPC to which you want to deploy the VMs.</para>
+ <para>The VPC page is displayed where all the tiers you created are listed in a
+ diagram.</para>
+ </listitem>
+ <listitem>
+ <para>Click the Settings icon.</para>
+ <para>The following options are displayed.</para>
+ <itemizedlist>
+ <listitem>
+ <para>IP Addresses</para>
+ </listitem>
+ <listitem>
+ <para>Gateways</para>
+ </listitem>
+ <listitem>
+ <para>Site-to-Site VPN</para>
+ </listitem>
+ <listitem>
+ <para>Network ACLs</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>Select Site-to-Site VPN.</para>
+ <para>If you are creating the VPN gateway for the first time, selecting Site-to-Site VPN
+ prompts you to create a VPN gateway.</para>
+ </listitem>
+ <listitem>
+ <para>In the confirmation dialog, click Yes to confirm.</para>
+ <para>Within a few moments, the VPN gateway is created. You will be prompted to view the
+ details of the VPN gateway you have created. Click Yes to confirm.</para>
+ <para>The following details are displayed in the VPN Gateway page:</para>
+ <itemizedlist>
+ <listitem>
+ <para>IP Address</para>
+ </listitem>
+ <listitem>
+ <para>Account</para>
+ </listitem>
+ <listitem>
+ <para>Domain</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </orderedlist>
+</section>
\ No newline at end of file