Bug #8161

CloudPack documentation should include an AWS EC2 Quick Start

Added by Jeff McCune almost 2 years ago. Updated over 1 year ago.

Status:AcceptedStart date:06/30/2011
Priority:NormalDue date:
Assignee:Kelsey Hightower% Done:

0%

Category:cloudpackSpent time:-
Target version:-
Keywords:cloudpack Branch:

Description

Overview

There are a number of required steps to setup an Amazon AWS EC2 account and configure certain things before Cloud Pack is functional for the end-user.

The CloudPack documentation should help an end-user who has never used Amazon EC2 or Puppet quickly get started.

At a high level these are:

  1. Create an AWS Account
  2. Create an SSH key pair and download the SSH private key
  3. Find and copy / paste your access key ID and secret access key
  4. Re-configure the default security group to allow port 22 (SSH) inbound
  5. Select an AMI to use (There’s a TON, which to pick?)
  6. Select an image size (—type) to use

These actions are not specific to Puppet and Cloud Pack, but rather specific to Amazon AWS EC2. Since they’re required actions and common stumbling blocks for people it would be nice to help the end user overcome these issues.

Related issues

Related to Cloud-Provisioner - Feature #7510: CloudPack face actions should be documented Closed 05/12/2011

History

#1 Updated by Jeff McCune almost 2 years ago

Nice to have for release

Dan and I believe this is a “nice to have” for release, but not required.

#2 Updated by James Turnbull almost 2 years ago

  • Status changed from Unreviewed to Accepted

#3 Updated by Nigel Kersten almost 2 years ago

  • Category set to cloudpack

#4 Updated by Kelsey Hightower over 1 year ago

  • Assignee set to Kelsey Hightower

I am going to take a shot at providing this high level documentation. The plan is to merge this work with the updates I need to do for the CP READMEs.

#5 Updated by Kelsey Hightower over 1 year ago

My thoughts are to add the Amazon EC2 Quick Start to the README file. Here is my initial outline:

Amazon EC2 Quick Start
======================
Before launching instances with the Cloud Provisioner module, you'll need to complete
the following tasks:

 * Create an Amazon EC2 Account
 * Create an SSH key pair
 * Create an Fog configuration file
 * Configure your AWS default security group to allow inbound SSH
 * Select an AMI image and size to launch

The above tasks are not specific to Puppet or Cloud Pack, but rather specific to Amazon AWS EC2.

Creating an Amazon EC2 Account
------------------------------

Creating an SSH Key Pair
------------------------

Creating an Fog configuration file
----------------------------------

Configure your AWS default security group to allow inbound SSH
--------------------------------------------------------------

Select an AMI image and size to launch
--------------------------------------

#6 Updated by Jeff McCune over 1 year ago

This looks like a great outline kelsey. My only comment is that it’d be great to sync up with Nick F just in case he already has a draft of this “done”

You may also want to borrow from the quick start guide for CloPro at docs.puppetlabs.com.

Finally, if you’re in there as well, the docs repository accepts pull requests too if you’re feeling particularly charitable. =) You can fork it from: https://github.com/puppetlabs/puppet-docs

-Jeff

Also available in: Atom PDF