Skip to content
This repository
Browse code

Quickstart updates

  • Loading branch information...
commit 0d07e2e1ee0fc550c83b719fc6a54f2b1b378777 1 parent 5524ea3
David LaBissoniere authored November 29, 2010

Showing 1 changed file with 61 additions and 81 deletions. Show diff stats Hide diff stats

  1. 142  docs/src/clouds/cloudquickstart.html
142  docs/src/clouds/cloudquickstart.html
@@ -36,26 +36,31 @@
36 36
 <p>
37 37
   Note that using the cloud client requires access to a Nimbus cloud. If you are
38 38
   a member of the academic community, you can gain access to one of several
39  
-  <a href="http://www.scienceclouds.org/">science clouds</a>.
  39
+  <a href="http://www.scienceclouds.org/">science clouds</a>. You may also apply
  40
+    for an account on a <a href="http://www.futuregrid.org">FutureGrid</a> Nimbus cloud.
40 41
 </p>
41 42
 
42 43
 <p>
43 44
     Download the
44  
-    <a href="_NIMBUS_WEBSITE/downloads/">latest
45  
-    nimbus cloud client</a>, untar the file, and change to the
46  
-    cloud client directory (<i><a href="_NIMBUS_WEBSITE/archive/#cloudclients">older
47  
-    versions of the cloud client</a></i>).
  45
+    <a href="_NIMBUS_WEBSITE/downloads/nimbus-cloud-client-017.tar.gz">latest
  46
+    Nimbus cloud client</a> from the <a href="_NIMBUS_WEBSITE/downloads/">downloads page</a>,
  47
+    untar the file, and change to the cloud client directory.
48 48
 </p>
49 49
 
  50
+<pre class="panel">
  51
+$ wget _NIMBUS_WEBSITE/downloads/nimbus-cloud-client-017.tar.gz
  52
+$ tar xzvf nimbus-cloud-client-017.tar.gz
  53
+$ cd nimbus-cloud-client-017/
  54
+</pre>
  55
+
50 56
 <p> 
51 57
     Congratulations -- you are now the happy owner of a brand new cloud client!
52 58
     At any time, get help like so:
53 59
 </p>
54 60
 
55  
-_EXAMPLE_GENERICCMD_BEGIN
56  
-./bin/cloud-client.sh --help
57  
-_EXAMPLE_CMD_END
58  
-
  61
+<pre class="panel">
  62
+$ ./bin/cloud-client.sh --help
  63
+</pre>
59 64
 <p>
60 65
     Make sure to subscribe to <i>workspace-user@globus.org</i> (see the
61 66
     <a href="_NIMBUS_WEBSITE/contact.html">contact</a> page for instruction on how
@@ -68,32 +73,14 @@
68 73
 <h2>Configure and prepare for deployment _NAMELINK(configure)</h2>
69 74
 
70 75
 <p>
71  
-  First, see if you have configured the desired certificate:
72  
-</p>
73  
-
74  
-_EXAMPLE_GENERICCMD_BEGIN
75  
-./bin/grid-cert-info.sh
76  
-_EXAMPLE_CMD_END
77  
-
78  
-<p>
79  
-  Then create a proxy credential:
80  
-</p>
81  
-
82  
-_EXAMPLE_GENERICCMD_BEGIN
83  
-./bin/grid-proxy-init.sh
84  
-_EXAMPLE_CMD_END
85  
-
86  
-<p>
87  
-  Alternatively, if you have access to a MyProxy credential you can use the
88  
-  "./bin/myproxy.sh" program.
  76
+    You will need credentials for the cloud you are accessing. These should be given to you by the cloud provider. 
89 77
 </p>
90 78
 
91 79
 <p>Test the security setup:</p>
92 80
 
93  
-_EXAMPLE_GENERICCMD_BEGIN
94  
-./bin/cloud-client.sh --security
95  
-_EXAMPLE_CMD_END
96  
-
  81
+<pre class="panel">
  82
+$ ./bin/cloud-client.sh --security
  83
+</pre>
97 84
 
98 85
 <p>
99 86
     Issues? See the <a href="#help">help resources</a> for help.
@@ -104,15 +91,14 @@
104 91
 </p>
105 92
 
106 93
 <p class="indent">
107  
-    You need to look at the instructions published for each cloud.  Many clouds will give you access and provide you with the proper credentials and cloud.properties file.
  94
+    You need to look at the instructions published for each cloud.  Many clouds will give you access
  95
+    and provide you with the proper credentials and <tt class="literal">cloud.properties</tt> file.
108 96
 </p>
109 97
 
110  
-<p class="indent">
111  
-    For clouds running the newest versions of Nimbus (2.5+ with the Cumulus image repository), you will need to have the image repository credentials in your cloud.properties file and you will need to use cloud client #16 or later.  The administrator should have provided you with this file.
112  
-</p>
113  
-
114  
-<p class="indent">
115  
-    Backwards compatibility note: cloud client #16 or later will however work with clouds running older Nimbus software.  Again the cloud's website and/or administrator should very clearly state to you where you need to get credentials and the proper cloud.properties file.
  98
+<p class="note">
  99
+    For clouds running the newest versions of Nimbus (2.5+ with the Cumulus image repository),
  100
+    you will need to have the image repository credentials in your <tt class="literal">cloud.properties</tt> file and you
  101
+    will need to use cloud client #16 or later.  The administrator should have provided you with this file.
116 102
 </p>
117 103
 
118 104
 <p>
@@ -135,7 +121,7 @@
135 121
 	</p>
136 122
 	<p>
137 123
 		You might want to change things in
138  
-        the <i>conf/cloud.properties</i> file, <b>probably not</b>.
  124
+        the <tt class="literal">conf/cloud.properties</tt> file, <b>probably not</b>.
139 125
     </p>
140 126
 	<p>
141 127
 		Most of the time a configuration file tailored to the cloud
@@ -161,7 +147,7 @@
161 147
         <li>
162 148
             <p>
163 149
                 Note that you can override options via commandline if desired
164  
-                (see the <i><i>--extrahelp</i></i> option)
  150
+                (see the <tt class="literal">--extrahelp</tt> option)
165 151
             </p>
166 152
         </li>
167 153
     </ul>
@@ -188,10 +174,9 @@
188 174
     follows:
189 175
 <p>
190 176
 
191  
-_EXAMPLE_GENERICCMD_BEGIN
192  
-./bin/cloud-client.sh --list
193  
-_EXAMPLE_CMD_END
194  
-
  177
+<pre class="panel">
  178
+$ ./bin/cloud-client.sh --list
  179
+</pre>
195 180
 <p>
196 181
     If you are feeling adventurous you could also create an image yourself
197 182
     and upload them to the cloud, see this
@@ -206,23 +191,23 @@
206 191
 <h2>Deploy a workspace _NAMELINK(run)</h2>
207 192
 
208 193
 <p>
209  
-    To launch, use the <i>--run</i> option of the client. There are
210  
-    two required run options: (1) <i>--name</i> defines the name of
211  
-    an image and (2) <i>--hours</i> specifies the number of hours for
  194
+    To launch, use the <tt class="literal">--run</tt> option of the client. There are
  195
+    two required run options: (1) <tt class="literal">--name</tt> defines the name of
  196
+    an image and (2) <tt class="literal">--hours</tt> specifies the number of hours for
212 197
     which the image will be deployed. For example, if you want to run
213 198
     the image in your personal repository called "hello-cloud" for 1 hour,
214 199
     run the following command:
215 200
 </p>
216 201
   
217  
-_EXAMPLE_GENERICCMD_BEGIN
218  
-./bin/cloud-client.sh --run --name hello-cloud --hours 1
219  
-_EXAMPLE_CMD_END
  202
+<pre class="panel">
  203
+$ ./bin/cloud-client.sh --run --name hello-cloud --hours 1
  204
+</pre>
220 205
 
221 206
 <p>
222 207
 If successful, the run command should produce roughly this output:
223 208
 </p>
224 209
   
225  
-<div class="screen"><pre>
  210
+<pre class="panel">
226 211
 SSH public keyfile contained tilde:
227 212
   - '~/.ssh/id_rsa.pub' --> '/home/guest/.ssh/id_rsa.pub'
228 213
 
@@ -244,7 +229,7 @@
244 229
 State changed: Running
245 230
 
246 231
 Running: 'vm-023'
247  
-</pre></div>
  232
+</pre>
248 233
 
249 234
 <p>
250 235
     The output prints out the endpoint information of the Nimbus service
@@ -254,11 +239,10 @@
254 239
     contact information for the workspace.
255 240
 </p>
256 241
 
257  
-<div style="float: left; width: 56px;"><img src="img/note.png" /></div>
258  
-<p>
259  
-    <b>Note</b> that the information printed contains the network address
  242
+<div class="note">
  243
+    Note that the information printed contains the network address
260 244
     for the VM.  <i>You will need this in order to log in.</i>
261  
-</p>
  245
+</div>
262 246
 
263 247
 <br />
264 248
         
@@ -267,15 +251,15 @@
267 251
 
268 252
 <p>
269 253
     Recall that your public key has been configured in the
270  
-    <i>conf/cloud.properties </i> file. At launch time, 
271  
-    the public key file was installed to <i>/root/.ssh/authorized_keys</i>
  254
+    <tt class="literal">conf/cloud.properties</tt> file. At launch time,
  255
+    the public key file was installed to <tt class="literal">/root/.ssh/authorized_keys</tt>
272 256
     on the VM image, so that after it boots you should be able to log
273 257
     in by typing:
274 258
 </p>
275 259
         
276  
-_EXAMPLE_GENERICCMD_BEGIN
277  
-ssh <b>root</b>@ahostname.cloudurl.edu
278  
-_EXAMPLE_CMD_END
  260
+<pre class="panel">
  261
+$ ssh <b>root</b>@ahostname.cloudurl.edu
  262
+</pre>
279 263
 
280 264
 <p>
281 265
     Make sure that you log in to the <b>root account</b> -- that's the
@@ -288,14 +272,10 @@
288 272
     if you don't want SSH to remember the generated host key in the
289 273
     known-hosts file (and complain when this name is taken by a
290 274
     different VM later), use SSH with the
291  
-    option "-o StrictHostKeyChecking=no"
  275
+    option "<tt class="literal">-o StrictHostKeyChecking=no</tt>"
292 276
     (<a href="clusters.html#secgap">later</a> you will learn how to be more secure)
293 277
 </p>
294 278
 
295  
-<p>
296  
-    Enjoy! And may we ask that you send us a postcard
297  
-    (workspace-user@globus.org).
298  
-</p>
299 279
 
300 280
 <br />
301 281
     
@@ -307,13 +287,13 @@
307 287
     VMs there is an easy way to reestablish relations:
308 288
 </p>
309 289
   
310  
-_EXAMPLE_GENERICCMD_BEGIN
311  
-./bin/cloud-client.sh --status --handle vm-023
312  
-_EXAMPLE_CMD_END
  290
+<pre class="panel">
  291
+$ ./bin/cloud-client.sh --status --handle vm-023
  292
+</pre>
313 293
 
314 294
 <p>
315 295
     If you don't recall what the handle you need is, there are running
316  
-    logs of each run kept in the "history" directory.  The highest numbered
  296
+    logs of each run kept in the <tt class="literal">history</tt> directory.  The highest numbered
317 297
     subdirectory name in the history directory is probably a good guess.
318 298
 </p>
319 299
 
@@ -328,24 +308,24 @@
328 308
     repository directory. 
329 309
 </p>
330 310
 
331  
-_EXAMPLE_GENERICCMD_BEGIN
332  
-./bin/cloud-client.sh --save --handle vm-023 --newname custom-1
333  
-_EXAMPLE_CMD_END
  311
+<pre class="panel">
  312
+$ ./bin/cloud-client.sh --save --handle vm-023 --newname custom-1
  313
+</pre>
334 314
 
335 315
 <p>
336  
-    Note that without the <i>--newname</i> parameter this will
  316
+    Note that without the <tt class="literal">--newname</tt> parameter this will
337 317
     <b>overwrite the source file</b>.  If you do not have permissions
338 318
     to overwrite the source file (for example, you are using the
339 319
     pre-populated template images that are provided), you must use the
340  
-    <i>--newname</i> parameter which is kind of like the "save as" option
  320
+    <tt class="literal">--newname</tt> parameter which is kind of like the "save as" option
341 321
     for documents in a word processor.
342 322
 </p>
343 323
 <p>
344 324
     Failing to do so will cause a permissions error and you will lose
345 325
     the changes on that run.  If you uploaded the image personally, you
346 326
     will have the permissions to overwrite the source file (i.e., the
347  
-    ability to use the <i>--save</i> option without also using
348  
-    <i>--newname</i>).
  327
+    ability to use the <tt class="literal">--save</tt> option without also using
  328
+    <tt class="literal">--newname</tt>).
349 329
 </p>
350 330
 
351 331
 <p>
@@ -363,9 +343,9 @@
363 343
     come to an end in the following way:
364 344
 </p>
365 345
   
366  
-_EXAMPLE_GENERICCMD_BEGIN
367  
-./bin/cloud-client.sh --terminate --handle vm-023
368  
-_EXAMPLE_CMD_END
  346
+<pre class="panel">
  347
+$ ./bin/cloud-client.sh --terminate --handle vm-023
  348
+</pre>
369 349
 
370 350
 <p>
371 351
     As explained in the <a href="#query">query</a> section above, if you
@@ -403,7 +383,7 @@
403 383
 
404 384
 <p>
405 385
   For help with security issues, you should also inquire to the list.  Before
406  
-  doing so, note that the cloud-client has a "--security" flag for a basic
  386
+  doing so, note that the cloud-client has a <tt class="literal">--security</tt> flag for a basic
407 387
   trust check.  And other programs under the "bin" directory have their own
408 388
   help system, for example if you run "<i>./bin/grid-proxy-init.sh -help</i>" 
409 389
   this may solve a problem your having right away.

0 notes on commit 0d07e2e

Please sign in to comment.
Something went wrong with that request. Please try again.