You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by ed...@apache.org on 2013/10/11 03:01:47 UTC
[44/67] [abbrv] [partial] Removing docs from master
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/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
deleted file mode 100644
index 54fbe68..0000000
--- a/docs/en-US/automatic-snapshot-creation-retention.xml
+++ /dev/null
@@ -1,36 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
-%BOOK_ENTITIES;
-]>
-<!-- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-<section id="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>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/autoscale.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/autoscale.xml b/docs/en-US/autoscale.xml
deleted file mode 100644
index 26e795b..0000000
--- a/docs/en-US/autoscale.xml
+++ /dev/null
@@ -1,286 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
-%BOOK_ENTITIES;
-]>
-
-<!-- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-<section id="autoscale">
- <title>Configuring AutoScale</title>
- <para>AutoScaling allows you to scale your back-end services or application VMs up or down
- seamlessly and automatically according to the conditions you define. With AutoScaling enabled,
- you can ensure that the number of VMs you are using seamlessly scale up when demand increases,
- and automatically decreases when demand subsides. Thus it helps you save compute costs by
- terminating underused VMs automatically and launching new VMs when you need them, without the
- need for manual intervention.</para>
- <para>NetScaler AutoScaling is designed to seamlessly launch or terminate VMs based on
- user-defined conditions. Conditions for triggering a scaleup or scaledown action can vary from a
- simple use case like monitoring the CPU usage of a server to a complex use case of monitoring a
- combination of server's responsiveness and its CPU usage. For example, you can configure
- AutoScaling to launch an additional VM whenever CPU usage exceeds 80 percent for 15 minutes, or
- to remove a VM whenever CPU usage is less than 20 percent for 30 minutes.</para>
- <para>&PRODUCT; uses the NetScaler load balancer to monitor all aspects of a system's health and
- work in unison with &PRODUCT; to initiate scale-up or scale-down actions.</para>
- <note>
- <para>AutoScale is supported on NetScaler Release 10 Build 73.e and beyond.</para>
- </note>
- <formalpara>
- <title>Prerequisites</title>
- <para>Before you configure an AutoScale rule, consider the following:</para>
- </formalpara>
- <itemizedlist>
- <listitem>
- <para>Ensure that the necessary template is prepared before configuring AutoScale. When a VM
- is deployed by using a template and when it comes up, the application should be up and
- running.</para>
- <note>
- <para>If the application is not running, the NetScaler device considers the VM as
- ineffective and continues provisioning the VMs unconditionally until the resource limit is
- exhausted.</para>
- </note>
- </listitem>
- <listitem>
- <para>Deploy the templates you prepared. Ensure that the applications come up on the first
- boot and is ready to take the traffic. Observe the time requires to deploy the template.
- Consider this time when you specify the quiet time while configuring AutoScale.</para>
- </listitem>
- <listitem>
- <para>The AutoScale feature supports the SNMP counters that can be used to define conditions
- for taking scale up or scale down actions. To monitor the SNMP-based counter, ensure that
- the SNMP agent is installed in the template used for creating the AutoScale VMs, and the
- SNMP operations work with the configured SNMP community and port by using standard SNMP
- managers. For example, see <xref linkend="configure-snmp-rhel"/> to configure SNMP on a RHEL
- machine.</para>
- </listitem>
- <listitem>
- <para>Ensure that the endpointe.url parameter present in the Global Settings is set to the
- Management Server API URL. For example, http://10.102.102.22:8080/client/api. In a
- multi-node Management Server deployment, use the virtual IP address configured in the load
- balancer for the management server’s cluster. Additionally, ensure that the NetScaler device
- has access to this IP address to provide AutoScale support.</para>
- <para>If you update the endpointe.url, disable the AutoScale functionality of the load
- balancer rules in the system, then enable them back to reflect the changes. For more
- information see <xref linkend="update-autoscale"/></para>
- </listitem>
- <listitem>
- <para>If the API Key and Secret Key are regenerated for an AutoScale user, ensure that the
- AutoScale functionality of the load balancers that the user participates in are disabled and
- then enabled to reflect the configuration changes in the NetScaler.</para>
- </listitem>
- <listitem>
- <para>In an advanced Zone, ensure that at least one VM should be present before configuring a
- load balancer rule with AutoScale. Having one VM in the network ensures that the network is
- in implemented state for configuring AutoScale.</para>
- </listitem>
- </itemizedlist>
- <formalpara>
- <title>Configuration</title>
- <para>Specify the following:</para>
- </formalpara>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/autoscale-config.png"/>
- </imageobject>
- <textobject>
- <phrase>autoscaleateconfig.png: Configuring AutoScale</phrase>
- </textobject>
- </mediaobject>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">Template</emphasis>: A template consists of a base OS image and
- application. A template is used to provision the new instance of an application on a scaleup
- action. When a VM is deployed from a template, the VM can start taking the traffic from the
- load balancer without any admin intervention. For example, if the VM is deployed for a Web
- service, it should have the Web server running, the database connected, and so on.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Compute offering</emphasis>: A predefined set of virtual hardware
- attributes, including CPU speed, number of CPUs, and RAM size, that the user can select when
- creating a new virtual machine instance. Choose one of the compute offerings to be used
- while provisioning a VM instance as part of scaleup action.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Min Instance</emphasis>: The minimum number of active VM instances
- that is assigned to a load balancing rule. The active VM instances are the application
- instances that are up and serving the traffic, and are being load balanced. This parameter
- ensures that a load balancing rule has at least the configured number of active VM instances
- are available to serve the traffic.</para>
- <note>
- <para>If an application, such as SAP, running on a VM instance is down for some reason, the
- VM is then not counted as part of Min Instance parameter, and the AutoScale feature
- initiates a scaleup action if the number of active VM instances is below the configured
- value. Similarly, when an application instance comes up from its earlier down state, this
- application instance is counted as part of the active instance count and the AutoScale
- process initiates a scaledown action when the active instance count breaches the Max
- instance value.</para>
- </note>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Max Instance</emphasis>: Maximum number of active VM instances
- that <emphasis role="bold">should be assigned to </emphasis>a load balancing rule. This
- parameter defines the upper limit of active VM instances that can be assigned to a load
- balancing rule.</para>
- <para>Specifying a large value for the maximum instance parameter might result in provisioning
- large number of VM instances, which in turn leads to a single load balancing rule exhausting
- the VM instances limit specified at the account or domain level.</para>
- <note>
- <para>If an application, such as SAP, running on a VM instance is down for some reason, the
- VM is not counted as part of Max Instance parameter. So there may be scenarios where the
- number of VMs provisioned for a scaleup action might be more than the configured Max
- Instance value. Once the application instances in the VMs are up from an earlier down
- state, the AutoScale feature starts aligning to the configured Max Instance value.</para>
- </note>
- </listitem>
- </itemizedlist>
- <para>Specify the following scale-up and scale-down policies:</para>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">Duration</emphasis>: The duration, in seconds, for which the
- conditions you specify must be true to trigger a scaleup action. The conditions defined
- should hold true for the entire duration you specify for an AutoScale action to be invoked.
- </para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Counter</emphasis>: The performance counters expose the state of
- the monitored instances. By default, &PRODUCT; offers four performance counters: Three SNMP
- counters and one NetScaler counter. The SNMP counters are Linux User CPU, Linux System CPU,
- and Linux CPU Idle. The NetScaler counter is ResponseTime. The root administrator can add
- additional counters into &PRODUCT; by using the &PRODUCT; API. </para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Operator</emphasis>: The following five relational operators are
- supported in AutoScale feature: Greater than, Less than, Less than or equal to, Greater than
- or equal to, and Equal to.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Threshold</emphasis>: Threshold value to be used for the counter.
- Once the counter defined above breaches the threshold value, the AutoScale feature initiates
- a scaleup or scaledown action.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Add</emphasis>: Click Add to add the condition.</para>
- </listitem>
- </itemizedlist>
- <para>Additionally, if you want to configure the advanced settings, click Show advanced settings,
- and specify the following:</para>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">Polling interval</emphasis>: Frequency in which the conditions,
- combination of counter, operator and threshold, are to be evaluated before taking a scale up
- or down action. The default polling interval is 30 seconds.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Quiet Time</emphasis>: This is the cool down period after an
- AutoScale action is initiated. The time includes the time taken to complete provisioning a
- VM instance from its template and the time taken by an application to be ready to serve
- traffic. This quiet time allows the fleet to come up to a stable state before any action can
- take place. The default is 300 seconds.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Destroy VM Grace Period</emphasis>: The duration in seconds, after
- a scaledown action is initiated, to wait before the VM is destroyed as part of scaledown
- action. This is to ensure graceful close of any pending sessions or transactions being
- served by the VM marked for destroy. The default is 120 seconds.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Security Groups</emphasis>: Security groups provide a way to
- isolate traffic to the VM instances. A security group is a group of VMs that filter their
- incoming and outgoing traffic according to a set of rules, called ingress and egress rules.
- These rules filter network traffic according to the IP address that is attempting to
- communicate with the VM.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Disk Offerings</emphasis>: A predefined set of disk size for
- primary data storage. </para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">SNMP Community</emphasis>: The SNMP community string to be used by
- the NetScaler device to query the configured counter value from the provisioned VM
- instances. Default is public.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">SNMP Port</emphasis>: The port number on which the SNMP agent that
- run on the provisioned VMs is listening. Default port is 161. </para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">User</emphasis>: This is the user that the NetScaler device use to
- invoke scaleup and scaledown API calls to the cloud. If no option is specified, the user who
- configures AutoScaling is applied. Specify another user name to override.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Apply</emphasis>: Click Apply to create the AutoScale
- configuration.</para>
- </listitem>
- </itemizedlist>
- <formalpara>
- <title>Disabling and Enabling an AutoScale Configuration</title>
- <para>If you want to perform any maintenance operation on the AutoScale VM instances, disable
- the AutoScale configuration. When the AutoScale configuration is disabled, no scaleup or
- scaledown action is performed. You can use this downtime for the maintenance activities. To
- disable the AutoScale configuration, click the Disable AutoScale<inlinemediaobject>
- <imageobject>
- <imagedata fileref="./images/enable-disable-autoscale.png"/>
- </imageobject>
- <textobject>
- <phrase>EnableDisable.png: button to enable or disable AutoScale.</phrase>
- </textobject>
- </inlinemediaobject>button.</para>
- </formalpara>
- <para>The button toggles between enable and disable, depending on whether AutoScale is currently
- enabled or not. After the maintenance operations are done, you can enable the AutoScale
- configuration back. To enable, open the AutoScale configuration page again, then click the
- Enable AutoScale<inlinemediaobject>
- <imageobject>
- <imagedata fileref="./images/enable-disable-autoscale.png"/>
- </imageobject>
- <textobject>
- <phrase>EnableDisable.png: button to enable or disable AutoScale.</phrase>
- </textobject>
- </inlinemediaobject>button.</para>
- <formalpara id="update-autoscale">
- <title>Updating an AutoScale Configuration</title>
- <para>You can update the various parameters and add or delete the conditions in a scaleup or
- scaledown rule. Before you update an AutoScale configuration, ensure that you disable the
- AutoScale load balancer rule by clicking the Disable AutoScale button.</para>
- </formalpara>
- <para>After you modify the required AutoScale parameters, click Apply. To apply the new AutoScale
- policies, open the AutoScale configuration page again, then click the Enable AutoScale
- button.</para>
- <formalpara>
- <title>Runtime Considerations</title>
- <para/>
- </formalpara>
- <itemizedlist>
- <listitem>
- <para>An administrator should not assign a VM to a load balancing rule which is configured for
- AutoScale.</para>
- </listitem>
- <listitem>
- <para>Before a VM provisioning is completed if NetScaler is shutdown or restarted, the
- provisioned VM cannot be a part of the load balancing rule though the intent was to assign
- it to a load balancing rule. To workaround, rename the AutoScale provisioned VMs based on
- the rule name or ID so at any point of time the VMs can be reconciled to its load balancing
- rule.</para>
- </listitem>
- <listitem>
- <para>Making API calls outside the context of AutoScale, such as destroyVM, on an autoscaled
- VM leaves the load balancing configuration in an inconsistent state. Though VM is destroyed
- from the load balancer rule, NetScaler continues to show the VM as a service assigned to a
- rule.</para>
- </listitem>
- </itemizedlist>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/aws-api-examples.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/aws-api-examples.xml b/docs/en-US/aws-api-examples.xml
deleted file mode 100644
index ee3b44a..0000000
--- a/docs/en-US/aws-api-examples.xml
+++ /dev/null
@@ -1,145 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
-%BOOK_ENTITIES;
-]>
-
-<!-- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-
-<section id="aws-api-examples">
- <title>Examples</title>
- <para>There are many tools available to interface with a AWS compatible API. In this section we provide
- a few examples that users of &PRODUCT; can build upon.</para>
-
- <section id="aws-api-boto-examples">
- <title>Boto Examples</title>
- <para>Boto is one of them. It is a Python package available at https://github.com/boto/boto.
- In this section we provide two examples of Python scripts that use Boto and have been tested with the
- &PRODUCT; AWS API Interface.</para>
- <para>First is an EC2 example. Replace the Access and Secret Keys with your own and
- update the endpoint.</para>
- <para>
- <example>
- <title>An EC2 Boto example</title>
- <programlisting>#!/usr/bin/env python
-
-import sys
-import os
-import boto
-import boto.ec2
-
-region = boto.ec2.regioninfo.RegionInfo(name="ROOT",endpoint="localhost")
-apikey='GwNnpUPrO6KgIdZu01z_ZhhZnKjtSdRwuYd4DvpzvFpyxGMvrzno2q05MB0ViBoFYtdqKd'
-secretkey='t4eXLEYWw7chBhDlaKf38adCMSHx_wlds6JfSx3z9fSpSOm0AbP9Moj0oGIzy2LSC8iw'
-
-def main():
- '''Establish connection to EC2 cloud'''
- conn =boto.connect_ec2(aws_access_key_id=apikey,
- aws_secret_access_key=secretkey,
- is_secure=False,
- region=region,
- port=7080,
- path="/awsapi",
- api_version="2010-11-15")
-
- '''Get list of images that I own'''
- images = conn.get_all_images()
- print images
- myimage = images[0]
- '''Pick an instance type'''
- vm_type='m1.small'
- reservation = myimage.run(instance_type=vm_type,security_groups=['default'])
-
-if __name__ == '__main__':
- main()
- </programlisting>
- </example>
- </para>
- <para>Second is an S3 example. Replace the Access and Secret keys with your own,
- as well as the endpoint of the service. Be sure to also update the file paths to something
- that exists on your machine.</para>
- <para>
- <example>
- <title>An S3 Boto Example</title>
- <programlisting>#!/usr/bin/env python
-
-import sys
-import os
-from boto.s3.key import Key
-from boto.s3.connection import S3Connection
-from boto.s3.connection import OrdinaryCallingFormat
-
-apikey='ChOw-pwdcCFy6fpeyv6kUaR0NnhzmG3tE7HLN2z3OB_s-ogF5HjZtN4rnzKnq2UjtnHeg_yLA5gOw'
-secretkey='IMY8R7CJQiSGFk4cHwfXXN3DUFXz07cCiU80eM3MCmfLs7kusgyOfm0g9qzXRXhoAPCH-IRxXc3w'
-
-cf=OrdinaryCallingFormat()
-
-def main():
- '''Establish connection to S3 service'''
- conn =S3Connection(aws_access_key_id=apikey,aws_secret_access_key=secretkey, \
- is_secure=False, \
- host='localhost', \
- port=7080, \
- calling_format=cf, \
- path="/awsapi/rest/AmazonS3")
-
- try:
- bucket=conn.create_bucket('cloudstack')
- k = Key(bucket)
- k.key = 'test'
- try:
- k.set_contents_from_filename('/Users/runseb/Desktop/s3cs.py')
- except:
- print 'could not write file'
- pass
- except:
- bucket = conn.get_bucket('cloudstack')
- k = Key(bucket)
- k.key = 'test'
- try:
- k.get_contents_to_filename('/Users/runseb/Desktop/foobar')
- except:
- print 'Could not get file'
- pass
-
- try:
- bucket1=conn.create_bucket('teststring')
- k=Key(bucket1)
- k.key('foobar')
- k.set_contents_from_string('This is my silly test')
- except:
- bucket1=conn.get_bucket('teststring')
- k = Key(bucket1)
- k.key='foobar'
- k.get_contents_as_string()
-
-if __name__ == '__main__':
- main()
-
- </programlisting>
- </example>
- </para>
- </section>
-
- <section id="aws-api-jclouds-examples">
- <title>JClouds Examples</title>
- <para></para>
- </section>
-
- </section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/aws-ec2-configuration.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/aws-ec2-configuration.xml b/docs/en-US/aws-ec2-configuration.xml
deleted file mode 100644
index f0f2d0f..0000000
--- a/docs/en-US/aws-ec2-configuration.xml
+++ /dev/null
@@ -1,109 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
-%BOOK_ENTITIES;
-]>
-
-<!-- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-
-<section id="aws-ec2-configuration">
- <title>Enabling the EC2 and S3 Compatible Interface</title>
-
- <para>The software that provides AWS API compatibility is installed along with &PRODUCT;. You must enable the services and perform some setup steps prior to using it.
- </para>
- <orderedlist>
- <listitem id="set-global-config"><para>Set the global configuration parameters for each service to true.
- See <xref linkend="global-config" />.</para></listitem>
- <listitem><para>Create a set of &PRODUCT; service offerings with names that match the Amazon service offerings.
- You can do this through the &PRODUCT; UI as described in the Administration Guide.</para>
- <warning><para>Be sure you have included the Amazon default service offering, m1.small. As well as any EC2 instance types that you will use.</para></warning>
- </listitem>
- <listitem><para>If you did not already do so when you set the configuration parameter in step <xref linkend="set-global-config"/>, restart the Management Server.</para>
- <programlisting># service cloudstack-management restart</programlisting>
- </listitem>
- </orderedlist>
- <para>The following sections provides details to perform these steps</para>
-
- <section id="aws-api-settings">
- <title>Enabling the Services</title>
- <para>To enable the EC2 and S3 compatible services you need to set the configuration variables <emphasis>enable.ec2.api</emphasis>
- and <emphasis>enable.s3.api</emphasis> to true. You do not have to enable both at the same time. Enable the ones you need.
- This can be done via the &PRODUCT; GUI by going in <emphasis>Global Settings</emphasis> or via the API.</para>
- <para>The snapshot below shows you how to use the GUI to enable these services</para>
-
- <para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/ec2-s3-configuration.png"/>
- </imageobject>
- <textobject>
- <phrase>Use the GUI to set the configuration variable to <emphasis>true</emphasis></phrase>
- </textobject>
- </mediaobject>
- </para>
-
- <para>Using the &PRODUCT; API, the easiest is to use the so-called integration port on which you can make
- unauthenticated calls. In Global Settings set the port to 8096 and subsequently call the <emphasis>updateConfiguration</emphasis> method.
- The following urls shows you how:</para>
-
- <para>
- <programlisting>
- http://localhost:8096/client/api?command=updateConfiguration&name=enable.ec2.api&value=true
- http://localhost:8096/client/api?command=updateConfiguration&name=enable.ec2.api&value=true
- </programlisting>
- </para>
-
- <para>Once you have enabled the services, restart the server.</para>
- </section>
-
- <section id="aws-ec2-service-offerings">
- <title>Creating EC2 Compatible Service Offerings</title>
- <para>You will also need to define compute service offerings with names compatible with the <ulink url="http://aws.amazon.com/ec2/instance-types/">
- Amazon EC2 instance types</ulink> API names (e.g m1.small,m1.large). This can be done via the &PRODUCT; GUI.
- Go under <emphasis>Service Offerings</emphasis> select <emphasis>Compute offering</emphasis> and either create
- a new compute offering or modify an existing one, ensuring that the name matches an EC2 instance type API name. The snapshot below shows you how:</para>
- <para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/compute-service-offerings.png"/>
- </imageobject>
- <textobject>
- <phrase>Use the GUI to set the name of a compute service offering to an EC2 instance
- type API name.</phrase>
- </textobject>
- </mediaobject>
- </para>
- </section>
- <section id="aws-api-port-change">
- <title>Modifying the AWS API Port</title>
- <note>
- <para>(Optional) The AWS API listens for requests on port 7080. If you prefer AWS API to listen on another port, you can change it as follows:</para>
- <orderedlist numeration="loweralpha">
- <listitem><para>Edit the files /etc/cloudstack/management/server.xml, /etc/cloudstack/management/server-nonssl.xml,
- and /etc/cloudstack/management/server-ssl.xml.</para></listitem>
- <listitem><para>In each file, find the tag <Service name="Catalina7080">. Under this tag,
- locate <Connector executor="tomcatThreadPool-internal" port= ....<.</para></listitem>
- <listitem><para>Change the port to whatever port you want to use, then save the files.</para></listitem>
- <listitem><para>Restart the Management Server.</para></listitem>
- </orderedlist>
- <para>If you re-install &PRODUCT;, you will have to re-enable the services and if need be update the port.</para>
- </note>
- </section>
-
- </section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/aws-ec2-introduction.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/aws-ec2-introduction.xml b/docs/en-US/aws-ec2-introduction.xml
deleted file mode 100644
index 4cf071b..0000000
--- a/docs/en-US/aws-ec2-introduction.xml
+++ /dev/null
@@ -1,53 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
-%BOOK_ENTITIES;
-]>
-
-<!-- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-
-<section id="aws-ec2-introduction">
- <title>Amazon Web Services Compatible Interface</title>
- <para>&PRODUCT; can translate Amazon Web Services (AWS) API calls to native &PRODUCT; API calls
- so that users can continue using existing AWS-compatible tools. This translation service runs as
- a separate web application in the same tomcat server as the management server of &PRODUCT;,
- listening on a different port. The Amazon Web Services (AWS) compatible interface provides the
- EC2 SOAP and Query APIs as well as the S3 REST API.</para>
- <note>
- <para>This service was previously enabled by separate software called CloudBridge. It is now
- fully integrated with the &PRODUCT; management server. </para>
- </note>
- <warning>
- <para>The compatible interface for the EC2 Query API and the S3 API are Work In Progress. The S3 compatible API offers a way to store data on the management server file system, it is not an implementation of the S3 backend.</para>
- </warning>
- <para>Limitations</para>
- <itemizedlist>
- <listitem>
- <para>Supported only in zones that use basic networking.</para>
- </listitem>
- <listitem>
- <para>Available in fresh installations of &PRODUCT;. Not available through upgrade of previous versions.</para>
- </listitem>
- <listitem>
- <para>Features such as Elastic IP (EIP) and Elastic Load Balancing (ELB) are only available in an infrastructure
- with a Citrix NetScaler device. Users accessing a Zone with a NetScaler device will need to use a
- NetScaler-enabled network offering (DefaultSharedNetscalerEIP and ELBNetworkOffering).</para>
- </listitem>
- </itemizedlist>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/aws-ec2-requirements.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/aws-ec2-requirements.xml b/docs/en-US/aws-ec2-requirements.xml
deleted file mode 100644
index 62e94b1..0000000
--- a/docs/en-US/aws-ec2-requirements.xml
+++ /dev/null
@@ -1,36 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
-%BOOK_ENTITIES;
-]>
-
-<!-- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-
-<section id="aws-ec2-requirements">
- <title>Supported API Version</title>
- <itemizedlist>
- <listitem><para>The EC2 interface complies with Amazon's WDSL version dated November 15, 2010, available at
- <ulink url="http://ec2.amazonaws.com/doc/2010-11-15/">http://ec2.amazonaws.com/doc/2010-11-15/</ulink>.</para></listitem>
- <listitem><para>The interface is compatible with the EC2 command-line
- tools <emphasis>EC2 tools v. 1.3.6230</emphasis>, which can be downloaded at <ulink
- url="http://s3.amazonaws.com/ec2-downloads/ec2-api-tools-1.3-62308.zip">http://s3.amazonaws.com/ec2-downloads/ec2-api-tools-1.3-62308.zip</ulink>.</para>
- </listitem>
- </itemizedlist>
- <note><para>Work is underway to support a more recent version of the EC2 API</para></note>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/aws-ec2-supported-commands.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/aws-ec2-supported-commands.xml b/docs/en-US/aws-ec2-supported-commands.xml
deleted file mode 100644
index 7cdbcad..0000000
--- a/docs/en-US/aws-ec2-supported-commands.xml
+++ /dev/null
@@ -1,396 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
-%BOOK_ENTITIES;
-]>
-
-<!-- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-
-<section id="aws-ec2-supported-commands">
- <title>Supported AWS API Calls</title>
- <para>The following Amazon EC2 commands are supported by &PRODUCT; when the AWS API compatible interface is enabled.
- For a few commands, there are differences between the &PRODUCT; and Amazon EC2 versions, and these differences are noted. The underlying SOAP call for each command is also given, for those who have built tools using those calls.
- </para>
- <table frame='all'>
- <title>Elastic IP API mapping</title>
- <tgroup cols='3' align='left' colsep='1' rowsep='1'>
- <!--<colspec colname='c1'tcolwidth="1*"/>
- <colspec colname='c2'tcolwidth="1*"/>-->
- <thead>
- <row>
- <entry>EC2 command</entry>
- <entry>SOAP call</entry>
- <entry>&PRODUCT; API call</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>ec2-allocate-address</entry>
- <entry>AllocateAddress</entry>
- <entry>associateIpAddress</entry>
- </row>
- <row>
- <entry>ec2-associate-address</entry>
- <entry>AssociateAddress</entry>
- <entry>enableStaticNat</entry>
- </row>
- <row>
- <entry>ec2-describe-addresses</entry>
- <entry>DescribeAddresses</entry>
- <entry>listPublicIpAddresses</entry>
- </row>
- <row>
- <entry>ec2-diassociate-address</entry>
- <entry>DisassociateAddress</entry>
- <entry>disableStaticNat</entry>
- </row>
- <row>
- <entry>ec2-release-address</entry>
- <entry>ReleaseAddress</entry>
- <entry>disassociateIpAddress</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <table frame='all'>
- <title>Availability Zone API mapping</title>
- <tgroup cols='3' align='left' colsep='1' rowsep='1'>
- <!--<colspec colname='c1'tcolwidth="1*"/>
- <colspec colname='c2'tcolwidth="1*"/>-->
- <thead>
- <row>
- <entry>EC2 command</entry>
- <entry>SOAP call</entry>
- <entry>&PRODUCT; API call</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>ec2-describe-availability-zones</entry>
- <entry>DescribeAvailabilityZones</entry>
- <entry>listZones</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <table frame='all'>
- <title>Images API mapping</title>
- <tgroup cols='3' align='left' colsep='1' rowsep='1'>
- <!--<colspec colname='c1'tcolwidth="1*"/>
- <colspec colname='c2'tcolwidth="1*"/>-->
- <thead>
- <row>
- <entry>EC2 command</entry>
- <entry>SOAP call</entry>
- <entry>&PRODUCT; API call</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>ec2-create-image</entry>
- <entry>CreateImage</entry>
- <entry>createTemplate</entry>
- </row>
- <row>
- <entry>ec2-deregister</entry>
- <entry>DeregisterImage</entry>
- <entry>DeleteTemplate</entry>
- </row>
- <row>
- <entry>ec2-describe-images</entry>
- <entry>DescribeImages</entry>
- <entry>listTemplates</entry>
- </row>
- <row>
- <entry>ec2-register</entry>
- <entry>RegisterImage</entry>
- <entry>registerTemplate</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <table frame='all'>
- <title>Image Attributes API mapping</title>
- <tgroup cols='3' align='left' colsep='1' rowsep='1'>
- <!--<colspec colname='c1'tcolwidth="1*"/>
- <colspec colname='c2'tcolwidth="1*"/>-->
- <thead>
- <row>
- <entry>EC2 command</entry>
- <entry>SOAP call</entry>
- <entry>&PRODUCT; API call</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>ec2-describe-image-attribute</entry>
- <entry>DescribeImageAttribute</entry>
- <entry>listTemplatePermissions</entry>
- </row>
- <row>
- <entry>ec2-modify-image-attribute</entry>
- <entry>ModifyImageAttribute</entry>
- <entry>updateTemplatePermissions</entry>
- </row>
- <row>
- <entry>ec2-reset-image-attribute</entry>
- <entry>ResetImageAttribute</entry>
- <entry>updateTemplatePermissions</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <table frame='all'>
- <title>Instances API mapping</title>
- <tgroup cols='3' align='left' colsep='1' rowsep='1'>
- <!--<colspec colname='c1'tcolwidth="1*"/>
- <colspec colname='c2'tcolwidth="1*"/>-->
- <thead>
- <row>
- <entry>EC2 command</entry>
- <entry>SOAP call</entry>
- <entry>&PRODUCT; API call</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>ec2-describe-instances</entry>
- <entry>DescribeInstances</entry>
- <entry>listVirtualMachines</entry>
- </row>
- <row>
- <entry>ec2-run-instances</entry>
- <entry>RunInstances</entry>
- <entry>deployVirtualMachine</entry>
- </row>
- <row>
- <entry>ec2-reboot-instances</entry>
- <entry>RebootInstances</entry>
- <entry>rebootVirtualMachine</entry>
- </row>
- <row>
- <entry>ec2-start-instances</entry>
- <entry>StartInstances</entry>
- <entry>startVirtualMachine</entry>
- </row>
- <row>
- <entry>ec2-stop-instances</entry>
- <entry>StopInstances</entry>
- <entry>stopVirtualMachine</entry>
- </row>
- <row>
- <entry>ec2-terminate-instances</entry>
- <entry>TerminateInstances</entry>
- <entry>destroyVirtualMachine</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <table frame='all'>
- <title>Instance Attributes Mapping</title>
- <tgroup cols='3' align='left' colsep='1' rowsep='1'>
- <!--<colspec colname='c1'tcolwidth="1*"/>
- <colspec colname='c2'tcolwidth="1*"/>-->
- <thead>
- <row>
- <entry>EC2 command</entry>
- <entry>SOAP call</entry>
- <entry>&PRODUCT; API call</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>ec2-describe-instance-attribute</entry>
- <entry>DescribeInstanceAttribute</entry>
- <entry>listVirtualMachines</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <table frame='all'>
- <title>Keys Pairs Mapping</title>
- <tgroup cols='3' align='left' colsep='1' rowsep='1'>
- <!--<colspec colname='c1'tcolwidth="1*"/>
- <colspec colname='c2'tcolwidth="1*"/>-->
- <thead>
- <row>
- <entry>EC2 command</entry>
- <entry>SOAP call</entry>
- <entry>&PRODUCT; API call</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>ec2-add-keypair</entry>
- <entry>CreateKeyPair</entry>
- <entry>createSSHKeyPair</entry>
- </row>
- <row>
- <entry>ec2-delete-keypair</entry>
- <entry>DeleteKeyPair</entry>
- <entry>deleteSSHKeyPair</entry>
- </row>
- <row>
- <entry>ec2-describe-keypairs</entry>
- <entry>DescribeKeyPairs</entry>
- <entry>listSSHKeyPairs</entry>
- </row>
- <row>
- <entry>ec2-import-keypair</entry>
- <entry>ImportKeyPair</entry>
- <entry>registerSSHKeyPair</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <table frame='all'>
- <title>Passwords API Mapping</title>
- <tgroup cols='3' align='left' colsep='1' rowsep='1'>
- <!--<colspec colname='c1'tcolwidth="1*"/>
- <colspec colname='c2'tcolwidth="1*"/>-->
- <thead>
- <row>
- <entry>EC2 command</entry>
- <entry>SOAP call</entry>
- <entry>&PRODUCT; API call</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>ec2-get-password</entry>
- <entry>GetPasswordData</entry>
- <entry>getVMPassword</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <table frame='all'>
- <title>Security Groups API Mapping</title>
- <tgroup cols='3' align='left' colsep='1' rowsep='1'>
- <!--<colspec colname='c1'tcolwidth="1*"/>
- <colspec colname='c2'tcolwidth="1*"/>-->
- <thead>
- <row>
- <entry>EC2 command</entry>
- <entry>SOAP call</entry>
- <entry>&PRODUCT; API call</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>ec2-authorize</entry>
- <entry>AuthorizeSecurityGroupIngress</entry>
- <entry>authorizeSecurityGroupIngress</entry>
- </row>
- <row>
- <entry>ec2-add-group</entry>
- <entry>CreateSecurityGroup</entry>
- <entry>createSecurityGroup</entry>
- </row>
- <row>
- <entry>ec2-delete-group</entry>
- <entry>DeleteSecurityGroup</entry>
- <entry>deleteSecurityGroup</entry>
- </row>
- <row>
- <entry>ec2-describe-group</entry>
- <entry>DescribeSecurityGroups</entry>
- <entry>listSecurityGroups</entry>
- </row>
- <row>
- <entry>ec2-revoke</entry>
- <entry>RevokeSecurityGroupIngress</entry>
- <entry>revokeSecurityGroupIngress</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <table frame='all'>
- <title>Snapshots API Mapping</title>
- <tgroup cols='3' align='left' colsep='1' rowsep='1'>
- <!--<colspec colname='c1'tcolwidth="1*"/>
- <colspec colname='c2'tcolwidth="1*"/>-->
- <thead>
- <row>
- <entry>EC2 command</entry>
- <entry>SOAP call</entry>
- <entry>&PRODUCT; API call</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>ec2-create-snapshot</entry>
- <entry>CreateSnapshot</entry>
- <entry>createSnapshot</entry>
- </row>
- <row>
- <entry>ec2-delete-snapshot</entry>
- <entry>DeleteSnapshot</entry>
- <entry>deleteSnapshot</entry>
- </row>
- <row>
- <entry>ec2-describe-snapshots</entry>
- <entry>DescribeSnapshots</entry>
- <entry>listSnapshots</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <table frame='all'>
- <title>Volumes API Mapping</title>
- <tgroup cols='3' align='left' colsep='1' rowsep='1'>
- <!--<colspec colname='c1'tcolwidth="1*"/>
- <colspec colname='c2'tcolwidth="1*"/>-->
- <thead>
- <row>
- <entry>EC2 command</entry>
- <entry>SOAP call</entry>
- <entry>&PRODUCT; API call</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>ec2-attach-volume</entry>
- <entry>AttachVolume</entry>
- <entry>attachVolume</entry>
- </row>
- <row>
- <entry>ec2-create-volume</entry>
- <entry>CreateVolume</entry>
- <entry>createVolume</entry>
- </row>
- <row>
- <entry>ec2-delete-volume</entry>
- <entry>DeleteVolume</entry>
- <entry>deleteVolume</entry>
- </row>
- <row>
- <entry>ec2-describe-volume</entry>
- <entry>DescribeVolume</entry>
- <entry>listVolumes</entry>
- </row>
- <row>
- <entry>ec2-detach-volume</entry>
- <entry>DetachVolume</entry>
- <entry>detachVolume</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/aws-ec2-timeouts.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/aws-ec2-timeouts.xml b/docs/en-US/aws-ec2-timeouts.xml
deleted file mode 100644
index 73d0c16..0000000
--- a/docs/en-US/aws-ec2-timeouts.xml
+++ /dev/null
@@ -1,51 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
-%BOOK_ENTITIES;
-]>
-
-<!-- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-
-<section id="aws-ec2-timeouts">
- <title>Using Timeouts to Ensure AWS API Command Completion</title>
- <para>The Amazon EC2 command-line tools have a default connection timeout. When used with &PRODUCT;, a longer timeout might be needed for some commands. If you find that commands are not completing due to timeouts, you can specify a custom timeouts. You can add the following optional command-line parameters to any &PRODUCT;-supported EC2 command:</para>
- <informaltable frame="all">
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" />
- <colspec colname="c2" />
- <tbody>
- <row>
- <entry><programlisting>--connection-timeout <replaceable>TIMEOUT</replaceable></programlisting></entry>
- <entry>Specifies a connection timeout (in seconds).
- Example: <programlisting>--connection-timeout 30</programlisting>
- </entry>
- </row>
- <row>
- <entry><programlisting>--request-timeout <replaceable>TIMEOUT</replaceable></programlisting></entry>
- <entry>Specifies a request timeout (in seconds).
- Example: <programlisting>--request-timeout 45</programlisting>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- <para>Example:</para>
- <programlisting>ec2-run-instances 2 –z us-test1 –n 1-3 --connection-timeout 120 --request-timeout 120</programlisting>
- <note><para>The timeouts optional arguments are not specific to &PRODUCT;.</para></note>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/aws-ec2-user-setup.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/aws-ec2-user-setup.xml b/docs/en-US/aws-ec2-user-setup.xml
deleted file mode 100644
index a2d8918..0000000
--- a/docs/en-US/aws-ec2-user-setup.xml
+++ /dev/null
@@ -1,105 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
-%BOOK_ENTITIES;
-]>
-
-<!-- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-<section id="aws-ec2-user-setup">
- <title>AWS API User Setup</title>
- <para>In general, users need not be aware that they are using a translation service provided by &PRODUCT;.
- They only need to send AWS API calls to &PRODUCT;'s endpoint, and it will translate the calls to the native &PRODUCT; API. Users of the Amazon EC2 compatible interface will be able to keep their existing EC2 tools
- and scripts and use them with their &PRODUCT; deployment, by specifying the endpoint of the
- management server and using the proper user credentials. In order to do this, each user must
- perform the following configuration steps: </para>
- <para>
- <itemizedlist>
- <listitem>
- <para>Generate user credentials.</para>
- </listitem>
- <listitem>
- <para>Register with the service.</para>
- </listitem>
- <listitem>
- <para>For convenience, set up environment variables for the EC2 SOAP command-line tools.</para>
- </listitem>
- </itemizedlist>
- </para>
- <section id="aws-ec2-user-registration">
- <title>AWS API User Registration</title>
- <para>Each user must perform a one-time registration. The user follows these steps:</para>
- <orderedlist>
- <listitem id="obtain-access-secret-keys">
- <para>Obtain the following by looking in the &PRODUCT; UI, using the API, or asking the cloud administrator:
- </para>
- <itemizedlist>
- <listitem><para>The &PRODUCT; server's publicly available DNS name or IP address</para></listitem>
- <listitem><para>The user account's Access key and Secret key</para></listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>Generate a private key and a self-signed X.509 certificate. The user substitutes their own desired storage location for /path/to/… below.
- </para>
- <para>
- <programlisting>$ openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout /path/to/private_key.pem -out /path/to/cert.pem</programlisting>
- </para>
- </listitem>
- <listitem>
- <para>Register the user X.509 certificate and Access/Secret keys with the AWS compatible service.
- If you have the source code of &PRODUCT; go to the awsapi-setup/setup directory and use the Python script
- cloudstack-aws-api-register. If you do not have the source then download the script using the following command.
- </para>
- <para>
- <programlisting>wget -O cloudstack-aws-api-register <ulink url="https://git-wip-us.apache.org/repos/asf?p=cloudstack.git;a=blob_plain;f=awsapi-setup/setup/cloudstack-aws-api-register;hb=4.1">"https://git-wip-us.apache.org/repos/asf?p=cloudstack.git;a=blob_plain;f=awsapi-setup/setup/cloudstack-aws-api-register;hb=4.1"</ulink>
- </programlisting>
- </para>
- <para> Then execute it, using the access and secret keys that were obtained in step <xref linkend="obtain-access-secret-keys"/>. An example is shown below.</para>
- <para>
- <programlisting>$ cloudstack-aws-api-register --apikey=<replaceable>User’s &PRODUCT; API key</replaceable> --secretkey=<replaceable>User’s &PRODUCT; Secret key</replaceable> --cert=<replaceable>/path/to/cert.pem</replaceable> --url=http://<replaceable>&PRODUCT;.server</replaceable>:7080/awsapi</programlisting>
- </para>
- </listitem>
- </orderedlist>
- <note>
- <para>
- A user with an existing AWS certificate could choose to use the same certificate with &PRODUCT;, but note that the certificate would be uploaded to the &PRODUCT; management server database.
- </para>
- </note>
- </section>
- <section id="aws-api-tools-setup">
- <title>AWS API Command-Line Tools Setup</title>
- <para>To use the EC2 command-line tools, the user must perform these steps:</para>
- <orderedlist>
- <listitem>
- <para>Be sure you have the right version of EC2 Tools.
- The supported version is available at <ulink url="http://s3.amazonaws.com/ec2-downloads/ec2-api-tools-1.3-62308.zip">http://s3.amazonaws.com/ec2-downloads/ec2-api-tools-1.3-62308.zip</ulink>.
- </para>
- </listitem>
- <listitem>
- <para>Set up the EC2 environment variables. This can be done every time you use the service or you can set them up in the proper shell profile. Replace the endpoint (i.e EC2_URL) with the proper address of your &PRODUCT; management server and port. In a bash shell do the following.
- </para>
- <programlisting>
- $ export EC2_CERT=/path/to/cert.pem
- $ export EC2_PRIVATE_KEY=/path/to/private_key.pem
- $ export EC2_URL=http://localhost:7080/awsapi
- $ export EC2_HOME=/path/to/EC2_tools_directory
- </programlisting>
- </listitem>
- </orderedlist>
- </section>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/aws-interface-compatibility.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/aws-interface-compatibility.xml b/docs/en-US/aws-interface-compatibility.xml
deleted file mode 100644
index 2c85c24..0000000
--- a/docs/en-US/aws-interface-compatibility.xml
+++ /dev/null
@@ -1,34 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!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="aws-interface-compatibility">
- <title>Amazon Web Services Compatible Interface</title>
- <xi:include href="aws-ec2-introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="aws-ec2-requirements.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="aws-ec2-configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="aws-ec2-user-setup.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="aws-ec2-timeouts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="aws-ec2-supported-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="aws-api-examples.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-</chapter>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/basic-adv-networking.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/basic-adv-networking.xml b/docs/en-US/basic-adv-networking.xml
deleted file mode 100644
index 46f0650..0000000
--- a/docs/en-US/basic-adv-networking.xml
+++ /dev/null
@@ -1,113 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
-%BOOK_ENTITIES;
-]>
-<!-- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-<section id="basic-adv-networking">
- <title>Basic and Advanced Networking</title>
- <para>&PRODUCT; provides two styles of networking:.</para>
- <formalpara>
- <title>Basic</title>
- <para>For AWS-style networking. Provides a single network where guest isolation can be provided
- through layer-3 means such as security groups (IP address source filtering). </para>
- </formalpara>
- <formalpara>
- <title>Advanced</title>
- <para>For more sophisticated network topologies. This network model provides the most
- flexibility in defining guest networks, but requires more configuration steps than basic
- networking.</para>
- </formalpara>
- <para>Each zone has either basic or advanced networking. Once the choice of networking model for a
- zone has been made and configured in &PRODUCT;, it can not be changed. A zone is either
- basic or advanced for its entire lifetime.</para>
- <para>The following table compares the networking features in the two networking models.</para>
- <informaltable>
- <tgroup cols="3" align="left" colsep="1" rowsep="1">
- <thead>
- <row>
- <entry><para>Networking Feature</para></entry>
- <entry><para>Basic Network</para></entry>
- <entry><para>Advanced Network</para></entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><para>Number of networks</para></entry>
- <entry><para>Single network</para></entry>
- <entry><para>Multiple networks</para></entry>
- </row>
- <row>
- <entry><para>Firewall type</para></entry>
- <entry><para>Physical</para></entry>
- <entry><para>Physical and Virtual</para></entry>
- </row>
- <row>
- <entry><para>Load balancer</para></entry>
- <entry><para>Physical</para></entry>
- <entry><para>Physical and Virtual</para></entry>
- </row>
- <row>
- <entry><para>Isolation type</para></entry>
- <entry><para>Layer 3</para></entry>
- <entry><para>Layer 2 and Layer 3</para></entry>
- </row>
- <row>
- <entry><para>VPN support</para></entry>
- <entry><para>No</para></entry>
- <entry><para>Yes</para></entry>
- </row>
- <row>
- <entry><para>Port forwarding</para></entry>
- <entry><para>Physical</para></entry>
- <entry><para>Physical and Virtual</para></entry>
- </row>
- <row>
- <entry><para>1:1 NAT</para></entry>
- <entry><para>Physical</para></entry>
- <entry><para>Physical and Virtual</para></entry>
- </row>
- <row>
- <entry><para>Source NAT</para></entry>
- <entry><para>No</para></entry>
- <entry><para>Physical and Virtual</para></entry>
- </row>
- <row>
- <entry><para>Userdata</para></entry>
- <entry><para>Yes</para></entry>
- <entry><para>Yes</para></entry>
- </row>
- <row>
- <entry><para>Network usage monitoring</para></entry>
- <entry><para>sFlow / netFlow at physical router</para></entry>
- <entry><para>Hypervisor and Virtual Router</para></entry>
- </row>
- <row>
- <entry><para>DNS and DHCP</para></entry>
- <entry><para>Yes</para></entry>
- <entry><para>Yes</para></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- <para>The two types of networking may be in use in the same cloud. However, a given zone must use
- either Basic Networking or Advanced Networking.</para>
- <para>Different types of network traffic can be segmented on the same physical network. Guest
- traffic can also be segmented by account. To isolate traffic, you can use separate VLANs. If you
- are using separate VLANs on a single physical network, make sure the VLAN tags are in separate
- numerical ranges.</para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/basic-zone-configuration.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/basic-zone-configuration.xml b/docs/en-US/basic-zone-configuration.xml
deleted file mode 100644
index 79d4ab8..0000000
--- a/docs/en-US/basic-zone-configuration.xml
+++ /dev/null
@@ -1,319 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
-%BOOK_ENTITIES;
-]>
-
-<!-- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-<section id="basic-zone-configuration">
- <title>Basic Zone Configuration</title>
- <orderedlist>
- <listitem>
- <para>After you select Basic in the Add Zone wizard and click Next, you will be asked to enter
- the following details. Then click Next.</para>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">Name.</emphasis> A name for the zone.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">DNS 1 and 2.</emphasis> These are DNS servers for use by guest
- VMs in the zone. These DNS servers will be accessed via the public network you will add
- later. The public IP addresses for the zone must have a route to the DNS server named
- here.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Internal DNS 1 and Internal DNS 2.</emphasis> These are DNS
- servers for use by system VMs in the zone (these are VMs used by &PRODUCT; itself, such
- as virtual routers, console proxies, and Secondary Storage VMs.) These DNS servers will
- be accessed via the management traffic network interface of the System VMs. The private
- IP address you provide for the pods must have a route to the internal DNS server named
- here.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Hypervisor.</emphasis> (Introduced in version 3.0.1) Choose
- the hypervisor for the first cluster in the zone. You can add clusters with different
- hypervisors later, after you finish adding the zone.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Network Offering.</emphasis> Your choice here determines what
- network services will be available on the network for guest VMs.</para>
- <informaltable frame="all">
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1"/>
- <colspec colname="c2"/>
- <thead>
- <row>
- <entry><para>Network Offering</para></entry>
- <entry><para>Description</para></entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><para>DefaultSharedNetworkOfferingWithSGService</para></entry>
- <entry><para>If you want to enable security groups for guest traffic isolation,
- choose this. (See Using Security Groups to Control Traffic to
- VMs.)</para></entry>
- </row>
- <row>
- <entry><para>DefaultSharedNetworkOffering</para></entry>
- <entry><para>If you do not need security groups, choose this.</para></entry>
- </row>
- <row>
- <entry><para>DefaultSharedNetscalerEIPandELBNetworkOffering</para></entry>
- <entry><para>If you have installed a Citrix NetScaler appliance as part of your
- zone network, and you will be using its Elastic IP and Elastic Load Balancing
- features, choose this. With the EIP and ELB features, a basic zone with
- security groups enabled can offer 1:1 static NAT and load
- balancing.</para></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Network Domain.</emphasis> (Optional) If you want to assign a
- special domain name to the guest VM network, specify the DNS suffix.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Public.</emphasis> A public zone is available to all users. A
- zone that is not public will be assigned to a particular domain. Only users in that
- domain will be allowed to create guest VMs in this zone.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>Choose which traffic types will be carried by the physical network.</para>
- <para>The traffic types are management, public, guest, and storage traffic. For more
- information about the types, roll over the icons to display their tool tips, or see Basic
- Zone Network Traffic Types. This screen starts out with some traffic types already assigned.
- To add more, drag and drop traffic types onto the network. You can also change the network
- name if desired.</para>
- </listitem>
- <listitem>
- <para>Assign a network traffic label to each traffic type on the physical network. These
- labels must match the labels you have already defined on the hypervisor host. To assign each
- label, click the Edit button under the traffic type icon. A popup dialog appears where you
- can type the label, then click OK.</para>
- <para>These traffic labels will be defined only for the hypervisor selected for the first
- cluster. For all other hypervisors, the labels can be configured after the zone is
- created.</para>
- </listitem>
- <listitem>
- <para>Click Next.</para>
- </listitem>
- <listitem>
- <para>(NetScaler only) If you chose the network offering for NetScaler, you have an additional
- screen to fill out. Provide the requested details to set up the NetScaler, then click
- Next.</para>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">IP address.</emphasis> The NSIP (NetScaler IP) address of the
- NetScaler device.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Username/Password.</emphasis> The authentication credentials
- to access the device. &PRODUCT; uses these credentials to access the device.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Type.</emphasis> NetScaler device type that is being added. It
- could be NetScaler VPX, NetScaler MPX, or NetScaler SDX. For a comparison of the types,
- see About Using a NetScaler Load Balancer.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Public interface.</emphasis> Interface of NetScaler that is
- configured to be part of the public network.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Private interface.</emphasis> Interface of NetScaler that is
- configured to be part of the private network.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Number of retries.</emphasis> Number of times to attempt a
- command on the device before considering the operation failed. Default is 2.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Capacity.</emphasis> Number of guest networks/accounts that
- will share this NetScaler device.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Dedicated.</emphasis> When marked as dedicated, this device
- will be dedicated to a single account. When Dedicated is checked, the value in the
- Capacity field has no significance – implicitly, its value is 1.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>(NetScaler only) Configure the IP range for public traffic. The IPs in this range will
- be used for the static NAT capability which you enabled by selecting the network offering
- for NetScaler with EIP and ELB. Enter the following details, then click Add. If desired, you
- can repeat this step to add more IP ranges. When done, click Next.</para>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">Gateway.</emphasis> The gateway in use for these IP
- addresses.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Netmask.</emphasis> The netmask associated with this IP
- range.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">VLAN.</emphasis> The VLAN that will be used for public
- traffic.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Start IP/End IP.</emphasis> A range of IP addresses that are
- assumed to be accessible from the Internet and will be allocated for access to guest
- VMs.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>In a new zone, &PRODUCT; adds the first pod for you. You can always add more pods later.
- For an overview of what a pod is, see <xref linkend="about-pods"/>.</para>
- <para>To configure the first pod, enter the following, then click Next:</para>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">Pod Name.</emphasis> A name for the pod.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Reserved system gateway.</emphasis> The gateway for the hosts
- in that pod.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Reserved system netmask.</emphasis> The network prefix that
- defines the pod's subnet. Use CIDR notation.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Start/End Reserved System IP.</emphasis> The IP range in the
- management network that &PRODUCT; uses to manage various system VMs, such as Secondary
- Storage VMs, Console Proxy VMs, and DHCP. For more information, see System Reserved IP
- Addresses.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>Configure the network for guest traffic. Provide the following, then click Next:</para>
- <itemizedlist>
- <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>
- <listitem>
- <para><emphasis role="bold">Guest start IP/End IP.</emphasis> Enter the first and last IP
- addresses that define a range that &PRODUCT; can assign to guests.</para>
- <itemizedlist>
- <listitem>
- <para>We strongly recommend the use of multiple NICs. If multiple NICs are used, they
- may be in a different subnet.</para>
- </listitem>
- <listitem>
- <para>If one NIC is used, these IPs should be in the same CIDR as the pod CIDR.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>In a new pod, &PRODUCT; adds the first cluster for you. You can always add more clusters
- later. For an overview of what a cluster is, see About Clusters.</para>
- <para>To configure the first cluster, enter the following, then click Next:</para>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">Hypervisor.</emphasis> (Version 3.0.0 only; in 3.0.1, this
- field is read only) Choose the type of hypervisor software that all hosts in this
- cluster will run. If you choose VMware, additional fields appear so you can give
- information about a vSphere cluster. For vSphere servers, we recommend creating the
- cluster of hosts in vCenter and then adding the entire cluster to &PRODUCT;. See Add
- Cluster: vSphere.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Cluster name.</emphasis> Enter a name for the cluster. This
- can be text of your choosing and is not used by &PRODUCT;.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>In a new cluster, &PRODUCT; adds the first host for you. You can always add more hosts
- later. For an overview of what a host is, see About Hosts.</para>
- <note>
- <para>When you add a hypervisor host to &PRODUCT;, the host must not have any VMs already
- running.</para>
- </note>
- <para>Before you can configure the host, you need to install the hypervisor software on the
- host. You will need to know which version of the hypervisor software version is supported by
- &PRODUCT; and what additional configuration is required to ensure the host will work with
- &PRODUCT;. To find these installation details, see:</para>
- <itemizedlist>
- <listitem>
- <para>Citrix XenServer Installation and Configuration</para>
- </listitem>
- <listitem>
- <para>VMware vSphere Installation and Configuration</para>
- </listitem>
- <listitem>
- <para>KVM vSphere Installation and Configuration</para>
- </listitem>
- <!-- <listitem><para>Oracle VM (OVM) Installation and Configuration</para></listitem> -->
- </itemizedlist>
- <para>To configure the first host, enter the following, then click Next:</para>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">Host Name.</emphasis> The DNS name or IP address of the
- host.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Username.</emphasis> The username is root.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Password.</emphasis> This is the password for the user named
- above (from your XenServer or KVM install).</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Host Tags.</emphasis> (Optional) Any labels that you use to
- categorize hosts for ease of maintenance. For example, you can set this to the cloud's
- HA tag (set in the ha.tag global configuration parameter) if you want this host to be
- used only for VMs with the "high availability" feature enabled. For more information,
- see HA-Enabled Virtual Machines as well as HA for Hosts.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <para>In a new cluster, &PRODUCT; adds the first primary storage server for you. You can
- always add more servers later. For an overview of what primary storage is, see About Primary
- Storage.</para>
- <para>To configure the first primary storage server, enter the following, then click
- Next:</para>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">Name.</emphasis> The name of the storage device.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Protocol.</emphasis> For XenServer, choose either NFS, iSCSI,
- or PreSetup. For KVM, choose NFS, SharedMountPoint,CLVM, or RBD. For vSphere choose
- either VMFS (iSCSI or FiberChannel) or NFS. The remaining fields in the screen vary
- depending on what you choose here.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- </orderedlist>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5586a221/docs/en-US/basic-zone-guest-ip-addresses.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/basic-zone-guest-ip-addresses.xml b/docs/en-US/basic-zone-guest-ip-addresses.xml
deleted file mode 100644
index 5143f71..0000000
--- a/docs/en-US/basic-zone-guest-ip-addresses.xml
+++ /dev/null
@@ -1,27 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
-%BOOK_ENTITIES;
-]>
-
-<!-- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-<section id="basic-zone-guest-ip-addresses">
- <title>Basic Zone Guest IP Addresses</title>
- <para>When basic networking is used, &PRODUCT; will assign IP addresses in the CIDR of the pod to the guests in that pod. The administrator must add a Direct IP range on the pod for this purpose. These IPs are in the same VLAN as the hosts.</para>
-</section>