Note: If you cannot find a topic, go to docs.rightscale.com where all RightScale documentation will soon be located. Also, feel free to Chat with us!
Home > Partners > InterSystems > Documentation > InterSystems Caché Setup Guide and Runbook (Windows)

InterSystems Caché Setup Guide and Runbook (Windows)

You can access the "InterSystems Caché (Windows Server 2008 R2 x64)" ServerTemplate, which is published by InterSystems, from the RightScale MultiCloud Marketplace.

The ServerTemplate has numerous inputs that are used to configure the Caché instance when it's launched.  Many of these inputs have default values that can be modified, if desired. 

By default, an EC2 "small" instance will be launched, and Caché will be configured on it. If desired, the instance size can be modified to suit your needs.

Table of Contents

Setup Guide

The following steps will explain how to use the InterSystems Caché ServerTemplates and RightScripts to properly setup a Caché solution in the cloud.

Prerequisites

  • 'designer', 'library', and 'actor' user role privileges in the RightScale account

Create Required Cloud Resources

The Caché ServerTemplate is designed to launch servers into one of the AWS EC2 regions. In order to launch an EC2 server you will need to have an EC2 SSH Key and Security Group. If you need to create new resources, follow the tutorials below.  Be sure to create the cloud resources in the EC2 cloud/region (e.g. US-East) into which you will launch the servers because cloud resources are cloud-specific.

  • EC2 SSH Key - See Create a New SSH Key.
  • EC2 Security Group - See Create a New EC2 Security Group.
    • Enable TCP Port 23 -any- if Caché telnet will be enabled on the Caché instance
    • Enable TCP Port 3389 -any- if Windows Remote Desktop capabilities are needed
    • Enable TCP Port 1972 -any-
    • Enable TCP Port 57772 -any-

Create Required Credentials

The Caché ServerTemplate is designed to use RightScale's Credentials store (Design -> Credentials) to provide sensitive information to some of the scripts when they are executed.  Create the following credentials with the following names. If you do not have access to this information, contact the person who set up the AWS account.  See Sign Up for Amazon Web Services (AWS).

Create a New Credential

  • AWS_ACCESS_KEY_ID - this credential should contain the AWS Access Key ID
  • AWS_SECRET_ACCESS_KEY - this credential should contain the AWS Secrect Access Key
  • INTERSYSTEMS_CACHE_USER_PASSWORD - this credential should contain a login password for the Caché System (_SYSTEM) user
  • INTERSYSTEMS_OS_ADMIN_PASSWORD - this credential should contain a login password for the Widows Administrator user, and should conform to the Windows Server 2008 Administrator Password guidelines
  • [Optional] INTERSYSTEMS_CACHE_LICENSE_KEY - if you would like to automatically activate a Caché License as part of the instance launch, this credential should contain the contents of your InterSystems Caché Key

 

Import the InterSystems Caché ServerTemplate

Log into the RightScale dashboard and go to Design -> MultiCloud Marketplace -> ServerTemplates. Use the search tool to find and import the most recent revisions of the InterSystems Caché ServerTemplate published by "InterSystems Corporation" A copy of the template will be saved in your RightScale account's local collection. (Design -> ServerTemplates)  Any RightScale account will be able to import the ServerTemplates.

Add Servers to a Deployment

If you do not have a deployment, you must create one before you can add servers into it.  See Create a New Deployment. (e.g. InterSystems).

Go to the imported "InterSystems Caché (Windows Server 2008 R2 x64)" ServerTemplate and add a server to the new "InterSystems" deployment. Be sure to select the same cloud/region where you created the cloud resources in an earlier step.

See Add a Server to a Deployment.  Select the appropriate EC2 SSH key and security group that you created in an earlier step. It's recommended that you select an appropriate Instance Type depending on your needs (the default is m1.small). You can use the default selections for the other server detail options.

Define Inputs

The ServerTemplate has numerous inputs that are used to configure the Caché instance when it's launched.  Many of these inputs have default values that can be modified, if desired.  You will need to define any missing inputs for any boot/decomission scripts before you can successfully launch the server.

The following inputs must be specified for the successful execution of the InterSystems Caché scripts.  It's recommended that you define the inputs at the deployment level.  

Inputs
  • AWS_ACCESS_KEY_ID - This will default to use the "cred:AWS_ACCESS_KEY_ID" credential that you created in an earlier step.
  • AWS_SECRET_ACCESS_KEY -  This will default to use the "cred:AWS_SECRET_ACCESS_KEY" credential that you created in an earlier step.
  • CACHE_USER_PASSWORD - This will default to use the "cred:INTERSYSTEMS_CACHE_USER_PASSWORD" credential that you created in an earlier step.
  • ENABLE_TELNET - This defaults to "No"; To enable the Caché Telnet service, toggle to "text:Yes".
  • GLOBAL_BUFFERS - This defaults to 500 (MB); to increase or decrease the global buffer pool size, change this input parameter. Note that the total memory on the system should be taken into account (for example, an m1.small (default) instance only has 1.7 GB of total memory).
  • INSTALL_DIR - This defaults to "C:\InterSystems\Cache"; to install to a different directory/location, change this input parameter.
  • INSTALL_LOG_FILE - This defaults to "C:\Windows\CacheInstall.log"; to log output from the installation to another log file, change this input parameter.
  • INSTALL_VERSION - This defaults to "2012.1.2"; to select a different Caché version, pick any from the dropdown.
  • INSTANCE_NAME - This defaults to "CACHE"; To name your Caché instance something different, change this input parameter.
  • OPT_LICENSE - [Optional] If you created the "INTERSYSTEMS_CACHE_LICENSE_KEY" credential, you can provide it here so that the ServerTemplate will activate the Caché License during installation. If no license is provided, the install will still succeed, but you will have limited capabilities 
  • ROUTINE_BUFFERS - This defaults to 200 (MB);to increase or decrease the global buffer pool size, change this input parameter. Note that the total memory on the system should be taken into account (for example, an m1.small (default) instance only has 1.7 GB of total memory)
  • SUPERSERVER_PORT - This defaults to 1972; to use a different SuperServer Port for this Caché instance, change this input parameter.
  • UNICODE - This defaults to "Yes"; to launch a non-Unicode (i.e., 8-bit) Caché system, change this input parameter to "No".
  • WEBSERVER_PORT - This defaults to 57772; to use a different private WebServer Port for this Caché instance, change this input parameter.
  • SKETCHY - This will default to use the "env:RS_SKETCHY" environment variable (this is pre-defined; no need to change this value).
  • ADMIN_PASSWORD - This will default to use the "cred:INTERSYSTEMS_OS_ADMIN_PASSWORD" credential that you created in an earlier step.
  • FIREWALL_OPEN_PORTS_TCP - This will default to "23 1972 57772 3389"; to open additional (or different) ports, update this input parameter (add new ports separated by a space). Note: the appropriate ports must be opened by the RightScripts in order for you to be able to access the Caché instance as well as the Windows Server.
  • FIREWALL_OPEN_PORTS_UDP - N/A; leave blank
  • INSTANCE_ID - This will default to use the "env:INSTANCE_ID" environment variable (this is pre-defined; no need to change this value).

 

Click Save.

Launch the Server

Once you have filled out the inputs, you are ready to launch the server. Click the Launch button, review the inputs, then click Launch once again.

That's it! Within minutes, you will have a fully functional instance of Caché running in the Amazon EC2 cloud!

EBS Volumes

The InterSystems Caché (Windows Server 2008 R2 x64) ServerTemplate and associated RightScripts will create the following EBS volumes:

  • C:\ - this is the default OS install volume, and is also used for installing Caché, and storing the Caché Database Files; it is a 80GB EBS volume
  • F:\ - this is the primary journal directory, and it is a 50GB EBS volume
  • G:\ - this is the alternate journal directory, and it is a 50GB EBS volume

Presently, it is not possible to control the size of these volumes via input parameters.

Monitoring

Caché provides a robust WMI (Windows Management Instrumentation) interface. A sample custom monitor is included as part of this ServerTemplate - it is included as the "InterSystems Caché Global References WMI Script". This provides an example of how you can extend the RightScale monitoring and expose additional Caché metrics to the RightScale dashboard. To view a complete listing of the WMI metrics provided by Caché, see: Monitoring Caché using WMI.

Note that the InterSystems Caché (Windows Server 2008 R2 x64) ServerTemplate automatically enables the Caché instance and the base OS for WMI.

Backups

InterSystems Caché provides a robust, self-contained database backup feature. For details, see: Caché Online Backup.

You must to post a comment.
Last modified
23:41, 16 May 2013

Tags

This page has no custom tags.

Classifications

This page has no classifications.

Announcements

None


© 2006-2014 RightScale, Inc. All rights reserved.
RightScale is a registered trademark of RightScale, Inc. All other products and services may be trademarks or servicemarks of their respective owners.