Permalink
Browse files

Update phantom docs with new images and better steps

  • Loading branch information...
1 parent 339e4cc commit 1802fff0f12a0c7ebcf0ca9ce2596c07145cfcd6 @oldpatricka oldpatricka committed Dec 20, 2012
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
@@ -1,12 +1,12 @@
===============
-Web Application
+Phantom Web App
===============
The best way to get familiar with the Nimbus Phantom service is to
-check out the web application
+check out the Phantom Web App
`here <https://svc.uc.futuregrid.org:8440/phantom>`_.
-In order to use the web application you will need a `FutureGrid account
+In order to use the Phantom Web App you will need a `FutureGrid account
<https://portal.futuregrid.org/user/register>`_ and a Phantom account.
To get a Phantom account, request to join the `Nimbus Auto Scale
<https://portal.futuregrid.org/projects/224>`_ project.
@@ -16,118 +16,148 @@ accepted.
Login
=====
-Once you have the needed accounts you can log into the web application.
-You will first be presented with a login screen similar to the one
-below:
+Once you have the needed accounts you can log in.
+You will first be presented with a login screen:
.. image:: images/phantom_login.png
:width: 502
- :height: 124
If you have forgotten your account information you can click on the
`Forgot Password <https://svc.uc.futuregrid.org:8440/accounts/reset_password/>`_
-link. After successfully logging in you will be presented with the landing
-page:
+link. After logging in you will see the home page:
.. image:: images/phantom_home.png
:width: 500
- :height: 313
-That screen explains the basic steps. The first thing you need to do is
-go to the
-`Edit Clouds <https://svc.uc.futuregrid.org:8440/phantom/sites>`_
-page and add your site credentials. The page should look like this:
+This page should guide you through the steps to start launching set of
+virtual machines, which are called Domains in Phantom.
+
+Setting up your Cloud Credentials
+=============================
+
+Go to the `Clouds <https://svc.uc.futuregrid.org:8440/phantom/sites>`_
+page and add your site credentials:
.. image:: images/phantom_sites.png
:width: 500
- :height: 313
All FutureGrid accounts should come pre-loaded with your credentials. If you
-wish to use EC2 you can add your credentials by selecting the EC2 cloud,
-adding your access and secret key, and then click save. Once the system
-has your keys you can select the keyname that you wish to use. Select it
-and click save a second time.
+wish to use EC2 in addition to FutureGrid clouds,
+you can add your credentials:
+
+Adding EC2 Credentials
+----------------------
+
+1. Select the EC2 cloud
+2. Add your access key
+3. Add your secret key
+4. Click Save
+
+Phantom will now fetch your ssh keys from EC2. When this is done:
+
+5. Choose an ssh keyname for your VMs
+6. Click Save again
-Create a launch configuration
+Creating a Launch Configuration
=============================
-Once you have all of your site information configured it is time to create
-a launch configuration. Got to the
+Now that your credentials are configured, you can create a launch configuration.
+A launch configuration is a list of which VM images you would like to start on
+which clouds. You will provide an ordering for the list of clouds to start VMs
+on.
+
+Go to the
`Launch Configuration <https://svc.uc.futuregrid.org:8440/phantom/launchconfig>`_
-page and you will see a screen like the following:
+page:
.. image:: images/phantom_lc.png
:width: 500
- :height: 313
-
-This is where you create a launch plan. The first thing to do is to select
-a name for the launch configuration, for this example we will use
-*testoverflow*. Now the ordered list of clouds must be created. On the left
-panel *Cloud Options* select a cloud from the list. Then give it a max
-number of VMs that you will allow on that cloud (-1 means infinity).
-Select an instance type (if you are unsure choose m1.small). Finally
-select the image you wish to launch. In the combo box labeled * Personal Image*
-you will find a list of all of the images you have created and uploaded.
-If you have not yet done this you can specify the name of a public image.
-If you are using a FutureGrid cloud enter *hello-cloud*.
-
-Click *Add* to add the cloud configuration to the list. Now you can configure
-the next cloud by repeating the above process with another cloud in the
-Cloud Options panel.
-
-Once you have added all of the clouds you can use the *Up* and *Down* buttons
-to order them. When you are happy with the order click the *Save* button
-at the top. Once successfully saved you can launch a domain using this launch
+
+First, name your launch configuration. Type the name in the top field. This
+example will be named
+*testoverflow*.
+
+Now we will create a list of clouds in the order we would like to have Phantom
+use them. This way you can prioritize your preferred clouds, while still using
+other clouds when your preferred ones are not available.
+
+Adding a Cloud
+--------------
+
+1. Select a cloud from the list of clouds under *Cloud Options*
+2. Specify the maximum number of VMs you would like on this cloud (-1 means infinity)
+3. Select an instance type (m1.small is a good choice if you have no preference)
+4. Select the image you wish to launch. You can either pick a *Personal Image* from
+ the list, or type in the name of a *Public Image* supplied by someone else.
+ If you are using a FutureGrid cloud, you can use *hello-cloud*, for example.
+5. If you like, you can provide User Data that will be provided on the VM via the
+ EC2 or Nimbus metadata server.
+6. Click *Add* to add the cloud configuration to the list of clouds on the right.
+
+You can now add aditional clouds if you like by repeating the above steps.
+
+Once you have added the clouds you would like to use, you can use the *Up* and
+*Down* buttons to change the launch priority of these clouds. Phantom will try
+to start as many VMs as it can (up to the maximum you specified) on the first
+cloud in the list before starting VMs on the second.
+
+When you are happy with the order you have selected, click the *Save* button
+at the top. Once saved, you can now launch a domain using this launch
configuration.
-Launch a domain
-===============
+Launching a domain
+==================
-At this point you can use the application to create new domains, monitor
-existing domains, resize existing domains, and terminate existing domains.
+Now that you have set up your credentials and created a launch configuration,
+you can launch and manage domains that will launch and monitor VMs for you.
-To launch a new domain go to the
+To launch a new domain, go to the
`domains <https://svc.uc.futuregrid.org:8440/phantom/domain>`_
-page. You should see something like this:
+page:
-.. image:: images/phantom_lc.png
+.. image:: images/phantom_domain.png
:width: 500
- :height: 313
-
-The first thing you should do is select a name for
-it and enter it into the 'Domain Name' text box. After that set the
-number of VMs you wish to run in this domain by typing that number in the
-"Size" box. Finally select the launch configuration you wish to use.
-In the screen above we selected *testoverflow*.
-
-The final step is to select click 'Start'. Once you
-start it you will notice that your 'domain name' is now listed in the
-lowest box on the left panel. This means that the system is aware of your
-domain and running it.
-
-Click on your domain name and you should see
-the domain details panel populated with information about your domain.
-Each
-entry represents the state of one of your requested VMs. When a VM
-instance is listed as 'RUNNING' it is ready for use (you can ssh into it as
-root).
-Click the 'Update' Button until you see your VMs are all running.
-
-Resize a domain
+
+Creating a simple domain
+------------------------
+
+To create a domain:
+
+1. Click *Add Domain*
+2. Choose a name for the domain in the popup window
+3. Pick the Launch Configuration you created earlier
+4. Leave Sensors to Monitor blank for now
+5. Make sure *Scaling Policy* is set to "Multi Cloud"
+6. Type in the number of VMs you would like Phantom to start
+7. Click *Start*
+
+Phantom is now starting your Domain, and in turn, starting your VMs. You should
+see the list of VMs that Phantom has started on the right under Details. Click
+the *Refresh* button to see updated information.
+
+When you see that your VM is RUNNING, it is now ready to use.
+
+Update a domain
===============
-Select your domain from the list in the lowest box in the bottom left pane.
-When you select it notice that all the options for running a domain are
-set to represent your domain, including the 'Size' field. If you wish, you
-can change the size. Simply enter a new value and click the 'Resize'
-button. You should now see the status bar working and changes on the right
-pane begin to take effect.
+Once you have started a Domain, you may wish to adjust the settings you picked
+earlier. For example, you may wish to increase or decrease the number of VMs
+that are running as a part of your domain. To do this:
+
+1. Select your domain from the list of domains on the left
+2. Change the number of VMs in the domain
+3. Click Update
-Delete a domain
+You should now see the status bar working and the details view should show the
+updated number of VMs.
+
+Terminate a domain
===============
-When you wish to terminate a domain simply select it and click the terminate
-button. This will begin terminating all of the VMs under the domain
-and stopping all other processes associated with the domain. It may
-take a few moments to complete and you may need to click update to see
-the results of the operation.
+When you wish to terminate a domain:
+
+1. Select your domain from the list of domains on the left
+2. Click Terminate
+
+You should now see the status bar working, and soon, your domain, as well as
+all of the VMs started by it, will be terminated.

0 comments on commit 1802fff

Please sign in to comment.