Commit 85938ea3 authored by Jonathon Duerig's avatar Jonathon Duerig

Add new screenshots, update some text to reflect recent UI changes.

parent 8008d22d
......@@ -11,7 +11,8 @@ SCRIBBLEFILES=$(wildcard *.scrbl)
SCREENSHOTFILES=$(wildcard screenshots/*)
DEFSFILE=defs.rkt
GENI_LIB_DIR=$(shell ./py/find-geni-lib.py)
GENI_LIB_DIR=/local/duerig/genilib
#GENI_LIB_DIR=$(shell ./py/find-geni-lib.py)
SOURCES=$(SCRIBBLEFILES) $(SCREENSHOTFILES) $(DEFSFILE)
......
......@@ -25,27 +25,31 @@ physical) described by the RSpec.
@section[#:tag "creating-from-existing"]{Creating a profile from an existing one}
The easiest way to create a new profile is by cloning an existing one and
The easiest way to create a new profile is by cloning or copying an existing one and
customizing it to your needs. The basic steps are:
@itemlist[ #:style 'ordered
@item{Find an existing profile that's closest to your needs}
@item{Create an experiment using that profile}
@item{Log into the node(s) in your experiment to install your software,
configure the operating system, etc.}
@item{``Clone'' the experiment to create a new profile}
]
When you @bold{clone} an experiment, you are taking an existing experiment, including a snapshot of the disk, and creating a new profile based on it. The new profile will be identical to the profile that experiment was based on in all other respects. Cloning only works on experiments with a single node.
If you @bold{copy} a profile, you are creating a new profile that is identical in every way to an existing profile. You may or may not have a running experiment using the source profile. And if you do have a running experiment, it does not impact the copy. After copying a profile, you can then modify it for your own use. And if you instantiate the copy, you can then take snapshots of disk images and use them in future version of your copy. Any profile that you have access to may be copied.
@subsection[#:tag "profile-creation-preparation"]{Preparation and precautions}
To create profiles, you need to be a @seclink["register"]{registered user}.
Creating a profile can take a while, so we recommend that you
Cloning a profile can take a while, so we recommend that you
@seclink["experiments"]{extend your experiment} while creating it, and contact
us if you are worried your experiment might expire before you're done creating
your profile. We also strongly recommend testing your profile fully before
terminating the experiment you're creating it from.
When cloning, your home directory is @bold{not} included in the disk image snapshot! You will need to install your code and data elsewhere in the image. We recommend /local/. Keep in mind that others who use your profile are going to have their own accounts, so make sure that nothing in your image makes assumptions about the username, home directory, etc. of the user running it.
When cloning, be aware the only the contents of disk (not running process, etc.) are stored as part of the profile, and as part of the creation process, your node(s) will be rebooted in order to take consistent snapshots of the disk.
For the time being, cloning only works for single-node profiles; we will add support for multi-node profiles in the future.
When copying a profile, remember that the disk images of a currently running experiment are not saved. If you want to customize the disk images using copy, you must copy the profile first, then instantiate your copy, then take snapshots of the modified disk image in your experiment.
@apt-only{
If you want your profile to be usable by @seclink["guest-users"]{guest
users}, keep in mind that there are @seclink["guest-users"]{several
......@@ -56,22 +60,10 @@ terminating the experiment you're creating it from.
the profile.
}
Your home directory is @bold{not} included in the disk image snapshot! You
will need to install your code and data elsewhere in the image. We recommend
@code{/local/}. Keep in mind that others who use your profile are going to have
their own accounts, so make sure that nothing in your image makes assumptions
about the username, home directory, etc. of the user running it.
Be aware the only the contents of disk (not running process, etc.) are stored
as part of the profile, and as part of the creation process, your node(s) will
be rebooted in order to take consistent snapshots of the disk.
For the time being, this process only works for single-node profiles; we will
add support for multi-node profiles in the future.
@subsection[#:tag "creating-the-profile"]{Creating the Profile}
@subsection[#:tag"cloning-a-profile"]{Cloning a Profile}
@itemlist[ #:style 'ordered
@instructionstep["Create an experiment"]{Create an experiment using the
profile that is most similar to the one you want to build. Usually, this
will be one of our facility-provided profiles with a generic installation
......@@ -95,6 +87,39 @@ add support for multi-node profiles in the future.
your running experiment.
}
@instructionstep["Create Profile"]{
You will be taken to a complete profile form and should fill it out as described below.
}
]
@subsection[#:tag"copying-a-profile"]{Copying a Profile}
@itemlist[ #:style 'ordered
@instructionstep["Choose a profile"
#:screenshot "begin-experiment.png" ]{
Find the profile you wish to clone using the “Start Experiment” selector. Then you can click “Show Profile” to clone the profile directly or you can instantiate the profile if you wish to create an experiment first. Both profiles themselves and active experiments can be copied.
}
@instructionstep["Copy the profile or experiment"
#:screenshot "copy-button.png" ]{
While logged in, both your experiment page and the show profile page will have a copy button. Clicking this button will create a profile based on that profile or experiment.
This button only copies the rspec or genilib script. No state in the active experiment is preserved.
}
@instructionstep["Create Profile"]{
You will be taken to a complete profile form and should fill it out as described below.
}
]
@subsection[#:tag "creating-the-profile"]{Creating the Profile}
After copying or cloning a profile (see above) or selecting the menu option to create a new profile from scratch, you will need to fill out the profile creation form in order to complete the creation process.
@itemlist[ #:style 'ordered
@instructionstep["Fill out information for the new profile"]{
After clicking on the ``clone'' button, you will see a form that
allows you to view and edit the basic information associated with your
......@@ -144,7 +169,7 @@ add support for multi-node profiles in the future.
ready! It will now show up in your ``My Profiles'' list.}
@instructionstep["Test your profile"]{Before terminating your experiment
(or letting it expire), we strongly recommend testing out the profile. If
(or letting it expire), we strongly recommend testing out the new profile. If
you elected to make it publicly visible, it will be listed in the profile
selection dialog on the front page of @url[(apturl)]. If not,
you can instantiate it from the listing in your ``My Profiles'' page. If
......
......@@ -46,11 +46,16 @@ Start by pointing your browser at @url[(apturl)].
}
}
@instructionstep["Select a profile"
#:screenshot "select-profile.png"]{
Clicking the ``Change Profile'' button will let you select the
@seclink["profiles"]{profile} that your @seclink["experiments"]{experiment}
will be built from. A profile describes @seclink["rspecs"]{a set of
@instructionstep["Start Experiment"]{
From the top menu, click “Experiments” and then “Start Experiment” to begin.
}
@instructionstep["Experiment Wizard"
#:screenshot "begin-experiment.png"]{
Experiments must be configured before they can be instantiated.
A short wizard guides you through the process.
The first step is to pick a profile for your experiment.
A profile describes @seclink["rspecs"]{a set of
resources} (both hardware and software) that will be used to start your
experiment. On the hardware side, the profile will control whether you get
@seclink["virtual-machines"]{virtual machines} or
......@@ -66,13 +71,24 @@ Start by pointing your browser at @url[(apturl)].
results, etc. Profiles represent a powerful way to enable
@seclink["repeatable-research"]{repeatable research}.
Clicking the ``Change Profile'' button will let you select the
@seclink["profiles"]{profile} that your @seclink["experiments"]{experiment}
will be built from.
}
@instructionstep["Select a profile"
#:screenshot "select-profile.png"]{
On the left side is the profile selector which lists the profiles you can choose.
The list contains both globally accessible profiles and profiles accessible to the projects you are part of.
The large display in this dialog box shows the network topology of the
profile, and a short description sits below the topology view.
@apt-only{The @tt{OneVM} profile that we've selected here will get you a
@apt-only{The @tt{OneVM} profile will get you a
single VM running version 12.04 of the Ubuntu operating system---this
is a good place to start.}
@clab-only{The @tt{OpenStack} profile that we've selected here will give you
@clab-only{The @tt{OpenStack} profile will give you
a small OpenStack installation with one master node and one compute
node. It provides a simple example of how complex software stacks can
be packaged up within @(tb). If you'd prefer to start from bare metal,
......@@ -80,6 +96,20 @@ Start by pointing your browser at @url[(apturl)].
physical machines.}
}
@clab-only{
@instructionstep["Choose Parameters"
#:screenshot "choose-parameters.png"]{
Some profiles are simple and provide the same topology every time they are instantiated.
But others, like the OpenStack profile, are parameterized and allow users to make choices about how they are instantiated.
The OpenStack profile allows you to pick the number of compute nodes, the hardware to use, and many more options.
The creator of the profile chooses which options to allow and provides information on what those options mean.
Just mouse over a blue ’?’ to see a description of an option.
For now, stick with the default options and click “Next” to continue.
}
}
@clab-only{
@instructionstep["Pick a cluster"
#:screenshot "pick-datacenter.png"]{
......@@ -104,6 +134,7 @@ Start by pointing your browser at @url[(apturl)].
Watch your email and enter the code into @(tb) when prompted. (If it
doesn't arrive in a few minutes, check your spam folder!)}
}
@instructionstep["Use your experiment"]{
When your experiment is ready to use, the progress bar will be complete, and
you'll be given a lot of new options at the bottom of the screen.
......
screenshots/apt/clone-button.png

346 KB | W: | H:

screenshots/apt/clone-button.png

162 KB | W: | H:

screenshots/apt/clone-button.png
screenshots/apt/clone-button.png
screenshots/apt/clone-button.png
screenshots/apt/clone-button.png
  • 2-up
  • Swipe
  • Onion skin
screenshots/apt/create-project.png

318 KB | W: | H:

screenshots/apt/create-project.png

115 KB | W: | H:

screenshots/apt/create-project.png
screenshots/apt/create-project.png
screenshots/apt/create-project.png
screenshots/apt/create-project.png
  • 2-up
  • Swipe
  • Onion skin
screenshots/apt/join-project.png

302 KB | W: | H:

screenshots/apt/join-project.png

83.9 KB | W: | H:

screenshots/apt/join-project.png
screenshots/apt/join-project.png
screenshots/apt/join-project.png
screenshots/apt/join-project.png
  • 2-up
  • Swipe
  • Onion skin
screenshots/apt/node-list.png

386 KB | W: | H:

screenshots/apt/node-list.png

98.4 KB | W: | H:

screenshots/apt/node-list.png
screenshots/apt/node-list.png
screenshots/apt/node-list.png
screenshots/apt/node-list.png
  • 2-up
  • Swipe
  • Onion skin
screenshots/apt/please-wait.png

306 KB | W: | H:

screenshots/apt/please-wait.png

46.6 KB | W: | H:

screenshots/apt/please-wait.png
screenshots/apt/please-wait.png
screenshots/apt/please-wait.png
screenshots/apt/please-wait.png
  • 2-up
  • Swipe
  • Onion skin
screenshots/apt/select-profile.png

308 KB | W: | H:

screenshots/apt/select-profile.png

215 KB | W: | H:

screenshots/apt/select-profile.png
screenshots/apt/select-profile.png
screenshots/apt/select-profile.png
screenshots/apt/select-profile.png
  • 2-up
  • Swipe
  • Onion skin
screenshots/clab/clone-button.png

375 KB | W: | H:

screenshots/clab/clone-button.png

162 KB | W: | H:

screenshots/clab/clone-button.png
screenshots/clab/clone-button.png
screenshots/clab/clone-button.png
screenshots/clab/clone-button.png
  • 2-up
  • Swipe
  • Onion skin
screenshots/clab/create-project.png

285 KB | W: | H:

screenshots/clab/create-project.png

115 KB | W: | H:

screenshots/clab/create-project.png
screenshots/clab/create-project.png
screenshots/clab/create-project.png
screenshots/clab/create-project.png
  • 2-up
  • Swipe
  • Onion skin
screenshots/clab/join-project.png

267 KB | W: | H:

screenshots/clab/join-project.png

83.9 KB | W: | H:

screenshots/clab/join-project.png
screenshots/clab/join-project.png
screenshots/clab/join-project.png
screenshots/clab/join-project.png
  • 2-up
  • Swipe
  • Onion skin
screenshots/clab/log-in.png

180 KB | W: | H:

screenshots/clab/log-in.png

59 KB | W: | H:

screenshots/clab/log-in.png
screenshots/clab/log-in.png
screenshots/clab/log-in.png
screenshots/clab/log-in.png
  • 2-up
  • Swipe
  • Onion skin
screenshots/clab/node-list.png

346 KB | W: | H:

screenshots/clab/node-list.png

98.4 KB | W: | H:

screenshots/clab/node-list.png
screenshots/clab/node-list.png
screenshots/clab/node-list.png
screenshots/clab/node-list.png
  • 2-up
  • Swipe
  • Onion skin
screenshots/clab/openstack-shell.png

403 KB | W: | H:

screenshots/clab/openstack-shell.png

304 KB | W: | H:

screenshots/clab/openstack-shell.png
screenshots/clab/openstack-shell.png
screenshots/clab/openstack-shell.png
screenshots/clab/openstack-shell.png
  • 2-up
  • Swipe
  • Onion skin
screenshots/clab/pick-datacenter.png

224 KB | W: | H:

screenshots/clab/pick-datacenter.png

60.7 KB | W: | H:

screenshots/clab/pick-datacenter.png
screenshots/clab/pick-datacenter.png
screenshots/clab/pick-datacenter.png
screenshots/clab/pick-datacenter.png
  • 2-up
  • Swipe
  • Onion skin
screenshots/clab/please-wait.png

182 KB | W: | H:

screenshots/clab/please-wait.png

46.6 KB | W: | H:

screenshots/clab/please-wait.png
screenshots/clab/please-wait.png
screenshots/clab/please-wait.png
screenshots/clab/please-wait.png
  • 2-up
  • Swipe
  • Onion skin
screenshots/clab/select-profile.png

220 KB | W: | H:

screenshots/clab/select-profile.png

215 KB | W: | H:

screenshots/clab/select-profile.png
screenshots/clab/select-profile.png
screenshots/clab/select-profile.png
screenshots/clab/select-profile.png
  • 2-up
  • Swipe
  • Onion skin
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment