Repository: cloudstack-docs Updated Branches: refs/heads/master 5d2d72747 -> 45f88741d
CLOUDSTACK-5287 CLOUDSTACK-5288 CLOUDSTACK-5972 Project: http://git-wip-us.apache.org/repos/asf/cloudstack-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/cloudstack-docs/commit/45f88741 Tree: http://git-wip-us.apache.org/repos/asf/cloudstack-docs/tree/45f88741 Diff: http://git-wip-us.apache.org/repos/asf/cloudstack-docs/diff/45f88741 Branch: refs/heads/master Commit: 45f88741d0b4fe2c03f55e8c1bb13b916b445977 Parents: 5d2d727 Author: radhikap <[email protected]> Authored: Tue Mar 25 23:07:39 2014 +0530 Committer: radhikap <[email protected]> Committed: Tue Mar 25 23:07:39 2014 +0530 ---------------------------------------------------------------------- en-US/configure-vpn-vpc.xml | 202 +++++++++++++++++++++-------------- en-US/secondary-storage-add.xml | 137 ++++++++++++------------ en-US/vr-monitor.xml | 25 +++-- en-US/vr-upgrade.xml | 3 +- 4 files changed, 207 insertions(+), 160 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/45f88741/en-US/configure-vpn-vpc.xml ---------------------------------------------------------------------- diff --git a/en-US/configure-vpn-vpc.xml b/en-US/configure-vpn-vpc.xml index 379b850..fecb5b5 100644 --- a/en-US/configure-vpn-vpc.xml +++ b/en-US/configure-vpn-vpc.xml @@ -26,89 +26,131 @@ <para>On enabling Remote Access VPN on a VPC, any VPN client present outside the VPC can access VMs present in the VPC by using the Remote VPN connection. The VPN client can be present anywhere except inside the VPC on which the user enabled the Remote Access VPN service. </para> - <para>To enable VPN for a VPC:</para> - <orderedlist> - <listitem> - <para>Log in as a user or administrator to the &PRODUCT; UI.</para> - </listitem> - <listitem> - <para>In the left navigation, click 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.</para> - <para>For each tier, the following options are displayed:</para> - <itemizedlist> - <listitem> - <para>Internal LB</para> - </listitem> - <listitem> - <para>Public LB IP</para> - </listitem> - <listitem> - <para>Static NAT</para> - </listitem> - <listitem> - <para>Virtual Machines</para> - </listitem> - <listitem> - <para>CIDR</para> - </listitem> - </itemizedlist> - <para>The following router information is displayed:</para> - <itemizedlist> - <listitem> - <para>Private Gateways</para> - </listitem> - <listitem> - <para>Public IP Addresses</para> - </listitem> - <listitem> - <para>Site-to-Site VPNs</para> - </listitem> - <listitem> - <para>Network ACL Lists</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>In the Router node, select Public IP Addresses.</para> - <para>The IP Addresses page is displayed.</para> - </listitem> - <listitem> - <para>Click Source NAT IP address.</para> - </listitem> - <listitem> - <para>Click the Enable VPN button. <inlinemediaobject> + <section id="enable-vpn-vpc"> + <title>Enabling or Disabling Remote Access VPN for a VPC</title> + <orderedlist> + <listitem> + <para>Log in as a user or administrator to the &PRODUCT; UI.</para> + </listitem> + <listitem> + <para>In the left navigation, click 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.</para> + <para>For each tier, the following options are displayed:</para> + <itemizedlist> + <listitem> + <para>Internal LB</para> + </listitem> + <listitem> + <para>Public LB IP</para> + </listitem> + <listitem> + <para>Static NAT</para> + </listitem> + <listitem> + <para>Virtual Machines</para> + </listitem> + <listitem> + <para>CIDR</para> + </listitem> + </itemizedlist> + <para>The following router information is displayed:</para> + <itemizedlist> + <listitem> + <para>Private Gateways</para> + </listitem> + <listitem> + <para>Public IP Addresses</para> + </listitem> + <listitem> + <para>Site-to-Site VPNs</para> + </listitem> + <listitem> + <para>Network ACL Lists</para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para>In the Router node, select Public IP Addresses.</para> + <para>The IP Addresses page is displayed.</para> + </listitem> + <listitem> + <para>Click Source NAT IP address.</para> + </listitem> + <listitem> + <para>Click the Enable VPN button. <inlinemediaobject> + <imageobject> + <imagedata fileref="./images/vpn-icon.png"/> + </imageobject> + <textobject> + <phrase>vpn-icon.png: button to enable VPN</phrase> + </textobject> + </inlinemediaobject></para> + <para>Click OK to confirm. The IPsec key is displayed in a pop-up window.</para> + <para>To disable, click the Disable VPN button.<inlinemediaobject> <imageobject> - <imagedata fileref="./images/vpn-icon.png"/> + <imagedata fileref="./images/disable-vpnvpc.png"/> </imageobject> <textobject> - <phrase>vpn-icon.png: button to enable VPN</phrase> + <phrase>disable-vpnvp.png: button to disable VPN</phrase> </textobject> </inlinemediaobject></para> - <para>Click OK to confirm. The IPsec key is displayed in a pop-up window.</para> - </listitem> - </orderedlist> - <para>Now, you need to add the VPN users.</para> - <orderedlist> - <listitem> - <para>Click the Source NAT IP.</para> - </listitem> - <listitem> - <para>Select the VPN tab.</para> - </listitem> - <listitem> - <para>Add the username and the corresponding password of the user you wanted to add.</para> - </listitem> - <listitem> - <para>Click Add.</para> - </listitem> - <listitem> - <para>Repeat the same steps to add the VPN users.</para> - </listitem> - </orderedlist> + </listitem> + <listitem> + <para>Now, continue with <xref linkend="add-vpc-vpnuser"/>.</para> + </listitem> + </orderedlist> + </section> + <section id="add-vpc-vpnuser"> + <title>Adding Remote Access VPN Users</title> + <orderedlist> + <listitem> + <para>Click the Source NAT IP.</para> + </listitem> + <listitem> + <para>Select the VPN tab.</para> + </listitem> + <listitem> + <para>Add the username and the corresponding password of the user you wanted to add.</para> + </listitem> + <listitem> + <para>Click Add.</para> + </listitem> + <listitem> + <para>Repeat the same steps to add the VPN users.</para> + </listitem> + </orderedlist> + </section> + <section id="disable-vpc-vpn"> + <title>Removing Remote Access VPN Users</title> + <orderedlist> + <listitem> + <para>Click the Source NAT IP.</para> + </listitem> + <listitem> + <para>Select the VPN tab.</para> + </listitem> + <listitem> + <para>Locate the user you want to remove.</para> + </listitem> + <listitem> + <para>Click Delete User.<inlinemediaobject> + <imageobject> + <imagedata fileref="./images/remove-user.png"/> + </imageobject> + <textobject> + <phrase>remove-user.png: button to remove a VPN user</phrase> + </textobject> + </inlinemediaobject></para> + </listitem> + <listitem> + <para>Repeat the same steps to remove the VPN users.</para> + </listitem> + </orderedlist> + </section> </section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/45f88741/en-US/secondary-storage-add.xml ---------------------------------------------------------------------- diff --git a/en-US/secondary-storage-add.xml b/en-US/secondary-storage-add.xml index acc94fb..4f06987 100644 --- a/en-US/secondary-storage-add.xml +++ b/en-US/secondary-storage-add.xml @@ -5,111 +5,110 @@ ]> <!-- 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="secondary-storage-add"> - <title>Add Secondary Storage</title> - <section id="sys-require-secondary-storage"> - <title>System Requirements for Secondary Storage</title> - <itemizedlist> - <listitem> - <para>NFS storage appliance or Linux NFS server</para> - </listitem> - <listitem> - <para>SMB/CIFS (Hyper-V)</para> - </listitem> - <listitem><para>(Optional) OpenStack Object Storage (Swift) (see http://swift.openstack.org)</para></listitem> - <listitem><para>100GB minimum capacity</para></listitem> - <listitem><para>A secondary storage device must be located in the same zone as the guest VMs it serves.</para></listitem> - <listitem><para>Each Secondary Storage server must be available to all hosts in the zone.</para></listitem> - </itemizedlist> - </section> - <section id="adding-secondary-storage"> - <title>Adding Secondary Storage</title> + <title>Adding Secondary Storage</title> + <note><para>Be sure there is nothing stored on the server. Adding the server to &PRODUCT; will destroy any existing data.</para></note> + <para/> <para>When you create a new zone, the first secondary storage is added as part of that procedure. You can add secondary storage servers at any time to add more servers to an existing zone.</para> - <warning><para>Ensure that nothing is stored on the server. Adding the server to &PRODUCT; will destroy any - existing data.</para></warning> - <para></para> <orderedlist> - <listitem><para>To prepare for the zone-based Secondary Staging Store, you should have created and mounted an - NFS share during Management Server installation. <phrase condition="install">See <xref - linkend="prepare-nfs-shares"/>.</phrase><phrase condition="admin">See Preparing NFS - Shares in the Installation Guide.</phrase></para> - <para>If you are using an Hyper-V host, ensure that you have created a SMB share.</para></listitem> - <listitem><para>Make sure you prepared the system VM template during Management Server installation. <phrase condition="install">See <xref linkend="prepare-system-vm-template" />.</phrase><phrase condition="admin">See Prepare the System VM Template in the Installation Guide.</phrase></para></listitem> + <listitem><para>To prepare for the zone-based Secondary Staging Store, you should have created and mounted an NFS share during Management Server installation.</para></listitem> + <listitem><para>Make sure you prepared the system VM template during Management Server installation.</para></listitem> <listitem><para>Log in to the &PRODUCT; UI as root administrator.</para></listitem> <listitem><para>In the left navigation bar, click Infrastructure.</para></listitem> <listitem><para>In Secondary Storage, click View All.</para></listitem> <listitem><para>Click Add Secondary Storage.</para></listitem> <listitem><para>Fill in the following fields:</para> <itemizedlist> - <listitem><para>Name. Give the storage a descriptive name.</para></listitem> - <listitem><para>Provider. Choose S3, Swift, NFS, or CIFS then fill in the related fields which appear. The - fields will vary depending on the storage provider; for more information, consult the - provider's documentation (such as the S3 or Swift website). NFS can be used for - zone-based storage, and the others for region-wide storage. For Hyper-V, select - SMB/CIFS.</para> - <warning><para>Heterogeneous Secondary Storage is not supported in Regions. You can use only a single NFS, - S3, or Swift account per region.</para></warning> - <para></para></listitem> - <listitem><para>Create NFS Secondary Staging Store. This box must always be checked.</para> - <warning><para>Even if the UI allows you to uncheck this box, do not do so. - This checkbox and the three fields below it must be filled in. - Even when Swift or S3 is used as the secondary storage provider, an NFS - staging storage in each zone is still required.</para></warning><para/></listitem> - <listitem><para>Zone. The zone where the NFS Secondary Staging Store is to be located.</para></listitem> + <listitem><para><emphasis role="bold">Name</emphasis>: Give the storage a descriptive name.</para></listitem> + <listitem><para><emphasis role="bold">Provider</emphasis>: Choose the type of storage provider (such as S3, + Swift, or NFS). NFS can be used for zone-based storage, and the others for region-wide + object storage. Depending on which provider you choose, additional fields will appear. + Fill in all the required fields for your selected provider. For more information, + consult the provider's documentation (such as the S3 or Swift website). </para> + <para>For Hyper-V, select SMB/CIFS.</para> + <warning><para>You can use only a single region-wide object storage account per region. + For example, you can not mix both Swift and S3, or use S3 accounts from multiple different users.</para></warning><para/></listitem> + <listitem><para><emphasis role="bold">Create NFS Secondary Staging Store</emphasis>: Be sure this box is + checked, unless the zone already contains a secondary staging store. This would only be + the case if you are upgrading an existing NFS secondary storage into an object storage, + as described in <phrase condition="install"><xref linkend="upgrading-to-object-storage" + />.</phrase> + <phrase condition="admin">Upgrading from NFS to Object Storage in the Installation + Guide.</phrase> In this case, you can skip the rest of the fields described below + (Zone, NFS Server, and Path).</para> + <warning><para>If you are setting up a new zone, be sure the box is checked. + This checkbox and the three fields below it must be filled in. + Even when object storage (such as S3) is used as the secondary storage provider, an NFS + staging storage in each zone is still required.</para></warning><para/></listitem> + <listitem> + <para><emphasis role="bold">Zone</emphasis>: The zone where the NFS Secondary Staging + Store is to be located.</para> + </listitem> + <listitem> + <para><emphasis role="bold">Server.</emphasis> The IP address or DNS name of + the storage device.</para> + </listitem> + <listitem> + <para><emphasis role="bold">Path.</emphasis> The exported path from the + server.</para> + </listitem> <listitem> <para><emphasis role="bold">SMB Username</emphasis>: Applicable only if you select - SMB/CIFS provider. The username of the account which has the necessary permissions to - the SMB shares. The user must be part of the Hyper-V administrator group.</para> + SMB/CIFS provider. The username of the account which has the necessary permissions to + the SMB shares. The user must be part of the Hyper-V administrator group.</para> </listitem> <listitem> <para><emphasis role="bold">SMB Password</emphasis>: Applicable only if you select - SMB/CIFS provider. The password associated with the account.</para> + SMB/CIFS provider. The password associated with the account.</para> </listitem> <listitem> <para><emphasis role="bold">SMB Domain</emphasis>: Applicable only if you select - SMB/CIFS provider. The Active Directory domain that the SMB share is a part of.</para> + SMB/CIFS provider. The Active Directory domain that the SMB share is a part of.</para> </listitem> - <listitem><para>NFS server. The name of the zone's Secondary Staging Store.</para></listitem> - <listitem><para>Path. The path to the zone's Secondary Staging Store.</para></listitem> + <listitem><para><emphasis role="bold">NFS server</emphasis>: The name of the zone's Secondary Staging + Store.</para></listitem> + <listitem><para><emphasis role="bold">Path</emphasis>: The path to the zone's Secondary Staging Store.</para></listitem> </itemizedlist> </listitem> </orderedlist> - </section> <section id="secondary-staging-store"> <title>Adding an NFS Secondary Staging Store for Each Zone</title> + <para>You can skip this section if you are upgrading an existing zone from NFS to object storage. + You only need to perform the steps below when setting up a new zone that does not yet have its NFS server.</para> <para>Every zone must have at least one NFS store provisioned; multiple NFS servers are allowed per zone. To provision an NFS Staging Store for a zone:</para> <orderedlist> - <listitem><para>Log in to the &PRODUCT; UI as root administrator.</para></listitem> + <listitem><para>To prepare for the zone-based Secondary Staging Store, you should have created and mounted an NFS share during Management Server installation.</para></listitem> + <listitem><para>Make sure you prepared the system VM template during Management Server installation.</para></listitem><listitem><para>Log in to the &PRODUCT; UI as root administrator.</para></listitem> <listitem><para>In the left navigation bar, click Infrastructure.</para></listitem> <listitem><para>In Secondary Storage, click View All.</para></listitem> <listitem><para>In Select View, choose Secondary Staging Store.</para></listitem> <listitem><para>Click the Add NFS Secondary Staging Store button.</para></listitem> <listitem><para>Fill out the dialog box fields, then click OK:</para> <itemizedlist> - <listitem><para>Zone. The zone where the NFS Secondary Staging Store is to be located.</para></listitem> - <listitem><para>NFS server. The name of the zone's Secondary Staging Store.</para></listitem> - <listitem><para>Path. The path to the zone's Secondary Staging Store.</para></listitem> + <listitem><para>Zone. The zone where the NFS Secondary Staging Store is to be located.</para></listitem> + <listitem><para>NFS server. The name of the zone's Secondary Staging Store.</para></listitem> + <listitem><para>Path. The path to the zone's Secondary Staging Store.</para></listitem> </itemizedlist> </listitem> </orderedlist> </section> - + <xi:include href="s3-ss-add.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> </section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/45f88741/en-US/vr-monitor.xml ---------------------------------------------------------------------- diff --git a/en-US/vr-monitor.xml b/en-US/vr-monitor.xml index 2034cea..919f0ba 100644 --- a/en-US/vr-monitor.xml +++ b/en-US/vr-monitor.xml @@ -23,14 +23,13 @@ --> <section id="vr-monitor"> <title>Service Monitoring Tool for Virtual Router</title> - <para>Various services running on the &PRODUCT; virtual routers can be monitored by using a - Service Monitoring tool. The tool ensures that services are successfully running until &PRODUCT; - deliberately disables them. If a service goes down, the tool automatically restarts the service, - and if that does not help bringing up the service, an alert as well as an event is generated - indicating the failure. A new global parameter, + <para>The network service daemons running on the &PRODUCT; virtual routers can be monitored by + using the Service Monitoring tool. If a service goes down, the tool automatically restarts the + service, and if that does not help bringing up the service, an event log is written to + <filename>/var/log/messages</filename> indicating the failure. A new global parameter, <code>network.router.enableservicemonitoring</code>, has been introduced to control this - feature. The default value is false, implies, monitoring is disabled. When you enable, ensure - that the Management Server and the router are restarted.</para> + feature. The default value is true, implies, monitoring is enabled. On changing this parameter, + you need to restart the Management Server and the virtual router.</para> <para>Monitoring tool can help to start a VR service, which is crashed due to an unexpected reason. For example:</para> <itemizedlist> @@ -55,7 +54,7 @@ <para>DNS</para> </listitem> <listitem> - <para>HA Proxy</para> + <para>DHCP</para> </listitem> <listitem> <para>SSH</para> @@ -63,6 +62,9 @@ <listitem> <para>Apache Web Server</para> </listitem> + <listitem> + <para>Load balancing service</para> + </listitem> </itemizedlist> <para>The following networks are supported:</para> <itemizedlist> @@ -70,11 +72,14 @@ <para>Isolated Networks</para> </listitem> <listitem> - <para>Shared Networks in both Advanced and Basic zone</para> + <para>Shared Networks in Advanced zone</para> </listitem> + <listitem> + <para>Shared Networks in Basic zone</para> + </listitem> </itemizedlist> <note> <para>VPC networks are not supported.</para> </note> - <para>This feature is supported on the following hypervisors: XenServer, VMware, and KVM.</para> + <para>This feature is supported on all the hypervisors.</para> </section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/45f88741/en-US/vr-upgrade.xml ---------------------------------------------------------------------- diff --git a/en-US/vr-upgrade.xml b/en-US/vr-upgrade.xml index 43c4745..7bb1a43 100644 --- a/en-US/vr-upgrade.xml +++ b/en-US/vr-upgrade.xml @@ -103,7 +103,8 @@ <para>Download the latest System VM template.</para> </listitem> <listitem> - <para>Download the latest System VM to all the primary storage pools.</para> + <para>By using the prepareTemplate API, download the latest System VM to all the primary + storage pools.</para> </listitem> <listitem> <para>Upgrade the Management Server.</para>
