Paper < CF < TWiki

CF Web>Paper (2021-06-25, HarshRoghelia) (raw view)
---+ Paper

%TOC% 

---++ User QuickStart
---+++ Token for reservation site access

A password/token is required for the reservation system (below).  These can be (re-)generated at any time from the command line of the login system;

<verbatim> 
~$ get-token 
</verbatim>

---++ Reservation System

Paper features an autonomous, user-managed graphical interfaces for reserving Facility resources.
   * The Reservation System allows for users to reserve multiple compute resources easily and include other Facility users in reservations to facilitate collaboration.
   * The Reservation System allows users to reserve resources for 30-minute periods on the top and bottom of the hour.
   * Reservations can be placed, modified and deleted until 5 minutes before the opening of the next reservation period. Once a reservation has been successfully registered, all participants will receive a notification e-mail with details of the reservation.
   * For long-term reservations spanning several days, it is highly-recommended to generate a series a repeating 1-day reservations and include your contact information in the reservation description.

At the end of the reservation period, access to reserved resources will be revoked and reassigned to users as allocated in the Reservation System.

There are several steps involved in registering a reservation on the system:

---+++ Dashboard

Once logged into the System, the initial landing page is the user dashboard. The dashboard gives a condensed overview of a user's upcoming reservations on the System and Announcements generated by the administrator.<br /> Details of a reservation can be edited here by double-clicking on the reservation. For example:

<img alt="" height="500" src="https://vault.cs.uwaterloo.ca/s/RePYwajTt9XbMxT/preview" />

---+++ Bookings

The Bookings section of the System is the primary location where reservations on the Facility are placed and viewed. To go to Bookings, browse to the Schedule tab and select Bookings (SYN example):

<img alt="" height="403" src="https://vault.cs.uwaterloo.ca/s/cdp2XdBxya9nDkY/preview" width="990" />

---+++ Registering a Reservation

In order to register a reservation on the system, browse to the desired starting time slot for any machine to be included in your reservation. Double-clicking will open up window to create a reservation:

<img alt="" height="413" src="https://vault.cs.uwaterloo.ca/s/M8ZMx8EeyP4GwSZ/preview" width="1500" />

The "Create a new reservation" window is the location where details of a reservation request are registered. Select the start/end time for the reservation and enter a title and short description of the reason for the reservation request. Reservations without appropriate labelling risk being removed by the Administrator. Once the time and description of the reservation have been entered, one can add additional resources (if necessary) by selecting "More Resources":

<img alt="" src="https://vault.cs.uwaterloo.ca/s/NYfLLM5fkAfE5mw/preview" />

An "Add Resources" window will pop up with a listing of all available Facility resources. This window give an convenient method for selecting multiple resources or entire clusters (resource groups) by selecting the group label:

<img alt="" src="https://vault.cs.uwaterloo.ca/s/fARtWNeZr4FCBC4/preview" />

Once desired resources have been chosen in the "Add Resources" window, select "Done" to add them to the reservation.

<img alt="" height="500" src="https://vault.cs.uwaterloo.ca/s/g2x4WeNfffRdpEA/preview" />

If the reservation involves only a single Facility user, review your request and select "Create" at the bottom of the page to create the reservation. The System should return you to the Bookings page and you should recieve a notification e-mail promptly.

The Reservation System includes the ability to invite additional Facility users to your reservation for collaboration. All users included in a reservation will have access to reservation resources for the duration of reservation with equal system privilege (eg. sudo). In order to add participants to your reservation, select "Select User" in the Participant List section:

<img alt="" src="https://vault.cs.uwaterloo.ca/s/Z5c26YSn9kGqgCR/preview" />

In the pop-up window, select the "+" beside a user's name to add them to the participant list. Multiple users can be selected. When finished adding participants, close the pop-up with the "x" in the top right corner.

<img alt="" src="https://vault.cs.uwaterloo.ca/s/cn7PdNWeaRktHxp/preview" />

To register your reservation, review the request and select the "Create" button at the bottom of the page. You should see a confirmation page and then be returned the Bookings page where your reservation is displayed on the appropriate resources.<br /> Once the reservation has been created you and any invited participants will receive an e-mail from the reservation system with a record of the reservation.
-- %USERSIG{HarshRoghelia - 2020-04-06}%

---++ Comments

%COMMENT%
Topic revision: r2 - 2021-06-25 - HarshRoghelia
Information in this area is meant for use by CSCF staff and is not official documentation, but anybody who is interested is welcome to use it if they find it useful.
Other Webs
My links
- People
- CERAS
- WatForm
- Tetherless lab
- Ubuntu Main.HowTo
- eDocs
- RGG NE notes
- RGG
- CS infrastructure
- Grad images
Edit