This section describes the processes for from your EC2 console.
Before taking the steps described in this section, open the Launching Jaspersoft for AWS page, on the Jaspersoft Community website:
http://community.jaspersoft.com/jaspersoft-aws/launch
This web page includes information you'll need for creating and launching your instance.
Select the option that applies to your set-up:
The above methods use Jaspersoft's CloudFormation templates to generate an instance and its permissions and roles automatically, which gives you a secure and easy-to-maintain instance of the Jaspersoft BI.
We don't recommend this method, because it doesn't provide the auto-connect feature for Amazon RDS and Redshift included with the CloudFormation templates. If you choose this method, and you're using a VPC, be sure to define that option during the setup process.
| Your Jaspersoft software is charged separately from the AWS EC2 instance charges. Please make sure you follow these instructions to turn off your EC2 instance server running Jaspersoft after use. If not, you will continue to be charged by the hour for EC2 use. Note that when you stop your EC2 instance server no one will have access to the reports or dashboards you've created until you restart the EC2 instance server. When you stop an EC2 instance server, you will still be charged the small EBS charge. If you don't want to be charged for EBS, make sure you terminate your EC2 instance server. Note that in this case none of your work will be retrievable, unless you are you're using a high availability instance.. |
Creating a JasperReports Server Instance from a Jaspersoft CloudFormation Template
A stack is a collection of AWS resources you create and delete as a single unit. Our CloudFormation template creates the following resources and bundles them into a usable stack:
| • | IAM role with permissions on RDS and Redshift |
| • | EC2 instance with JasperReports Server installed, configured, and using the IAM role for appropriate credentials. |
To create a new JasperReports Server instance:
| 2. | Click the Launch Jaspersoft for AWS tab. |
| 3. | Click the URL for your region. The Select Template page appears. |
Select Template page |
|
| 4. | In the Stack section, give your CloudFormation stack a unique name. |
By default, AWS provides a stack template source URL. Do not change this.
| 5. | Click Next. The Specify Parameters page appears. |
Specify Parameters page |
|
| 6. | Select an Instance Type from the drop down. The supported instance types are: |
| • | Standard Large (m1.large) |
| • | Standard XL (m1.xlarge) |
| • | High-Memory XL (m2.xlarge) |
| • | High-Memory 2XL (m2.2xlarge) |
| • | High-Memory 4XL (m2.4xlarge) |
| • | High-CPU XL (c1.xlarge) |
Performance may vary based on system attributes, such as network bandwidth, memory requirements for a given use case, query requirements, and the like.
| For AWS with Multi-Tenancy Hourly, the m3.medium is the only available instance. It's recommended only for basic evaluation and development. |
For more information about EC2 instance types, see the AWS documentation:
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html
| 7. | In the KeyName field, enter an existing key pair name. |
| 8. | Click Next. The Options page appears. |
| 9. | Add any tags you want to simplify administration of your infrastructure. |
A tag consists of a key/value pair and will flow to resources inside your stack. You can add up to 10 unique tags for each instance.
| 10. | Expand the Advanced section of the Options page and set your notification, timeout, and other options. Click the Learn more link for an explanation of these options. |
| 11. | Click Next. The Review page appears. |
Double-check your template, parameter, and option information.
| 12. | Click the acknowledgment check box, then click Create. |
You'll see your Stack Name listed in a table. While it's being created the Status column will display CREATE_IN_PROGRES. After a few minutes the status should change to CREATE_COMPLETE.
If the status changes to ROLLBACK instead of CREATE_COMPLETE, you may need to accept the Terms of Use. Check the Events tab for more information.
| It may be another few minutes before the JasperReports Server URL becomes available. If you get a message saying “Unable to Connect”, try again in a few minutes. |
| 13. | Select your complete instance and click the Outputs tab. Here you'll find information you'll need when you're ready to log into JasperReports Server: |
| • | The URL for Getting Started with JasperReports Server (Key: GettingStartedURL) |
| • | The generated password (Key: Password). |
Creating a JasperReports Server Instance with High Availability
Jaspersoft provides a high availability option using Amazon Relational Database Service (RDS). With high availability, your JasperReports Server instance provides a failover mechanism by storing your repository in an external database, so if something happens to your instance it will be replaced and connected to your existing repository. Our high availability options support the Amazon Elastic Load Balancer (ELB) and currently support PostgresSQL databases only. The following options are available:
| • | Automatic High Availability—This option doesn't support VPC, but the CloudFormation Template automatically creates an EC2 instance with Jaspersoft, Postgres RDS database, then automatically deploys your initial data. |
| • | Manual High Availability - non VPC—Automatically provides a failover mechanism, but you'll need to manually create and initialize your Postgres RDS or other Postgres database. |
| • | Manual High Availability - with VPC—Automatically provides a failover mechanism, but you'll need to manually create and initialize your Postgres RDS or other Postgres database.
|
Automatic High Availability
To create a high availability instance to deploy automatically:
| 2. | Click the Launch Jaspersoft for AWS tab. |
| 3. | Click the URL for your region. The Select Template page appears. |
Select Template page |
|
| 4. | In the Stack section, give your CloudFormation stack a unique name. |
By default, AWS provides a stack template source URL. Do not change this.
| 5. | Click Next. The Specify Parameters page appears. |
Specify Parameters page |
|
| 6. | Choose your AvailabilityZone. |
| 7. | EnableELB defaults to "true" to enable the Amazon Elastic Load Balancer for static endpoint (DNS Name - URL) and monitoring of JasperReports Server. If something happens to your high availability instance--the instance fails or JRS stops responding--the instance will be replaced with new one. |
If ELB is disabled, the new instance will have a different DNS Name. You'll need to get the DNS name of the new instance from the EC2 Console--Autoscaling Group, then enter the DNS Name in JRS.
| 8. | Choose your instance Type, and Key Name from the drop downs. |
| 9. | Enter a valid email address in the OperatorEMail field. |
| 10. | Choose your database size from the RDSDbSize drop down |
| 11. | Enter the password for your RDS database in the RDSPassword field |
Save this password. You'll use it again when you first log into your instance.
| 12. | Enter the user name for your RDS database in the RDSUser field. |
| 13. | Click Next. The Options page appears. |
| 14. | Add any tags you want to simplify administration of your infrastructure. |
A tag consists of a key/value pair and will flow to resources inside your stack. You can add up to 10 unique tags for each instance.
| 15. | Expand the Advanced section of the Options page and set your notification, timeout, and other options. Click the Learn more link for an explanation of these options. |
| 16. | Click Next. The Review page appears. |
Double-check your template, parameter, and option information.
| 17. | Click the acknowledgment check box, then click Create. |
You'll see your Stack Name listed in a table. While it's being created the Status column will display CREATE_IN_PROGRES. After a few minutes the status should change to CREATE_COMPLETE.
If the status changes to ROLLBACK instead of CREATE_COMPLETE, you may need to accept the Terms of Use. Check the Events tab for more information.
| It may be another few minutes before the JasperReports Server URL becomes available. If you get a message saying “Unable to Connect”, try again in a few minutes. |
| 18. | Select your complete instance and click the Outputs tab. Here you'll find information you'll need when you're ready to log into JasperReports Server: |
| • | The URL for Getting Started with JasperReports Server (Key: GettingStartedURL) |
| • | The generated password (Key: Password). |
Database Recovery with Automatic High Availability
The automatic high availability setup creates an RDS database for your repository and assigns a termination policy that will create a final snapshot in case of RDS instance termination. You can use this snapshot to recover from an accidental deletion of your stack or RDS instance. The snapshot is stored in your AWS account. In your AWS account go to RDS Dashboard > Snapshots.
Manual High Availability
To create a high availability instance to deploy manually:
| 2. | Click the Launch Jaspersoft for AWS tab. |
| 3. | Click the URL for your region. The Select Template page appears. |
Select Template page |
|
| 4. | In the Stack section, give your CloudFormation stack a unique name. |
By default, AWS provides a stack template source URL. Do not change this.
| 5. | Click Next. The Specify Parameters page appears. |
Specify Parameters page |
|
| 6. | Chose your AvailabilityZone from the drop down. |
| 7. | Enter your database information: DBHost, DBName, DBPasword, DBPort, and DBUser. |
| 9. | Choose an instanceType. |
| 10. | Choose the KeyName of your EC2 KeyPair. |
| 11. | To enable notifications about your instance state, enter a valid email address in the OperatorEMail field. Leave this field blank to disable notification. |
| 12. | Click Next. The Options page appears. |
| 13. | Add any tags you want to simplify administration of your infrastructure. |
A tag consists of a key/value pair and will flow to resources inside your stack. You can add up to 10 unique tags for each instance.
| 14. | Expand the Advanced section of the Options page and set your notification, timeout, and other options. Click the Learn more link for an explanation of these options. |
| 15. | Click Next. The Review page appears. |
Double-check your template, parameter, and option information.
| 16. | Click the acknowledgment check box, then click Create. |
You'll see your Stack Name listed in a table. While it's being created the Status column will display CREATE_IN_PROGRES. After a few minutes the status should change to CREATE_COMPLETE.
If the status changes to ROLLBACK instead of CREATE_COMPLETE, you may need to accept the Terms of Use. Check the Events tab for more information.
| It may be another few minutes before the JasperReports Server URL becomes available. If you get a message saying “Unable to Connect”, try again in a few minutes. |
| 17. | Select your complete instance and click the Outputs tab. Here you'll find information you'll need when you're ready to log into JasperReports Server: |
| • | The URL for Getting Started with JasperReports Server (Key: GettingStartedURL) |
| • | The generated password (Key: Password). |
Manually Deploy Your Instance
Manually create a new Repository database in an external Postgres database and initialize it.
To deploy your high availability instance manually:
| 1. | Log into your instance by ssh using the information on the Outputs tab. |
| 2. | Change the directory to: |
/usr/share/jrs_dist/jasperreports-server-bin
| 3. | Run the initialization script: |
sudo ./deploy-database-to-external-repo.sh minimal
| You may want to skip the initialization script If your external database already contains a valid JasperReports Server repository that you want of use. The script will create (or recreate) a JasperReports Server repository database (for example from a previous dump or RDS snapshot) with a minimal set of resources or with samples. |
| 4. | If initialization is successful, halt the instance: sudo halt -p
|
If initialization is unsuccessful, troubleshoot the database, then run the initialization script (step 3).
| 5. | Go to the EC2 Console and increase the instance count from 0 to 1 in the Autoscaling group (name is provided on the Outputs tab of the CloudFormation template). |
| 6. | Use the Getting Started URL from the Outputs tab to access your high availability instances. |
Creating a JasperReports Server Instance Inside a VPC
You have additional options on the Specify Parameters page if you're creating your instance inside a VPC.
To create a new JasperReports Server instance in a VPC:
| 1. | Open the Launching Jaspersoft for AWS web page and scroll down to "Start an EC2 instance with Jaspersoft BI, either in or outside of VPC". |
| 2. | Click the Launch Jaspersoft for AWS into VPC tab. |
| 3. | Click the URL for your region. Choose a URL specific to the type of AMI you're using. The Select Template page appears. |
Select Template page |
|
| 4. | In the Stack section, give your CloudFormation stack a unique name. |
By default, AWS provides a stack template source URL. Do not change this.
| 5. | Click Next. The Specify Parameters page appears. |
Specify Parameters page for VPC users (non HA) |
|
Parameters are listed in alphabetical order according to standard CloudFormation template behavior. They include:
| • | EnablePublicIp: Create a publicly accessible IP address for the instance. Default is True. Enter False to refuse. Supported instance types are: |
| • | Standard Large (m1.large) |
| • | Standard XL (m1.xlarge) |
| • | High-Memory XL (m2.xlarge) |
| • | High-Memory 2XL (m2.2xlarge) |
| • | High-Memory 4XL (m2.4xlarge) |
| • | High-CPU XL (c1.xlarge) |
| • | KeyName: Enter the name of your EC2 KeyPair to enable security measures. |
| • | SubnetId: Enter the Subnet ID from the VPC. Make sure its IP settings don't conflict with the EnablePublicIp settings, and that this Subnet ID exists in your VPC. |
| • | VpcId: Enter the VPC ID from your account. |
| 6. | Click Next. The Options page appears. |
| 7. | Add any tags you want use to simplify administration of your infrastructure. |
A tag consists of a key/value pair and will flow to resources inside your stack. You can add up to 10 unique keys to each instance, along with an optional value for each key.
| 8. | Expand the Advanced section and set your notification, timeout, and other options. |
| 10. | On the Review page double check your template, parameter, and option information. |
| 11. | Click Create. You'll see a message telling you your stack has been created. The Services web page, shows your stack's initial status as CREATE_IN_PROGRESS. It generally takes two to four minutes for the status to change to CREATE_COMPLETE. |
| 12. | Select your complete instance and click the Outputs tab. Here you'll find information you'll need when you're ready to log into JasperReports Server: |
| • | The URL for Getting Started with JasperReports Server (Key: GettingStartedURL) |
| • | The generated password (Key: Password). |
Creating a High Availability JasperReports Server Instance Inside a VPC
You have additional options on the Specify Parameters page if you're creating your instance inside a VPC.
To create a new high availability JasperReports Server instance in a VPC:
| 1. | Open the Launching Jaspersoft for AWS web page and scroll down to "Start an EC2 instance with Jaspersoft BI, either in or outside of VPC". |
| 2. | Click the Launch Jaspersoft for AWS into VPC tab. |
| 3. | Click the URL for your region. Choose a URL specific to the type of AMI you're using. The Select Template page appears. |
Select Template page |
|
| 4. | In the Stack section, give your CloudFormation stack a unique name. |
By default, AWS provides a stack template source URL. Do not change this.
| 5. | Click Next. The Specify Parameters page appears. |
Specify Parameters page |
|
| 6. | Enter the host name of your database connection in DBHost, the database name in DBName, the database port number in DBPort, and the database password in DBPassword. |
| 7. | Enter the database user name in the DBUser field. |
| 9. | EnablePublicIp defaults to true. Unless you change this setting, your initialization instance will be assigned a public IP address and ELB (if enabled) will be configured as "internet-facing". See Amazon's documentation about internet fading load balancers here: |
http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/elb-internet-facing-load-balancers.html
| 10. | Choose an instanceType. |
| 11. | Choose the KeyName of your EC2 KeyPair. |
| 12. | To enable notifications about your instance state, enter a valid email address in the OperatorEMail field. Leave this field blank to disable notification. |
| 13. | Choose your Subnetid and Vpcid from the drop downs. |
| 14. | Click Next. The Options page appears. |
| 15. | Add any tags you want to simplify administration of your infrastructure. |
A tag consists of a key/value pair and will flow to resources inside your stack. You can add up to 10 unique tags for each instance.
| 16. | Expand the Advanced section of the Options page and set your notification, timeout, and other options. Click the Learn more link for an explanation of these options. |
| 17. | Click Next. The Review page appears. |
Double-check your template, parameter, and option information.
| 18. | Click the acknowledgment check box, then click Create. |
You'll see your Stack Name listed in a table. While it's being created the Status column will display CREATE_IN_PROGRES. After a few minutes the status should change to CREATE_COMPLETE.
If the status changes to ROLLBACK instead of CREATE_COMPLETE, you may need to accept the Terms of Use. Check the Events tab for more information.
Manually Deploy Your Instance in VPC
Manually create new Repository database in an external Postgres database and initialize it.
To deploy your high availability instance manually:
| 1. | Log into your instance by ssh using the information on the Outputs tab. |
| 2. | Change the directory to: |
/usr/share/jrs_dist/jasperreports-server-bin
| 3. | Run the initialization script: |
sudo ./deploy-database-to-external-repo.sh minimal
| You may want to skip the initialization script If your external database already contains a valid JasperReports Server repository that you want of use. The script will create (or recreate) a JasperReports Server repository database (for example from a previous dump or RDS snapshot) with a minimal set of resources or with samples. |
| 4. | If initialization is successful, halt the instance: sudo halt -p
|
If initialization is unsuccessful, troubleshoot the database, then run the initialization script (step 3).
| 5. | Go to the EC2 Console and increase the instance count from 0 to 1 in the Autoscaling group (name is provided on the Outputs tab of the CloudFormation template). |
| 6. | Use the Getting Started URL from the Outputs tab to access your high availability instances. |
Creating a JasperReports Server Instance from the EC2 Console
If you have a complex network topology or special volume requirements, you might need to create your instance from the EC2 Console.
Before you can create a JasperReports Server instance from the EC2 console, you need to create a CloudFormation role. If you skip this step, when you get to the Welcome screen, you'll see the following error message:
Missing Role Error Message |
|
Create a Role for Your Instance
If you launch your instance with a role, JasperReports Server will use that Role to generate temporary AWS security tokens for automatic discovery and management of security between your JRS instance and RDSRedshift instances.
If no role is defined in your JRS Instance, you have 2 options:
| • | Provide Access and Secret keys in AWS Datasource for Discovery and Automatic Security management. |
| • | Manage security manually. (In this case remember to disable Automatic security management in JRS Server Settings.) |
To create a CloudFormation role:
| 1. | Sign into Amazon Marketplace with your AWS account. |
| 2. | Navigate to http://www.jaspersoft.com/jrs-create-role. The Select Template page appears. |
Select Template page |
|
| 3. | In the Stack section, give your CloudFormation stack a unique name |
By default, AWS provides a stack template source URL. Do not change this.
| 4. | Click Next. The Options page appears. |
| 5. | Add any tags you want to simplify administration of your infrastructure. |
A tag consists of a key/value pair and will flow to resources inside your stack. You can add up to 10 unique keys to each instance, along with an optional value for each key.
| 6. | Expand the Advanced section and set your notification, timeout, and other options. Click the Learn more link for an explanation of these options. |
| 7. | Click Next. The Review page appears. |
Double-check your information and parameters.
| 8. | Click Next. A window appears to say your stack is being created. |
| 9. | Click Close. The CloudFormation Stacks page appears. Your new stack shows as CREATE_IN_PROGRESS then changes to CREATE_COMPLETE when it's ready to be used. |
| 10. | Select your stack and click the Outputs tab. |
Outputs Tab Showing RoleName and Description |
|
Note the RoleName for the stack you created. You'll need it in the next procedure.
To create a JasperReports Server instance from the EC2 console:
| 2. | Sign in with your AWS account. |
| 3. | Go to Compute > EC2. The Resources page opens. |
| 4. | On the left, click Images > AMIs. |
| 5. | Expand the menu to the left of the Search text field and select Public Images. |
| 6. | Enter Jaspersoft in the Search text field and press Enter. |
| 7. | Select the AMI you want, and click the Launch button at the top of the page. The Choose an Instance Type page opens. |
| Make sure you select the correct AMI for you license type (hourly, annual, or BYOL). |
| 8. | Choose an Instance Type from the list. |
Instance Type list |
|
Supported instance types are:
| • | Standard Large (m1.large) |
| • | Standard XL (m1.xlarge) |
| • | High-Memory XL (m2.xlarge) |
| • | High-Memory 2XL (m2.2xlarge) |
| • | High-Memory 4XL (m2.4xlarge) |
| • | High-CPU XL (c1.xlarge) |
If you choose an unsupported instance type, you'll receive an error message.
| 9. | Click Next: Configure Instance Details at the bottom of the page, and configure the following details. Hover over the information icon |
| • | Availability Zone (if using EC2) or Subnet (if using VPC) |
| • | Enable termination protection |
| 10. | Expand the Advanced Details section and configure the following details: |
| 11. | Click Next: Add Storage and review the details. Click items you want to edit. You can add EBS and instance store volumes by clicking the Add New Volume button. |
| 12. | Click Next: Tag Instance and add optional tags. To add more tags click the Create Tag button. |
A tag is a key/value pair that will flow to resources inside your stack. You can add up to 10 unique tags to each instance.
| 13. | Click Next: Configure Security Group and configure your firewall rules. Choose an existing security group or create a new security group. |
| We set up one AWS DB Security Group (using IP address) per JasperReports Server instance in each RDS region. The security group allows connections from the JRS instance to the specified AWS database instance. |
| 14. | Click Review and Launch. Review your information and edit if necessary. |
| 16. | When prompted, select an existing key pair, or create a new key pair, and click Launch Instances. |
You'll see a message telling you that your instance is now launching. Your instances may take a few minutes to launch, depending on the software you are running.
| Hours of use on your new instances will start immediately and continue to accrue until you stop or terminate your instances. |
Logging in to JasperReports Server
Log into JasperReports Server using the Getting Started URL generated when you created your JasperReports Server instance. You'll find this URL in the Cloud Formation Outputs tab.
The initial user is superuser and password is your AWS instance ID, located below the Getting Started URL in the Outputs tab or in the EC2 console. You can change the password after your initial login.
To log into JasperReports Server the first time:
| 1. | Click the GettingStartedURL link in your Outputs tab. The Welcome to Jaspersoft BI page appears. |
Welcome to Jaspersoft BI page |
|
| 2. | Choose what you want from the following: |
| • | Your Customer Portal account to download a single-user registration of Jaspersoft Studio Professional, the commercial version of the open source, Eclipse-based report designer for JasperReports. |
| • | Free online support through the Jaspersoft Community forums (requires separate registration). |
| • | A single-user registration for the Online Learning Portal, Jaspersoft's self-guided training site. |
| • | Documentation for all Jaspersoft products, free of charge. |
| 3. | Complete the registration form and click the Sign Up for Free button. If you have already registered with Jaspersoft, click the I've Already Signed Up button. The Getting Started page appears. |
Getting Started page |
|
You can watch an introductory video, explore resources on our Community site, or go ahead and log in.
Login Screen |
|
If you're using BYOL, you'll start with a 72-hour license. This page will display a reminder when your license is set to expire.
Before you click the Login button on this page:
| 1. | Enter superuser as your User ID. |
| 2. | Your password depends on whether you set up high availability. With a high availability, your password is the DBPassword you provided in the CloudFormation template. If you did not set up high availability,your AWS instance ID is your initial password. |
You'll find your AWS instance ID on the CloudFormation Outputs tab of your instance or in the EC2 console.
Finding the default password in the CloudFormation stack |
|
Finding the default password in the EC2 console. |
|
| 3. | Click Change password and enter a new password. |
| 4. | Log in again. The Home screen appears. |
Home Screen |
|
| If you use PostgreSQL as your database, not all PostgreSQL-supported functions will work with Redshift. See the Redshift documentation for details about supported functions. |
Recommended Comments
There are no comments to display.