users.scrbl 5.14 KB
Newer Older
Robert Ricci's avatar
Robert Ricci committed
1
#lang scribble/manual
2
@(require "defs.rkt")
Robert Ricci's avatar
Robert Ricci committed
3

4
@title[#:tag "users" #:version apt-version]{@(tb) Users}
5

Robert Ricci's avatar
Robert Ricci committed
6 7
Registering for an account is @seclink["register"]{quick and easy}. Registering
doesn't cost anything, it's simply for accountability. We just ask that if
8 9
you're going to use @(tb) for anything other than light use, you tell us a bit
more about who you are and what you want to use @(tb) for.
10

11
Users in @(tb) are grouped into @seclink["projects"]{@italic{projects}}: a
Robert Ricci's avatar
Robert Ricci committed
12
project is a (loosely-defined) group of people working together on some common
13
goal, whether that be a research project, a class, etc. @(tb) places a lot of
Robert Ricci's avatar
Robert Ricci committed
14
trust on project leaders, including the ability to authorize others to use the
15
@(tb). We therefore require that project leaders be faculty, senior research
Robert Ricci's avatar
Robert Ricci committed
16
staff, or others who are relatively senior positions.
17

18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
@clab-only{
    @section[#:tag "geni-users"]{GENI Users}

    If you already have a @hyperlink["http://www.geni.net"]{GENI} account,
    you may use it instead of creating a new CloudLab account. On the login
    page, select the ``GENI User'' button. You will be taken to a page like
    the one below to select where you normally log into your GENI account.

    @screenshot["pick-ma.png"]

    From here, you will be taken to the login page of your GENI federate; for
    example, the login page for the @hyperlink["http://portal.geni.net"]{GENI
    portal} is shown below.

    @screenshot["geni-portal-login.png"]

    After you log in, you will asked to authorize the @(tb) portal to use
Robert Ricci's avatar
Robert Ricci committed
35
    this account on your behalf. If your certificate at your GENI aggregate
36 37 38 39 40 41 42 43 44 45 46
    has a passphrase on it, you may be asked to enter that passphrase; if not,
    (as is the case with the GENI portal) you will simply see an ``authorize''
    button as below:

    @screenshot["trusted-signer.png"]

    That's it! When you log in a second time, some of these steps may be
    skipped, as your browser has them cached.

}

47

48
@section[#:tag "register"]{Register for an Account}
Robert Ricci's avatar
Robert Ricci committed
49

50
To get an account on @(tb), you either @seclink["join-project"]{join an existing
Robert Ricci's avatar
Robert Ricci committed
51
project} or @seclink["create-project"]{create a new one}. In general, if you are
52 53 54 55 56
a student, you should join a project led by a faculty member with whom
you're working.

If you already have an account on
@hyperlink["http://www.emulab.net/"]{Emulab.net}, you don't need to sign
57
up for a new account on @(tb)---simply log in with your Emulab username and
58 59
password.

Robert Ricci's avatar
Robert Ricci committed
60
@subsection[#:tag "join-project"]{Join an existing project}
61

Robert Ricci's avatar
Robert Ricci committed
62
@screenshot["join-project.png"]
63 64

To join an existing project, simply use the ``Sign Up'' button found on every
65
@(tb) page. The form will ask you a few basic questions about yourself and the
66 67 68 69 70 71 72
institution you're affiliated with.

An SSH public key is required; if you're
unfamiliar with creating and using ssh keypairs, we recommend taking a look
at the first few steps in
@hyperlink["https://help.github.com/articles/generating-ssh-keys"]{GitHub's
guide to generating SSH keys}. (Obviously, the steps about how to upload the
73
keypair into GitHub don't apply to @(tb).)
74

75
@margin-note{@(tb) will send you email to confirm your address---watch for it (it
Robert Ricci's avatar
Robert Ricci committed
76 77
might end up in your spam folder), as your request won't be processed until
you've confirmed your address.}
78 79
You'll be asked to enter the project ID for the project you are asking to
join; you should get this from the leader of the project, likely your advisor
80
or your class instructor. (If they don't already have a project on @(tb), you
Robert Ricci's avatar
Robert Ricci committed
81 82
can @seclink["create-project"]{ask them to create one}.) The leader of your
project is responsible for approving your account.
83 84


Robert Ricci's avatar
Robert Ricci committed
85
@subsection[#:tag "create-project"]{Create a new project}
86 87 88 89 90 91 92

@screenshot["create-project.png"]

@margin-note{You should only start a new project if you are a faculty member,
senior research staff, or in some other senior position.  Students should ask
their advisor or course instructor to create a new project.}

93
To start a new project, use the ``Sign Up'' button found on every @(tb) page. In
94
addition to basic information about yourself, the form will ask you a few
95
questions about how you intend to use @(tb). The application will be reviewed
96 97 98 99
by our staff, so please provide enough information for us to understand the
research or educational value of your project. The review process may take
a few days, and you will receive mail informing you of the outcome.

Robert Ricci's avatar
Robert Ricci committed
100 101 102 103 104 105 106 107
Every person working in your project needs to have
@seclink["join-project"]{their own account}. You get to approve these
additional users yourself (you will receive email when anyone applies to join.)
It is common, for example, for a faculty member to create a project which is
primarily used by his or her students, who are the ones who run experiments. We
still require that the project leader be the faculty member, as we require that
there is someone in a position of authority we can contact if there are
questions about the activities of the project.
108

109
Note that projects in @(tb) are publicly-listed: a page that allows users to
110 111 112
see a list of all projects and search through them does not exist yet, but
it will in the future.

Robert Ricci's avatar
Robert Ricci committed
113 114
@;{

Robert Ricci's avatar
Robert Ricci committed
115
@subsection[#:tag "invite-project"]{Invite others to join your project}
116 117

@TODO{Write about this when the feature is finished}
Robert Ricci's avatar
Robert Ricci committed
118 119

}