Jaapi FS

N1GE functional specification process Functional Specification Document Template Ver. 1.
0
All deliverables/or! products are N1GE functional specificaion process unless ot"erise indicated.
Functional Specification Document
N1GE Java Admin API
Draft
Document
Version
#omments Date Aut"or
0.1 $nitial version 0%/%1/%00& Andr' Alefeld(
)ic"ard *ierlmeier
10/1+/1+ Sun #onfidential, N1GE En-ineerin- .a-e 1 of 1/
5
10
15
N1GE functional specification process Functional Specification Document Template Ver. 1.0
Table of Contents
1 $ntroduction......................................................................................................+
1.1Description.......................................................................................................+
% .ro0ect 1vervie..............................................................................................+
%.1.ro0ect aim.......................................................................................................+
%.%.ro0ect duration...............................................................................................+
%./E2pected benefit..............................................................................................+
%.+.ro0ect Dependencies.....................................................................................+
/ S3stem Arc"itecture.........................................................................................4
/.1En"ancement Functions..................................................................................4
/.%1verall 5loc! Dia-ram.....................................................................................4
+ Functional Definition........................................................................................4
+.1.erformance....................................................................................................4
+.%)eliabilit3( Availabilit3( Serviceabilit3 6)AS7 ...................................................4
+./Dia-nostics......................................................................................................4
+.+8ser E2perience .............................................................................................4
+.49anufacturin-..................................................................................................4
+.&:ualit3 Assurance............................................................................................4
+.;Securit3 < .rivac3...........................................................................................4
+.=Government )e-ulator3 #ompliance..............................................................4
+.>9i-ration .at".................................................................................................&
+.10Documentation...............................................................................................&
+.11$nstallation......................................................................................................&
+.1%.ac!a-in-......................................................................................................&
+.1/$ssues/)is!s and .roposed 9iti-ation..........................................................&
4 #omponent Descriptions.................................................................................&
4.1N1GE ?ava Admin A.$.....................................................................................&
4.1.11vervie..............................................................................................&
4.1.%Functionalit3.........................................................................................&
4.1./@mod 1perations.................................................................................=
4.1.+?ava #ode Samples.............................................................................=
4.1.4$nterfaces.............................................................................................=
4.1.&1t"er )e@uirements............................................................................=
& Document *istor3 and Approvals....................................................................>
; Appendi2 A Appendi2 B1 Name.......................................................................>
10/1+/1+ Sun #onfidential, N1GE En-ineerin- .a-e % of 1/
5
20
25
30
35
40
45
50
55
1 Introduction
1.1 Description
Future N1GE releases s"all deliver a ne broser based 8$ 658$7 t"at s"all
replace t"e current 9otif based -rap"ical user interface 6G8$7 @mon. T"e
tec"nolo-3 c"osen to implement t"is is t"e Sun Ceb #onsole 6a!a Doc!"art7
and its underl3in- tec"nolo-3 6?SF( Sun Ceb #omponents v /.07. To offer
t"e full set of administrative operations t"at are currentl3 available as a #
bindin- or via a set of #D$ tools a ?ava Admin A.$ "as to be developed t"at
provides t"is functionalit3. T"e primar3 -oal is to map and improve t"e
current # based implementation of t"e @mon tool to a Ceb bases 8$. T"is
re@uires some additional en"ancements of t"e underl3in- # -di functions to
allo t"e dele-ation of a re@uest to a different user t"an t"e eb component
is run. T"erefore an e2tension to aut"enticate a user a-ainst t"e s3stem or
at least a lo-in of t"e eb component at startup to mar! it as a trusted
component of t"e N1GE cluster must be delivered. Apart from t"at t"e A.$
s"all "ave t"e abilit3 to connect to different clusters in order to service
different clusters t"rou-" t"e same administrative 8$. T"ese re@uirements
result in an e2tension to t"e current GD$ protocol in order to transport t"e
needed information to N1GE. 1n top of t"ese e2tension ?N$ rapper
functions are defined t"at are t"e basis of t"e ?ava class librar3 to be
developed. $n order to reduce t"e effort of redoin- similar parts a-ain and
a-ain t"e approac" is to develop a code -enerator t"at ta!es t"e information
from t"e e2istin- #ull datamodel and translates it to t"e needed ?ava
classes and t"eir correspondin- ?N$ counterparts. T"is approac" -ives t"e
additional advanta-e to maintain c"an-es in an "i-"l3 automated fas"ion.
Alt"ou-" not ever3t"in- can be made available t"rou-" t"is mec"anism and
t"e additional time to develop suc" a converter it proves ver3 useful and
easil3 e2tensible to provide additional needed tools li!e 0unit testin-
modules.
.arts of ?AA.$ mi-"t be of interest to ot"er development pro0ects li!e 1S.D
and SSS too.
2 Project Overview
%.1 .ro0ect aim
Deliver a a3 to perform all administrative tas!s via ?AA.$. T"is re@uires t"e
definition and implementation of a ?ava class librar3 t"at provides a
complete set of interfaces to t"e currentl3 available administrative
functionalit3. T"e tar-eted scope is to ma!e t"e current @mon functional
feature set available in order to replace @mon it" a broser based 8$.
Furt"ermore it s"all allo to e2tend it b3 functionalit3 t"at is eit"er needed in
10/1+/1+ Sun #onfidential, N1GE En-ineerin- .a-e / of 1/
10
60
65
70
75
80
85
90
95
t"e conte2t of ot"er development pro0ect *ait"abu or must cover ne
developments li!e Fle2ible )esource Dimits.
Since t"e ?AA.$ "i-"l3 depends on t"e confi-uration ob0ects of N1GE e
are not tar-etin- a standard implementation of a Grid Admin A.$. T"e impact
of c"an-es beteen different versions of ?AA.$ s"all be !ept minimal
"enever possible.
%.% .ro0ect duration
%./ E2pected benefit
T"e benefit is t"e eas3 deplo3ment of N1GE administrative functionalit3
it"in t"e ?ava lan-ua-e. $t can be seen as a complement to ?ava D)9AA
t"ereb3 bein- of course more stron-l3 bound to t"e implementation details
in"erent in N1GE. A -eneral administrative interface definition is not t"e
primar3 tar-et of ?AA.$.
Anot"er -oal is t"e replacements of current #D$ based inte-rations 6e.-.
N1S97 it" ?AA.$/D)9AA based inte-ration to deliver a ti-"ter couplin-
and additional functionalit3 li!e c"an-in- N1GE confi-uration from it"in
N1S9 for e2ample.
%.+ .ro0ect Dependencies
Fle2ible )esource Dimits introduce additional administrative functionalit3 and
mi-"t c"an-e e2istin- interfaces li!e @stat EF. .ro0ect *ait"abu ma3 also
introduce several ne interfaces t"at need to be mapped to ?AA.$ as ell.
$deall3 t"ese interface e2tensions s"ould be made available via ?AA.$ if t"is
is ac"ievable in time.
N1S9 8$ inte-ration is currentl3 completel3 based on t"e #D$ interfaces and
a mi-ration to ?AA.$ mi-"t be seen as ell as t"e development of t"e @mon
58$ as a test of completeness and usefulness of ?AA.$.
Table 2.4 Project dependencies
Available Supplier Product Name Dependency
S!"tem Arc#itecture
?AA.$ consists of t"e folloin- modules,
10/1+/1+ Sun #onfidential, N1GE En-ineerin- .a-e + of 1/
15
100
105
110
115
120
125
130
?AA.$ 0ava classes
s"ared ?N$ # librar3
aut"entication mec"anism
customiFation( confi-uration and installation scripts
?avadoc A.$ documentation and e2amples
/.1 En"ancement Functions
)9$ pro23 service 6reference implementation( not intended for productive
use7
/.% 1verall 5loc! Dia-ram
A protot3pical s!etc" of t"e arc"itecture of t"e planned Ceb8$ can be seen belo,
135
140
20
An overvie of t"e internals of t"e ?AA.$ is outlined in t"e folloin-
dia-ram. Furt"er details can be found in t"e ?AA.$ 0avadoc documentation.
10/1+/1+ Sun #onfidential, N1GE En-ineerin- .a-e & of 1/
145
10/1+/1+ Sun #onfidential, N1GE En-ineerin- .a-e ; of 1/
25
$ Functional Definition
+.1 .erformance
T"e performance -oals for t"is release are to deliver a full3 functional
version t"at is not notabl3 sloer t"an t"e current # implementation. $n a
later p"ase additional cac"in- mec"anisms s"all address performance
improvements as a -oal.
+.% )eliabilit3( Availabilit3( Serviceabilit3 6)AS7
*i-" availabilit3 can onl3 be in"erited from t"e current N1GE *A
implementation. Additional *A aspects t"at are entered it" t"e )9$ pro23
are not 3et addressed. A possible solution ould be an inte-ration of t"e
pro23 functionalit3 as a ?V9 t"read of t"e master. 6EG dbriter7
+./ Dia-nostics
Native parts of ?AA.$ reuse t"e dia-nostic functions of t"e current
implementation. T"e SGEHDE58GHDEVED enviroment variable can be
used for tracin- errors in t"e ?N$ la3er. Apart from t"at standard ?ava
debu--in- tec"ni@ues can be used. Errors are translated in ?ava e2ceptions
"erever possible.
+.+ 8ser E2perience
T"is release strives to provide an incremental positive increase in usabilit3
of t"e s3stem in terms of information content and scalabilit3.
?AA.$ s"all ma!e use of t"e poer of t"e ?ava lan-ua-e to facilitate t"e
inte-ration of N1GE admin functionalit3 into /
rd
part3 components.
An optional future en"ancement mi-"t be a ?9I bindin- of t"e interfaces to
allo inte-ration into standard mana-ement applications. .rovisionin- suc"
a frameor! is more a decision of "at informations to e2pose to t"ose
applications t"an creatin- t"e necessar3 ?ava classes. A bi- part can
certainl3 be -enerated b3 addin- a ne J?9I -enerator templateJ to t"e
conversion frameor!.
+.4 9anufacturin-
Vim c"ainsa edition KE7 and for t"ose "o can memoriFe t"e !e3stro!es
Netbeans.
+.& :ualit3 Assurance
8sual #ode revies
?8nit tests
Testsuite inte-ration
.erformance Testin- of ?AA.$ 6optional7
10/1+/1+ Sun #onfidential, N1GE En-ineerin- .a-e = of 1/
30
150
155
160
165
170
175
180
185
8$ inte-ration 6as -eneral use case7
N1S9 inte-ration 6optional7
Describe different test cases < scenarios
+.; Securit3 < .rivac3
Do-in mec"anism to s3stem T5D( )9$ .ro23 issues( )9$ securit3 mana-er
+.= Government )e-ulator3 #ompliance
N1GE &.1 ill compl3 it" all -overnment re-ulations re-ardin- e2ported
softare.
6c"ec! securit3 issues EG securit3 mec"anisms LLLL 7
+.> 9i-ration .at"
+.10 Documentation
?avadoc A.$ documentation it" a set of documented e2amples s"all be
delivered.
+.11 $nstallation
Cill be added to t"e current N1GE installation procedure. T"e mec"anism
for ?AA.$ is t"e same as t"e one used for D)9AA. $f t"e )9$ pro23 is a
standalone component additional installation steps are re@uired.
+.1% .ac!a-in-
A similar mec"anism as for D)9AA pac!a-in- s"all be used.
+.1/ $ssues/)is!s and .roposed 9iti-ation
Table 4.16 Risk and Mitigation List
#ate-or3 )is! $mpact
6D/9/*7
.robabilit3
6D/9/*7
9iti-ation .lan 1ner
Categories: (e.g. Tecnical! Market! "ced#le! Reso#rce and $inancial%
&'pact: (L% Lo( i'pact) (M% Medi#' i'pact) (*% *ig i'pact
Probabilit+: (L% Lo( probabilit+) (M% Medi#' probabilit+) (*% *ig probabilit+
% &omponent De"cription"
#ullconv mec"anism,
.arser parsed s-eHMD." files and creates a list of N1GE ob0ects and t"ere
descriptions in a -eneric form. From t"is ob0ect list several template files are
processed for ever3 ob0ect and ob0ect specific parts of t"e A.$ are -enerated. 9ost
10/1+/1+ Sun #onfidential, N1GE En-ineerin- .a-e > of 1/
35
190
195
200
205
210
215
of t"e e2istin- functionalit3 can be mapped b3 t"is procedure. $f t"is is not possible
t"e e2istin- native implementation "as been rapped b3 implementin- ?N$
adapters.
4.1 N1GE ?ava Admin A.$
%'1'1 Overview
%'1'2 Functionalit!
:conf operations,
Object Add Modify Delete Show Show
List
Generated
Calendar -acal
-Acal
-mcal
-Mcal
-dcal -scal -scall x
Checkpoi
nt
Environm
ent
-ackpt
-
Ackpt
-mckpt
-Mckpt
-dckpt -sckpt -sckptl x
Cluster
Queue
-a
-A
-m
-M
-d -s -sl x
Parallel
Environm
ent
-ap
-Ap
-mp
-Mp
-dp -sp -spl x
Pro!ect -apr!
-Apr!
-mpr!
-Mpr!
-dpr! -spr! -spr!l "# subclassed
$rom %P
Execution
&ost
-ae
-Ae
-me
-Me
-de -se -sel x
%ser -auser
-
Auser
-muser
-Muser
-duser -suser -suserl "# subclassed
$rom %P
&ost'roup -
ah'rp
-
Ah'r
p
-mh'rp
-Mh'rp
-dh'rp -sh'rp
-sh'rp(tree
-
sh'rp(resolved
(tree
-sh'rpl x
%serset
)AC*#
Departme
nt+
-au
-Au
-mu
-Mu
-du
-dul
-su -sul x
Sharetree -
astree
-
Astre
-mstree
-Mstree
-dstree -sstree Not yet
implemented
220
225
230
40
Object Add Modify Delete Show Show
List
Generated
e
Sharetree
Node
-
astno
de
-mstnode -dstnode -sstnode
-rsstnode
Not yet
implemented
Cluster
Con$i'ura
tion
-acon$
-
Acon$
-mcon$ -dcon$ -scon$ -scon$l Not yet
implemeted
Submit
&ost *ist
-as -ds -ss x
Admin
&ost *ist
-ah -dh -sh x
Mana'er
*ist
-am -dm -sm "# subclassed
$rom
,perator
*ist
-ao -do -so
Scheduler
Con$i'ura
tion
-mscon$
-Mscon$
-sscon$
Complex
Attributes
-mc -sc
,b!ect
Attributes
-aattr
-Aattr
-mattr
-Mattr
-rattr
--attr
-dattr
-Dattr
-sob!l
,ther con$ operations.
-sep
sho/ licensed processors
-sds
sho/ detached settin's
-secl
sho/ event client list
-sss
sho/ scheduler status
-tsm
tri''er scheduler monitorin'
-clearusa'e
clear sharetree usa'e
-kec
kill event client)s+
-ke)!+
kill execution daemon)s+
-km
kill master
-ks
kill scheduler
%'1' (mod Operation"
Object Operation
Queue -d disable ueue
-e enable ueue
-c clear Queue error state
-c clear error state
-s suspend ueue
-s suspend ueue
-us unsuspend ueue
-us unsuspend ueue
-r reschedule !obs runnin' in ueue
-r reschedule !obs runnin' in ueue
all options can take the -$ $orce $la'
0ob -c! clear 0ob error state
-c clear error state
-s! suspend !ob
-s suspend !ob
-us! unsuspend !ob
-us unsuspend !ob
-r! reschedule !obs
-r reschedule !obs
all options can take the -$ $orce $la'
%'1'$ Interface Javadoc
http://gridware.germany/~rh150277/jgdi/jaapi.pdf
%'1'% Java &ode Sample"
http://gridware.germany/~rh150277/jgdi/example/JGDITest.java
%'1') *ifec!cle
10/1+/1+ Sun #onfidential, N1GE En-ineerin- .a-e 1% of 1/
45
235
240
%'1'+ Ot#er ,e(uirement"
) Document -i"tor! and Approval"
Table , -oc#'ent *istor+
Dash Rev Date Description of Change Originator
+ Appendi. / 0imeta1le
http://gridware.germany/~rh150277/jgdi/todo.pdf
10/1+/1+ Sun #onfidential, N1GE En-ineerin- .a-e 1/ of 1/
50
250
255

Jaapi FS

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Jaapi FS

Uploaded by

Copyright:

Available Formats

N1GE functional specification process Functional Specification Document Template Ver. 1.

You might also like