mirror of
https://github.com/apache/cloudstack.git
synced 2025-10-26 08:42:29 +01:00
97 lines
5.1 KiB
XML
97 lines
5.1 KiB
XML
<?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 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 and register with the service.</para>
|
||
</listitem>
|
||
<listitem>
|
||
<para>Set up the environment variables for the EC2 command-line tools.</para>
|
||
</listitem>
|
||
<listitem>
|
||
<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>
|
||
<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 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>
|
||
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 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 &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 the public key 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 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> |