Changes between Version 3 and Version 4 of installation_QCG_Broker_Client

Show
Ignore:
Timestamp:
05/18/11 17:39:52 (10 years ago)
Author:
bartek
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • installation_QCG_Broker_Client

    v3 v4  
    204204 
    205205= Job Profile = 
    206 Every experiment submitted to GRMS has to be described by XML-based document called "Job Profile". The structure of Job Profile is formalized by [http://node2.qoscosgrid.man.poznan.pl/~qcg/download/QCGJobProfile.xsd Job Profile schema]. 
    207  
    208 Examples of Job Profiles describing basic use cases are distributed with QCG-Broker and can be found in ''<CLIENT_DIR>/examples directory''. 
    209  
    210 =Usage= 
     206Every experiment submitted to QCG-Broker has to be described by XML-based document called ''Job Profile''. The structure of ''Job Profile'' is formalized by [[http://node2.qoscosgrid.man.poznan.pl/~qcg/download/QCGJobProfile.xsd|Job Profile schema]]. 
     207 
     208Examples of Job Profiles describing basic use cases are distributed with QCG-Broker and can be found in `<CLIENT_DIR>/examples directory`. 
     209 
     210= Usage = 
    211211 
    212212The QCG-Groker command-line java based client can operate in two modes: 
     
    216216 
    217217The usage of the client depends on the mode: 
    218 * for batch mode: “qcg-broker OPRATION [ARG1 .. ARGn]” 
    219 * for console mode: “qcg-broker -console” and then user is prompted to type in lines in format “OPERATION [ARG1 .. ARGn]” to be processed by client.  
     218* for batch mode: "`qcg-broker OPRATION [ARG1 .. ARGn]`" 
     219* for console mode: "`qcg-broker -console`" and then user is prompted to type in lines in format "`OPERATION [ARG1 .. ARGn]`" to be processed by client.  
    220220 
    221221'''IMPORTANT:''' To secure the communication between client and service and to delegate user's privileges to the service client needs access to user's proxy certificate. 
    222222 
    223 ==Operations== 
     223== Operations == 
    224224 
    225225Regardless from the mode the QCG-Broker java based command-line client supports following list of operations: 
    226226 
    227 {| border="1" align="center" style="text-align:center;" 
    228 ! Operation 
    229 ! Arguments 
    230 ! Description 
    231 |- 
    232 | '''submit_job'''  
    233 | <desc_file> [GRMS or JSDL]   
    234 | align="left" | submits a job to be executed. The description of job can be expressed either in native QCG-Broker language or if it is possible in JSDL one. If the description is valid client returns to the user a globally unique job identifier, which unambiguously identifies the job in the system.  QCG defines jobs as a sets of dependent tasks that constitute a logical whole (workflow). Each task is executed by system only if all tasks it depends on are in specified by the user states.  
    235 |- 
    236 | '''list_jobs'''  
    237 | [<limit>] [<status>]   
    238 | align="left" | lists jobs belonging to the user. It is possible either to limit number of jobs or to display only ones in given state. All possible states are listed below  the table. 
    239 |- 
    240 | '''list_user_jobs'''  
    241 | [<limit>] [<status>] <user>   
    242 | align="left" | lists jobs belonging to the given user. The functionality is destined for administrative purposes.                                  
    243 |- 
    244 | '''test_description'''  
    245 | <desc_file> [GRMS or JSDL] 
    246 | align="left" | validates job description   
    247 |- 
    248 | '''translate_description'''  
    249 | <desc_file> JSDL  
    250 | align="left" | translates job description to native QCG-Broker one  
    251 |- 
    252 | '''job_info'''  
    253 | <jobId> [<showJobDesc>] 
    254 | align="left" | return complex information about the given job. If the showJobDesc is ''false'' the job description is not shown  
    255 |- 
    256 | '''cancel_job'''  
    257 | <jobId>  
    258 | align="left" | cancels execution of the given job  
    259 |- 
    260 | '''commit_job'''  
    261 | <jobId>  
    262 | align="left" | allows to approve the job submitted with two phase commit mechanism to be processed by the system. The two phase commit mechanism can be used to register notifications before the processing of the job will be started by broker.  
    263 |-                                                                                                                
    264 | '''list_tasks'''  
    265 | <jobId> [<status>]  
    266 | align="left" | lists tasks belonging to given job. Optionally it is possible to specify the task's status. Possible task statuses are listed below the table. 
    267 |- 
    268 | '''tasks_statuses'''  
    269 | <jobId> <summary>  
    270 | align="left" | lists tasks constituting the given job with their statuses. If the ''summary'' argument is ''true'' some kind of statistics is additionally displayed. 
    271 |- 
    272 | '''register_job_notification'''  
    273 | <jobId> <url>   
    274 | align="left" | registers notification consumer for the given job  
    275 |- 
    276 | '''list_job_notifications'''  
    277 | <jobId>   
    278 | align="left" | lists notifications registered for the given job  
    279 |- 
    280 | '''register_tasks_notification'''  
    281 | <jobId> <url>  
    282 | align="left" | register notification for all tasks of the given job 
    283 |- 
    284 | '''monitor_job'''  
    285 | <jobId> [<interval>]  
    286 | align="left" | monitors status changes of tasks belonging to given job. The ''interval'' argument determines delay in seconds between next status checks. 
    287 |- 
    288 | '''monitor_task'''  
    289 | <jobId> <taskId> [<interval>]  
    290 | align="left" | monitors status changes of allocations belonging to the given tasks. The ''interval'' argument determines delay in seconds between next status checks. 
    291 |- 
    292 | '''task_info'''  
    293 | <jobId> <taskId> [<showDesc> [<limit>]]   
    294 | displays information about the given task. If the ''showDesc'' is false the task description is not shown. If the ''limit'' argument is specified the history of the task is limited to given value. 
    295 |- 
    296 | '''register_task_notification'''  
    297 | <jobId> <taskId> <url>   
    298 | align="left" | registers task's notification consumer  
    299 |- 
    300 | '''list_task_notifications'''  
    301 | <jobId> <taskId>  
    302 | lists task's notifications 
    303 |- 
    304 | '''cancel_task'''  
    305 | <jobId> <taskId>   
    306 | align="left" | cancels execution of the given task 
    307 |- 
    308 | '''commit_task'''  
    309 | <jobId> <taskId>  
    310 | align="left" | commits the given task to be processed by the system 
    311 |- 
    312 | '''reserve_resources'''  
    313 | [<taskId>] <job_desc> [ GRMS or JSDL]  
    314 | align="left" | reserve resources that meet either the wole job or given task requirements. The reservation identifier is returned. '''This functionality is not implemented yet!''' 
    315 |- 
    316 | '''reservation_info'''  
    317 | <reservationId>  
    318 | align="left" | return complex information concerning the given reservation: list of reserved resources, local identifiers of reservations, reservation time slot. T'''his functionality id not implemented yet!''' 
    319 |- 
    320 | '''cancel_reservation'''  
    321 | <reservationId>  
    322 | align="left" | releases reserved resources. '''This functionality is not implemented yet!''' 
    323 |} 
     227|| Operation || Arguments || Description || 
     228|| '''submit_job''' || `<desc_file>` (GRMS or JSDL) || submits a job to be executed. The description of job can be expressed either in native QCG-Broker language or if it is possible in JSDL one. If the description is valid client returns to the user a globally unique job identifier, which unambiguously identifies the job in the system.  QCG defines jobs as a sets of dependent tasks that constitute a logical whole (workflow). Each task is executed by system only if all tasks it depends on are in specified by the user states. || 
     229|| '''list_jobs''' || `[<limit>]` `[<status>]` || lists jobs belonging to the `user`. It is possible either to `limit` number of jobs or to display only ones in given state. All possible states are listed below  the table. || 
     230|| '''list_user_jobs''' || `[<limit>]` `[<status>]` `<user>` || lists jobs belonging to the given `user`. The functionality is destined for administrative purposes.                                  
     231|| '''test_description''' || `<desc_file>` (GRMS or JSDL) || validates job description ||  
     232|| '''translate_description''' || `<desc_file>` JSDL || translates job description to native QCG-Broker one || 
     233|| '''job_info''' || `<jobId>` `[<showJobDesc>]` || return complex information about the given job. If the `showJobDesc is` `false` the job description is not shown || 
     234|| '''cancel_job''' || `<jobId>` || cancels execution of the given job || 
     235|| '''commit_job''' || `<jobId>` || allows to approve the job submitted with two phase commit mechanism to be processed by the system. The two phase commit mechanism can be used to register notifications before the processing of the job will be started by broker. || 
     236|| '''list_tasks''' || `<jobId>` `[<status>]` || lists tasks belonging to given job. Optionally it is possible to specify the task's status. Possible task statuses are listed below the table. || 
     237|| '''tasks_statuses''' || `<jobId>` `<summary>` || lists tasks constituting the given job with their statuses. If the `summary` argument is `true` some kind of statistics is additionally displayed. || 
     238|| '''register_job_notification''' || `<jobId>` `<url>` || registers notification consumer for the given job || 
     239|| '''list_job_notifications''' || `<jobId>` || lists notifications registered for the given job || 
     240|| '''register_tasks_notification''' || `<jobId>` `<url>` || register notification for all tasks of the given job || 
     241|| '''monitor_job''' || `<jobId>` `[<interval>]` || monitors status changes of tasks belonging to given job. The `interval` argument determines delay in seconds between next status checks. || 
     242|| '''monitor_task''' || `<jobId>` `<taskId>` `[<interval>]` || monitors status changes of allocations belonging to the given tasks. The `interval` argument determines delay in seconds between next status checks. || 
     243|| '''task_info''' || `<jobId>` `<taskId>` `[<showDesc>` `[<limit>]]` || displays information about the given task. If the `showDesc` is `false` the task description is not shown. If the `limit` argument is specified the history of the task is limited to given value. || 
     244|| '''register_task_notification''' || `<jobId>` `<taskId>` `<url>` || registers task's notification consumer || 
     245|| '''list_task_notifications''' || `<jobId>` `<taskId>` || lists task's notifications 
     246|| '''cancel_task''' || `<jobId>` `<taskId>` || cancels execution of the given task || 
     247|| '''commit_task''' || `<jobId>` `<taskId>` || commits the given task to be processed by the system || 
     248|| '''reserve_resources''' || `[<taskId>]` `<job_desc>` (GRMS or JSDL) || reserve resources that meet either the wole job or given task requirements. The reservation identifier is returned. '''This functionality is not implemented yet!''' || 
     249|| '''reservation_info''' || `<reservationId>` || return complex information concerning the given reservation: list of reserved resources, local identifiers of reservations, reservation time slot. '''This functionality id not implemented yet!''' || 
     250|| '''cancel_reservation''' || `<reservationId>` || releases reserved resources. '''This functionality is not implemented yet!''' || 
    324251 
    325252== Usage examples ==