Zend Server Amazon AMI Quick Start Guide

Transcription

1 Zend Server Amazon AMI Quick Start Guide By Zend Technologies

2 Disclaimer This is the Quick Start Guide for The Zend Server Zend Server Amazon Machine Image The information in this document is subject to change without notice and does not represent a commitment on the part of Zend Technologies Ltd. No part of this manual may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying, recording, or information storage and retrieval systems, for any purpose other than the purchaser s personal use, without the written permission of Zend Technologies Ltd. All trademarks mentioned in this document, belong to their respective owners Zend Technologies Ltd. All rights reserved. Zend AMI Quick Start Guide, issued November DN: ZSAMI-RM

3 Contents Getting Started with Zend Server AMI (Amazon Machine Image)... 1 Registration, Purchase and Activation... 2 Activating Your Zend Server AMI... 3 Running your Zend Server AMI Instances... 5 Running your Zend Server AMI Instances from the EC2 Console... 5 Accessing Zend Server on your AMI Instance... 7 Logging into the Zend Server AMI Instance... 8 Configuring with Zend Server AMI Command Line Tools Initial Password and License Configuration using zend-server-setup Automatic Configuration Management using Amazon S3 Snapshots Saving a Zend Server Configuration to Amazon S Loading Zend Server Configuration from Amazon S Using EC2 User Data Scripts to Pre-configure New Instances Example 1: Automatically Setting the Zend Server Administration Interface Password and License Key at Machine Boot Time Example 2: Automatically Installing Additional Extensions and Loading a Configuration Snapshot at Machine Boot Time Re-bundling your Zend Server AMI Additional Information: Glossary... 21

4 Getting Started with Zend Server AMI (Amazon Machine Image) Welcome to the Zend Server AMI getting started guide. In this guide you will find information on how to setup and purchase your Zend Sever AMI and instructions for using the Zend Server AMI to quickly develop and deploy PHP applications in a cloud environment. What would you like to do? Register Purchase and Activate Run your Zend Server AMI Instances Access Zend Server on your AMI Instance Configure Zend Server AMI from the Command Line Re-bundle your Zend Server AMI Terminate an Instance 1

5 Registration, Purchase and Activation The activation process requires that you go through three steps: 1. Order Subscription (Amazon) 2. Activate Zend Server AMI (zend.com) 3. Purchase Zend Server AMI Subscription (Amazon) To start working with the Zend Server AMI you will need to open or have details available for the following accounts: Amazon Web Services account ( All the information you will need in order to create an Amazon EC2 account and understand the how to work with the Amazon EC2 web service can be found in Amazon s Getting Started Guide. zend.com account ( 2

6 Activating Your Zend Server AMI The following procedure describes how to perform each step in order to complete the Zend Server AMI activation process. To activate a Zend Server AMI: 1) In zend.com open the product page and click on the Order link 2) Clicking on the Order link will direct you to the Zend Server AMI purchase process on Amazon you should be directed to the following page: 3) Sign-in with your Amazon account or create a new account to start the purchasing process. 4) Payment includes the AMI and a set fee for usage as stated in the price list Additional information can be found in 3

7 5) Clicking the Place your order button leads to the order completion page click the link above the Zend Logo to accept the terms of usage and continue. 6) Clicking on the link will lead you to Zend s Account Login area to where you need to login and complete the activation process. 7) An invoice will be sent to you including a License for Zend Server. Registration only needs to be done once, the license you get is intended used for all subsequent Zend Server AMI usage. 8) You can now run your AMI that will come ready made with Zend Server on it Once you have registered to run the AMI you can launce your Zend Server AMI instances using standard Amazon EC2 tools such as the AWS Console, Amazon command line tools etc. 4

8 Running your Zend Server AMI Instances You can launch your Zend Server AMI from the Amazon EC2 Console or by using the Zend Server AMI Command Line Tools. The run process includes: Choosing the right AMI Running the Zend Server AMI Instance Accessing the Zend Server Administration Interface (GUI) o ZS GUI (License) o SSH (Windows /Linux) Running your Zend Server AMI Instances from the EC2 Console To run a Zend Server AMI instance from the EC2 console: 1) Go to and sign in to the Amazon EC2 Console using your Amazon account details. 2) In the Amazon EC2 Console Dashboard click Launch Instance this will raise an AMI instance for you. 3) Go to the Community AMI s tab and use the search option to search for Zend AMI s. 4) Choose the AMI that reflects the OS and PHP version you want to use (remember to select the Availability Zone relevant to you). 5) Clicking select will start the instance configuration wizard follow the steps in the wizard (see screen below) 5

9 Reference: tomerpurchaseexperience.html 6

10 Accessing Zend Server on your AMI Instance The following procedure instructs you on how to connect to the Zend Server Administration Interface in order to manage and configure your Zend Server AMI. Additional information on the Zend Server Administration interface can be found in the Zend Server online documentation at: Prerequisite: Before accessing the Administration Interface you have to make sure your AWS Security Group allows you to create a TCP connection with the AMI. To do so, create a security group allowing access on TCP ports (for HTTP access) and/or (for HTTPs access). To access the Zend Server AMI Instance s Administration Interface: 1) Take your Instance s public DNS information from the Instances page by clicking on the required instance 2) Open a browser and create a URL with the DNS number as follows: with DNS>:10081/ 3) To create a secure connection use: with DNS>:10082/ 4) Clicking both links will lead you to the Zend Server login page. First time users will be prompted with a registration wizard to define password and enter license. Note: Passwords and licenses can be automatically configured at launch time using a script, see Initial Configuration using zend-server-setup. Once you have accessed the Zend Server Administration Interface you can configure the Zend Server AMI or upload your PHP application files. 7

11 Logging into the Zend Server AMI Instance Logging into the Zend Server AMI instance is the process of establishing a connection with the virtual instance in order to perform actions such as CLI commands and checking log files. The machine that you use to connect with the instance does not have to be of the same operating system. For a list of command line options see the Zend Server Installation Guide. The following procedure describes how to login to your Zend Server AMI instance on a Linux machine. Connecting to the Zend Server AMI instance requires that you use some sort of SSH client installed on your machine. To login to the Zend Server AMI Instance Linux: Run the following command using the keypair that you used/crated the first time you ran the instance from the EC2management console. $ ssh -i <id_file_name> root@<ec2_hostname> <id_file_name> - the name of the keypair file you want to generate. <ec2_hostname> - the name of the virtual instance. The following procedure describes how to login to your Zend Server AMI instance on a Windows machine. Connecting to the Zend Server AMI instance requires that you use some sort of SSH client installed on your machine. The following instructions use PuTTY and therefore require that you also convert your Keypair in to a format supported by PuTTY To convert your keypair into a PuTTY supported format: 1) Download and install PuTTYgen from: 2) In PuTTYgen go to Conversions Import. 3) After the import, the keypair information will be displayed in the dialog. Click Save Private Key to generate a new file. You have now converted the *.pem keypair file that you had into a *.ppk file that is supported by PuTTY Further Information: 19/putty.html 8

12 To login to the Zend Server AMI Instance Windows: 1) Open PuTTY and enter the following information: a. In the Category Tree go to Connection SSH Auth, and click Browse to locate the private key file. b. In Session Logging and in HPst Name or IP address enter the instances address. 2) Click open to run the instance. 3) A command line screen will open. Enter root when prompted to login. Upon successful login the following screen will be displayed. 9

13 Configuring with Zend Server AMI Command Line Tools The Zend Server AMI includes several command line tools that can automate setting up and configuring Zend Server through non-interactive scripts. For example, these tools can be used to automatically launch multiple Zend Server instances with the same customized configuration. You can automate the following: 1. Password and License input 2. Configuration import/export 3. Using boot scripts Initial Password and License Configuration using zend-server-setup The zend-server-setup tool included with the Zend Server AMI allows you to script the initial setup of Zend Server, and saves the need to go through the initial configuration wizard normally presented at first access to the Zend Server Administration Interface. This includes setting up the Zend Server Administration Interface password and the Zend Server License Key and accepting the Zend Server End User License Agreement. To run Zend Servers initial setup using scripts: Run the following commands as root. 1. To get helpful usage information for zend-server-setup, run: # /usr/local/zend/bin/zend-server-setup --help 2. To set the Zend Server Administration Interface password, run: # /usr/local/zend/bin/zend-server-setup --password <password> 3. To set the Zend Server License Key, run: # /usr/ local/zend/bin/zend-server-setup -o <order number> \ --key <license key> 4. To accept the Zend Server End User License Agreement, view the EULA first at /usr/local/zend/docs/eula.txt, and then run: # /usr/local/zend/bin/zend-server-setup --accept-eula You will now de able to login to the Zend Server AMI s Administration Interface using the password specified in step 2. 10

14 The following command can be used to combine all three steps into a single command: # /usr/local/zend/bin/zend-server-setup p <password> -o <order> \ -k <key> -a Note: Complete all three steps in order to skip the initial setup wizard. Automatic Configuration Management using Amazon S3 Snapshots To support fast automatic launching of identically configured Zend Server EC2 instances, the Zend Server AMI includes two additional command line tools that enable saving the current configuration of Zend Server to a snapshot stored in Amazon S3, and loading saved snapshots from S3. In order to use this functionality, you must be registered to the Amazon S3 service, and have your Amazon Web Services Access Key ID and Secret Key ready. To save a configuration snapshot, use: # /usr/local/zend/bin/zend-server-s3-config-save To load a configuration snapshot, use: # /usr/local/zend/bin/zend-server-s3-config-load Both tools can be run with the --help flag for detailed usage information. 11

15 Saving a Zend Server Configuration to Amazon S3 Once you have configured Zend Server to suite your needs (this includes PHP settings and Zend Server Components settings), you can use zend-server-s3-config-save to save a snapshot of the configuration, to be restored in the future or used by other instances of the same AMI. To save a configuration snapshot, run as root: # /usr/local/zend/bin/zend-server-s3-config-save -b <S3 bucket> \ -p <profile name> -a <AWS access key> -s <AWS secret key> The parameters are as follows: <S3 bucket> should be an existing S3 bucket owned by you. If you wish to create a new bucket, add the -c flag to the command this will ensure creation of the S3 bucket if it does not exist. Note that bucket names are globally unique, so you cannot create a bucket with a name that is already used by a different AWS user. <profile name> is the name of the configuration profile this should describe the configuration profile and will be used for your own future reference. For example, a good profile name would be myapp-production-php to designate that the configuration profile is for a PHP 5.3 production server running myapp, and the date in which the snapshot was created. Profile names should be composed of alphanumeric characters, dots, dashes and underscores. Profile names should be unique within your S3 bucket. Saving a new snapshot in the same bucket will overwrite any existing snapshots with the same profile name. <AWS access key> is your Amazon Web Services Access Key ID. This is a roughly 20 character long string. <AWS secret key> is your Amazon Web Services Secret Key. This is a roughly 40 character long string. You may omit the -a (access key) and -s (secret key) flags if you instead export the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables. For example: # export AWS_ACCESS_KEY_ID=ABCDEFGHIJABCDEFGHIJ # export AWS_SECRET_ACCESS_KEY=abcdefghijABCD abcdefghij # /usr/local/zend/bin/zend-server-s3-config-save -b <S3 bucket> \ -p <profile name> 12

16 Upon success, the command will not produce any output, and should return zero (run echo $? immediately after running zend-server-s3-config-save to verify). Upon failure, a non-zero return code should be returned, along with an error message. Loading Zend Server Configuration from Amazon S3 After saving your Zend Server configuration to S3, you may now load this configuration snapshot automatically on additional instances of the same AMI or a similar AMI using the zend-server-s3- config-load command. Note: Do not load configuration snapshots taken on Zend Server AMIs of a different Linux distribution, CPU architecture and Zend Server version. To load an existing configuration snapshot, run as root: # /usr/local/zend/bin/zend-server-s3-config-load -b <S3 bucket> \ -p <profile name> -a <AWS access key> -s <AWS secret key> <S3 bucket> should be an existing S3 bucket owned by you, into which you saved the configuration snapshot you are loading. <profile name> is the name of the configuration profile you wish to load. <AWS access key> is your Amazon Web Services Access Key ID. This is a roughly 20 character long string. <AWS secret key> is your Amazon Web Services Secret Key. This is a roughly 40 character long string. You may omit the -a (access key) and -s (secret key) flags if you instead export the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables. For example: # export AWS_ACCESS_KEY_ID=ABCDEFGHIJABCDEFGHIJ # export AWS_SECRET_ACCESS_KEY=abcdefghijABCD abcdefghij # /usr/local/zend/bin/zend-server-s3-config-load -b <S3 bucket> \ -p <profile name> 13

17 The zend-server-s3-config-load command will verify that the loaded snapshot was taken on a similar machine. If it fails to verify that, it will not proceed with loading the configuration unless you specify the -f (or --force') flag. Upon success, the command will not produce any output, and should return zero (run echo $? immediately after running zend-server-s3-config-save to verify). Upon failure, a non-zero return code should be returned, along with an error message. After successfully loading the configuration snapshot, be sure to restart Zend Server to apply the new configuration. This can be done by running, as root: # /usr/local/zend/bin/zendctl.sh restart 14

18 Using EC2 User Data Scripts to Pre-configure New Instances You may automate the usage of the commands described above, as well as additional tuning and configuration tasks, by creating a shell script to call these commands and sending the contents of this script as the User Data parameter when launching a new instance. This is particularly useful when you need to launch additional pre-configured instances of the Zend Server AMI in an automatic manner. Any text starting with the #! symbols ( shebang ) passed as the User Data parameter when launching a Zend Server AMI instance will be treated as a script and executed at machine boot time. Example 1: Automatically Setting the Zend Server Administration Interface Password and License Key at Machine Boot Time The following example demonstrates how to automate the usage of zend-serversetup using a simple User Data script. Create a User Data boot script as follows: 1) Create the following script and save it as zend-server-user-data.sh. There is no need to make this script executable: #!/bin/sh # Replace the following with your GUI password, # order number and license key ZEND_SERVER_PASSWD=mypassword ORDER_NUMBER=ORDER-1234 LICENSE_KEY=ABCDEFGHIJKLMNOPQRSTUVWXYZ if [ -f /etc/zce.rc ]; then else fi. /etc/zce.rc echo "Error: /etc/zce.rc doesn't exist" >&2 exit 2 $ZCE_PREFIX/bin/zend-server-setup -a \ -p $ZEND_SERVER_PASSWD \ -o $ORDER_NUMBER -k $LICENSE_KEY 15

19 2) Launch new AMI instance using the script you have just created as User Data. Performing this differs depending on the method used to launch new instances. The following example shows how to add a User Data script when launching an instance using the Amazon EC2 Command Line tools: $ ec2-run-instances <AMI ID> -k <key> -g <group> \ -f <path to user data script> When launching a new instance using the AWS Web Console, you should copy and paste the script s content into the User Data field in the Launch Instance wizard. 16

20 Example 2: Automatically Installing Additional Extensions and Loading a Configuration Snapshot at Machine Boot Time The following example demonstrates how to automate the configuration of a Zend Server AMI instance to suite a specific need, by installing additional PHP extensions and loading a saved configuration profile from Amazon S3 at boot time. Please note that most PHP extensions are already installed on all Zend Server AMIs. Installing additional extensions is only required if your application requires an extension which is not a part of the Zend Server Common Extensions package. Create a User Data boot script as follows: 1) Create the following script and save it as zend-server-user-data.sh. There is no need to make this script executable: #!/bin/sh # Replace the following with your S3 bucket, # profile name and AWS credentials S3_BUCKET=my-config-profiles CONFIG_PROFILE=myapp-prod-php AWS_ACCESS_KEY_ID=MYAWSACCESSKEYID AWS_SECRET_ACCESS_KEY=abcdefghijABCD01234abcdefghij if [ -f /etc/zce.rc ]; then else fi. /etc/zce.rc echo "Error: /etc/zce.rc doesn't exist" >&2 exit 2 # Install some required additional extensions PACKAGES="php-5.3-imagick-zend-server php-5.3-loader-zendserver" if [ -n "`which aptitude`" ]; then else aptitude update aptitude install -y $PACKAGES 17

21 yum clean all yum install -y $PACKAGES fi # Load the saved configuration profile export AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY $ZCE_PREFIX/bin/zend-server-s3-config-load \ -b $S3_BUCKET -p $CONFIG_PROFILE 2) Launch new AMI instance using the script you have just created as User Data. Performing this differs depending on the method used to launch new instances. The following example shows how to add a User Data script when launching an instance using the Amazon EC2 Command Line tools: $ ec2-run-instances <AMI ID> -k <key> -g <group> \ -f <path to user data script> When launching a new instance using the AWS Web Console, you should copy and paste the script s content into the User Data field in the Launch Instance wizard. 18

22 Re-bundling your Zend Server AMI In order to be able to deploy a preconfigured version of the Zend Server AMI customized to your requirements, you can customize Zend Server AMI and re-bundle it. Re-bundling is done using standard Amazon tools. Please refer to the official Amazon documentation for instructions at: 08/GettingStartedGuide/index.html?creating-an-image.html Note: you will need to upload your Amazon X.500 certificate to the instance and use the ec2- bundle-vol command to bundle the instance. You would then upload the bundle into Amazon S3 using the ec2-upload-bundle command and the Amazon S3 access keys. You should review the Amazon guide to bundling an AMI to ensure that your AMI is secured. 19

23 Additional Information: Zend s website The Zend Server product page on zend.com Zend Product Forums Zend Server Documentation (HTML and PDF Amazon EC2 Documentation Putty Documentation Amazon Web Services EC2 Web page rguide/index.html?using.html ml 20

24 Glossary S3 Amazon Simple Storage Service S3 Bucket EBS Amazon Elastic Block Storage AMI Instance Amazon EC2 - Amazon Elastic Compute Cloud (Amazon EC2) Zend Server Zend Server AMI Amazon account Zend.com account Zend Server License AWS Public DNS AWS Private DNS Amazon EC2 Console AWS Console Amazon s cloud storage service A virtual container for files ( Objects ) in Amazon S3, owned by a specific user A virtual disk ( Volume ) based persistent storage service for Amazon EC2 machine instances Amazon Machine Image, a virtual machine image for the Amazon EC2 Cloud Computing environment. A single running Amazon EC2 virtual machine, started from a specific AMI. Amazon EC2 allows running multiple instances of the same AMI at the same time. A web service that provides resizable compute capacity in the cloud. Zend Server is a complete, enterprise-ready Web Application Server for running and managing PHP applications that require a high level of reliability, performance and security. A ready to use virtual machine image that includes the latest version of Zend Server running on Linux. Your Amazon account is your main mode of access for managing Zend Server AMI instances and payments per usage. If you do not already have an Amazon account you can register at: This account provides you with the License key necessary for running each Zend Server AMI instance. In addition your account is the main point of interaction for managing subscriptions, opening support cases and posting to forums. If you do not already have a zend.com account you can register at: Used to activate Zend Server. The license is created once the activation process is completed in your zend.com account. The license is also sent in an to the address specified in your zend.com account. The public DNS host name of a specific Amazon EC2 instance. This host name can be used to access the instance from outside your internal EC2 LAN The private (internal) DNS host name of a specific Amazon EC2 instance. This host name can only be used to access the instance from other EC2 instances owned by you in the same EC2 Region. The Amazon management console is a web-based user interface for managing Amazon s infrastructure web services. The AWS Management Console allows you to manage your compute, storage, and other cloud resources see Amazon EC2 Console 21

25 EC2 Region Availability Zone Key pair Amazon EC2 services are available on different geographical regions, such as East-coast USA or Western Europe. Resources, such as EBS volumes, AMIs, instances, Load Balancers, key pairs etc. cannot be shared or moved between EC2 regions. It is recommended to run your application in the EC2 region closest to your target audience. Note that Zend Server AMIs are available in all EC2 regions, however the AMI ID for the same image is different from region to region. Each Amazon EC2 Region is divided into two or more availability zones, and each EC2 instance can be started in a specific zone. Availability Zones may represent different data centers or physical locations, and when running large clusters, it is recommended to spread machines across different availability zones in order to ensure maximal reliability. Some resources, such as EBS Volumes, cannot be used across availability zones. Public/private key pairs allow you to securely connect to your instance after it launches. 22