Difference between revisions of "Opentaps Amazon EC2 Images"

From Opentaps Wiki
Jump to navigationJump to search
Line 1: Line 1:
 
__TOC__
 
__TOC__
  
Beginning with opentaps-1.4-preview2, you can use [http://aws.amazon.com/ec2/ Amazon EC2] images to install opentaps on an Amazon Elastic Computing Cloud virtual server.  You can find Amazon Machine Images (AMI) for opentaps which allow you to set up a virtual server with opentaps pre-installed with demo data.
+
opentaps [http://www.amazon.com/ec2 Amazon Elastic Computing Cloud (EC2)] images allow you to get up and running with opentaps in minutes using pre-stored Amazon Machine Images (AMI's).  You can use these AMI's for demo or production purposes, and you can pay for them by the hour.
  
You can watch our [http://www.youtube.com/watch?v=RkXpBTKVA4I YouTube video about opentaps on Amazon EC2] or follow the instructions below.
+
To learn more about how these AMI's work, see [http://www.opentaps.org/Cloud opentaps In The Cloud].  These instructions are included in [http://www.youtube.com/watch?v=CzvSAQXcwVY the following video for how to set up opentaps in the Amazon EC2 Cloud]:
  
==Recent Changes==
+
'''IMPORTANT''': Do not use the AMI's for sensitive data such as financial information or customer records unless you have secured the instance following the steps from the [http://shop.opentaps.org/index.php/opentaps-professional-configuration-service.html
 +
opentaps Professional Configuration Service].
  
Beginning with opentaps 1.4.1,
+
==Starting the AMI==
* opentaps will be automatically moved from <tt>/opt/opentaps</tt> to <tt>/mnt/opentaps</tt> when the server is initially set up.  This takes approximately 5 minutes.  All references to <tt>/opt/opentaps</tt> below should be changed to <tt>/mnt/opentaps</tt>
 
  
==Finding opentaps Amazon EC2 Images==
+
To start using an opentaps Amazon EC2 image, you must first enable your Amazon account to use the [http://www.amazon.com/ec2 Amazon EC2] service.
  
To use an opentaps AMI, login to the Amazon AWS Management Console.  
+
Then, go to [http://www.opentaps.org/Cloud opentaps In The Cloud] and follow the links to subscribe to either the [https://aws-portal.amazon.com/gp/aws/user/subscription/index.html?ie=UTF8&offeringCode=8258DE39 opentaps Mini] or [https://aws-portal.amazon.com/gp/aws/user/subscription/index.html?ie=UTF8&offeringCode=B0CA38BF opentaps Full] '''You must subscribe to the opentaps AMI's here first before you can launch them.'''
  
First, make sure that you are set to the "US East" region:
+
Next, login to the [https://console.aws.amazon.com/ec2/home Amazon EC2 Management Console].  If you have not already done so, you need to create a security group which opens ports 22 (SSH), 80 (http), and 443 (https).  Then you can launch your opentaps AMI by searching for '''opentaps''' under "Community AMI's" and launching it. 
  
[[Image:Amazon_ec2_region_us_east.png]]
+
'''IMPORTANT''': If you did not subscribe to the opentaps AMI's first, then your AMI's could not be launched successfully, and you will receive an error message '''Subscription to ProductCode EE259203 required.''': 
  
Then, from the "Instances" screen, click on "Launch Instances", and then click on "Community AMIs"  and search for "opentaps".  You should see a list of opentaps machine images available, listing the version of opentaps and the preinstalled database, like this:
 
 
[[Image:Opentaps-amis.png]]
 
 
 
Simply choose the image with the opentaps version and database that you would like to use, click on [Select] next to it, and then Amazon will take you to the next screen to finish setting up your server.
 
 
If this is your first time using Amazon EC2, you should create a security group to open up ports 22 (SSH), 80 (http), 443 (https), 8080, and 8443 for opentaps.
 
 
If you encounter the following error and cannot launch your instance, it is because this particular instance requires a special subscription.
 
 
[[Image:EC2_Subscription_Required.png]]
 
[[Image:EC2_Subscription_Required.png]]
  
Please see [http://www.opentaps.org/Cloud Opentaps In The Cloud] for opentaps instances which require special subscriptions.
+
You must go back to [http://www.opentaps.org/Cloud opentaps In The Cloud] and subscribe to either the [https://aws-portal.amazon.com/gp/aws/user/subscription/index.html?ie=UTF8&offeringCode=8258DE39 opentaps Mini] or [https://aws-portal.amazon.com/gp/aws/user/subscription/index.html?ie=UTF8&offeringCode=B0CA38BF opentaps Full] AMI first and try again.
  
==Accessing your New opentaps Instance==
+
==Using the AMI==
  
Once Amazon has set up your new opentaps instance, you can use the DNS to access it. For example, if your instance's public DNS is ec2-123-456-78-90.compute-1.amazonaws.com, that you can access opentaps from your browser at
+
Once you have successfully launched your AMI, wait until your  [https://console.aws.amazon.com/ec2/home Amazon EC2 Management Console] shows a green button next to your instance.  This means that the instance is up and running. The instance should also show a public DNS address which begins with `ec2-`, such as `ec2-123-456-78-90.compute-1.amazonaws.com`  You will be using this address to access the instance.
  
http://ec2-123-456-78-90.compute-1.amazonaws.com:8080/opentaps
+
When the instance first starts up, opentaps will be automatically moving itself from <tt>/opt/opentaps</tt> to <tt>/mnt/opentaps</tt>. This takes approximately 5 minutes.
  
and you will be able to access your instance of opentaps, preloaded with the demo data.
+
When it is done, you can access opentaps from your browser with its public DNS address, like this:
  
If you are using one of the pre-configured AMI's from [http://www.opentaps.org/cloud opentaps In The Cloud], you can access it directly on port 80:
+
http://ec2-123-456-78-90.compute-1.amazonaws.com/opentaps
  
http://ec2-123-456-78-90.compute-1.amazonaws.com/opentaps
+
The initial username and password are '''admin'''/'''opentaps'''
  
These instances are preloaded with the [[How to Setup opentaps from Default Template | Default Template]], so you can start configuring your company and loading your data.
+
opentaps 1.4.2 and opentaps 1.5M1 are both preloaded with [[How to Setup opentaps from Default Template|Base Template]] data which you can customize to set up your company.
 
 
'''NOTE''': Starting with opentaps 1.4.1, you must wait about 5 minutes while the Amazon server moves opentaps from <tt>/opt/opentaps/</tt> to <tt>/mnt/opentaps/</tt>
 
  
 
==Managing your opentaps Instance==
 
==Managing your opentaps Instance==
Line 54: Line 42:
 
  $ ssh ec2/mysecurekey.pem root@ec2-123-456-78-90.compute-1.amazonaws.com
 
  $ ssh ec2/mysecurekey.pem root@ec2-123-456-78-90.compute-1.amazonaws.com
  
By convention, opentaps will be installed in the /opt/opentaps directory, so you can go to your version as the root user:
+
By convention, opentaps will be installed in the `/mnt/opentaps` directory, so you can go to your version as the root user:
  
  $ cd /opt/opentaps/opentaps-1.4-preview-2
+
  $ cd /mnt/opentaps/opentaps
  
 
and modify the configuration files.
 
and modify the configuration files.
 
For example, if you want opentaps to run on port 80 and 443, edit the files <tt>framework/base/config/ofbiz-containers.xml</tt> and <tt>framework/webapp/config/url.properties</tt> and change the ports 8080 and 8443 to 80 and 443.
 
  
 
To start, stop, or restart opentaps, you can use the /etc/init.d/opentaps script:
 
To start, stop, or restart opentaps, you can use the /etc/init.d/opentaps script:
Line 67: Line 53:
 
  $ /etc/init.d/opentaps start
 
  $ /etc/init.d/opentaps start
  
Now you should be able to access opentaps at http://ec2-123-456-78-90.compute-1.amazonaws.com/opentaps
+
==Switching from Production to Demo==
 +
 
 +
Starting with opentaps 1.4.2 (but not 1.5M1), the same instance can be used for both demo or production purposes.  By default, opentaps 1.4.2 AMI is configured to use the [[How to Setup opentaps from Default Template|Base Template]] database, but you can switch to the demo database with
 +
 +
$ /etc/init.d/opentaps switch-demo
 +
 
 +
To switch back to the [[How to Setup opentaps from Default Template|Base Template]] database, which is recommended for configuring your production instance:
 +
 
 +
$ /etc/init.d/opentaps switch-prod
 +
 
 +
==Setting up opentaps Update Service==
 +
 
 +
''These instructions apply to opentaps 1.4.2 and later AMI's''
 +
 
 +
Your opentaps AMI comes with a free subscription to the [http://www.opentaps.org/opentaps-update-service opentaps Update Service].  To register yourself, [http://www.opentaps.org/Contact contact opentaps] with your Amazon instance ID (see below):
 +
 
 +
Once we have verified your instance, you will receive a username and password for the service. Edit the file `/etc/init.d/opentaps` and put it in the fields for
 +
 
 +
$ SVN_USERNAME=
 +
$ SVN_PASSWORD=
 +
 
 +
Then, you can update opentaps with
 +
 
 +
$ /etc/init.d/opentaps update
  
==Deploying opentaps For Production in Amazon EC2==
+
==Completing your Setup==
  
For production deployments, you can use the [https://aws-portal.amazon.com/gp/aws/user/subscription/index.html?ie=UTF8&offeringCode=B0CA38BF Pre-configured opentaps AMI] with opentaps and MySQL configured for production environmentsSee [http://www.opentaps.org/Cloud opentaps In The Cloud] for more details.
+
'''IMPORTANT''' Before using your AMI for sensitive data, you need to secure it with an SSL certificateThe [http://shop.opentaps.org/index.php/opentaps-professional-configuration-service.html opentaps Professional Configuration Service] can help you secure your production instance and configure email, DNS, and performance monitoring.

Revision as of 19:26, 14 December 2010

opentaps Amazon Elastic Computing Cloud (EC2) images allow you to get up and running with opentaps in minutes using pre-stored Amazon Machine Images (AMI's). You can use these AMI's for demo or production purposes, and you can pay for them by the hour.

To learn more about how these AMI's work, see opentaps In The Cloud. These instructions are included in the following video for how to set up opentaps in the Amazon EC2 Cloud:

IMPORTANT: Do not use the AMI's for sensitive data such as financial information or customer records unless you have secured the instance following the steps from the [http://shop.opentaps.org/index.php/opentaps-professional-configuration-service.html opentaps Professional Configuration Service].

Starting the AMI

To start using an opentaps Amazon EC2 image, you must first enable your Amazon account to use the Amazon EC2 service.

Then, go to opentaps In The Cloud and follow the links to subscribe to either the opentaps Mini or opentaps Full You must subscribe to the opentaps AMI's here first before you can launch them.

Next, login to the Amazon EC2 Management Console. If you have not already done so, you need to create a security group which opens ports 22 (SSH), 80 (http), and 443 (https). Then you can launch your opentaps AMI by searching for opentaps under "Community AMI's" and launching it.

IMPORTANT: If you did not subscribe to the opentaps AMI's first, then your AMI's could not be launched successfully, and you will receive an error message Subscription to ProductCode EE259203 required.:

EC2 Subscription Required.png

You must go back to opentaps In The Cloud and subscribe to either the opentaps Mini or opentaps Full AMI first and try again.

Using the AMI

Once you have successfully launched your AMI, wait until your Amazon EC2 Management Console shows a green button next to your instance. This means that the instance is up and running. The instance should also show a public DNS address which begins with `ec2-`, such as `ec2-123-456-78-90.compute-1.amazonaws.com` You will be using this address to access the instance.

When the instance first starts up, opentaps will be automatically moving itself from /opt/opentaps to /mnt/opentaps. This takes approximately 5 minutes.

When it is done, you can access opentaps from your browser with its public DNS address, like this:

http://ec2-123-456-78-90.compute-1.amazonaws.com/opentaps

The initial username and password are admin/opentaps

opentaps 1.4.2 and opentaps 1.5M1 are both preloaded with Base Template data which you can customize to set up your company.

Managing your opentaps Instance

To manage your opentaps instance, use your Amazon .pem key and login as root:

$ ssh ec2/mysecurekey.pem root@ec2-123-456-78-90.compute-1.amazonaws.com

By convention, opentaps will be installed in the `/mnt/opentaps` directory, so you can go to your version as the root user:

$ cd /mnt/opentaps/opentaps

and modify the configuration files.

To start, stop, or restart opentaps, you can use the /etc/init.d/opentaps script:

$ /etc/init.d/opentaps stop
$ /etc/init.d/opentaps start

Switching from Production to Demo

Starting with opentaps 1.4.2 (but not 1.5M1), the same instance can be used for both demo or production purposes. By default, opentaps 1.4.2 AMI is configured to use the Base Template database, but you can switch to the demo database with

$ /etc/init.d/opentaps switch-demo

To switch back to the Base Template database, which is recommended for configuring your production instance:

$ /etc/init.d/opentaps switch-prod

Setting up opentaps Update Service

These instructions apply to opentaps 1.4.2 and later AMI's

Your opentaps AMI comes with a free subscription to the opentaps Update Service. To register yourself, contact opentaps with your Amazon instance ID (see below):

Once we have verified your instance, you will receive a username and password for the service. Edit the file `/etc/init.d/opentaps` and put it in the fields for

$ SVN_USERNAME=
$ SVN_PASSWORD=

Then, you can update opentaps with

$ /etc/init.d/opentaps update

Completing your Setup

IMPORTANT Before using your AMI for sensitive data, you need to secure it with an SSL certificate. The opentaps Professional Configuration Service can help you secure your production instance and configure email, DNS, and performance monitoring.