You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cloudstack.apache.org by Rohit Yadav <bh...@apache.org> on 2013/03/19 12:23:19 UTC

[DISCUSS] Make a video on "Writing plugins, APIs for CloudStack"

Writing a plugin and a new API for CloudStack is not difficult, we
just need to put some content on our wikis; Do we want to release a
new write a plugin or api video for 4.1+, I can volunteer?

I've updated the wiki: (read about the PluggableService design and how
it helps ApiServer and ApiDiscoveryService)
https://cwiki.apache.org/confluence/display/CLOUDSTACK/CloudStack+API+Development

There are only three steps:
1. Write your api cmd class with correct annotations
(https://cwiki.apache.org/confluence/display/CLOUDSTACK/Annotations+use+in+the+API)
2. Configure role based access in commands.properties.in
3. Your service should extend PluggableService. Add your api's cmd
class to its implementation's getCommands() list of API classes. Make
sure the service implementation is a Spring bean (put it either in one
of the xmls or use the @Component annotation on the service impl).

Note: In case you're adding an API to CloudStack server itself, add
your API class in ManagementServerImpl's getCommands() list of APIs.
Test with cloudmonkey!

Cheers.

Re: [DISCUSS] Make a video on "Writing plugins, APIs for CloudStack"

Posted by Mike Tutkowski <mi...@solidfire.com>.
Yeah, any content on creating a CS plug-in would be great to have.  I've
been reading the Wiki on it, but am still not convinced I know enough about
it to actually do it.


On Tue, Mar 19, 2013 at 7:35 AM, Donal Lafferty
<do...@citrix.com>wrote:

> +1, and can we be clear on how the CS4.1 and above 'PluggableService'
> relates to the 4.0 and below 'Plugin'?
>
> If there's a clear evolutionary path between the two, we should explain
> this under under Developer 101 [1] and CloudStack University [2].
>
> [1]
> https://cwiki.apache.org/confluence/display/CLOUDSTACK/CloudStack+API+Development
> [2] https://cwiki.apache.org/CLOUDSTACK/cloudstack-university.html
>
>
>
> > -----Original Message-----
> > From: Sebastien Goasguen [mailto:runseb@gmail.com]
> > Sent: 19 March 2013 12:27 PM
> > To: cloudstack-dev@incubator.apache.org
> > Subject: Re: [DISCUSS] Make a video on "Writing plugins, APIs for
> > CloudStack"
> >
> >
> > On Mar 19, 2013, at 7:23 AM, Rohit Yadav <bh...@apache.org> wrote:
> >
> > > Writing a plugin and a new API for CloudStack is not difficult, we
> > > just need to put some content on our wikis; Do we want to release a
> > > new write a plugin or api video for 4.1+, I can volunteer?
> >
> > Rohit, see my CS University wiki page.
> >
> > There is a section in there for "API" and "plugins"
> >
> > If you do this, could you do two separate screencasts and two separate
> slide
> > decks ?
> >
> > >
> > > I've updated the wiki: (read about the PluggableService design and how
> > > it helps ApiServer and ApiDiscoveryService)
> > >
> > https://cwiki.apache.org/confluence/display/CLOUDSTACK/CloudStack+API+
> > > Development
> > >
> > > There are only three steps:
> > > 1. Write your api cmd class with correct annotations
> > >
> > (https://cwiki.apache.org/confluence/display/CLOUDSTACK/Annotations+us
> > > e+in+the+API) 2. Configure role based access in commands.properties.in
> > > 3. Your service should extend PluggableService. Add your api's cmd
> > > class to its implementation's getCommands() list of API classes. Make
> > > sure the service implementation is a Spring bean (put it either in one
> > > of the xmls or use the @Component annotation on the service impl).
> > >
> > > Note: In case you're adding an API to CloudStack server itself, add
> > > your API class in ManagementServerImpl's getCommands() list of APIs.
> > > Test with cloudmonkey!
> > >
> > > Cheers.
>
>


-- 
*Mike Tutkowski*
*Senior CloudStack Developer, SolidFire Inc.*
e: mike.tutkowski@solidfire.com
o: 303.746.7302
Advancing the way the world uses the
cloud<http://solidfire.com/solution/overview/?video=play>
*™*

RE: [DISCUSS] Make a video on "Writing plugins, APIs for CloudStack"

Posted by Donal Lafferty <do...@citrix.com>.
+1, and can we be clear on how the CS4.1 and above 'PluggableService' relates to the 4.0 and below 'Plugin'?

If there's a clear evolutionary path between the two, we should explain this under under Developer 101 [1] and CloudStack University [2].

[1] https://cwiki.apache.org/confluence/display/CLOUDSTACK/CloudStack+API+Development
[2] https://cwiki.apache.org/CLOUDSTACK/cloudstack-university.html



> -----Original Message-----
> From: Sebastien Goasguen [mailto:runseb@gmail.com]
> Sent: 19 March 2013 12:27 PM
> To: cloudstack-dev@incubator.apache.org
> Subject: Re: [DISCUSS] Make a video on "Writing plugins, APIs for
> CloudStack"
> 
> 
> On Mar 19, 2013, at 7:23 AM, Rohit Yadav <bh...@apache.org> wrote:
> 
> > Writing a plugin and a new API for CloudStack is not difficult, we
> > just need to put some content on our wikis; Do we want to release a
> > new write a plugin or api video for 4.1+, I can volunteer?
> 
> Rohit, see my CS University wiki page.
> 
> There is a section in there for "API" and "plugins"
> 
> If you do this, could you do two separate screencasts and two separate slide
> decks ?
> 
> >
> > I've updated the wiki: (read about the PluggableService design and how
> > it helps ApiServer and ApiDiscoveryService)
> >
> https://cwiki.apache.org/confluence/display/CLOUDSTACK/CloudStack+API+
> > Development
> >
> > There are only three steps:
> > 1. Write your api cmd class with correct annotations
> >
> (https://cwiki.apache.org/confluence/display/CLOUDSTACK/Annotations+us
> > e+in+the+API) 2. Configure role based access in commands.properties.in
> > 3. Your service should extend PluggableService. Add your api's cmd
> > class to its implementation's getCommands() list of API classes. Make
> > sure the service implementation is a Spring bean (put it either in one
> > of the xmls or use the @Component annotation on the service impl).
> >
> > Note: In case you're adding an API to CloudStack server itself, add
> > your API class in ManagementServerImpl's getCommands() list of APIs.
> > Test with cloudmonkey!
> >
> > Cheers.


Re: [DISCUSS] Make a video on "Writing plugins, APIs for CloudStack"

Posted by Rohit Yadav <bh...@apache.org>.
On Tue, Mar 19, 2013 at 5:57 PM, Sebastien Goasguen <ru...@gmail.com> wrote:
>
> On Mar 19, 2013, at 7:23 AM, Rohit Yadav <bh...@apache.org> wrote:
>
>> Writing a plugin and a new API for CloudStack is not difficult, we
>> just need to put some content on our wikis; Do we want to release a
>> new write a plugin or api video for 4.1+, I can volunteer?
>
> Rohit, see my CS University wiki page.
>
> There is a section in there for "API" and "plugins"
>
> If you do this, could you do two separate screencasts and two separate slide decks ?

Okay will follow up that tomorrow, gym time now!

Cheers.

>
>>
>> I've updated the wiki: (read about the PluggableService design and how
>> it helps ApiServer and ApiDiscoveryService)
>> https://cwiki.apache.org/confluence/display/CLOUDSTACK/CloudStack+API+Development
>>
>> There are only three steps:
>> 1. Write your api cmd class with correct annotations
>> (https://cwiki.apache.org/confluence/display/CLOUDSTACK/Annotations+use+in+the+API)
>> 2. Configure role based access in commands.properties.in
>> 3. Your service should extend PluggableService. Add your api's cmd
>> class to its implementation's getCommands() list of API classes. Make
>> sure the service implementation is a Spring bean (put it either in one
>> of the xmls or use the @Component annotation on the service impl).
>>
>> Note: In case you're adding an API to CloudStack server itself, add
>> your API class in ManagementServerImpl's getCommands() list of APIs.
>> Test with cloudmonkey!
>>
>> Cheers.
>

Re: [DISCUSS] Make a video on "Writing plugins, APIs for CloudStack"

Posted by Sebastien Goasguen <ru...@gmail.com>.
On Mar 19, 2013, at 7:23 AM, Rohit Yadav <bh...@apache.org> wrote:

> Writing a plugin and a new API for CloudStack is not difficult, we
> just need to put some content on our wikis; Do we want to release a
> new write a plugin or api video for 4.1+, I can volunteer?

Rohit, see my CS University wiki page.

There is a section in there for "API" and "plugins"

If you do this, could you do two separate screencasts and two separate slide decks ?

> 
> I've updated the wiki: (read about the PluggableService design and how
> it helps ApiServer and ApiDiscoveryService)
> https://cwiki.apache.org/confluence/display/CLOUDSTACK/CloudStack+API+Development
> 
> There are only three steps:
> 1. Write your api cmd class with correct annotations
> (https://cwiki.apache.org/confluence/display/CLOUDSTACK/Annotations+use+in+the+API)
> 2. Configure role based access in commands.properties.in
> 3. Your service should extend PluggableService. Add your api's cmd
> class to its implementation's getCommands() list of API classes. Make
> sure the service implementation is a Spring bean (put it either in one
> of the xmls or use the @Component annotation on the service impl).
> 
> Note: In case you're adding an API to CloudStack server itself, add
> your API class in ManagementServerImpl's getCommands() list of APIs.
> Test with cloudmonkey!
> 
> Cheers.