Jump to content
Changes to the Jaspersoft community edition download ×
  • This documentation is an older version of Jaspersoft for AWS User Guide. View the latest documentation.

    This section describes the processes for creating a JasperReports Server instance from a CloudFormation template, including how to create a JasperReports Server instance inside a Virtual Private Cloud (VPC), or from an 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 to create and launch your instance.

    Select the option that applies to your set-up:

    • Users creating a Jaspersoft AMI instance in an EC2 Classic environment, see Creating a JasperReports Server Instance from a Jaspersoft CloudFormation Template
    • Users creating a Jaspersoft AMI instance in a VPC, see Creating a JasperReports Server Instance Inside a VPC

    The above methods use Jaspersoft's CloudFormation templates to generate an instance and its permissions and roles automatically, which gives you a secure and easily-maintainable instance of the Jaspersoft BI.

    • Users launching a server manually in the EC2 console, see Creating a JasperReports Server Instance from the EC2 Console

    This method is not recommended, as it does not provide the auto-connect feature for Amazon RDSand Redshift included with the CloudFormation templates. If you choose this method, and are using a VPC, be sure to define that option during the setup process.

    note-icon-ns.png.10c1c20615ad0c247649b9e4084ee58e.png

    Your Jaspersoft software is charged separately from the AWS EC2 instance charges. Please make sure to 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 usage. Note that when you stop your EC2 instance server no one will have access to any reports or dashboards you have 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 prefer not to be charged for EBS, make sure to terminate your EC2 instance server. Note that in this case none of your work will be retrievable.

    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 and configured and using this role in order to have appropriate credentials.

    To create a new JasperReports Server instance:

    1. Open the Launching Jaspersoft for AWS web page.
    2. Click the Launch Jaspersoft for AWS tab.
    3. Click the URL for the region you're using.

    The Select Template page appears.

    Select Template page

    create-stack_339x221.png.fc0e67f2acc0f43d056e271db89f1a61.png
    4. On the Select Template page:
    •      In the Stack section of the page, give your CloudFormation stack a unique name.
    •      By default, AWS provides a stack template source URL. Do not change this selection.
    5. Click Next. The Specify Parameters page appears.

    Specify Parameters page

    create-stack-specify-parameters_321x107.png.c1f36d1ac58e235e8e909e1079dfce3e.png
    6. On the Specify Parameters page:
    a. In the Instance Type field, copy and paste any of the supported instance types from the descriptions:
    • Standard Large (m1.large)
    • Standard XL (m1.xlarge)
    • High-Memory XL (m2.xlarge)
    • High-Memory 2XL (m2.2xlarge)
    • High-Memory 4XL (m2.4xlarge)
    • M3 Medium (m3.medium)
    • M3 Large (m3.large)
    • M3 XL (m3.xlarge)
    • 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.

    note-icon-ns.png.3c7753fc8c9c5e98ae78954bbab13b31.png

    For AWS with Multi-Tenancy Hourly, the m3.medium is the only available instance. It is 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

    b. In the KeyName field, enter an existing key pair name.
    7. Click Next. The Options page appears.
    8. On the Options page, 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.

    9. Expand the Advanced section of the Options page and set your notification, timeout, and other options.
    10. Click Next. The Review page appears.

    Double-check your template, parameter, and option information.

    11. Click Create.

    A message appears telling you that your stack has been created. On the Services web page, your stack's initial status is “CREATE_IN_PROGRESS”. It generally takes two to four minutes for the status to change to “CREATE_COMPLETE”.

    note-icon-ns_28x28.png.107e27cef367fa434d0b47212db852e0.png

    It can still take another few minutes for the JasperReports Server URL to become available after the stack shows CREATE_COMPLETE. If you get a message saying “Unable to Connect”, try again in a few minutes.
    12. Select your new instance once its status is CREATE_COMPLETE, then click the Outputs tab. When you are ready to log in to JasperReports Server, you will need the following information located here:
    •      The URL for Getting Started with JasperReports Server (Key: GettingStartedURL)
    •      The generated password (Key: Password).

    note-icon-ns_28x28.png.b0bb43ab7551432fb8554e4e592e1f3e.png

    If the stack creation gives a status message saying ROLLBACK instead of CREATE_COMPLETE, you may need to accept the Terms of Use. Check the Events tab for more information.

    Creating a JasperReports Server Instance Inside a VPC

    If you are creating an instance inside a VPC, there are additional options to configure on the Specify Parameters page.

    To create a new JasperReports Server instance in a VPC:

    1. Open the Launching Jaspersoft for AWS web page.
    2. Click the Launch Jaspersoft for AWS into VPC tab.
    3. Click the URL for your region. These URLS are specific to the type of AMI you are using; make sure you are choosing one from the right AMI list.

    The Select Template page appears.

    Select Template page

    create-stack_339x221.png.1927be8cf517f525da776541fa62601f.png
    4. On the Select Template page:
    •      In the Stack section of the page, give your CloudFormation stack a unique name.
    •      By default, AWS provides a stack template source URL. Do not change this selection.
    5. Click Next. The Specify Parameters page appears.

    Specify Parameters page for VPC users

    SpecifyParametersVPC_340x165.png.ac7138718e4e3478674c306f4204dd63.png

    Parameters are listed in alphabetical order, according to standard CloudFormation template behavior. They include:

    •      EnablePublicIp: Creates (or doesn't) a publicly-accessible IP address for the instance. Enter True to create a public IP, or False to refuse. This is set to True by default. 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)
    • M3 Medium (m3.medium)
    • M3 Large (m3.large)
    • M3 XL (m3.xlarge)
    • 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. Be sure its IP settings do not conflict with the EnablePublicIp parameter settings, and this Subnet ID exists in the VPC entered below.
    •      VpcId: Enter the VPC ID from your account.
    6. Click Next. The Options page appears.
    7. On the Options page, 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.

    8. Expand the Advanced section of the Options page and set your notification, timeout, and other options.
    9. Click Next. The Review page appears.

    Double-check your template, parameter, and option information.

    10. Click Create.

    A message appears telling you that your stack has been created. On the Services web page, your stack's initial status is “CREATE_IN_PROGRESS”. It generally takes two to four minutes for the status to change to “CREATE_COMPLETE”.

    note-icon-ns_28x28.png.cb05764b428a9ab9c0c046b2bffd0b50.png

    It can still take another few minutes for the JasperReports Server URL to become available after the stack shows CREATE_COMPLETE. If you get a message saying “Unable to Connect”, try again in a few minutes.
    11. Select your new instance once its status is CREATE_COMPLETE, then click the Outputs tab. When you are ready to log in to JasperReports Server, you will need the following information located here:
    •      The URL for Getting Started with JasperReports Server (Key: GettingStartedURL)
    •      The generated password (Key: Password).

    note-icon-ns_28x28.png.ab55cb2b7e8b928c841718ad5d026589.png

    If the stack creation gives a status message saying ROLLBACK instead of CREATE_COMPLETE, you may need to accept the Terms of Use. Check the Events tab for more information.

    Creating a JasperReports Server Instance from the EC2 Console

    If you have a complex network topology, 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 will see the following error message:

    Missing Role Error Message

    no-role-error_524x104.png.db62f09bdd269744215e081dddb49ca1.png

    To create a CloudFormation role:

    1. Sign in to Amazon Marketplace with your AWS account.
    2. Navigate to http://www.jaspersoft.com/jrs-create-role.

    The Select Template page appears.

    Select Template page

    create-stack_319x252.png.1845b9e01bdd8e03a9ce3362fe051356.png

     

     
    3. In the Select Template page:
    a. Give your CloudFormation stack a unique name.
    b. By default, AWS provides a stack template source URL. Do not change this selection.
    4. Click Next. The Specify Parameters page appears.

    On the Specify Parameters page check the box to acknowledge that the template can create IAM (Identity and Access Management) resources. Checking the box is necessary .

    Be sure to select the correct AMI (hourly, annual, or BYOL).

    note-icon-ns.png.a2ed32caa0e622d772a5c99b0e4a9be9.png

    If you are using a template with VPC support, the Specify Parameters page includes options particular to that set up. See Creating a JasperReports Server Instance Inside a VPC
    5. Click Next. The Options page appears.
    6. On the Options page, 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.

    7. Expand the Advanced section of the Options page and set your notification, timeout, and other options.
    8. Click Next. The Review page appears.

    Double-check your information and parameters.

    9. Click Next. A window appears to say your stack is being created.
    10. Click Close. The CloudFormation Stacks page appears. Your new stack will say CREATE_IN_PROGRESS until it is finished being created and CREATE_COMPLETE once it is ready to be used.
    11. Click the Outputs tab.

    Outputs Tab Showing RoleName and Description

    outputs-tab-ec2_489x87.png.ddb7207559c55e8669e7b8384b94bde2.png

    You see the RoleName for the stack you created. Note the value carefully, because you need it in the next procedure.

    To create a JasperReports Server instance from the EC2 console:

    1. Navigate to: http://aws.amazon.com/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. Using the dropdown menu at the search box, select Public Images.
    6. Enter Jaspersoft in the Search box.
    7. Select the AMI you want, and click the Launch button at the top of the page.

    note-icon-ns_28x28.png.a818be982bf2d22335970166c0ae494a.png

    Make sure you select the correct AMI for you license: Hourly or BYOL.

    The Choose an Instance Type page opens.

    8. Choose an Instance Type from the list.

    Instance Type list

    instance-type_416x285.png.252ff71a3fb63971e9c551c9529cdb70.png

    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)
    •      M3 Medium (m3.medium)
    •      M3 Large (m3.large)
    •      M3 XL (m3.xlarge)
    •      High-CPU XL (c1.xlarge)

    If you choose an unsupported instance type, you receive an error message. Select a different image and continue following these instructions.

    9. Click Next: Configure Instance Details at the bottom of the page, and configure the following details. Mouse over the information icon icon-info.png.9510112674d966321265a3c684c4da70.png
    •      Number of instances
    •      Purchasing option
    •      Network
    •      Availability Zone (if using EC2) or Subnet (if using VPC)
    •      IAM role
    •      Shutdown behavior
    •      Enable termination protection
    •      Monitoring
    10. Expand the Advanced Details section of the page and configure the following details. Mouse over the information icon icon-info.png.bc38c252b6cc045b6c94759277c139a5.png
    •      Kernel ID
    •      RAM disk ID
    •      User data
    11. Click Next: Add Storage at the bottom of the page, 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 at the bottom of the page, and add tags, if needed, in the text entry boxes. Add additional tags by clicking the Create Tag button.

    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.

    13. Click Next: Configure Security Group at the bottom of the page, and configure your firewall rules. Choose an existing security group or create a new security group.

    note-icon-ns_28x28.png.6b8f8e5218397f3e802f3be49cb22404.png

    We set up one AWS DB Security Group (using IP address) in each RDS region, per JasperReports Server instance. The security group allows connections from the specific JRS instance to the specified AWS database instance.
    14. Click Review and Launch. Review your information, and edit if necessary.

    Double-check your information and parameters.

    15. Click Launch.
    16. When prompted, select an existing key pair, or create a new key pair, and click Launch Instances.

    A message appears telling you that your instance is now launching.

    Your instances may take a few minutes to launch, depending on the software you are running.

    note-icon-ns_28x28.png.6d62bb16a8d59e6bf85909344c678f96.png

    Usage hours on your new instances will start immediately and continue to accrue until you stop or terminate your instances.
    17. Click Close.

    Logging in to JasperReports Server

    Log into JasperReports Server using the Getting Started URL generated when you created your JasperReports Server instance. You can 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 in to 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

    welcome_500x451.png.1bf5f5d27b8b3c3c2cb62777e31734f7.png
    2. From the Welcome to Jaspersoft BI page, you can register to receive:
    •      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

    getting-started_500x360.png.615690500b0532644ab0f9c72ee4009e.png
    4. On the Getting Started page:
    a. Click the Watch Video button to watch a short video that shows you how to quickly connect to your AWS data sources.
    b. Click the Explore Resources button to visit the Jaspersoft Community Site.
    c. Click the Login button to go to the Jaspersoft login page.

    The Welcome to Jaspersoft page appears.

    Login Screen

    login-screen_528x368.png.59973cfcf2bc2fd76f170ea301252945.png

    If you are using BYOL, you have a 72-hour license to start. This page will include a reminder of when your license is set to expire and offer slightly different Getting Started links.

    Before you click the Login button on this page:

    1. Enter superuser as your User ID, and the AWS instance ID (found in the CloudFormation Outputs tab of your instance, or in the EC2 console) as your password.

    This password is pre-configured as expired. You must change it when you initially log in.

    Finding the default password in the CloudFormation stack

    stack.png.4e4ab5485f5d5a56f01a5e38b61286ae.png

     

    Finding the default password in the EC2 console.

    EC2-console.png.052555cda695355745880276a533fdb1.png
    2. Click Change password.
    3. Set the new password to any password you will remember.
    4. Now, click the Login button.

    The Home screen appears.

    Home Screen

    home-screen_400x256.png.ef280d81f96c24a0a35c26821694782a.png

    warning-icon-ns_28x28.png.3ed8b4c7c64c70c91651a26667e35e44.png

    If you use PostgreSQL as your database, note that not all PostgreSQL-supported functions will work with Redshift. See the Redshift documentation for details about supported functions.

     Share
    Go to documents

    User Feedback

    Recommended Comments

    There are no comments to display.



    Guest
    This is now closed for further comments

×
×
  • Create New...

© 2024 Cloud Software Group,
Inc. All rights reserved.

Products

Explore