wiki:GENIEducation/SampleAssignments/UnderstandAMAPI/Procedure/DesignSetup

Version 3 (modified by sedwards@bbn.com, 11 years ago) (diff)

--

Understanding the AM API

Image Map

1. Design the Experiment

  1. In today's experiment you will use resources at the aggregate listed on the worksheet.

2. Establish the Environment

2.1 Pre-work: Create a GENI account

  1. Go to https://portal.geni.net and press the Use GENI button
  2. From the Drop Down menu select your institution. If you got an account through the GENI Identity Provider, please select GENI Project Office.
    Tip Start typing the name of your institution and see the list become smaller.
  3. You will be transferred to the Login Page of your institution. Fill in your username and password.
  4. Complete the form that appears after you have successfully logged in and press Continue.
  5. You will be transferred to an Activation Page. Make sure both checkboxes are checked and then press Activate.
Use GENI
Figure 2-1 Logging into the GENI Experimenter Portal.

Congratulations, you have successfully created a GENI account.

2.2 Pre-work: Project lead adds you to a project

In order to use the portal to reserve resources, you must join a project. We have created a project for this tutorial.

  1. The tutorial organizers should have added you to the project for this tutorial. On the home page, you should see that you are a member of at least one project.
    Tip If you are not doing this exercise as part of an in-person tutorial please sign up for a GENI account and join a project.

2.3 Generate and Download SSH Keypair

Access to compute resources in GENI is provided through ssh key pairs and thus the portal needs a public key to upload to compute resources. For the purposes of the tutorial we will have the portal create an SSH key pair for you. (However, if you prefer to use your personal public key you can choose to upload it.)

  1. Once you are logged in, click on the Profile page.
  2. On the Profile page in the SSH Keys section, select generate and download an SSH keypair button.
Generate an SSH Key Pair

Figure 2-2 On the Profile page, select the "generate and download an SSH keypair" button.
  1. Enter the same passphrase twice, then press Generate SSH private key.
Generate an SSH Key Pair
Figure 2-3 Enter passphrase twice, then generate SSH private key.
  1. Now, press the Download Private Key button
  2. Open a terminal and execute:
    $ mv ~/Downloads/id_geni_ssh_rsa ~/.ssh/.
    $ chmod 0600 ~/.ssh/id_geni_ssh_rsa
    $ ssh-add ~/.ssh/id_geni_ssh_rsa
    
    Later in the tutorial, this will allow you to log into your nodes securely without a password.
Download an SSH Key Pair
Figure 2-4 Download an SSH Key Pair.

2.4 Configure Omni

  1. Go to your browser tab with the GENI Portal page.
  2. On that page, select the tab labeled "Profile". This is on the upper right of the page.
  3. Scroll down to the section labeled "Option 1: Automatic omni configuration".
  4. Click on "customized configuration data" in Step 2 of this section.
  5. Generate a GENI certificate. The easiest choice is to have the portal generate a combined certificate and key file:
  6. Make sure your default project is "GEC17". If not, make that your default.
  7. Click "Download omni bundle" and "save" the file. The file is saved in your Downloads folder.
  8. Open a terminal window and type:
    omni-configure.py
    The cert and key files you need will be installed in the appropriate folders.

3. Obtain Resources

Now that you are a member of a project, you can create a slice and reserve resources.

3.1 Create a slice

  1. Go to the Home tab.
  2. Press the Create Slice button for this project.
  3. As a slice name use the slice name on your worksheet, you can leave the description empty and press Create Slice
Create a GENI Slice
Figure 3-1 Create a new slice.

3.2 (optional) Renew your slice

Slices and the resources within them are reserved until their individual expiration times. Renewing allows you to extend the expiration time of your slice and the resources in them.

Warning Slices and the resources within them have distinct expiration times. You must renew both the slice and the resources separately.
  1. On the Slice page, select the Renew slice only radio button.
  2. Click on the date below. In the calendar that pops up, select a date in the near future.
  3. Press Renew to renew the slice. Renewing the slice now allows the resources to have longer initial expiration times.
Renew slice
Figure 3-2 Renew the slice.

3.3 Reserve Two Virtual Machines at One Aggregate

The Portal is integrated with a tool, Flack, which allows you to draw topologies of GENI resources and then reserve them.

  1. On the Slice tab, press the Flack button. Flack will open in a new tab.
Launch Flack
Figure 3-3 Launch Flack
  1. Wait for Flack to load. You should see: your username, the slice name, and a list of aggregates. Flack should look like the picture to the right.
Flack
Figure 3-4 Flack after it has loaded.
  1. Find the aggregate listed on your worksheet.
  2. Click the VM box next to that aggregate and drag it onto the canvas.
  3. Repeat the above step. You should now see two VM boxes on the canvas.
  4. Now click near one of the VM boxes on the canvas, then click and drag towards the other VM. Release when you reach the other VM. You should now see a line and a box representing a link connecting the two VMs.
  5. The canvas should now look like the picture on the right.
  6. To edit the name of each VM, click the i in the circle.
Two VMs connected by a link.
Figure 3-5 Two VMs connected by a link.
  1. In the field at the top, replace "VM" with "client".
  2. If you are using an ExoGENI rack, set the "Sliver Type" to "EC2Small".
    ExoGENI ExoGENI allows you to reserve machines of various sizes. We will use small ones for this tutorial to conserve resources.
Relabel VM
Figure 3-6 Edit the name of the VM. Set the Sliver Type on ExoGENI racks.
  1. Now click on "Interfaces and Links" (this is the middle tab with the "link" symbol").
  2. Enter the Desired IP Address for this node which is listed on your worksheet.
  3. Enter the Desired Mask of 255.255.255.0.
  4. Then Press "Apply" at the bottom of the screen.
  5. Repeat the above six steps for the second VM, labeling it "server" and setting the server's Desired IP Address.
Relabel VM
Figure 3-7 Edit the IP Address and Mask of the VM.
  1. Click the Submit button near the bottom of the page. When prompted, confirm you want to actually reserve resources.
Two VMs connected by a link
Figure 3-8 Two VMs connected by a link.

3.4 Check Whether Virtual Machines are Ready to be Used

  1. After clicking the Submit button, wait for the canvas to turn green. (This may take awhile.)
  2. The canvas should now look like the picture on the right.
Resources are ready
Figure 3-9 Two VMs connected by a link are reserved and ready to login.

Introduction

Next: Execute