Changes between Version 2 and Version 3 of RemoteOverview

Timestamp:

Feb 15, 2013, 2:18:10 PM (11 years ago)

Author:

davea

Comment:

--

RemoteOverview

@@ +1 @@
+[[PageOutline]]
 = Remote job submission - overview =
 
 In early versions of BOINC, scientists submitted jobs to
 a BOINC server by logging in to the server and running programs or scripts.
-More recently, BOINC has been used to build systems in which scientists can submit
-jobs without logging in to the BOINC server.
-These systems can be structured in various ways
-(several examples are shown below);
-we collectively call them '''remote job submission''' systems.
+More recently, BOINC has been used to build systems,
+collectively called '''remote job submission''' systems,
+in which scientists can submit jobs without logging in to the BOINC server.
 
 In all these systems, job submitters are identified using accounts on the BOINC project
@@ -16 +15 @@
 Users have '''quotas''' how resources are allocated to their jobs.
 
+The structure and details of remote job submission systems
+vary widely.
+BOINC doesn't include a pre-packaged remote job submission system,
+but it provides a number of components that can be used to build such systems.
+We'll list some example systems, then describe the components.
+
 == Example: single-server portal ==
+
+Users submit jobs using forms on the project web site:
 
 [[Image(submit2.png)]]
 
-Users submit jobs using forms on the project web site.
 These forms are application-specific; you must develop them yourself.
 Two examples are included in the BOINC distribution:
@@ -29 +35 @@
 provide a minimal/generic example.
 
-The job-submission scripts use [foo local PHP interfaces] to
+The job-submission scripts use [RemoteOverview#LocalPHPinterfaces local PHP interfaces] to
 authenticate users and to create jobs and batches.
 
@@ -67 +73 @@
 == Components supplied by BOINC ==
 
-BOINC doesn't include a pre-packaged remote job submission system,
-but it provides a number of components that can be used to build such systems.
-
 === Job submission control panel ===
 
@@ -89 +92 @@
 === Local PHP interfaces ===
 
+Job-submission scripts to be run on the BOINC server
+are best implemented in PHP.
+BOINC provides a large set of PHP APIs for accessing the BOINC database,
+staging files, and so on.
+
+For example, you can authorize a job submission request with code like
+{{{
+$user = get_logged_in_user();
+$user_submit = BoincUserSubmit::lookup_userid($user->id);
+if (!$user_submit) error_page("no submit access");
+$app = BoincApp::lookup("name='lammps'");
+if (!$app) error_page("no lammps app");
+if (!$user_submit->submit_all) {
+    $usa = BoincUserSubmitApp::lookup("user_id=$user->id and app_id=$app->id");
+    if (!$usa) {
+        error_page("no submit access");
+    }
+}
+}}}
+
+You can create a batch as follows:
+{{{
+$batch_id = BoincBatch::insert(
+    "(user_id, create_time, njobs, name, app_id, state)
+    values ($user->id, $now, $njobs, '$batch_name', $app->id, ".BATCH_STATE_IN_PROGRESS.")"
+);
+}}}
+
+'''TODO: document these interfaces, or provide simpler examples.'''
+
 === Web RPCs for input file management ===
 
+BOINC provides [RemoteInputFiles#Content-basedfilemanagement Web RPCs for remotely managing input files],
+and a C++ binding of this API.
+
 === Web RPCs for job submission ===
+
+BOINC provides [RemoteJobs Web RPCs for creating and managing jobs].
+
+=== Per-user file sandbox ===
+
+BOINC provides [RemoteInputFiles#Per-userfilesandbox a web-based system allowing users to remotely manage input files].