You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@cloudstack.apache.org by Jose Rozanec <jr...@tendrilinc.com> on 2012/05/31 05:32:20 UTC

How do ec2 commands map cloudstack API?

Hello,

Is there a document explaining how do ec2 commands map cloudstack api
parameters? I found this
page<http://wiki.cloudstack.org/display/QA/EC2+API+support+-+Test+Execution>with
some data.
Specifically, is there a way to run the ec2-run-instances command
specifying a network (to be translated to something like the
iptonetworklist[0].networkid=207 parameter on cloudstack API?)
How is the --subnet parameter handled?

Thanks,

Jose.

 
This email and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed.
If you have received this email in error please notify the sender.
Please note that any views or opinions presented in this email are solely those of the author and do not necessarily represent those of the company.
Finally, the recipient should check this email and any attachments for the presence of viruses.
The company accepts no liability for any damage caused by any virus transmitted by this email.

RE: How do ec2 commands map cloudstack API?

Posted by Jessica Tomechak <Je...@citrix.com>.
Sam,
I filed this as a sub-task bug in Jira.

http://bugs.cloudstack.org/browse/CS-15189


Jessica T.
CloudStack Tech Pubs


-----Original Message-----
From: Sam Robertson [mailto:Sam.Robertson@citrix.com] 
Sent: Thursday, May 31, 2012 12:04 PM
To: cloudstack-users@incubator.apache.org
Subject: Re: How do ec2 commands map cloudstack API?

Hi Jose,

Here's a little more information, if you can decipher the code.
CloudBridge fortunately has all the mappings from ec2 api to cloudstack api in a single source file (there are obviously some tweaks to accommodate code reuse etc), but you can look at that on github directly if you would like to understand what command turns into what cloudstack calls.  As you can imagine, the systems are very different and some commands turn into multiple cloudstack calls (run instances in particular is a good example of that).

https://github.com/CloudStack/CloudBridge/blob/master/src/com/cloud/bridge/
service/core/ec2/EC2Engine.java


Again, this isn't real useful unless you can read the code.

This begs a question though, would this be useful in documentation?
Meaning, a table showing the ec2 calls on the left side with their corresponding cloudstack api calls on the right?

Look at the following table showing the supported commands currently in cloudbridge.  We should the ec2 cli tool, then the corresponding ec2 soap call.

http://docs.cloud.com/CloudBridge_Documentation/Supported_Amazon_EC2_Comman
ds_in_CloudBridge


I could see adding a third column that shows what you found in the spreadsheet directly in the documentation.

Sam

On 5/30/12 9:06 PM, "Jose Rozanec" <jr...@tendrilinc.com> wrote:

>Thanks!
>
>On Thu, May 31, 2012 at 12:59 AM, Jessica Tomechak < 
>Jessica.Tomechak@citrix.com> wrote:
>
>> Jose,
>> At the URL in your note, there is a link to an Excel spreadsheet. If 
>>you  look at the "API List" tab of the spreadsheet, it shows which 
>>parameters  are supported and which are not. Unsupported parameters 
>>are in red. On the  specific command you're asking about, 
>>ec2-run-instances, it looks to me as  if --subnet is in the red 
>>category.
>>
>> We are in the process of updating our published AWS API compatibility 
>> documentation. The existing version is at 
>> http://docs.cloudstack.org/CloudBridge_Documentation .
>>
>> I hope this information is helpful.
>>
>> Jessica T.
>> CloudStack Tech Pubs
>>
>>
>> -----Original Message-----
>> From: Jose Rozanec [mailto:jrozanec@tendrilinc.com]
>> Sent: Wednesday, May 30, 2012 8:32 PM
>> To: cloudstack-users@incubator.apache.org
>> Subject: How do ec2 commands map cloudstack API?
>>
>> Hello,
>>
>> Is there a document explaining how do ec2 commands map cloudstack api 
>> parameters? I found this page< 
>> http://wiki.cloudstack.org/display/QA/EC2+API+support+-+Test+Executio
>> n
>> >with
>> some data.
>> Specifically, is there a way to run the ec2-run-instances command  
>>specifying a network (to be translated to something like the
>> iptonetworklist[0].networkid=207 parameter on cloudstack API?) How is 
>>the  --subnet parameter handled?
>>
>> Thanks,
>>
>> Jose.
>>
>>
>> This email and any files transmitted with it are confidential and 
>>intended  solely for the use of the individual or entity to whom they 
>>are addressed.
>> If you have received this email in error please notify the sender.
>> Please note that any views or opinions presented in this email are 
>>solely  those of the author and do not necessarily represent those of 
>>the company.
>> Finally, the recipient should check this email and any attachments 
>>for the  presence of viruses.
>> The company accepts no liability for any damage caused by any virus  
>>transmitted by this email.
>>
>
> 
>This email and any files transmitted with it are confidential and 
>intended solely for the use of the individual or entity to whom they 
>are addressed.
>If you have received this email in error please notify the sender.
>Please note that any views or opinions presented in this email are 
>solely those of the author and do not necessarily represent those of the company.
>Finally, the recipient should check this email and any attachments for 
>the presence of viruses.
>The company accepts no liability for any damage caused by any virus 
>transmitted by this email.


Re: How do ec2 commands map cloudstack API?

Posted by Jose Rozanec <jr...@tendrilinc.com>.
Hello,

Yes, I think it would be useful to add the third column. Perhaps at
the beginning of the document the EC2Engine.java file can be referenced
explaining that all the mappings are made there. This way, anyone searching
for EC2-cloudstack mapping info will get all the information referenced on
that page.

Jose.

On Thu, May 31, 2012 at 4:04 PM, Sam Robertson <Sa...@citrix.com>wrote:

> Hi Jose,
>
> Here's a little more information, if you can decipher the code.
> CloudBridge fortunately has all the mappings from ec2 api to cloudstack
> api in a single source file (there are obviously some tweaks to
> accommodate code reuse etc), but you can look at that on github directly
> if you would like to understand what command turns into what cloudstack
> calls.  As you can imagine, the systems are very different and some
> commands turn into multiple cloudstack calls (run instances in particular
> is a good example of that).
>
> https://github.com/CloudStack/CloudBridge/blob/master/src/com/cloud/bridge/
> service/core/ec2/EC2Engine.java
>
>
> Again, this isn't real useful unless you can read the code.
>
> This begs a question though, would this be useful in documentation?
> Meaning, a table showing the ec2 calls on the left side with their
> corresponding cloudstack api calls on the right?
>
> Look at the following table showing the supported commands currently in
> cloudbridge.  We should the ec2 cli tool, then the corresponding ec2 soap
> call.
>
> http://docs.cloud.com/CloudBridge_Documentation/Supported_Amazon_EC2_Comman
> ds_in_CloudBridge
>
>
> I could see adding a third column that shows what you found in the
> spreadsheet directly in the documentation.
>
> Sam
>
> On 5/30/12 9:06 PM, "Jose Rozanec" <jr...@tendrilinc.com> wrote:
>
> >Thanks!
> >
> >On Thu, May 31, 2012 at 12:59 AM, Jessica Tomechak <
> >Jessica.Tomechak@citrix.com> wrote:
> >
> >> Jose,
> >> At the URL in your note, there is a link to an Excel spreadsheet. If you
> >> look at the "API List" tab of the spreadsheet, it shows which parameters
> >> are supported and which are not. Unsupported parameters are in red. On
> >>the
> >> specific command you're asking about, ec2-run-instances, it looks to me
> >>as
> >> if --subnet is in the red category.
> >>
> >> We are in the process of updating our published AWS API compatibility
> >> documentation. The existing version is at
> >> http://docs.cloudstack.org/CloudBridge_Documentation .
> >>
> >> I hope this information is helpful.
> >>
> >> Jessica T.
> >> CloudStack Tech Pubs
> >>
> >>
> >> -----Original Message-----
> >> From: Jose Rozanec [mailto:jrozanec@tendrilinc.com]
> >> Sent: Wednesday, May 30, 2012 8:32 PM
> >> To: cloudstack-users@incubator.apache.org
> >> Subject: How do ec2 commands map cloudstack API?
> >>
> >> Hello,
> >>
> >> Is there a document explaining how do ec2 commands map cloudstack api
> >> parameters? I found this page<
> >> http://wiki.cloudstack.org/display/QA/EC2+API+support+-+Test+Execution
> >> >with
> >> some data.
> >> Specifically, is there a way to run the ec2-run-instances command
> >> specifying a network (to be translated to something like the
> >> iptonetworklist[0].networkid=207 parameter on cloudstack API?) How is
> >>the
> >> --subnet parameter handled?
> >>
> >> Thanks,
> >>
> >> Jose.
> >>
> >>
> >> This email and any files transmitted with it are confidential and
> >>intended
> >> solely for the use of the individual or entity to whom they are
> >>addressed.
> >> If you have received this email in error please notify the sender.
> >> Please note that any views or opinions presented in this email are
> >>solely
> >> those of the author and do not necessarily represent those of the
> >>company.
> >> Finally, the recipient should check this email and any attachments for
> >>the
> >> presence of viruses.
> >> The company accepts no liability for any damage caused by any virus
> >> transmitted by this email.
> >>
> >
> >
> >This email and any files transmitted with it are confidential and
> >intended solely for the use of the individual or entity to whom they are
> >addressed.
> >If you have received this email in error please notify the sender.
> >Please note that any views or opinions presented in this email are solely
> >those of the author and do not necessarily represent those of the company.
> >Finally, the recipient should check this email and any attachments for
> >the presence of viruses.
> >The company accepts no liability for any damage caused by any virus
> >transmitted by this email.
>
>

 
This email and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed.
If you have received this email in error please notify the sender.
Please note that any views or opinions presented in this email are solely those of the author and do not necessarily represent those of the company.
Finally, the recipient should check this email and any attachments for the presence of viruses.
The company accepts no liability for any damage caused by any virus transmitted by this email.

Re: How do ec2 commands map cloudstack API?

Posted by Sam Robertson <Sa...@citrix.com>.
Hi Jose,

Here's a little more information, if you can decipher the code.
CloudBridge fortunately has all the mappings from ec2 api to cloudstack
api in a single source file (there are obviously some tweaks to
accommodate code reuse etc), but you can look at that on github directly
if you would like to understand what command turns into what cloudstack
calls.  As you can imagine, the systems are very different and some
commands turn into multiple cloudstack calls (run instances in particular
is a good example of that).

https://github.com/CloudStack/CloudBridge/blob/master/src/com/cloud/bridge/
service/core/ec2/EC2Engine.java


Again, this isn't real useful unless you can read the code.

This begs a question though, would this be useful in documentation?
Meaning, a table showing the ec2 calls on the left side with their
corresponding cloudstack api calls on the right?

Look at the following table showing the supported commands currently in
cloudbridge.  We should the ec2 cli tool, then the corresponding ec2 soap
call.

http://docs.cloud.com/CloudBridge_Documentation/Supported_Amazon_EC2_Comman
ds_in_CloudBridge


I could see adding a third column that shows what you found in the
spreadsheet directly in the documentation.

Sam

On 5/30/12 9:06 PM, "Jose Rozanec" <jr...@tendrilinc.com> wrote:

>Thanks!
>
>On Thu, May 31, 2012 at 12:59 AM, Jessica Tomechak <
>Jessica.Tomechak@citrix.com> wrote:
>
>> Jose,
>> At the URL in your note, there is a link to an Excel spreadsheet. If you
>> look at the "API List" tab of the spreadsheet, it shows which parameters
>> are supported and which are not. Unsupported parameters are in red. On
>>the
>> specific command you're asking about, ec2-run-instances, it looks to me
>>as
>> if --subnet is in the red category.
>>
>> We are in the process of updating our published AWS API compatibility
>> documentation. The existing version is at
>> http://docs.cloudstack.org/CloudBridge_Documentation .
>>
>> I hope this information is helpful.
>>
>> Jessica T.
>> CloudStack Tech Pubs
>>
>>
>> -----Original Message-----
>> From: Jose Rozanec [mailto:jrozanec@tendrilinc.com]
>> Sent: Wednesday, May 30, 2012 8:32 PM
>> To: cloudstack-users@incubator.apache.org
>> Subject: How do ec2 commands map cloudstack API?
>>
>> Hello,
>>
>> Is there a document explaining how do ec2 commands map cloudstack api
>> parameters? I found this page<
>> http://wiki.cloudstack.org/display/QA/EC2+API+support+-+Test+Execution
>> >with
>> some data.
>> Specifically, is there a way to run the ec2-run-instances command
>> specifying a network (to be translated to something like the
>> iptonetworklist[0].networkid=207 parameter on cloudstack API?) How is
>>the
>> --subnet parameter handled?
>>
>> Thanks,
>>
>> Jose.
>>
>>
>> This email and any files transmitted with it are confidential and
>>intended
>> solely for the use of the individual or entity to whom they are
>>addressed.
>> If you have received this email in error please notify the sender.
>> Please note that any views or opinions presented in this email are
>>solely
>> those of the author and do not necessarily represent those of the
>>company.
>> Finally, the recipient should check this email and any attachments for
>>the
>> presence of viruses.
>> The company accepts no liability for any damage caused by any virus
>> transmitted by this email.
>>
>
> 
>This email and any files transmitted with it are confidential and
>intended solely for the use of the individual or entity to whom they are
>addressed.
>If you have received this email in error please notify the sender.
>Please note that any views or opinions presented in this email are solely
>those of the author and do not necessarily represent those of the company.
>Finally, the recipient should check this email and any attachments for
>the presence of viruses.
>The company accepts no liability for any damage caused by any virus
>transmitted by this email.


Re: How do ec2 commands map cloudstack API?

Posted by Jose Rozanec <jr...@tendrilinc.com>.
Thanks!

On Thu, May 31, 2012 at 12:59 AM, Jessica Tomechak <
Jessica.Tomechak@citrix.com> wrote:

> Jose,
> At the URL in your note, there is a link to an Excel spreadsheet. If you
> look at the "API List" tab of the spreadsheet, it shows which parameters
> are supported and which are not. Unsupported parameters are in red. On the
> specific command you're asking about, ec2-run-instances, it looks to me as
> if --subnet is in the red category.
>
> We are in the process of updating our published AWS API compatibility
> documentation. The existing version is at
> http://docs.cloudstack.org/CloudBridge_Documentation .
>
> I hope this information is helpful.
>
> Jessica T.
> CloudStack Tech Pubs
>
>
> -----Original Message-----
> From: Jose Rozanec [mailto:jrozanec@tendrilinc.com]
> Sent: Wednesday, May 30, 2012 8:32 PM
> To: cloudstack-users@incubator.apache.org
> Subject: How do ec2 commands map cloudstack API?
>
> Hello,
>
> Is there a document explaining how do ec2 commands map cloudstack api
> parameters? I found this page<
> http://wiki.cloudstack.org/display/QA/EC2+API+support+-+Test+Execution
> >with
> some data.
> Specifically, is there a way to run the ec2-run-instances command
> specifying a network (to be translated to something like the
> iptonetworklist[0].networkid=207 parameter on cloudstack API?) How is the
> --subnet parameter handled?
>
> Thanks,
>
> Jose.
>
>
> This email and any files transmitted with it are confidential and intended
> solely for the use of the individual or entity to whom they are addressed.
> If you have received this email in error please notify the sender.
> Please note that any views or opinions presented in this email are solely
> those of the author and do not necessarily represent those of the company.
> Finally, the recipient should check this email and any attachments for the
> presence of viruses.
> The company accepts no liability for any damage caused by any virus
> transmitted by this email.
>

 
This email and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed.
If you have received this email in error please notify the sender.
Please note that any views or opinions presented in this email are solely those of the author and do not necessarily represent those of the company.
Finally, the recipient should check this email and any attachments for the presence of viruses.
The company accepts no liability for any damage caused by any virus transmitted by this email.

Re: How do ec2 commands map cloudstack API?

Posted by Jessica Tomechak <je...@gmail.com>.
The updated documentation on the Amazon Web Services API integration with
CloudStack is now available as a new section in the Installation Guide:

http://support.citrix.com/article/CTX133611

This updated Install Guide is for the Citrix-branded release 3.0.3. The
information about how to enable and set up AWS for CloudStack is new
starting in 3.0.3, but the information about which commands and parameters
are supported should be correct for any CloudStack 3.0.x, and (mostly)
correct for 2.2.x as well.

Jessica T.
CloudStack Tech Pubs

-----Original Message-----
> From: Jessica Tomechak [mailto:Jessica.Tomechak@citrix.com]
> Sent: Wednesday, May 30, 2012 9:00 PM
> To: cloudstack-users@incubator.apache.org
> Subject: RE: How do ec2 commands map cloudstack API?
>
> Jose,
> At the URL in your note, there is a link to an Excel spreadsheet. If you
> look at the "API List" tab of the spreadsheet, it shows which parameters
> are supported and which are not. Unsupported parameters are in red. On the
> specific command you're asking about, ec2-run-instances, it looks to me as
> if --subnet is in the red category.
>
> We are in the process of updating our published AWS API compatibility
> documentation. The existing version is at
> http://docs.cloudstack.org/CloudBridge_Documentation .
>
> I hope this information is helpful.
>
> Jessica T.
> CloudStack Tech Pubs
>
>
> -----Original Message-----
> From: Jose Rozanec [mailto:jrozanec@tendrilinc.com]
> Sent: Wednesday, May 30, 2012 8:32 PM
> To: cloudstack-users@incubator.apache.org
> Subject: How do ec2 commands map cloudstack API?
>
> Hello,
>
> Is there a document explaining how do ec2 commands map cloudstack api
> parameters? I found this page<
> http://wiki.cloudstack.org/display/QA/EC2+API+support+-+Test+Execution
> >with
> some data.
> Specifically, is there a way to run the ec2-run-instances command
> specifying a network (to be translated to something like the
> iptonetworklist[0].networkid=207 parameter on cloudstack API?) How is the
> --subnet parameter handled?
>
> Thanks,
>
> Jose.
>
>
> This email and any files transmitted with it are confidential and intended
> solely for the use of the individual or entity to whom they are addressed.
> If you have received this email in error please notify the sender.
> Please note that any views or opinions presented in this email are solely
> those of the author and do not necessarily represent those of the company.
> Finally, the recipient should check this email and any attachments for the
> presence of viruses.
> The company accepts no liability for any damage caused by any virus
> transmitted by this email.
>

RE: How do ec2 commands map cloudstack API?

Posted by Jessica Tomechak <Je...@citrix.com>.
Jose,
At the URL in your note, there is a link to an Excel spreadsheet. If you look at the "API List" tab of the spreadsheet, it shows which parameters are supported and which are not. Unsupported parameters are in red. On the specific command you're asking about, ec2-run-instances, it looks to me as if --subnet is in the red category.

We are in the process of updating our published AWS API compatibility documentation. The existing version is at http://docs.cloudstack.org/CloudBridge_Documentation .

I hope this information is helpful.

Jessica T.
CloudStack Tech Pubs


-----Original Message-----
From: Jose Rozanec [mailto:jrozanec@tendrilinc.com] 
Sent: Wednesday, May 30, 2012 8:32 PM
To: cloudstack-users@incubator.apache.org
Subject: How do ec2 commands map cloudstack API?

Hello,

Is there a document explaining how do ec2 commands map cloudstack api parameters? I found this page<http://wiki.cloudstack.org/display/QA/EC2+API+support+-+Test+Execution>with
some data.
Specifically, is there a way to run the ec2-run-instances command specifying a network (to be translated to something like the
iptonetworklist[0].networkid=207 parameter on cloudstack API?) How is the --subnet parameter handled?

Thanks,

Jose.

 
This email and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed.
If you have received this email in error please notify the sender.
Please note that any views or opinions presented in this email are solely those of the author and do not necessarily represent those of the company.
Finally, the recipient should check this email and any attachments for the presence of viruses.
The company accepts no liability for any damage caused by any virus transmitted by this email.