|
1 | 1 | # CPSC 310 |
2 | 2 |
|
3 | | -## Note: this document is stale; better docs exist [here](https://github.students.cs.ubc.ca/CPSC310/project-resources/blob/master/docs/README.md) and [here](https://github.students.cs.ubc.ca/CPSC310/classy-cs310-plugin). |
| 3 | +## Note: this document is stale; better docs exist [here](https://github.students.cs.ubc.ca/CPSC310/project-resources/blob/master/docs/README.md) and [here](https://github.students.cs.ubc.ca/CPSC310/classy-cs310-plugin). |
4 | 4 |
|
5 | | -A brief set of instructions for configuring Classy for 310. |
6 | | - |
7 | | -### Initial Setup |
8 | | - |
9 | | -* Request that the tech staff provision a VM and configure classy (including all required `autobot` tokens and the `github.student` org and `admin/staff` teams) for the term. |
10 | | -* Visit the [classy instance](https://cs310.students.cs.ubc.ca), import the classlist (using the `Update Classlist` API button in the config tab), and provision the deliverables (at least `d0` as shown below). |
11 | | -* Provision some repositories. |
12 | | - |
13 | | -<!-- |
14 | | -* Request a VM from the tech staff by emailing `help@cs`. |
15 | | -* Request a GitHub org from the tech staff by emailing `help@cs`. |
16 | | - * In the org settings (under Member Privileges): |
17 | | - * `Allow members to delete or transfer repositories for this organization` should be `false`. |
18 | | - * `Allow members to change repository visibilities for this organization` should be `false`. |
19 | | - * `Allow forking of private repositories` should be `false`. |
20 | | - * Create a `staff` team; add all TAs to this team. |
21 | | - * Create an `admin` team; add all faculty and `autobot` to this team. |
22 | | -* Install Classy on the VM using the other instructions in this directory. |
23 | | ---> |
24 | | - |
25 | | -### Monitoring Classy |
26 | | - |
27 | | -The VM should have monitoring configured by default: |
28 | | - |
29 | | -* Create tunnel on your machine: `ssh -L19999:localhost:19999 cs310.students.cs.ubc.ca` |
30 | | -* Connect: `http://localhost:19999` |
31 | | - |
32 | | -### Configuring Classy |
33 | | - |
34 | | -* Create your Deliverables (`d0`, `d1`, `d2`, `d3`, `d4`, and `project`). The two deliverables that will provision repositories are `d0` and `project`. |
35 | | - |
36 | | -* `d0` deliverable settings: |
37 | | - * Deliverable Id: `d0` |
38 | | - * URL: https://github.com/ubccpsc/310/blob/<TERM BRANCH HERE>/project/Deliverable0.md |
39 | | - * Visible: `true` (`false` if you're not quite ready to deploy, can change later) |
40 | | - * Rubric: `{}` |
41 | | - * Custom: `{}` |
42 | | - * Open: _open date_; first day of class is fine |
43 | | - * Close: _close date_; due date for project (usually around Sept 16 @ 1800) |
44 | | - * Allow late AutoTest: `false` |
45 | | - * Grades Released: `false` |
46 | | - * Will Provision Repos: `true` |
47 | | - * Import URL: `https://github.students.cs.ubc.ca/CPSC310/bootstrap.git` (make sure links in `bootstrap/README.md` are up-to-date) |
48 | | - * Repo prefix: `''` (Repo name will be `d0_userXXX` for students, `d0_CWL` for staff) |
49 | | - * Team prefix: `''` (Team name will be `d0_userXXX` for students, `d0_CWL` for staff) |
50 | | - * Min size: `1` |
51 | | - * Max size: `1` |
52 | | - * Same lab: `true` |
53 | | - * Students make teams: `false` |
54 | | - * Will use AutoTest: `true` |
55 | | - * Use `Create New image` to build your docker image (or select one if it has previously been created). |
56 | | - * Container timeout: `300` (5 minutes) |
57 | | - * Student Delay: `43200` (12 hours) |
58 | | - * Regression Deliverables: `` (blank) |
59 | | - * Custom Autotest Parameters: `{}` |
60 | | -* `d1` deliverable settings: |
61 | | - * Deliverable Id: `d1` |
62 | | - * URL: _deliverable description url_ |
63 | | - * Visible: `true` |
64 | | - * Rubric: `{}` |
65 | | - * Custom: `{}` |
66 | | - * Open: _open date_; first day of class is fine |
67 | | - * Close: _close date_ |
68 | | - * Grades Released: `false` |
69 | | - * Will Provision Repos: `false` |
70 | | - * Will use AutoTest: `true` |
71 | | - * Docker image name: `TBD: NICK` |
72 | | - * Container timeout: `300` (5 minutes) |
73 | | - * Student Delay: `43200` (12 hours) |
74 | | - * Regression Deliverables: `` (blank) |
75 | | - * Custom Autotest Parameters: `{}` **Note**: to show both public and private tests, set this to `{feedbackMode: "combined"}` |
76 | | -* `d2` deliverable settings: |
77 | | - * Deliverable Id: `d2` |
78 | | - * URL: _deliverable description url_ |
79 | | - * Visible: `true` |
80 | | - * Rubric: `{}` |
81 | | - * Custom: `{}` |
82 | | - * Open: _open date_; first day of class is fine |
83 | | - * Close: _close date_ |
84 | | - * Grades Released: `false` |
85 | | - * Will Provision Repos: `false` |
86 | | - * Will use AutoTest: `true` |
87 | | - * Docker image name: `TBD: NICK` |
88 | | - * Container timeout: `300` (5 minutes) |
89 | | - * Student Delay: `43200` (12 hours) |
90 | | - * Regression Deliverables: `d1` |
91 | | - * Custom Autotest Parameters: `{}` **Note**: to show both public and private tests, set this to `{feedbackMode: "combined"}` |
92 | | -* `d3` deliverable settings: |
93 | | - * Deliverable Id: `d3` |
94 | | - * URL: _deliverable description url_ |
95 | | - * Visible: `true` |
96 | | - * Rubric: `{}` |
97 | | - * Custom: `{}` |
98 | | - * Open: _open date_; first day of class is fine |
99 | | - * Close: _close date_ |
100 | | - * Grades Released: `false` |
101 | | - * Will Provision Repos: `false` |
102 | | - * Will use AutoTest: `true` |
103 | | - * Docker image name: `TBD: NICK` |
104 | | - * Container timeout: `300` (5 minutes) |
105 | | - * Student Delay: `43200` (12 hours) |
106 | | - * Regression Deliverables: `d1, d2` |
107 | | - * Custom Autotest Parameters: `{}` **Note**: to show both public and private tests, set this to `{feedbackMode: "combined"}` |
108 | | -* `d4` deliverable settings: |
109 | | - * Deliverable Id: `d4` |
110 | | - * URL: _deliverable description url_ |
111 | | - * Visible: `true` |
112 | | - * Rubric: `{}` |
113 | | - * Custom: `{}` |
114 | | - * Open: _open date_; first day of class is fine |
115 | | - * Close: _close date_ |
116 | | - * Grades Released: `false` |
117 | | - * Will Provision Repos: `false` |
118 | | - * Will use AutoTest: `true` |
119 | | - * Docker image name: `TBD: NICK` |
120 | | - * Container timeout: `300` (5 minutes) |
121 | | - * Student Delay: `43200` (12 hours) |
122 | | - * Regression Deliverables: `` (no longer used) |
123 | | - * Custom Autotest Parameters: `{}` |
124 | | -* `project` deliverable settings: |
125 | | - * Deliverable Id: `project` |
126 | | - * URL: _deliverable description url_ |
127 | | - * Visible: `false` |
128 | | - * Rubric: `{}` |
129 | | - * Custom: `{}` |
130 | | - * Open: _open date_; first day of class is fine |
131 | | - * Close: _close date_ |
132 | | - * Grades Released: `false` |
133 | | - * Will Provision Repos: `true` |
134 | | - * Import URL: `https://github.ugrad.cs.ubc.ca/CPSC310-2018W-T1/bootstrap.git` (should be updated each term) |
135 | | - * Team prefix: `team` (`team_project_` will be prepended) |
136 | | - * Repo prefix: '' (blank) (`project_` will be prepended) |
137 | | - * Min size: `2` |
138 | | - * Max size: `2` |
139 | | - * Same lab: `true` |
140 | | - * Students make teams: `true` |
141 | | - * Will use AutoTest: `true` |
142 | | - * Docker image name: `cpsc310image` |
143 | | - * Container timeout: `300` (5 minutes) |
144 | | - * Student Delay: `43200` (12 hours) |
145 | | - * Regression Deliverables: `` (blank) |
146 | | - * Custom Autotest Parameters: `{}` |
147 | | - |
148 | | -# Provisioning repos |
149 | | - |
150 | | -* Visit `Manage Repositories` in the classy Config tab. |
151 | | -* If you want initial grading on all the repos you provision, be sure to set the `Default deliverable` in the config tab first. |
152 | | -* Select the deliverable you want to provision, and then the repos you want to provision (I would start with one, but if you're feeling lucky do them all). |
153 | | - * This will create the repo and give staff access to it, but _not_ the students. |
154 | | - * This task will take a long time (~10-15 seconds per repo), you can't close the browser while this is happening. |
155 | | - * You can watch progress using the Classy toast, or just visit the GitHub dashboard for the term to see repos show up. |
156 | | -* When you're happy with the repositories that have been provisioned you can release them to the students. |
157 | | - * This might require refreshing the `Provision & Release` results (do this by just toggling the deliverable dropdown). |
158 | | - * Select the repos you want to release and release them. This is a fast task (a few seconds at most per repository). |
159 | | - * Students should then have access to the repo. |
160 | | - * Make sure the `Default deliverable` is set in the config tab so that AutoTest runs on all pushes. |
| 5 | +### Viewing with the database (changes strongly discouraged) |
161 | 6 |
|
| 7 | +* Configure your SSH keys on `remote` and `cs310` |
| 8 | +* Open an SSH tunnel: ssh -J remote.cs.ubc.ca cs310.students.cs.ubc.ca -L 27017:127.0.0.1:27017 |
| 9 | +* With Robo3T: connect to `localhost:27017`. Do not use SSH tunnel (in Robo) and just connect as if local. |
0 commit comments