Return-Path: X-Original-To: apmail-airavata-dev-archive@www.apache.org Delivered-To: apmail-airavata-dev-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 03975109E0 for ; Mon, 6 Jan 2014 18:21:27 +0000 (UTC) Received: (qmail 18076 invoked by uid 500); 6 Jan 2014 18:21:25 -0000 Delivered-To: apmail-airavata-dev-archive@airavata.apache.org Received: (qmail 17956 invoked by uid 500); 6 Jan 2014 18:21:21 -0000 Mailing-List: contact dev-help@airavata.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@airavata.apache.org Delivered-To: mailing list dev@airavata.apache.org Received: (qmail 17274 invoked by uid 99); 6 Jan 2014 18:21:20 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 06 Jan 2014 18:21:20 +0000 X-ASF-Spam-Status: No, hits=1.5 required=5.0 tests=HTML_MESSAGE,RCVD_IN_DNSWL_LOW,SPF_PASS X-Spam-Check-By: apache.org Received-SPF: pass (athena.apache.org: domain of raminderjsingh@gmail.com designates 209.85.213.176 as permitted sender) Received: from [209.85.213.176] (HELO mail-ig0-f176.google.com) (209.85.213.176) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 06 Jan 2014 18:21:14 +0000 Received: by mail-ig0-f176.google.com with SMTP id k19so7922071igc.3 for ; Mon, 06 Jan 2014 10:20:53 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=from:content-type:message-id:mime-version:subject:date:references :to:in-reply-to; bh=cQgiuCxGCmYDt9sgIuz9v6SDIsZi3ogXoX7REyZuI4I=; b=qgnDU7z/it96G2EIJeT8/vPlpF9l6GQTl+XleCF1YJ2nokFsCu9pVsIBiaJGm+ZHde IIQVr5ZPlW9juv/QnNGUkDWOK4YnrAEotuqSQLeV5YyAhz3VPjKkAekqMuDMOv6Y/Bml OAAa9LXJekRwvKRdUSBh8U2SDCI3IIcrw/ybLuznHrANgnyXcYvUGESQ7QFE9VyBt+or xySjpAv7A2BCXrNWxZcNQrvusKH0TtD6PqFRKyGYAn7PiCipaPrqZdpKQzYzUn7EMbN2 QRpyB6wZ02FCQR8vsFSghCIpOLbRcUll1gEfXt/KTrK3mCmoip7zFNC4cTgk5O/OlhFa 5pqw== X-Received: by 10.50.79.168 with SMTP id k8mr21517904igx.18.1389032453687; Mon, 06 Jan 2014 10:20:53 -0800 (PST) Received: from [192.168.0.106] (c-98-253-236-229.hsd1.in.comcast.net. [98.253.236.229]) by mx.google.com with ESMTPSA id t4sm16116343igm.10.2014.01.06.10.20.52 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Mon, 06 Jan 2014 10:20:52 -0800 (PST) From: Raminder Singh Content-Type: multipart/alternative; boundary="Apple-Mail=_AB67C801-ABC8-4FF2-80D2-4F0B8CAB58E0" Message-Id: Mime-Version: 1.0 (Mac OS X Mail 7.1 \(1827\)) Subject: Re: Gateway Developer Tutorial Date: Mon, 6 Jan 2014 13:20:50 -0500 References: To: dev@airavata.apache.org In-Reply-To: X-Mailer: Apple Mail (2.1827) X-Virus-Checked: Checked by ClamAV on apache.org --Apple-Mail=_AB67C801-ABC8-4FF2-80D2-4F0B8CAB58E0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset=iso-8859-1 +1 for using sample gateway to start with and build over it. Added = advantage is integration with credential store which is an important = step for gateways going forward.=20 Raminder On Jan 6, 2014, at 12:57 PM, Amila Jayasekara = wrote: > I would also suggest to explain the big picture first. i.e. where is = the API client and where is the server, where are the resources in a = pictorial view. You may also can use sample gateway as a basis for your = guide. So that users has an actual code to look into. >=20 > Thanks > Thejaka Amila >=20 >=20 > On Mon, Jan 6, 2014 at 12:23 PM, Saminda Wijeratne = wrote: > Sounds good Sachith. Few things to keep in mind.=20 > Describe the simple problem which you are simulating a solution for = through a simple gateway. (eg: a scientist wants to run his application = with the input datasets then wait until it finishes to view the results) > Might be a good idea to mention the obvious things for an actual = gateway which you are leaving-out of this tutorial for simplicity. (eg: = authentication, session management, file upload/downloads etc.) > You may have to specifically explain in brief things such as = authentication requirements for the Airavata Server (although the = gateway user doesn't require authentication). > Identify the user groups clearly. For example the gateway user is the = person who will be using the web portal. gateway developer is the person = who develops the web portal. a gateway admin is the person who = configures the web portal (in your simple gateway dev tutorial gateway = admin need not be included but I think its useful to mention who'd be = responsible for adding the workflows/descriptors perhaps through XBaya = for this simple gateway) > These are just things from top of my head. Feel free to get more = clarifications on them... >=20 > Saminda >=20 >=20 > On Mon, Jan 6, 2014 at 11:29 AM, Sachith Withana = wrote: > Hi Saminda, >=20 > I'm going to organize it base on the three major components I have = shown in my diagram. > Details wise, I would only include how the API could be used to create = the gateway. Anything beyond the API will not be explained since this is = the simple gateway guide. I would explain those details in the = elaborated version if required. Since the main expectation of the = gateway developer is to create a gateway and use Airavata API to use the = resources. So I thought details on "How to use" the API should be = enough? >=20 > Including downloadable samples would be a great idea. I would do that. >=20 > Here's the rough sketch. [1] >=20 > [1] = https://cwiki.apache.org/confluence/display/AIRAVATA/Simple+Gateway+Develo= per+Guide >=20 >=20 > On Sat, Jan 4, 2014 at 10:26 PM, Saminda Wijeratne = wrote: > Sachith, could you explain how are you going to organize simple = gateway guide? How far details are you planning to include in it? Any = down-loadable samples would be tempting for a developers to follow = through to the next steps. >=20 > IMO I think you should start on a rough sketch/draft of the wiki page. = Then it'll be easier for anyone to give feedback on it. >=20 > Regards, > Saminda >=20 >=20 > On Sat, Jan 4, 2014 at 12:07 AM, Sachith Withana = wrote: > Hi all, >=20 > Apache Airavata developer guide[1] is obsolete as mentioned by Saminda = in the Jira [2]. >=20 > We are planning to update the Wiki Gateway developer guide so that a = gateway developer is able to create the gateways using the latest = Airavata API.=20 >=20 > We have divided the developer guide into two components > 1. Simple Gateway developer guide=20 > 2. Elaborated Gateway developer guide >=20 > In the simple gateway guide, we will be targeting new gateway = developers to use the API to create a simple yet complete gateway. I = have attached the design of a simple gateway and the guide will help the = developer in accomplishing those components with the use of the Airavata = API.=20 > This design contains a simple workflow with inputs.=20 >=20 > In the elaborated Gateway guide, we will take on executing complex = workflows with multiple number of nodes in different hosts ...etc, = getting status of the experiment at multiple levels ( Experiment level, = workflow level( multiple workflows under the same experiment is not yet = supported), Node Level, Application Level ...etc) >=20 > Any suggestions are welcome. >=20 > [1] = https://cwiki.apache.org/confluence/display/AIRAVATA/Airavata+Developer+Gu= ide > [2] https://issues.apache.org/jira/browse/AIRAVATA-944--=20 > Thanks, > Sachith Withana >=20 >=20 >=20 >=20 >=20 > --=20 > Thanks, > Sachith Withana >=20 >=20 >=20 --Apple-Mail=_AB67C801-ABC8-4FF2-80D2-4F0B8CAB58E0 Content-Transfer-Encoding: 7bit Content-Type: text/html; charset=iso-8859-1 +1 for using sample gateway to start with and build over it. Added advantage is integration with credential store which is an important step for gateways going forward. 

Raminder

On Jan 6, 2014, at 12:57 PM, Amila Jayasekara <thejaka.amila@gmail.com> wrote:

I would also suggest to explain the big picture first. i.e. where is the API client and where is the server, where are the resources in a pictorial view. You may also can use sample gateway as a basis for your guide. So that users has an actual code to look into.

Thanks
Thejaka Amila


On Mon, Jan 6, 2014 at 12:23 PM, Saminda Wijeratne <samindaw@gmail.com> wrote:
Sounds good Sachith. Few things to keep in mind.
  1. Describe the simple problem which you are simulating a solution for through a simple gateway. (eg: a scientist wants to run his application with the input datasets then wait until it finishes to view the results)
  2. Might be a good idea to mention the obvious things for an actual gateway which you are leaving-out of this tutorial for simplicity. (eg: authentication, session management, file upload/downloads etc.)
  3. You may have to specifically explain in brief things such as authentication requirements for the Airavata Server (although the gateway user doesn't require authentication).
  4. Identify the user groups clearly. For example the gateway user is the person who will be using the web portal. gateway developer is the person who develops the web portal. a gateway admin is the person who configures the web portal (in your simple gateway dev tutorial gateway admin need not be included but I think its useful to mention who'd be responsible for adding the workflows/descriptors perhaps through XBaya for this simple gateway)
These are just things from top of my head. Feel free to get more clarifications on them...

Saminda


On Mon, Jan 6, 2014 at 11:29 AM, Sachith Withana <swsachith@gmail.com> wrote:
Hi Saminda,

I'm going to organize it base on the three major components I have shown in my diagram.
Details wise, I would only include how the API could be used to create the gateway. Anything beyond the API will not be explained since this is the simple gateway guide. I would explain those details in the elaborated version if required. Since the main expectation of the gateway developer is to create a gateway and use Airavata API to use the resources. So I thought details on "How to use" the API should be enough?

Including downloadable samples would be a great idea. I would do that.

Here's the rough sketch. [1]



On Sat, Jan 4, 2014 at 10:26 PM, Saminda Wijeratne <samindaw@gmail.com> wrote:
Sachith, could you explain how are you going to organize simple gateway guide? How far details are you planning to include in it? Any down-loadable samples would be tempting for a developers to follow through to the next steps.

IMO I think you should start on a rough sketch/draft of the wiki page. Then it'll be easier for anyone to give feedback on it.

Regards,
Saminda


On Sat, Jan 4, 2014 at 12:07 AM, Sachith Withana <swsachith@gmail.com> wrote:
Hi all,

Apache Airavata developer guide[1] is obsolete as mentioned by Saminda in the Jira [2].

We are planning to update the Wiki Gateway developer guide so that a gateway developer is able to create the gateways using the latest Airavata API.

We have divided the developer guide into two components
1. Simple Gateway developer guide 
2. Elaborated Gateway developer guide

In the simple gateway guide, we will be targeting new gateway developers to use the API to create a simple yet complete gateway. I have attached the design of a simple gateway and the guide will help the developer in accomplishing those components with the use of the Airavata API. 
This design contains a simple workflow with inputs. 

In the elaborated Gateway guide, we will take on executing complex workflows with multiple number of nodes in different hosts ...etc, getting status of the experiment at multiple levels ( Experiment level, workflow level( multiple workflows under the same experiment is not yet supported), Node Level, Application Level ...etc)

Any suggestions are welcome.




--
Thanks,
Sachith Withana




--Apple-Mail=_AB67C801-ABC8-4FF2-80D2-4F0B8CAB58E0--