Document compatibility with Amazon EC2 and how to use boto library

Bug #967916 reported by Lorin Hochstein
14
This bug affects 3 people
Affects Status Importance Assigned to Milestone
openstack-manuals
Won't Fix
Wishlist
Unassigned

Bug Description

Document the compatibility of the nova-api endpoint with Amazon EC2. This includes:

- Which API calls are supported (partially documented right now at http://wiki.openstack.org/Nova/EucalyptusFeatureComparison although possibly out of date)
- how compatible the metadata service is
- Any differences in the content of the data structures returned. (For example, I ran into the "architecture" field not being set and the name set to "None" when querying images using the EPI).

Should also document how to use boto to connect to the endpoint. For example (and I'm not even 100% sure this is correct:

import boto.ec2
region_name = "My internal cloud"

endpoint = "192.168.2.10" # Example endpoint IP
access_key = ... # Describe how to determine the access key
secret_key = ... # Describe how to determine the secret key

# These are the defaults, at least for Diablo
port = 8773
path = "/services/Cloud"
is_secure = False # endpoint does not use SSL by default

region = boto.ec2.regioninfo.RegionInfo(region_name, endpoint)
connection = boto.ec2.connect_ec2(access_key, secret_key, region=region, port=port, path=path, is_secure=is_secure)

Tags: nova ec2
Anne Gentle (annegentle)
Changed in openstack-manuals:
importance: Undecided → Low
status: New → Confirmed
Revision history for this message
Tom Fifield (fifieldt) wrote :
Tom Fifield (fifieldt)
tags: added: ec2 nova
Changed in openstack-manuals:
status: Confirmed → Triaged
Revision history for this message
Anne Gentle (annegentle) wrote :

Also note update to nova that enables version checking conditionals throughout
get_ec2_metadata and only includes the metadata if the requested version
should contain it.

When there is a difference between Amazon API implementation and documentation
I've gone with replicating the implementation. So far differences include:
- undocumented hostname introduced in 1.0, deprecated in favour of
  local-hostname
- kernel-id and ramdisk-id seem have to been implemented in 2007-12-15,
  not 2008-02-01 as documented

get_ec2_metadata has also been reordered so that data is added oldest to
newest by API version. In a future change I may attempt to add
unimplemented API versions (2011-01-01, 2012-06-01).

See https://review.openstack.org/#/c/9205/

Tom Fifield (fifieldt)
Changed in openstack-manuals:
importance: Low → Wishlist
Revision history for this message
Tom Fifield (fifieldt) wrote :

I think this is so wide-ranging, it should be a blueprint.

Revision history for this message
Tom Fifield (fifieldt) wrote :

lack of ec2 docs is a wide-ranging known problem area

Changed in openstack-manuals:
status: Triaged → Won't Fix
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.