User Manual: ConPaaS Web Hosting Service

Transcription

1 User Manual: ConPaaS Web Hosting Service 1 Cloud Front-end August 15, 2011 The cloud front-end provides an intuitive web-based user interface that allows users to register new accounts in order to start using the Web Hosting Service. Registered users can create as well as terminate services. Additionally, the front-end provides a simplified interface through which a user can configure his services. 1.1 ConPaaS Open Testbed The ConPaaS Open Testbed is a platform where users can experiment with ConPaaS services for free. The testbed utilizes compute resources from Amazon Web Services and places additional usage restrictions that are not part of the standard ConPaaS release. These restrictions guarantee that malicious applications do not hinder the testbed or cause harm to other entities over the Internet. User applications cannot open files, use sockets or start processes. Users will be limited to a certain number of hours of usage. Registered users are assigned a certain amount of credits by the system administrator. Each service runs on behalf of a user consumes a specific amount of credits depending on its size. One credit is worth running a single Amazon EC2 instance for a full hour. Note that a service may be utilizing multiple EC2 instances concurrently and hence charge multiple credits per hour. A full hour will be accounted for partial hour usage per EC2 instance. If a user runs out of credits, all his services will be terminated. The amount of credit assigned to a user is displayed at the top right of the web pages of the front-end.

2 User Manual:ConPaaS Web Hosting Service Register a user Note: User registration can only be done through the cloud front-end. 1. Click on the register link. 2. Enter your user name and click on the register button. 3. You will be automatically logged in. Notice your user name and the logout link at the top right corner of the web page. You are now ready to experiment with the Web Hosting Service. 1.3 Create a Web Hosting Service Node: Creating a new service can only be done through the cloud front-end. 1. Starting from the user home page, click on the create service button. 2. Select a type of web hosting service. For example PHP Service. 3. Select a target cloud platform. For example Amazon EC2. 4. Click on the create service button to start. What is happening now? The Web interface requested a new virtual machine from Amazon EC2 and is waiting for it to boot. This virtual machine will be the managing node of the new service. The web page will be automatically redirected and a list of all of the created services will be displayed. Note that, the service status is Initializing. When the service is ready, its status will change to created and you can click on it to configure it further. 1.4 Rename the Service Renaming a service can only be done through the cloud front-end. 1. Starting from the user home page, click on the service you intend to rename. 2. Click on the service name at the top left of the web page. A dialog box will appear where you can enter the new service name.

3 User Manual:ConPaaS Web Hosting Service Terminate the service Note: terminating the service can only be done through the cloud front-end. 1. Starting from the user home page, click on the service you intend to terminate. 2. Press on the terminate button at the top right of the page. Terminating the service will release the virtual machine hosting the manager and will delete all of the service s configuration and uploaded code. 2 Starting and Stopping the Service 2.1 Start the Service Through the Front-end 1. Starting from the user home page, click on the service you intend to start. 2. Notice the message No instances are running. This means that there is no web server running yet. 3. Click on the start button at the top right of the page to start a web server. Notice the progress message that appeared at the top of the page. What is happening now? The service requested a new virtual machine from the cloud provider. When the machine is ready, the manager will configure it to run a web server. When the web server is ready, the web page will display the running instances information. 4. Notice the displayed instance information. It is tagged with proxy, web and php which means that this virtual machine is running a proxy (load balancer) server, a web server and it supports executing PHP scripts.on the right end you will find the domain name of the virtual machine. You can use this to access the virtual machine directly.

4 User Manual:ConPaaS Web Hosting Service 4 5. Notice the link labeled access active version. Click on it to access the newly created web server. The web servers start with a default welcome page Using the Command-line Client $./cpsclient.web startup 2.2 Stop the Service Through the Front-end 1. Starting from the user home page, click on the service you intend to stop. 2. Press on the stop button at the top right of the web page. 3. Stopping the service would release the web servers but the service manager will remain active. If you want to permanently destroy the service, press on the terminate button after you stop the service Using the Command-line Client $./cpsclient.web shutdown 3 Code Management The Web Hosting Service can manage and store multiple code archives. You can upload code archives to it and select which one should be active online. This section explains how to manage code archives.

5 User Manual:ConPaaS Web Hosting Service Upload Code Version Through the Front-end 1. Use the choose file button to upload a code archive. When creating an archive, you need to make sure it expands directly in the same directory. The upload file must be an archive of type.zip,.tar,.tar.bz2 or.tar.gz. PHP applications should have a file named index.php which will be the default page. Java applications should have a file named index.jsp. 2. Notice that the available code versions list grew. A new code version appeared in the list but it is not active yet. Hover over the new code version with the mouse and two more links will appear; set active and download Using the Command-line Client $./cpsclient.web upload_code_version -h Usage: upload_code_version <filename> $./cpsclient.web upload_code_version path/to/archive.zip codeversionid: code-xxxxx 3.2 Activate Code Version Through the Front-end 1. Hover over a code version with the mouse and two links will appear; set active and download. 2. Click on set active to activate this version online. 3. Notice that the selected code version is labeled with active. 4. If the service is already running, click on access active version to validate that the new code version is running. Your web browser would normally cache web pages so you may need to refresh the page to view the latest updates.

6 User Manual:ConPaaS Web Hosting Service Using the Command-line Client $./cpsclient.web update_java_configuration -h Usage: update_java_configuration -c CODEVERSIONID, --code=codeversionid $./cpsclient.web update_java_configuration -c code-xxxx 3.3 Download Code Version Through the Front-end 1. Hover over a code version with the mouse and two links will appear; set active and download. 2. Click the download link will download the file to your local computer. 4 Resource Management One of the advantages of ConPaaS is elasticity. The Web Hosting Service can configure multiple servers and assign them different roles to scale. The deployment can grow and shrink transparently to the users without any service disruption. 4.1 Scaling Out/In Through the Front-end 1. Notice the section labeled add or remove instances to your deployment in the web page were there are 3 boxes labeled proxy, web and php with a 0 to the left of each one. 2. Click on the 0 of any box and a dialog will appear where you can specify the number of nodes you want to add/remove. 3. Let s add 1 web server, 1 proxy and 1 php. Then press on the submit button to their right.

7 User Manual:ConPaaS Web Hosting Service 7 4. A progress message will show up at the top of the page. What is happening now? Requesting new virtual machines will take some time. As soon as the new virtual machines become available, the manager will configure them and reconfigure the old nodes as well. If you want to monitor the progress of the new virtual machines more closely, click on the raw log link at the top of the page to view the log produced by the manager. You will need to refresh this page to view recent updates. Once the nodes are ready, they will be displayed on the web page. 5. Notice that the web page is now displaying the newly created nodes as well. Each node is tagged with its roles (proxy, web or php) Using the Command-line Client $./cpsclient.web add_nodes -h Usage: add_nodes -p PROXY, --proxy=proxy -w WEB, --web=web -b BACKEND, --backend=backend $./cpsclient.web add_nodes -w 1 -b 1 $./cpsclient.web remove_nodes -h Usage: remove_nodes -p PROXY, --proxy=proxy -w WEB, --web=web -b BACKEND, --backend=backend $./cpsclient.web remove_nodes -w 1 -b 1 5 Command-line Administration You can perform all of the operations provided by the web interface by using a command-line tool. Prerequisites: python >= 2.6, python-pycurl and python-simplejson packages. Create a service, go to its web page

8 User Manual:ConPaaS Web Hosting Service 8 and copy the URL provided by the access manager link at the top of the page. This URL points to the manager directly and you can use it with the command-line program cpsclient.web to issue commands. 5.1 Prepare Command-line Environment Download the source code file ConPaaSWeb.tar.gz. Unpack it and prepare your environment as follows: $ tar -zxf ConPaaSWeb.tar.gz # unpack the archive $ export PYTHONPATH= pwd /ConPaaSWeb/src # Set PYTHONPATH The PYTHONPATH environment variable needs to be pointing to the location of the src directory on your file system. Run ConPaaSWeb/bin/cpsclient.web to view a list of supported operations. $./cpsclient.web Usage:./cpsclient.web URL ACTION options Action could be one of: ACTION add_nodes getlog get_configuration get_node_info get_service_history get_service_info get_service_performance help list_code_versions list_nodes remove_nodes shutdown startup update_java_configuration update_php_configuration upload_code_version DESCRIPTION Add more service nodes to a deployment Get raw logging Get the configuration of a deployment Get information about a single service node Get the state change history of a deployment Get the state of a deployment Get the average request rate and throughput Print the help menu List identifiers of all code versions stored by a deployment Get a list of service nodes Remove some service nodes from a deployment Shutdown a deployment Startup a deployment Update the configuration of a Java deployment Update the configuration of a PHP deployment Upload a new code version

9 User Manual:ConPaaS Web Hosting Service 9 Use the access manager URL as a first argument to cpsclient.web followed by one of the operation names to perform it. Use the -h option to check if an operation requires additional arguments. $./cpsclient.web get_node_info -h Usage: get_node_info <nodeid> $./cpsclient.web get_node_info i-23dffe4 Service Node Address Role(s) i-23dffe4d ec2-xxx-xx-xx-xxx.compute-x.amazonaws.com WEB