Docs: Fix up grammar and missing text in AWS API compatibility chapter and add it to the Install Guide.
Project: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/commit/4846b67c Tree: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/tree/4846b67c Diff: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/diff/4846b67c Branch: refs/heads/4.0 Commit: 4846b67cad559c6e8130a88293e79e986baa35b6 Parents: 680032f Author: Jessica Tomechak <jessica.tomec...@gmail.com> Authored: Wed Oct 17 00:30:44 2012 -0700 Committer: Chip Childers <chip.child...@gmail.com> Committed: Mon Oct 22 10:49:41 2012 -0400 ---------------------------------------------------------------------- docs/en-US/Installation_Guide.xml | 1 + docs/en-US/aws-ec2-configuration.xml | 56 ++++++---------- docs/en-US/aws-ec2-introduction.xml | 13 ++-- docs/en-US/aws-ec2-requirements.xml | 15 +++-- docs/en-US/aws-ec2-supported-commands.xml | 37 ++++------- docs/en-US/aws-ec2-timeouts.xml | 50 ++++++++++++++ docs/en-US/aws-ec2-user-setup.xml | 82 ++++++++++++----------- docs/en-US/aws-interface-compatibility.xml | 33 +++++++++ docs/en-US/aws-interface-guide.xml | 32 --------- 9 files changed, 178 insertions(+), 141 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/4846b67c/docs/en-US/Installation_Guide.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/Installation_Guide.xml b/docs/en-US/Installation_Guide.xml index bdc3b8e..26c2521 100644 --- a/docs/en-US/Installation_Guide.xml +++ b/docs/en-US/Installation_Guide.xml @@ -53,5 +53,6 @@ <xi:include href="global-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> <xi:include href="hypervisor-installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> <xi:include href="choosing-a-deployment-architecture.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="aws-interface-compatibility.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> <xi:include href="Revision_History_Install_Guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> </book> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/4846b67c/docs/en-US/aws-ec2-configuration.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/aws-ec2-configuration.xml b/docs/en-US/aws-ec2-configuration.xml index e192407..b8966c1 100644 --- a/docs/en-US/aws-ec2-configuration.xml +++ b/docs/en-US/aws-ec2-configuration.xml @@ -23,42 +23,26 @@ --> <section id="aws-ec2-configuration"> - <title>Enabling the AWS API compatible Interface</title> + <title>Enabling the AWS API Compatible Interface</title> <para> - To enable the EC2 compatible service you need to set the configuration variable <emphasis>enable.ec2.api</emphasis>to true. This can be done via the &PRODUCT; GUI by going in <emphasis>Global Settings</emphasis> or via the API. - </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> - 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 url shows you how: - </para> - <para> - <programlisting> - http://localhost:8096/client/api?command=updateConfiguration&name=enable.ec2.api&value=true - </programlisting> - </para> - <para> - Once you have updated <emphasis>enable.ec2.api</emphasis>to true, restart the server. - </para> - <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 is easiest 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> + The software that provides AWS API compatibility is installed along with CloudPlatform. However, you must enable the feature and perform some setup steps. </para> + <orderedlist> + <listitem><para>Set the global configuration parameter enable.ec2.api to true. See <xref linkend="global-config" />.</para></listitem> + <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.</para></warning></listitem> + <listitem><para>If you did not already do so when you set the configuration parameter in step 1, restart the Management Server.</para> + <programlisting># service cloud-management restart</programlisting></listitem> + <listitem><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/cloud/management/server.xml, /etc/cloud/management/server-nonssl.xml, and /etc/cloud/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> + <note><para>If you re-install CloudStack, you will have to make these changes again.</para></note> + </listitem> + </orderedlist> + </listitem> + </orderedlist> </section> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/4846b67c/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 index c2bfb32..a4df086 100644 --- a/docs/en-US/aws-ec2-introduction.xml +++ b/docs/en-US/aws-ec2-introduction.xml @@ -24,13 +24,14 @@ <section id="aws-ec2-introduction"> <title>Amazon Web Services EC2 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 the same port. This Amazon EC2-compatible API is accessible through a SOAP web service as well as the REST query interface.</para> - <warning> - <para>Expect the SOAP service to be deprecated in new releases in favor of the REST interface.</para> - </warning> + <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 the same port. This Amazon EC2-compatible API is accessible through a SOAP web + service.</para> <note> - <para>This service was previously enabled by a separate software called CloudBridge, it is now fully integrated with the &PRODUCT; management server. - </para> + <para>This service was previously enabled by separate software called CloudBridge. It is now + fully integrated with the &PRODUCT; management server. </para> </note> <para>Limitations</para> <itemizedlist> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/4846b67c/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 index 916cec5..59fb5b6 100644 --- a/docs/en-US/aws-ec2-requirements.xml +++ b/docs/en-US/aws-ec2-requirements.xml @@ -23,8 +23,13 @@ --> <section id="aws-ec2-requirements"> - <title>System Requirements</title> - <para>This interface complies with Amazon's WDSL version dated November 15, 2010, available at http://ec2.amazonaws.com/doc/2010-11-15/. The EC2 command line utilities compatible with it are <emphasis>EC2 tools v. 1.3.6230</emphasis>that 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> - <note>Effort is underway to provide support for a newer API</note> -</section> + <title>System Requirements</title> + <itemizedlist> + <listitem><para>This 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>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> +</section> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/4846b67c/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 index 77e47bd..9494218 100644 --- a/docs/en-US/aws-ec2-supported-commands.xml +++ b/docs/en-US/aws-ec2-supported-commands.xml @@ -24,10 +24,9 @@ <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 compatibility feature 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>The following Amazon EC2 commands are supported by &PRODUCT; when the AWS API compatibility feature 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> - <para>Elastic IP Addresses</para> <table frame='all'> <title>Elastic IP API mapping</title> <tgroup cols='3' align='left' colsep='1' rowsep='1'> @@ -36,7 +35,7 @@ <thead> <row> <entry>EC2 command</entry> - <entry>SOAP all</entry> + <entry>SOAP call</entry> <entry>&PRODUCT; API call</entry> </row> </thead> @@ -69,7 +68,6 @@ </tbody> </tgroup> </table> - <para>Availability Zones</para> <table frame='all'> <title>Availability Zone API mapping</title> <tgroup cols='3' align='left' colsep='1' rowsep='1'> @@ -78,7 +76,7 @@ <thead> <row> <entry>EC2 command</entry> - <entry>SOAP all</entry> + <entry>SOAP call</entry> <entry>&PRODUCT; API call</entry> </row> </thead> @@ -91,7 +89,6 @@ </tbody> </tgroup> </table> - <para>Images</para> <table frame='all'> <title>Images API mapping</title> <tgroup cols='3' align='left' colsep='1' rowsep='1'> @@ -100,7 +97,7 @@ <thead> <row> <entry>EC2 command</entry> - <entry>SOAP all</entry> + <entry>SOAP call</entry> <entry>&PRODUCT; API call</entry> </row> </thead> @@ -128,7 +125,6 @@ </tbody> </tgroup> </table> - <para>Image Attributes</para> <table frame='all'> <title>Image Attributes API mapping</title> <tgroup cols='3' align='left' colsep='1' rowsep='1'> @@ -137,7 +133,7 @@ <thead> <row> <entry>EC2 command</entry> - <entry>SOAP all</entry> + <entry>SOAP call</entry> <entry>&PRODUCT; API call</entry> </row> </thead> @@ -160,7 +156,6 @@ </tbody> </tgroup> </table> - <para>Instances</para> <table frame='all'> <title>Instances API mapping</title> <tgroup cols='3' align='left' colsep='1' rowsep='1'> @@ -169,7 +164,7 @@ <thead> <row> <entry>EC2 command</entry> - <entry>SOAP all</entry> + <entry>SOAP call</entry> <entry>&PRODUCT; API call</entry> </row> </thead> @@ -207,7 +202,6 @@ </tbody> </tgroup> </table> - <para>Instance Attributes</para> <table frame='all'> <title>Instance Attributes Mapping</title> <tgroup cols='3' align='left' colsep='1' rowsep='1'> @@ -216,7 +210,7 @@ <thead> <row> <entry>EC2 command</entry> - <entry>SOAP all</entry> + <entry>SOAP call</entry> <entry>&PRODUCT; API call</entry> </row> </thead> @@ -229,7 +223,6 @@ </tbody> </tgroup> </table> - <para>Key Pairs</para> <table frame='all'> <title>Keys Pairs Mapping</title> <tgroup cols='3' align='left' colsep='1' rowsep='1'> @@ -238,7 +231,7 @@ <thead> <row> <entry>EC2 command</entry> - <entry>SOAP all</entry> + <entry>SOAP call</entry> <entry>&PRODUCT; API call</entry> </row> </thead> @@ -266,7 +259,6 @@ </tbody> </tgroup> </table> - <para>Passwords</para> <table frame='all'> <title>Passwords API Mapping</title> <tgroup cols='3' align='left' colsep='1' rowsep='1'> @@ -275,7 +267,7 @@ <thead> <row> <entry>EC2 command</entry> - <entry>SOAP all</entry> + <entry>SOAP call</entry> <entry>&PRODUCT; API call</entry> </row> </thead> @@ -288,7 +280,6 @@ </tbody> </tgroup> </table> - <para>Security Groups</para> <table frame='all'> <title>Security Groups API Mapping</title> <tgroup cols='3' align='left' colsep='1' rowsep='1'> @@ -297,7 +288,7 @@ <thead> <row> <entry>EC2 command</entry> - <entry>SOAP all</entry> + <entry>SOAP call</entry> <entry>&PRODUCT; API call</entry> </row> </thead> @@ -330,7 +321,6 @@ </tbody> </tgroup> </table> - <para>Snapshots</para> <table frame='all'> <title>Snapshots API Mapping</title> <tgroup cols='3' align='left' colsep='1' rowsep='1'> @@ -339,7 +329,7 @@ <thead> <row> <entry>EC2 command</entry> - <entry>SOAP all</entry> + <entry>SOAP call</entry> <entry>&PRODUCT; API call</entry> </row> </thead> @@ -362,7 +352,6 @@ </tbody> </tgroup> </table> - <para>Volumes</para> <table frame='all'> <title>Volumes API Mapping</title> <tgroup cols='3' align='left' colsep='1' rowsep='1'> @@ -371,7 +360,7 @@ <thead> <row> <entry>EC2 command</entry> - <entry>SOAP all</entry> + <entry>SOAP call</entry> <entry>&PRODUCT; API call</entry> </row> </thead> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/4846b67c/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 new file mode 100644 index 0000000..c8b3ec6 --- /dev/null +++ b/docs/en-US/aws-ec2-timeouts.xml @@ -0,0 +1,50 @@ +<?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 gain more time for commands to finish by overriding the default timeouts on individual commands. 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> +</section> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/4846b67c/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 index 50c9fe2..55b2950 100644 --- a/docs/en-US/aws-ec2-user-setup.xml +++ b/docs/en-US/aws-ec2-user-setup.xml @@ -22,70 +22,76 @@ under the License. --> <section id="aws-ec2-user-setup"> - <title>User configuration</title> - <para> - 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 specifyingi the endpoint of the managment server and using the proper user credentials.In order to do this, each user must perform the following configuration steps: - </para> + <title>AWS API User Setup Steps</title> + <para>In general, users need not be aware that they are using a translation service provided by &PRODUCT;. + They need only send AWS API calls to &PRODUCT;'s endpoint, and it will translate the calls to the native 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> + <para>Generate user credentials and register with the service.</para> </listitem> <listitem> - <para>Register with the service.</para> + <para>Set up the environment variables for the EC2 command-line tools.</para> </listitem> <listitem> - <para>Setup the environment variables</para> + <para>For SOAP access, use the endpoint http://<replaceable>&PRODUCT;-management-server</replaceable>:8080/awsapi. + The <replaceable>&PRODUCT;-management-server</replaceable> can be specified by a fully-qualified domain name or IP address.</para> </listitem> </itemizedlist> </para> - - <para> - To register, a user needs to: - </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> - <para> - Obtain his API key and his secret key as well as the DNS name or IP address of the &PRODUCT; server. Obtaining the keys can be done by asking the &PRODUCT; administrator or by using the GUI or via the API. - </para> + <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 API key and Secret key</para></listitem> + </itemizedlist> </listitem> <listitem> <para> - Obtain a self-signed X.509 certificate. It can be generated with the following command: + 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><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 mapping from the X.509 certificate to the API/Secret keys. Download the following script from http://download.cloud.com/releases/3.0.3/cloudstack-aws-api-register and run it. Substitute the values you obtained from the administrator in the URL below. + Register the mapping from the X.509 certificate to the API/Secret keys. + Download the following script from http://download.cloud.com/releases/3.0.3/cloudstack-aws-api-register and run it. + Substitute the values that were obtained in step 1 in the URL below. </para> <para> -<programlisting>$ cloudstack-aws-api-register --apikey=<replaceable>Userâs CloudPlatform API key</replaceable> --secretkey=<replaceable>Userâs CloudPlatform Secret key</replaceable> --cert=<replaceable>/path/to/cert.pem</replaceable> --url=http://<replaceable>&PRODUCT;.server</replaceable>:8080/awsapi</programlisting> +<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>:8080/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 public key would be uploaded to the &PRODUCT; management server database. + A user with an existing AWS certificate could choose to use the same certificate with &PRODUCT;, but the public key would be uploaded to the &PRODUCT; management server database. </para> </note> - - <para> - To use the EC2 command line tools, setup the environment variable in a similar fashion than with Amazon EC2 service. Specifically, in bash shell: - <programlisting> - $ export EC2_CERT=/path/to/cert.pem - $ export EC2_PRIVATE_KEY=/path/to/private_key.pem - $ export EC2_URL=http://<replaceable>&PRODUCT;.server</replaceable>:8080/awsapi - $ export EC2_HOME=/path/to/EC2_tools_directory - </programlisting> - </para> - - <note> - <para>The Amazon EC2 command-line tools have a default connection timeout. If you find that EC2 commands are not completing due to timeouts, you can pass a new timeout value as an argument with <programlisting>--connection-timeout TIMEOUT </programlisting> or <programlisting>--request-timeout TIMEOUT </programlisting> - </para> - </note> - -</section> + </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 environment variables that will direct the tools to the server. As a best practice, you may wish to place these commands in a script that may be sourced before using the AWS API translation feature.</para> + <programlisting>$ export EC2_CERT=/path/to/cert.pem +$ export EC2_PRIVATE_KEY=/path/to/private_key.pem +$ export EC2_URL=http://<replaceable>&PRODUCT;.server</replaceable>:8080/awsapi +$ export EC2_HOME=/path/to/EC2_tools_directory</programlisting> + </listitem> + </orderedlist> + </section> +</section> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/4846b67c/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 new file mode 100644 index 0000000..a03d447 --- /dev/null +++ b/docs/en-US/aws-interface-compatibility.xml @@ -0,0 +1,33 @@ +<?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 Service Interface Compatibility</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"; /> +</chapter> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/4846b67c/docs/en-US/aws-interface-guide.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/aws-interface-guide.xml b/docs/en-US/aws-interface-guide.xml deleted file mode 100644 index 0c42b5b..0000000 --- a/docs/en-US/aws-interface-guide.xml +++ /dev/null @@ -1,32 +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-guide"> - <title>Amazon Web Service Interface Guide</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-supported-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> -</chapter>
