[jira] [Commented] (SUBMARINE-481) Use Swagger to describe and document submarine RESTful APIs

2020-05-01 Thread Wangda Tan (Jira)


[ 
https://issues.apache.org/jira/browse/SUBMARINE-481?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17097715#comment-17097715
 ] 

Wangda Tan commented on SUBMARINE-481:
--

Thanks [~pingsutw], 

I just posted some comments to 
[https://docs.google.com/document/d/1T-NowARlz0EGrsMiAdUmA6af1b_G4bUPu-eKi7nvuk8/edit#heading=h.t713oano4cl4,
 
|https://docs.google.com/document/d/1T-NowARlz0EGrsMiAdUmA6af1b_G4bUPu-eKi7nvuk8/edit#heading=h.t713oano4cl4]

I will let [~sunilg]/[~tangzhankun], etc. to help with further reviews 
especially how we do implementation by using Swagger. 

Swagger 3.0 should be a better choice as we have some recent projects are 
struggling to upgrade to 3.0. 3.0 has some important features like inheritance 
support, etc. 
[https://swagger.io/docs/specification/data-models/inheritance-and-polymorphism/]

[~jiwq], do you have any more updates about how much work needed to use the new 
API? Draft see 
[https://docs.google.com/document/d/1T-NowARlz0EGrsMiAdUmA6af1b_G4bUPu-eKi7nvuk8/edit#heading=h.t713oano4cl4]

> Use Swagger to describe and document submarine RESTful APIs
> ---
>
> Key: SUBMARINE-481
> URL: https://issues.apache.org/jira/browse/SUBMARINE-481
> Project: Apache Submarine
>  Issue Type: Improvement
>  Components: Doc
>Reporter: Kevin Su
>Assignee: Kevin Su
>Priority: Major
>  Labels: pull-request-available
> Attachments: experiment.yaml, swagger.yaml
>
>
> Follow 
> [JobManagerRestApi.java|https://github.com/apache/submarine/blob/31f9322216307f958a1c3ec79e8a09cb0a5f5b5e/submarine-server/server-core/src/main/java/org/apache/submarine/server/rest/JobManagerRestApi.java#L44]
>  and [Job.java 
> |https://github.com/apache/submarine/blob/master/submarine-server/server-api/src/main/java/org/apache/submarine/server/api/job/Job.java],
>  [submarine-server 
> doc|https://github.com/apache/submarine/tree/master/docs/submarine-server] to 
> define our job API by swagger
> We could copy swagger.ymal to [https://editor.swagger.io/] so that we could 
> automatically generate doc and related client API.
> Anything I miss or something that needs to modify, please let me know
> cc [~leftnoteasy] [~liuxun] [~jiwq] [~tangzhankun] 



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

-
To unsubscribe, e-mail: dev-unsubscr...@submarine.apache.org
For additional commands, e-mail: dev-h...@submarine.apache.org



Re: [DISCUSS] Proposal of Task Breakdown and Timeline of Submarine 0.4.0/0.5.0/1.0.0 release

2020-05-01 Thread Wangda Tan
Good question, unless we got strong demand from the community to include it
and contributors have bandwidth to do it, making new experiment framework
work with YARN is a lower priority comparing to running on K8s. Even items
are dockerized, but implementation still different, and deploy Submarine
server on YARN needs a lot of net-new works in addition to support K8s.

We will not remove/deprecate existing YARN support, so anybody uses 0.3.0
release can continue.

Thanks,
Wangda

On Thu, Apr 30, 2020 at 7:06 PM Zhankun Tang  wrote:

> Thanks Wangda for the proposal. It LGTM.
> One doubt for running experiment on YARN. Will it be included?
>
> BR,
> Zhankun
>
> Wei-Chiu Chuang 于2020年5月1日 周五上午2:18写道:
>
> > Looks good to me. Thanks!
> >
> > Yes we need security to call a 1.0 GA
> >
> > On Wed, Apr 29, 2020 at 9:58 PM Wangda Tan  wrote:
> >
> > > Hi dev,
> > >
> > > Here's a WIP proposal of Submarine task breakdown:
> > >
> > >
> > >
> >
> https://docs.google.com/spreadsheets/d/19g9RCxQEPE74CsOHK-nAf5UO32sFCCP4jCJB3RuFivE/edit#gid=0
> > >
> > > *Please comment to add your thoughts. Some highlights: *
> > >
> > > - We will do release every two months (release cadence)
> > > - Target to release 0.4.0 by end of May, which experiments submission
> > > functionalities.
> > > - (Jul) 0.5.0 will include UI and internal implementation for
> > > notebook/experiment/environment.
> > > - (Sep) Will do 1.0.0 (GA) release, will include more end to end
> logics,
> > > comprehensive docs, must-to-have security-related features/guidances.
> > > - (Nov) 1.1.0 release, consider to include model management.
> > >
> > > Thoughts?
> > >
> > > Thanks,
> > > Wangda
> > >
> >
>