Note: If you cannot find a topic, go to docs.rightscale.com where all RightScale documentation will soon be located. Also, feel free to Chat with us!
Home > Partners > CloudOpt > Documentation > CloudOptimizer Setup and Runbook Guide

CloudOptimizer Setup and Runbook Guide

 

CloudOpt provides two (2) ServerTemplates that are designed to launch and configure a CloudOptimizer setup with a Gateway server or an Endpoint server. 

Table of Contents

Setup Guide

The following steps will explain how to use the CloudOpt ServerTemplates and RightScripts to properly setup a CloudOptimizer solution in the cloud.

Prerequisites

  • 'designer', 'library', and 'actor' user role privileges in the RightScale account

Create Required Cloud Resources

The CloudOpt ServerTemplates are designed to launch servers into one of the AWS EC2 regions. In order to launch an EC2 server you will need to have an EC2 SSH Key and Security Group. If you need to create new resources, follow the tutorials below.  Be sure to create the cloud resources in the EC2 cloud/region (e.g. US-East) into which you will launch the servers because cloud resources are cloud-specific.

Create Required Credentials

The CloudOpt ServerTemplates are designed to use RightScale's Credentials store (Design -> Credentials) to provide sensitive information to some of the scripts when they are executed.  Create the following credentials with the following names. If you do not have access to this information, contact the person who set up the AWS account.  See Sign Up for Amazon Web Services (AWS).

Create a New Credential

  • AWS_X509_CERT
  • AWS_X509_KEY

Import the CloudOpt ServerTemplates

Log into the RightScale dashboard and go to Design -> MultiCloud Marketplace -> ServerTemplates. Use the search tool to find and import the most recent revisions of both ServerTemplates published by "CloudOpt Inc." A copy of the templates will be saved in your RightScale account's local collection. (Design -> ServerTemplates)  Any RightScale account will be able to import the ServerTemplates.

  • CloudOptimizer Endpoint 
    • CloudOpt's CloudOptimizer configured in Endpoint mode. CloudOptimizer Endpoint accelerates only to/from the cloud instance that it is installed on. CloudOptimizer Gateway and Endpoint instances can be freely mixed in a deployment. Endpoint mode is ideal when you only have a few Linux clients or servers to accelerate. CloudOptimizer significantly accelerates applications and reduces the time and cost of data transfer into and around the cloud.
  • CloudOptimizer Gateway
    • CloudOpt's CloudOptimizer configured in Gateway mode. CloudOptimizer Gateway accelerates to/from many of your cloud instances. CloudOptimizer Gateway and Endpoint instances can be freely mixed in a deployment. Gateway mode is ideal when you have many clients or servers to accelerate. CloudOptimizer significantly accelerates applications and reduces the time and cost of data transfer into and around the cloud.

Add Servers to a Deployment

If you do not have a deployment, you must create one before you can add servers into it.  See Create a New Deployment. (e.g. CloudOpt)

There are two types of CloudOptimizer configurations that can be created with the ServerTemplates. The setup instructions below explain how to set up simple examples of each use case.

  • Endpoint Configuration - Consists of two Endpoint servers.
  • Gateway Configuration - Consists of one Endpoint server, one Gateway server, and a local machine.
CloudOptimizer Endpoint

Go to the imported "CloudOptimizer Endpoint" ServerTemplate and add a server to the new "CloudOpt" deployment. Be sure to select the same cloud/region where you created the cloud resources in an earlier step.

See Add a Server to a Deployment.  Select the appropriate EC2 SSH key and security group that you created in an earlier step. It's recommended that you select a specific availability zone (e.g. us-east-1a) because you will launch the CloudOptimizer Gateway in the same availability zone. You can use the default selections for the other server detail options.

CloudOptimizer Gateway

Go to the imported "CloudOptimizer Gateway" ServerTemplate and add a server to the new "CloudOpt" deployment. Be sure to select the same cloud/region, cloud resources, and availability zone as the CloudOptimizer Endpoint server.

Define Inputs

You will need to define any missing inputs for any boot/decomission scripts before you can successfully launch the server. Some inputs apply to operational scripts and can be left blank.

The following inputs must be specified for the successful execution of the CloudOpt scripts.  It's recommended that you define the inputs at the deployment level.  Go to the deployment's Inputs tab and define values for the following inputs:

  • AWS_X509_CERT - Select the "cred:AWS_X509_CERT" option from the dropdown menu to use the credential with the matching name that you created in an earlier step.
  • AWS_X509_KEY -  Select the "cred:AWS_X509_KEY" option from the dropdown menu.
  • CACHE_SIZE_GB -  Enter the size (GB) of the EBS volume that CloudOptimizer will use to store its byte cache. Minimum size if 30GB. Required input for launching a gateway server. (e.g. 30)


(Optional) You can define values for the other missing inputs, but it's not required to successfully launch the server.

Click Save.

Endpoint Configuration

Note: Please refer to http://kb.cloudopt.com assistance with any of the steps below. You can click on “All Articles” to access all of the articles on the CloudOpt Knowledge Base.

In an Endpoint Configuration, CloudOptimizer runs on the same system that is used to initiate file transfers.

  1. You will need to launch two CloudOptimizer Endpoint servers where one server will send files and another server will receive files.  Change the name of the server that was created using the "CloudOptimizer Gateway" ServerTemplate to denote that it will be the "sender" and the clone the server to create one that will be the "receiver."  Be sure to change the name of the receiving server. 
  2. Launch both servers.
  3. SSH into the CloudOptimizer Endpoint instance that will be used to send files.
  4. Generate a test file, using the following command to produce a normal but somewhat random file that is 100 MB in size and is named 1-100.mb.
    • test_file_generator.pl --size 100
  5. Transfer the file to the receiving CloudOptimizer system, using the following command.  Replace <key> with the SSH authentication key, <username> with a user, and <address> with the private IP address all from the receiving CloudOptimizer system.
    • scp -S cloudcopy -i <key> 1-100.mb <username>@<address>:~/.
  6. CloudOptimizer will optimize the transfer of the file and report the amount of time that it takes to complete the transfer with the bandwidth savings CloudOptimizer achieves.
  7. Check the transfer statistics from CloudOptimizer, with the following command:
    • cloudstats
      
    • This will show the bandwidth savings for the completed transfer. Here is an example of these statistics:
    • Component - cloudcopy
      ------------------------------------------------------------
            Number of connections:          1
            Original data size:        	100.00 MB
            Transferred data size:        	100.89 MB
            Bandwidth Saving:          	0 bytes (0.0%)
      
  8. Use an editor to make a modification to the file on the client CloudOptimizer Endpoint:
    • nano 1-100.mb
  9. Add random characters at different points in the file by adding characters at a random place or two in the file.
    • Save the file - <Cntl - W>
  10. Exit the editor
  11. Clear the cloudstats
    • cloudstats clear
  12. Transfer the file again to the receiving CloudOptimizer system, using the following command. Replace <key> with the SSH authentication key, <username> with a user, and <address> with the private IP address all of the receiving CloudOptimizer system. CloudOptimizer will again optimize the transfer of the file using any redundant bytes that were recognized from the previous transfer and will report the amount of time that it takes to complete the transfer along with the bandwidth savings CloudOptimizer achieves.
    • scp -S cloudcopy -i <key> 1-100.mb <username>@<address>:~/.
  13. Check the transfer statistics from CloudOptimizer, with the following command :
    • cloudstats
  14. An example of the bandwidth savings would be:
    • Component - cloudcopy
      ------------------------------------------------------------
            Number of connections:     1
            Original data size:        100.00 MB
            Transferred data size:     1.61 MB
            Bandwidth Saving:          98.39 MB (98.4%)
      
  15. CloudOptimizer in this mode works for more than just scp. Additional tests can be run using different applications and protocols. For example, using an http browser on the client and an http server on the receiving end, all http communication can be accelerated by either configuring CloudOptimizer peers/endpoints or by using CloudOptimizer Intelligent Mesh. CloudOptimizer will accelerate many protocols such as ftp, rsync, or others.
     

Gateway Configuration

Note: Please refer to http://kb.cloudopt.com assistance with any of the steps below. You can click on “All Articles” to access all of the articles on the CloudOpt Knowledge Base.

In a Gateway Configuration, files will be sent from the local computer to a CloudOptimizer running in Endpoint Mode via a CloudOptimizer running in Gateway Mode.

To keep the demonstration as simple as possible, you'll use two CloudOptimizer instances and one local computer. Use one CloudOptimizer server in Endpoint Mode and the other server in Gateway Mode.

  1. You will need to launch two CloudOptimizer servers.  Use the server that you created with the "CloudOptimizer Gateway" ServerTemplate to launch a CloudOptimizer server in Gateway mode. Use the server that you created with the "CloudOptimizer Endpoint" ServerTemplate to launch a CloudOptimizer server in Endpoint mode.
  2. SSH into the CloudOptimizer Gateway server and configure the Linux instance as an “endpoint” in the CloudOptimizer Gateway configuration /etc/cloudoptimizer.conf file.
  3. Install a static route on the local computer with the Endpoint Mode CloudOptimizer as the host and the Gateway Mode CloudOptimizer as the gateway.
  4. SSH into the Gateway Mode CloudOptimizer and run the cloudstats utility to monitor the transfer. Use the following command:
    • watch cloudstats
  5. SSH into the Endpoint Mode CloudOptimizer server and configure or enable an http or ftp server, then locate or generate a file to use in a test transfer. For example, generate a 5 MB file called 1-5.
    • mb:dd if=/dev/urandom of=1-5.mb bs=5M count=1
  6. Using curl or ftp, from the command line of the local computer, transfer the file from the address of the Endpoint Mode CloudOptimizer.
  7. Observe the CloudOptimizer statistics in the cloudstats utility on the Gateway Mode CloudOptimizer. An example of the bandwidth savings would be:
    • Component - cloudcopy
      ------------------------------------------------------------
           Number of connections:     1
           Original data size:        5.00 MB
           Transferred data size:     5.04 MB
           Bandwidth Saving:          0 bytes (0.0%)
      
  8. Use an editor to make a modification to the file on the local computer. Add random characters at different points in the file by adding characters at a random place or two in the file. Save the file using ‘Cntl - W then exit the editor.
  9. Clear the cloudstats.
    • cloudstats clear
  10. Transfer the file again to the address of the local computer from the Endpoint Mode CloudOptimizer. CloudOptimizer will again optimize the transfer of the file using any redundant bytes that were recognized from the previous transfer and will report the amount of time that it takes to complete the transfer along with the bandwidth savings CloudOptimizer achieves.
  11. Observe the CloudOptimizer statistics in the cloudstats utility on the Gateway Mode CloudOptimizer. An example of the bandwidth savings would be:
    • Component - cloudcopy
      ------------------------------------------------------------
            Number of connections:        	1
            Original data size:          	5.00 MB
            Transferred data size:         	87.45 KB
            Bandwidth Saving:          	4.91 MB (98.3%)
      

 

You must to post a comment.
Last modified
23:39, 16 May 2013

Tags

This page has no custom tags.

Classifications

This page has no classifications.

Announcements

None


© 2006-2014 RightScale, Inc. All rights reserved.
RightScale is a registered trademark of RightScale, Inc. All other products and services may be trademarks or servicemarks of their respective owners.