--- aeolusproject.org/content/basic_glossary.haml | 4 +- aeolusproject.org/content/cleaning_up.haml | 4 +- aeolusproject.org/content/configure_provider.haml | 231 +++++++++++++++++++++ aeolusproject.org/content/configuring_aeolus.haml | 8 +- aeolusproject.org/content/first_login.haml | 8 +- aeolusproject.org/content/make_template.haml | 27 ++- aeolusproject.org/content/start_image.haml | 14 +- aeolusproject.org/content/stop_image.haml | 4 +- aeolusproject.org/content/use_it.haml | 5 +- 9 files changed, 271 insertions(+), 34 deletions(-) create mode 100644 aeolusproject.org/content/configure_provider.haml
diff --git a/aeolusproject.org/content/basic_glossary.haml b/aeolusproject.org/content/basic_glossary.haml index 8b326ed..9d4afa3 100644 --- a/aeolusproject.org/content/basic_glossary.haml +++ b/aeolusproject.org/content/basic_glossary.haml @@ -25,8 +25,8 @@ filter: haml :title => "First login" } First login
%li - %a{ :href => "set_up_ec2.html", - :title => "Configuring for Amazon EC2" } Configuring for Amazon EC2 + %a{ :href => "configure_provider.html", + :title => "Configure your Provider" } Configure your Provider
%li %a{ :href => "make_template.html", diff --git a/aeolusproject.org/content/cleaning_up.haml b/aeolusproject.org/content/cleaning_up.haml index eb638be..d798e7e 100644 --- a/aeolusproject.org/content/cleaning_up.haml +++ b/aeolusproject.org/content/cleaning_up.haml @@ -25,8 +25,8 @@ Useful things to know when using development versions of Aeolus. :title => "First login" } First login
%li - %a{ :href => "set_up_ec2.html", - :title => "Configuring for Amazon EC2" } Configuring for Amazon EC2 + %a{ :href => "configure_provider.html", + :title => "Configure your Provider" } Configure your Provider
%li %a{ :href => "make_template.html", diff --git a/aeolusproject.org/content/configure_provider.haml b/aeolusproject.org/content/configure_provider.haml new file mode 100644 index 0000000..94e178c --- /dev/null +++ b/aeolusproject.org/content/configure_provider.haml @@ -0,0 +1,231 @@ +--- +title: Aeolus | Configure your Provider +breadcrumb_name: Configure your Provider +extension: html +filter: haml +--- +%h1 Configure your Provider + +%p + On this page you'll configure Aeolus to use Amazon EC2 (you'll need to have an existing account for EC2 with Amazon AWS) or the mock provider. + + %h2 Which provider would you like to configure? + + %ul + %li + %a(href="#ec2" title="Amazon EC2") + Amazon EC2 + %li + %a(href="#mock" title="Mock Provider") + Mock Provider + +.page-listing + %h3 Getting Started Guide + + %ol + %li + %a{ :href => "basic_glossary.html", + :title => "Basic glossary" } Basic glossary + + %li + %a{ :href => "configuring_aeolus.html", + :title => "Configuring Aeolus" } Configuring Aeolus + + %li + %a{ :href => "first_login.html", + :title => "First login" } First login + + %li + Configure your Provider + + %li + %a{ :href => "make_template.html", + :title => "Create a Fedora 15 Template" } Create a Fedora 15 Template + + %li + %a{ :href => "start_image.html", + :title => "Start an Instance of the Image" } Start an Instance of the Image + + %li + %a{ :href => "stop_image.html", + :title => "Stop a running Instance" } Stop a running Instance + + %li + %a{ :href => "cleaning_up.html", + :title => "Cleaning up" } Cleaning up + +%br + +%h1(id="ec2" style="margin-top:0") Amazon EC2 + +.warning + %b WARNING: + Amazon and other Cloud providers charge fees for using their products and + services, including EC2. + + %p + Setting up EC2 with Aeolus means your Amazon EC2 account will be billed + with their appropriate usage charges as you follow this guide and/or try + things out. + + %p + We + %b ARE NOT + responsible for any EC2 or other Cloud fees and charges you may incur. + + %p + As a precaution after finishing every Aeolus testing session, you + %b must + manually check all storage and instances in Amazon have been terminated + and removed as you expect. + + %p + Development versions of Aeolus have on occasion been known to report + instances as stopped when they are in fact still running in EC2, thereby + incurring charges from Amazon. + + %p + %b BE CAREFUL! + +%br + +.section-grouping + %h2 1. Configure EC2 credentials in Aeolus + + %p + Follow these steps to configure Amazon EC2 with Aeolus. + + %p + The information you need from Amazon is on the AWS + <a href="https://aws-portal.amazon.com/gp/aws/developer/account/index.html?action=acc..." + title="Security Credentials">Account ⇒ Security Credentials</a> + page . + + %p + %ol + %li + %em In the Aeolus web interface + (not the Amazon AWS Console) go to + %b Administer + ⇒ <b>Cloud Providers</b>. + + %li + Choose your provider in the upper right hand corner. + + %li + Click "Accounts" just below the choose provider selector. + + %li + Click the "New Account" button. + + %li + For + %b Account name + use any descriptive string you want, such as + "<em>Amazon EC2 East</em>". + %li + For Access Key, Secret Access Key and Account Number fill + in the values from the link at the top of this page. + +%br + +.section-grouping + %h2 2. x.509 Certificates + + %p + If you already have an existing EC2 x.509 certificate and private key, + use those for the key and certificate fields. + + %p + Alternatively, or if you don't have an X.509 Certificate yet, you can + create a new one: + + %p + %ol + %li + On the AWS + <a href="https://aws-portal.amazon.com/gp/aws/developer/account/index.html?action=acc..." + title="Security Credentials">Account ⇒ Security Credentials</a> + page, under + %b Access Credentials + click the + %em X.509 Certificates + tab. + + %li + Click <b>Create a new Certificate</b>. + %br + %br + A new window will open giving options to download and save the Private + Key and X.509 Certificate files. + %br + %br + + %li + Download and save the Private Key file using a name that is clear to + understand, such as <em>EC2 x509 Private Key.pem</em>. + + %li + Download and save the Certificate file using a name that is clear to + understand, such as <em>EC2 x509 Certificate.pem</em>. + + %li + Back in Aeolus, use the + %em EC2 x509 Private Key.pem + file for the key field. + %br + + %li + Use the + %em EC2 x509 Certificate.pem + file for the certificate field. + %br + + %li + Click the + %b Save + button. + + %p + This will take you back to the + %b PROVIDER ACCOUNT + screen. The new EC2 account should be listed. + + %p + If this does not happen, and you are presented with different behaviour + (such as an error message), please report it to us on the + %a{ :href => "contact.html#developer" } aeolus-devel + mailing list. + +%br + +%h1(id="mock" style="margin-top:0") Mock Provider + +.section-grouping + %h2 1. Confirm that the Mock Provider account exists + + %p + The mock provider account should already exist. Follow these steps to confirm. + + %p + %ol + %li + %em In the Aeolus web interface + go to + %b Administer + ⇒ <b>Cloud Providers</b>. + + %li + Choose the mock provider in the upper right hand corner. + + %li + Click "Accounts" just below the choose provider selector. + + %li + An account name "mock" should already exist. + +%br + +%a.button{ :href => "make_template.html", :title => "Create A Fedora 15 Template" } + Make Image + %img{:src => "images/button-right.png", :alt => "→"} diff --git a/aeolusproject.org/content/configuring_aeolus.haml b/aeolusproject.org/content/configuring_aeolus.haml index 77bccab..5ed9027 100644 --- a/aeolusproject.org/content/configuring_aeolus.haml +++ b/aeolusproject.org/content/configuring_aeolus.haml @@ -30,8 +30,8 @@ filter: haml :title => "First login" } First login
%li - %a{ :href => "set_up_ec2.html", - :title => "Configuring for Amazon EC2" } Configuring for Amazon EC2 + %a{ :href => "configure_provider.html", + :title => "Configure your Provider" } Configure your Provider
%li %a{ :href => "make_template.html", @@ -82,10 +82,10 @@ filter: haml %p %pre :preserve - $ sudo /usr/sbin/aeolus-configure -p ec2 + $ sudo /usr/sbin/aeolus-configure -p ec2,mock
%p - This performs an initial configuration of Aeolus with default settings. + This performs an initial configuration of Aeolus with default settings, along with pre-configured provider information for Amazon EC2 and the mock provider.
%p It is fully automatic, and doesn't require any input. It will take a diff --git a/aeolusproject.org/content/first_login.haml b/aeolusproject.org/content/first_login.haml index 6644850..5968012 100644 --- a/aeolusproject.org/content/first_login.haml +++ b/aeolusproject.org/content/first_login.haml @@ -26,8 +26,8 @@ filter: haml First login
%li - %a{ :href => "set_up_ec2.html", - :title => "Configuring for Amazon EC2" } Configuring for Amazon EC2 + %a{ :href => "configure_provider.html", + :title => "Configure your Provider" } Configure your Provider
%li %a{ :href => "make_template.html", @@ -185,6 +185,6 @@ filter: haml Click the "<b>Save User</b>" button when you're done. %br
-%a.button{ :href => "set_up_ec2.html", :title => "Set Up Amazon EC2" } - Set Up EC2 +%a.button{ :href => "configure_provider.html", :title => "Configure your Provider" } + Configure your Provider %img{:src => "images/button-right.png", :alt => "→"} diff --git a/aeolusproject.org/content/make_template.haml b/aeolusproject.org/content/make_template.haml index 9ef62b0..f875066 100644 --- a/aeolusproject.org/content/make_template.haml +++ b/aeolusproject.org/content/make_template.haml @@ -23,8 +23,8 @@ filter: haml :title => "First login" } First login
%li - %a{ :href => "set_up_ec2.html", - :title => "Configuring for Amazon EC2" } Configuring for Amazon EC2 + %a{ :href => "configure_provider.html", + :title => "Configure your Provider" } Configure your Provider
%li Create a Fedora 15 Template @@ -77,7 +77,12 @@ filter: haml
%pre :preserve - $ aeolus-cli build --target ec2 --template template.xml + $ aeolus-cli build --target ec2,mock --template template.xml + + Target Image Target Status Image Build + ------------------------------------ ------ --------- ------------------------------------ ------------------------------------ + 1306b29e-a30e-4efd-a1fb-09753863d77c ec2 COMPLETED 6214d1b6-7292-436f-9c62-f0852e469f70 995535c8-ee70-407c-9413-12d274bbdd1d + b33236d7-81b9-41b0-96f9-d039acd60537 mock COMPLETED 6214d1b6-7292-436f-9c62-f0852e469f70 995535c8-ee70-407c-9413-12d274bbdd1d
Target Image: 663ad46e-709f-4ea1-89f0-e73b8bb2205a Image: cb7acabd-59c3-41a7-894a-f3e1b072638c @@ -96,21 +101,22 @@ filter: haml used in the next step below.
%p - It is possible to build for more than one target by separating them with commas, e.g., with --target ec2,mock. + Note that it is possible to build for more than one target by separating them with commas, e.g., with --target ec2,mock.
%p Once an image is built, you will want to push the built image to one or more providers. You must specify the image, build, and target image UUIDs from the command above. In this step, instead of specifying --target, we will specify the name of the Provider as is configured in Conductor and also the name of the - appropriate Provider Account. + appropriate Provider Account. To push to the mock provider account, simply use "mock" as + both the provider and account name.
%pre :preserve $ aeolus-cli push --provider ec2-us-east-1 --account my_ec2 \ - --image 663ad46e-709f-4ea1-89f0-e73b8bb2205a \ - --build 3b5624b1-c9a5-48e2-b6cb-2abecd232eb9 \ - --targetimage 663ad46e-709f-4ea1-89f0-e73b8bb2205a + --image 6214d1b6-7292-436f-9c62-f0852e469f70 \ + --build 995535c8-ee70-407c-9413-12d274bbdd1d \ + --targetimage 1306b29e-a30e-4efd-a1fb-09753863d77c
Provider Image: 06479253-5f01-42b4-8d55-0e7ae8619700 Image: cb7acabd-59c3-41a7-894a-f3e1b072638c @@ -150,8 +156,9 @@ filter: haml %h2 3. Verifying on the Amazon Cloud side
%p - If you load Amazon's AWS Management Console in your web browser, you will - see this image in your list of registered AMI's: + If you pushed the template to your Amazon EC2 account, + load Amazon's AWS Management Console in your web browser. + You will see this image in your list of registered AMI's:
%p diff --git a/aeolusproject.org/content/start_image.haml b/aeolusproject.org/content/start_image.haml index 2836869..43bf71c 100644 --- a/aeolusproject.org/content/start_image.haml +++ b/aeolusproject.org/content/start_image.haml @@ -32,8 +32,8 @@ filter: haml :title => "First login" } First login
%li - %a{ :href => "set_up_ec2.html", - :title => "Configuring for Amazon EC2" } Configuring for Amazon EC2 + %a{ :href => "configure_provider.html", + :title => "Configure your Provider" } Configure your Provider
%li %a{ :href => "make_template.html", @@ -63,12 +63,12 @@ filter: haml <deployable name="My Deployable"> <description>This is an example deployment</description> <assemblies> - <assembly name="samplehost" hwp="hwp1"> - <image id="cb7acabd-59c3-41a7-894a-f3e1b072638c"> - </image> - </assembly> + <assembly name="samplehost" hwp="hwp1"> + <image id="cb7acabd-59c3-41a7-894a-f3e1b072638c"> + </image> + </assembly> </assemblies> - </deployable> + </deployable> %p %ol %li diff --git a/aeolusproject.org/content/stop_image.haml b/aeolusproject.org/content/stop_image.haml index 9ab0a24..7f742ae 100644 --- a/aeolusproject.org/content/stop_image.haml +++ b/aeolusproject.org/content/stop_image.haml @@ -23,8 +23,8 @@ filter: haml :title => "First login" } First login
%li - %a{ :href => "set_up_ec2.html", - :title => "Configuring for Amazon EC2" } Configuring for Amazon EC2 + %a{ :href => "configure_provider.html", + :title => "Configure your Provider" } Configure your Provider
%li %a{ :href => "make_template.html", diff --git a/aeolusproject.org/content/use_it.haml b/aeolusproject.org/content/use_it.haml index 4cf4dbe..6f49f65 100644 --- a/aeolusproject.org/content/use_it.haml +++ b/aeolusproject.org/content/use_it.haml @@ -1,4 +1,3 @@ - --- title: Aeolus | Use It breadcrumb_name: Use It @@ -36,8 +35,8 @@ filter: haml :title => "First login" } First login
%li - %a{ :href => "set_up_ec2.html", - :title => "Configuring for Amazon EC2" } Configuring for Amazon EC2 + %a{ :href => "configure_provider.html", + :title => "Configure your Provider" } Configure your Provider
%li %a{ :href => "make_template.html",
--- aeolusproject.org/content/cleaning_up.haml | 2 + aeolusproject.org/content/start_image.haml | 66 +++++++++------------------- aeolusproject.org/content/stop_image.haml | 29 ++++++------ 3 files changed, 37 insertions(+), 60 deletions(-)
diff --git a/aeolusproject.org/content/cleaning_up.haml b/aeolusproject.org/content/cleaning_up.haml index d798e7e..9e3ebbe 100644 --- a/aeolusproject.org/content/cleaning_up.haml +++ b/aeolusproject.org/content/cleaning_up.haml @@ -74,6 +74,8 @@ Useful things to know when using development versions of Aeolus. Conductor related data. Don't use it on a server whose data you want to keep.
+ %p + If you are using Amazon EC2, follow the next steps to complete the cleanup. %br
.section-grouping diff --git a/aeolusproject.org/content/start_image.haml b/aeolusproject.org/content/start_image.haml index 43bf71c..c1a7296 100644 --- a/aeolusproject.org/content/start_image.haml +++ b/aeolusproject.org/content/start_image.haml @@ -7,12 +7,12 @@ filter: haml %h1 Start an Instance of the Image
%p - With the image as an AMI in the Amazon Cloud, you can start instances + With the image as an AMI in your provider account, you can start instances when desired.
%p We'll take you through starting an instance of the image using Aeolus's - web interface, then show you how to connect to that image remotely using + web interface. Then, if you're using Amazon EC2, we'll show you how to connect to that image remotely using SSH.
.page-listing @@ -53,10 +53,10 @@ filter: haml %br
.section-grouping - %h2 1. Launch a deployable + %h2 1. Create a Catalog and Deployable
%p - On your Aeolus server create a file accessible in your web root with the following content. + Create a deployable XML file with the following content. Use the image id generated when you pushed the built image in the previous step.
%pre :escaped @@ -73,7 +73,18 @@ filter: haml %ol %li In the Aeolus web interface, go to the - %b MONITOR + %b Administer + ⇒ <b>Content</b>. + + %li + Click the "New Catalog" button. Give your catalog a name, associate it with the Default pool, and save it. + + %li + Click on the name of your new catalog. Click on the "New Catalog Entry" button. Give your entry a name, description, and upload the deployable XML file you created. Save your new catalog entry. + + %li + In the Aeolus web interface, go to the + %b Monitor tab. %br Under "Your Pools" is the default pool. On the right side @@ -90,56 +101,21 @@ filter: haml %br
%li - Give your deployment a name and enter the url to the deployable xml file you - just created. - - %br - %center - %a{ :href => "images/getting_started/new_deployment_details.png", - :target => "_blank" } - %img.thumbnail{ :src => "images/getting_started/thumbnails/new_deployment_details_thumb.png", - :title => "New Deployment - click to view at full size in a new window", - :alt => "New Deployment - click to view at full size in a new window" } - %br - - %li + Give your deployment a name and select the deployable you just created. Click the %b Next button.
%li - To launch the deployment click the "Launch this deployment" button. - - %br - %center - %a{ :href => "images/getting_started/launch_deployment.png", - :target => "_blank" } - %img.thumbnail{ :src => "images/getting_started/thumbnails/launch_deployment_thumb.png", - :title => "Launch Deployment - click to view at full size in a new window", - :alt => "Launch Deployment - click to view at full size in a new window" } - %br - + To launch the deployment click the "Launch" button. %p Aeolus will then launch an instance of the template, using the AMI - created on the previous page. - %p - The main view will list your instances, with the message - "<em>Deployment launched.</em>" near the top: - - %p - - %center - %a{ :href => "images/getting_started/instance_added.png", - :target => "_blank" } - %img.thumbnail{ :src => "images/getting_started/thumbnails/instance_added_thumb.png", - :title => "Instance 1 added", - :alt => "Instance 1 added" } - - %p - Within a minute or two, the + created on the previous page. Within a minute or two, the %b State field for the instance should change to "<em>running</em>".
+ %p + If you are using Amazon EC2, follow the next steps to complete your configuration. %br
.section-grouping diff --git a/aeolusproject.org/content/stop_image.haml b/aeolusproject.org/content/stop_image.haml index 7f742ae..4de4a49 100644 --- a/aeolusproject.org/content/stop_image.haml +++ b/aeolusproject.org/content/stop_image.haml @@ -50,19 +50,6 @@ filter: haml Shutting down a running instance is very simple.
%p - %ol - %li - On the same screen the ssh key and public address were available - switch to the grid view by clicking the grid button on the right - side of the page. - - %li - Tick the checkbox next to the instance name in the instance list. - - %li - Click the "Stop Selected Instances" button: - - %p %center %a{ :href => "images/getting_started/aeolus_stop_instance_button.png", @@ -72,8 +59,18 @@ filter: haml :alt => "Shutting down the instance - click to view at full size in a new window" }
%p - Within a minute or two the instance status should change to say - <em>stopped</em>: + %ol + %li + In the Aeolus web interface, click the + %b MONITOR + tab and select the grid view by clicking the grid button on the right side of the page. + + + %li + Click on "Instances" to view your running instances. Tick the checkbox next to the instance name in the instance list. + + %li + Click the "Stop selected instances" button. Within a minute or two the instance status should change to say <em>stopped</em>:
%p @@ -84,6 +81,8 @@ filter: haml :title => "Instance has stopped - click to view at full size in a new window", :alt => "Instance has stopped - click to view at full size in a new window" }
+ %p + If you are using Amazon EC2, follow the next step to check for instances running in EC2. %br
.section-grouping
--- aeolusproject.org/content/configure_provider.haml | 4 ++-- aeolusproject.org/content/stop_image.haml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/aeolusproject.org/content/configure_provider.haml b/aeolusproject.org/content/configure_provider.haml index 94e178c..25879d4 100644 --- a/aeolusproject.org/content/configure_provider.haml +++ b/aeolusproject.org/content/configure_provider.haml @@ -72,7 +72,7 @@ filter: haml We %b ARE NOT responsible for any EC2 or other Cloud fees and charges you may incur. - + %p As a precaution after finishing every Aeolus testing session, you %b must @@ -174,7 +174,7 @@ filter: haml %em EC2 x509 Private Key.pem file for the key field. %br - + %li Use the %em EC2 x509 Certificate.pem diff --git a/aeolusproject.org/content/stop_image.haml b/aeolusproject.org/content/stop_image.haml index 4de4a49..b2cb071 100644 --- a/aeolusproject.org/content/stop_image.haml +++ b/aeolusproject.org/content/stop_image.haml @@ -68,7 +68,7 @@ filter: haml
%li Click on "Instances" to view your running instances. Tick the checkbox next to the instance name in the instance list. - + %li Click the "Stop selected instances" button. Within a minute or two the instance status should change to say <em>stopped</em>:
aeolus-devel@lists.fedorahosted.org