Differences

This shows you the differences between two versions of the page.

--- services:grading [2019/05/28 15:55] – jas
+++ services:grading [2021/10/01 09:00] (current) – jas
@@ Line 27: / Line 27: @@
 </code>
-**NOTE:** <course> refers to the course name as it is listed in the course directory.  It is a case sensitive name and not a full path.
+**NOTE:** Only the owner of the course directory can use the //gsyncu// command.
-**NOTE:** Only the owner of the course directory can use the gsyncu command.
 For example, if your course is "9999":
@@ Line 37: / Line 35: @@
 User bob added to gsync user list.
-gsync enabled.
+Gsync is enabled.
+Gsync account updates occur once per hour, but only for courses in the current term.
 </code>
-gsync is enabled for course 9999.  The course directory owner (bob) is added to the gsync access list for the course.
+Gsync is enabled for course 9999.  The course directory owner (bob) is added to the gsync access list for the course.
-===== Step 2: Update the Gsync Access Control List For Your Course  =====
+**NOTE:** The instructions above assume your course is in the current term.  While you can initialize gsync for a course in a different term by specifying a full path to the course directory (eg. /eecs/dept/course/2018-19/F/9999 instead of just "9999" above), you will only be able to **use** gsync when your course is being taught in the current term.
-Give gsync the list of TAs for your course.
+===== Step 2: Add Course TAs to Gsync Access List =====
+Add TAs to the Gsync access list for your course:
 To add users: gsyncu <course> add user1 ... userN
@@ Line 52: / Line 53: @@
 To list users in the access list for your course: gsyncu <course> list
-===== Step 2: Add Directories to Sync =====
+**NOTE:** The instructions above assume your course is in the current term.  While you can add TAs to the gsync access list for your course in a different term by specifying a full path to the course directory (eg. /eecs/dept/course/2018-19/F/9999 instead of just "9999" above), those TAs will only be able to **use** gsync when your course is being taught in the current term.
-By default, gsync will sync the "submit" directory in your course folder to the grading area.  If you wish to add additional directories to sync, use these commands:
+===== (optional) Step 3: Add Directories to Sync =====
-To add a directories: gsyncu <course> diradd dir1 ... dir2
+By default, gsync will sync the "submit" directory in your course directory to the grading area.  If you wish to add additional directories to sync, use these commands:
-To remove a directories: gsyncu <course> dirdel dir1 ... dirN
+To add directories: gsyncu <course> diradd dir1 ... dir2
+To remove directories: gsyncu <course> dirdel dir1 ... dirN
 To list directories that will be gsynced for your course: gsyncu <course> list
-**NOTE:** <dir> is not a full path.  It starts at the course directory.  For example, to add the directory "quiz/quiz1" to gsync for course 9999: gsyncu 9999 diradd quiz1/quiz1
+**NOTE:** <dir> is relative to the course directory.  For example, to enable the directory /eecs/course/9999/quizes/quiz1 to be synced, use: gsyncu 9999 diradd quizes/quiz1
+===== Step 4: Wait for Your Gsync Account to be Initialized =====
+Gsync will create an account and group for your course (if one has not been created already).  The account will be named ta<course>, while the group will be ta<course>g.  For example, for course 9999, the account "ta9999" and group "ta9999g" would be created.  If additional letters are added to your course directory name (eg. 9999Z), those letters will also be added to the gsync account and group created.  Note however that any capital letters will be converted to lowercase.
-===== Step 3: Wait for Your Gsync Course Account and Group to be Created =====
+After about an hour, gsync will have created your gsync account and group, and will have updated the gsync access list.
-About an hour after you enable gsync access for your course, an account and group will be automatically created if one does not already exist.  The account and group will be named: ta<course directory name>.  For example, for the course directory "3311", the account name is ta3311 and the group is ta3311.  If additional letters are added to your course directory name (eg. 3311Z), then those letters will also be added to the account and group for your course.
+**NOTE:** If your course is not being taught in the current term (eg. your course is taught in 2019-20 fall, and it is presently 2018-19 summer), then your gsync account updates will only occur when your course is being taught in the present term.
+===== Step 5: Login to the Grading Server =====
-===== Step 4: Login to the Grading Server =====
+Login to the grading server (grade1.eecs.yorku.ca) with your regular EECS account.  For example:
-Login to the grading server (grade1.eecs.yorku.ca) with your own account.  For example:
+  indigo% ssh grade1
-indigo% ssh grade1
 ** NOTE: The grading server is intended to be used for grading assignments.  Any other use is forbidden. **
-===== Step 4: Access The Course Grading Account =====
+===== Step 6: Access The Course Grading Account =====
-In order to access the course grading account, use the "bu" (become user) command.  For example, if your course is EECS3311:
+In order to access the course grading account, use the "bu" (become user) command.  For example, if your course directory is "9999", then the account name is "ta9999" and can be accessed like this:
-grade1% bu ta3311
+  grade1% bu -d ta9999
-Note that the grading account is only accessible from the grading server, grade1.  It's only accessible with the "bu" command.  Your access list determines who can access the account.  No passwords are required.
+Notes:
-===== Step 5: Sync the Course Data =====
+  * The grading account is only accessible from the grading server, grade1.
+  * You can only access the grading account for a course that is being offered in the current term.  For example, if it is 2018-19 summer, and you have created a gsync account for teaching course 9999 in 2019-20 fall, you will not be able to access your gsync account until 2019-20 fall.  When it becomes 2019-20 winter, you will lose access to the gsync account for the course automatically.
+  * The grading account is only accessible with the "bu" command.
+  * Your access list determines who can access the account.  No passwords are required.
+  * If your course directory has capital letters (eg. 9999E), then all letters in the account name are converted to lowercase (eg. ta9999e).
-After you've logged into the grading account, run the "gsync" command to sync the data from your course directory to the grading directory.  gsync knows which course account you're logged into, so you don't need to tell it which course to sync:
+===== Step 7: Sync the Course Data =====
+After you've accessed the grading account, run the "gsync" command to sync the data from your course directory to the grading directory.  gsync knows which course grading account you're logged into, so you don't need to tell it which course to sync:
-grade1% gsync
+  grade1% gsync
-The first time you run gsync, it copies down all the data from your course directory to the grading directory.  Subsequent syncs will copy **only changed** files.
+Here's a sample run:
-The /eecs/grading hierarchy is arranged by session, term, and course, similar to the course directory hierarchy.  For example, if your course is EECS3311 in 2018-19 fall, then the grading directory will be:
+<code>
+Syncing ...
-/eecs/grading/2018-19/F/3311
+Number of files: 11 (reg: 5, dir: 6)
+Number of created files: 11 (reg: 5, dir: 6)
+Number of deleted files: 0
+Number of regular files transferred: 5
+Total file size: 76,229 bytes
+Total transferred file size: 76,229 bytes
+Literal data: 76,229 bytes
+Matched data: 0 bytes
+File list size: 0
+File list generation time: 0.001 seconds
+File list transfer time: 0.000 seconds
+Total bytes sent: 76,809
+Total bytes received: 154
-==== IMPORTANT NOTE - READ THIS TO AVOID LOSING DATA ====
+sent 76,809 bytes  received 154 bytes  153,926.00 bytes/sec
+total size is 76,229  speedup is 0.99
-By default, gsync will **not** overwrite data in the grading directory.  This allows you and your TAs to modify files in the grading area as part of grading without the risk that running gsync again would clear their changes.   If you want to allow gsync to **overwrite** files in the grading directory with files from the course directory, use the "-o" (ovewrite) option:
+Cleaning clone tree ...
-grade1% gsync -o
+Fixing file ownership/group ...
-If you want gsync to delete files and directories from the grading directory that do not exist in the course directory, use the "-c" (clean) option:
+Fixing file and directory permissions ...
-grade1% gsync -c
+gsync complete.
+</code>
-Note that -o and -c options can be combined.  Using both -o and -c will result in the grading directory being an identical copy of the course directory.
+The first time you run gsync on the grade1 server, it copies down the data from your course submit directory, and any other directories that you've configured gsync to clone. The synced data will be in /eecs/grading/<course>/clone.  This directory is READ ONLY.
+The /eecs/grading hierarchy works exactly like /eecs/course.  /eecs/grading points at the grading hierarchy for the current session and term while /eecs/dept/grading points to the grading hierarchy for the current term.
+Subsequent times that you run gsync, it will will copy down changes.  If a file is deleted on the source, it will be deleted from the destination.  If a file is updated on the source, it will be updated on the destination.
+Each grading account has 3 directories created:
+  * clone - a **READ ONLY** copy of your submit directory and other directories that you've asked gsync to clone.  All the files will be readable by everyone who has access to your grading account, no matter what the permissions are in the course directory.
+  * home - the home directory for the course gsync account (You probably won't be using this directory much.)
+  * work - This directory is created for you and your TAs to do grading.  You can write to this directory, but you cannot rename it.
+Neither you nor the TAs can create additional top-level directories in your grading directory.  You have complete control over the "work" directory.
+To begin grading, you or your TAs may want to copy the contents of the read only "clone" directory to the "work" directory.  You would do that like this:
+<code>
+grade1% cp -r /eecs/grading/9999/clone/* /eecs/grading/9999/work
+</code>
+When you or your TAs run the gsync command, gsync will only update the "clone" directory.  It will never touch files in the "work" directory to ensure that it doesn't overwrite your work!  Please be **very** careful about copying "clone" to "work" after you've started grading.  You need to be sure you don't overwrite your own files in "work".
+===== (optional) Step 8: Add a Password to Your Gsync =====
+If necessary, you can add a password to your course grading account to enable access to the files from your desktop via Secure FTP (sftp) client.  Adding a password to your grading account is entirely optional.
+Setup a password for course "9999" grading account like this:
+<code>
+  % gsyncu 9999 password
+*** WARNING ***
+Enabling a password on a Gsync account is possible, but discouraged.
+Please be vigilant about who has the Gsync password for your course.
+Use a blank password to disable a previously enabled Gsync password.
+Enter NEW password:
+Verify password:
+A Gsync password has been set.  It will be enabled within an hour.
+</code>
-** ATTENTION ** Both -o and -c options are destructive. Never use the -o or -c options without consulting with the other members of your grading group.  The grading area is not backed up, and any files that you erase from the grading area are not recoverable (unless you want to recover the original version of the file from the submit directory).
+In order to access the account via sftp, you must sftp to grade1.eecs.yorku.ca, and login as the course account (taXXXX) and the password provided.  You will only be able to access taXXXX accounts from home using grade1.eecs.york.ca.
 ===== Final Notes =====
@@ Line 122: / Line 190: @@
   * Remember that the grading account is only accessible on the grading server, grade1.
-  * gsync only copies data from the course directory to the grading area.  If you want to copy data from grading area back to your course directory, **faculty must do this manually**.  For example, to copy the "feedback" directory from the grading directory for course EECS3311 in 2018-19 Fall back to the course directory:<code>
+  * gsync only copies data from the course directory to the grading area.  If you want to copy data from grading area back to your course directory, you must do this manually.  For example, to copy the "feedback" directory from the grading directory for course EECS9999 back to the course directory:<code>
-grade1% cp -pr /eecs/grading/2018-19/F/3311/feedback /eecs/course/3311
+grade1% cd /eecs/grading/9999/work; tar cf - feedback | ( ssh bob@indigo "cd /eecs/course/9999; tar xvf -" )
 </code>
+  * NOTE: Only the course directory owner will be able to copy files back to the course directory.
+  * There are other options including SCPing files, SFTP, creating an archive (zip, bzip, bzip2, etc) and transferring that.
+  * You can only access the grading account for a course that is being offered **in the current term**.  For example, if it is 2018-19 summer, and you have created a gsync account for teaching course 9999 in 2019-20 fall, you will not be able to access your gsync account until 2019-20 fall.  In addition, when it becomes 2019-20 winter, you will **lose access** to the gsync account for the course automatically. Please make sure that you have transferred any required data from the gsync account to your course directory before the first day of the next term.
   * Ugrad TAs will need to have an alternate account setup with access to grade1 before they can access the grading account.  Please consult with tech.
@@ Line 132: / Line 204: @@
   * Group submit is now reserved for faculty use **only**.
-  * If you have any questions about gsync, please inform tech.
+  * If you have any questions or feedback about gsync, please inform tech.