All new accounts created on Gitlab now require administrator approval. If you invite any collaborators, please let Flux staff know so they can approve the accounts.

Commit 1ca3c4d0 authored by Robert Ricci's avatar Robert Ricci

Adapt the "creating profiles" chapter for CloudLab

parent 2b956fde
...@@ -37,6 +37,11 @@ CloudLab will interoperate with existing testbeds including ...@@ -37,6 +37,11 @@ CloudLab will interoperate with existing testbeds including
hardware at dozens of sites around the world. hardware at dozens of sites around the world.
@include-section["getting-started.scrbl"] @include-section["getting-started.scrbl"]
@;include-section["users.scrbl"]
@;include-section["repeatable-research.scrbl"]
@include-section["creating-profiles.scrbl"]
@include-section["basic-concepts.scrbl"] @include-section["basic-concepts.scrbl"]
@include-section["advanced-topics.scrbl"] @include-section["advanced-topics.scrbl"]
@;include-section["hardware.scrbl"]
@;include-section["planned.scrbl"]
@include-section["getting-help.scrbl"] @include-section["getting-help.scrbl"]
...@@ -4,15 +4,25 @@ ...@@ -4,15 +4,25 @@
@title[#:tag "creating-profiles" #:version apt-version]{Creating Profiles} @title[#:tag "creating-profiles" #:version apt-version]{Creating Profiles}
Using @(tb), you can share your research artifacts with others by creating your @apt-only{
own profiles. When you create a new profile, you are creating a new Using @(tb), you can share your research artifacts with others by creating
your own profiles.
}
@clab-only{
In @(tb), a profile captures an entire cloud environment---the software
needed to run a particular cloud, plus a description of the hardware
(including network topology) that the cloud software stack should run on.
}
When you create a new profile, you are creating a new
@seclink["rspecs"]{RSpec}, and, usually, creating one or more @seclink["rspecs"]{RSpec}, and, usually, creating one or more
@seclink["disk-images"]{disk images} that are referenced by that RSpec. @seclink["disk-images"]{disk images} that are referenced by that RSpec. When
someone uses your profile, they will get their own
When someone uses your profile, they will get their own
@seclink["experiments"]{experiment} that boots up the resources (virtual or @seclink["experiments"]{experiment} that boots up the resources (virtual or
physical) described by the RSpec. physical) described by the RSpec.
@section[#:tag "creating-from-existing"]{Creating a profile from an existing one} @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 an existing one and
...@@ -36,12 +46,15 @@ us if you are worried your experiment might expire before you're done creating ...@@ -36,12 +46,15 @@ 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 your profile. We also strongly recommend testing your profile fully before
terminating the experiment you're creating it from. terminating the experiment you're creating it from.
If you want your profile to be usable by @seclink["guest-users"]{guest users}, @apt-only{
keep in mind that there are @seclink["guest-users"]{several restrictions} If you want your profile to be usable by @seclink["guest-users"]{guest
placed on them; among these is the fact that they are not allowed to make users}, keep in mind that there are @seclink["guest-users"]{several
outgoing connections, meaning that the experiment must be self-contained. For restrictions} placed on them; among these is the fact that they are not
example, they will not be able to download software or datasets from within the allowed to make outgoing connections, meaning that the experiment must be
experiment---it should all be contained as part of the profile. self-contained. For example, they will not be able to download software or
datasets from within the experiment---it should all be contained as part of
the profile.
}
Your home directory is @bold{not} included in the disk image snapshot! You 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 will need to install your code and data elsewhere in the image. We recommend
...@@ -195,7 +208,7 @@ website, publish them in papers, etc. The link can be found on the profile's ...@@ -195,7 +208,7 @@ website, publish them in papers, etc. The link can be found on the profile's
detail page, which is linked for your ``My Profiles'' page. If you chose to detail page, which is linked for your ``My Profiles'' page. If you chose to
make your profile accessable to anyone, the link will take the form make your profile accessable to anyone, the link will take the form
@code[(apturl "p/<project-id>/<profile-id>")]. If you didn't make the profile @code[(apturl "p/<project-id>/<profile-id>")]. If you didn't make the profile
public, the URL will have the form @code[(apturl "p/<UUID>")], where public, the URL will have the form @code[(apturl "/p/<UUID>")], where
@code{UUID} is a 128-bit number so that the URL is not guessable. You can still @code{UUID} is a 128-bit number so that the URL is not guessable. You can still
share this URLs with anyone you want to have access to the profile---for share this URLs with anyone you want to have access to the profile---for
example, to give it to a collaborator to try out your work before publishing. example, to give it to a collaborator to try out your work before publishing.
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