Note: Please go to docs.rightscale.com to access the current RightScale documentation set. Also, feel free to Chat with us!
Home > ServerTemplates > v13.5 LTS > ST > Tomcat6 App Server (v13.5 LTS) > Tomcat6 App Server (v13.5.0-LTS) - Reference

Tomcat6 App Server (v13.5.0-LTS) - Reference

Table of Contents
  1. Info
  2. Images
  3. Scripts
  4. Inputs
    1. Account credential
      1. Account name
        1. Action
        2. AllowOverride Directive
        3. Application IP Type Given to Load Balancer
        4. Application Listen Port
        5. Application Name
        6. Backup Cron Hour (1)
        7. Backup Cron Hour (2)
        8. Backup Cron Minute (1)
        9. Backup Cron Minute (2)
        10. Backup Lineage (1)
        11. Backup Lineage (2)
        12. Backup Lineage Override
        13. Backup Max Snapshots (1)
        14. Backup Max Snapshots (2)
        15. Backup Restore Timestamp Override (1)
        16. Backup Restore Timestamp Override (2)
        17. Block Device Mount Directory (1)
        18. Block Device Mount Directory (2)
        19. Block Device(s) to Operate On
        20. Container datasource name
        21. Database Admin Password
        22. Database Admin Username
        23. Database Application Password
        24. Database Application Username
        25. Database Backup Lineage
        26. Database DNS TTL Limit
        27. Database Master DNS Record ID
        28. Database Master FQDN
        29. Database Provider type
        30. Database Replication Network Interface
        31. Database Replication Password
        32. Database Replication Username
        33. Database Restore Lineage Override
        34. Database Restore Timestamp Override
        35. Database Schema Name
        36. Database Slave DNS Record ID
        37. Database Slave FQDN
        38. Domain Name
        39. Domain Search Suffix
        40. Dump Container
        41. Dump Prefix
        42. Dump Storage Account ID
        43. Dump Storage Account Provider
        44. Dump Storage Account Secret
        45. Dump Storage Endpoint URL
        46. Enable security updates
        47. Ephemeral File System Type
        48. Firewall
        49. Firewall Rule
        50. Firewall Rule IP Address
        51. Firewall Rule Port
        52. Firewall Rule Protocol
        53. Force Promote to Master
        54. Force Reset Safety
        55. Health Check URI
        56. I/O Operations per Second (1)
        57. I/O Operations per Second (2)
        58. Init Slave at Boot
        59. Interval in Minutes to Run Reconverge List
        60. Keep Daily Backups (1)
        61. Keep Daily Backups (2)
        62. Keep Monthly Backups (1)
        63. Keep Monthly Backups (2)
        64. Keep Weekly Backups (1)
        65. Keep Weekly Backups (2)
        66. Keep Yearly Backups (1)
        67. Keep Yearly Backups (2)
        68. Known hosts ssh key
        69. Load Balance Pools
        70. Load Balance Provider
        71. Load Balance Service ID
        72. Load Balance Service Name
        73. Load Balance Service Region
        74. Load Balance Service Secret
        75. Logging Protocol
        76. Master Backup Cron Hour
        77. Master Backup Cron Minute
        78. Master Secondary Backup Cron Hour
        79. Master Secondary Backup Cron Minute
        80. Multi-Processing Module
        81. NTP Servers
        82. Nickname (1)
        83. Nickname (2)
        84. Number of Volumes in the Stripe (1)
        85. Number of Volumes in the Stripe (2)
        86. Percentage of the LVM used for data (1)
        87. Percentage of the LVM used for data (2)
        88. Percentage of the ephemeral LVM used for data
        89. Primary Backup Secret (default)
        90. Primary Backup Storage Cloud (default)
        91. Primary Backup Storage Cloud Endpoint URL (default)
        92. Primary Backup User (default)
        93. Private SSH Key
        94. Process List
        95. Process Match List
        96. Project App root
        97. ROS Prefix
        98. ROS Storage Account Provider
        99. Rackspace API Key
        100. Rackspace SNET Enabled for Backup
        101. Rackspace Tenant ID
        102. Rackspace Username
        103. Reconverge List
        104. RedHat Network Password
        105. RedHat Network Username
        106. Remote Server
        107. Repository Branch/Tag/Commit
        108. Repository Provider
        109. Repository URL/ROS Container
        110. SSL Certificate
        111. SSL Certificate Chain
        112. SSL Certificate Key
        113. SSL Enable
        114. SSL Passphrase
        115. Secondary Backup Secret (default)
        116. Secondary Backup Storage Cloud (default)
        117. Secondary Backup Storage Cloud Endpoint URL (default)
        118. Secondary Backup Storage Container (1)
        119. Secondary Backup Storage Container (2)
        120. Secondary Backup User (default)
        121. Short Hostname
        122. Slave Backup Cron Hour
        123. Slave Backup Cron Minute
        124. Slave Secondary Backup Cron Hour
        125. Slave Secondary Backup Cron Minute
        126. Status Page Password
        127. Status Page Username
        128. Status URI
        129. Storage Cloud Endpoint URL
        130. Swap size in GB
        131. Swapfile location
        132. Terminate Safety
        133. Timezone
        134. Tomcat Internal Port
        135. Tomcat Java MaxNewSize
        136. Tomcat Java MaxPermSize
        137. Tomcat Java NewSize
        138. Tomcat Java PermSize
        139. Tomcat Java XMS
        140. Tomcat Java XMX
        141. Total Volume Size (1)
        142. Total Volume Size (2)
        143. Use Session Stickiness
        144. Volume Type
        145. War file for ROOT
  5. Revision History
  6. See also

Table of Contents    
  1. Info
  2. Images
  3. Scripts
  4. Inputs
  5. Revisions
  6. See also

Long Term Support

Stable, tested ServerTemplate assets

   ►  Reference

Info

Current revision: 2
Date published: 2013/08/30 20:26:44 +0000
MultiCloud Marketplacehttp://www.rightscale.com/library/se.../lineage/44263

  • Description:
    This ServerTemplate is on the LTS Lineage. For the latest Infinity version, see the Infinity Lineage  
    
    For a description of the Infinity and LTS lineages, see ServerTemplate Release Methodology
    
    This ServerTemplate configures a combined Tomcat 6 and Apache application server, which uses the mod_jk connector plug-in. It creates an HTTP virtual host (vhost) and forwards requests to the specified application port to serve your web application.
    
    Related ServerTemplates:  
    Tomcat 7 App Server  
    Load Balancer  
    Database Manager for MySQL 5.5  
    Database Manager for PostgreSQL 9.1
    
    Documentation:  
    Release Notes  
    Tutorial  

    Application versions: * Apache 2.2 * Tomcat 6.0 * mod_jk 1.2 * Java 1.6 * MySQL Client (5.1 or 5.5) * Postgres Client 9.1 Supported public compute clouds: * Amazon Web Services EC2 * Datapipe * Google Compute Engine * HP Cloud * Rackspace First Generation * Rackspace Open Cloud * SoftLayer * Windows Azure Supported private compute clouds: * Citrix CloudStack 3.0.6 * OpenStack Folsom * Rackspace Private Cloud Supported MultiCloud Images: * CentOS 6 - Amazon, CloudStack, Datapipe, Google, HP, OpenStack, Rackspace, Rackspace Open Cloud, SoftLayer, Windows Azure * Ubuntu 12.04 - Amazon, CloudStack, Datapipe, HP, OpenStack, Rackspace, Rackspace Open Cloud, SoftLayer, Windows Azure * RHEL 6 - Amazon
  • Supported Clouds: AWS AP-Singapore, AWS AP-Sydney, AWS AP-Tokyo, AWS EU, AWS SA-Sao Paulo, AWS US-East, AWS US-Oregon, AWS US-West, Azure East Asia, Azure East US, Azure North Europe, Azure Southeast Asia, Azure West Europe, Azure West US, CloudStack default, Datapipe Hong Kong, Datapipe London, Datapipe New York Metro, Datapipe Silicon Valley, HP Cloud, OpenStack default, Rackspace, Rackspace Managed, Rackspace Open Cloud - Chicago, Rackspace Open Cloud - Dallas, Rackspace Open Cloud - London, Rackspace Open Cloud - Sydney, Rackspace UK

Images

The following MultiCloud Images (MCIs) are used by the ServerTemplate. The MCIs determine which operating systems and clouds are supported.

MultiCloud Images

  • RightImage_Ubuntu_12.04_x64_v13.5_LTS
    • AWS AP-Singapore, AWS AP-Sydney, AWS AP-Tokyo, AWS EU, AWS SA-Sao Paulo, AWS US-East, AWS US-Oregon, AWS US-West, Azure East Asia, Azure East US, Azure North Europe, Azure Southeast Asia, Azure West Europe, Azure West US, HP Cloud, Rackspace, Rackspace Managed, Rackspace Open Cloud - Chicago, Rackspace Open Cloud - Dallas, Rackspace Open Cloud - London, Rackspace Open Cloud - Sydney, Rackspace UK
  • RightImage_Ubuntu_12.04_x64_v13.5_LTS_EBS
    • AWS AP-Singapore, AWS AP-Sydney, AWS AP-Tokyo, AWS EU, AWS SA-Sao Paulo, AWS US-East, AWS US-Oregon, AWS US-West
  • RightImage_Ubuntu_12.04_x64_v13.5_LTS_HVM_EBS
    • AWS AP-Tokyo, AWS EU, AWS US-East, AWS US-Oregon
  • RightImage_Ubuntu_12.04_x64_v13.5_LTS_KVM
    • CloudStack default, Datapipe Hong Kong, Datapipe London, Datapipe New York Metro, Datapipe Silicon Valley, OpenStack default
  • RightImage_Ubuntu_12.04_x64_v13.5_LTS_VMware
    • None
  • RightImage_Ubuntu_12.04_x64_v13.5_LTS_XenServer
    • None
  • SoftLayerImage_Storage_Ubuntu_12.04_x64_v13.5_LTS
    • None
  • SoftLayerImage_Ubuntu_12.04_x64_v13.5_LTS
    • None

Scripts

Inputs

Account credential

A valid credential (i.e. password, SSH key, account secret) to access files in the specified location. This input is always required for Git and Rsync but may be optional for other providers. Example: cred:RACKSPACE_AUTH_KEY

Account name

The account name (i.e. username, ID) that is required to access files in the specified location. This input is optional and may not be required. Example: cred:RACKSPACE_USERNAME

Action

Specify how the application code will be pulled from the specified repository. 'pull'- standard repository pull, 'capistrano_pull' standard repository pull plus a capistrano deployment style is applied. Example: pull

AllowOverride Directive

Allows/disallows the use of .htaccess files in project web root directory. Can be None (default), All, or any directive-type as specified in Apache documentation. Example: None

Application IP Type Given to Load Balancer

Specify the IP type where the application server is listening. Example: private

Application Listen Port

The port that the application service is listening on. Example: 8000

Application Name

Sets the directory for your application's web files (/home/webapps/Application Name/). If you have multiple applications, you can run the code checkout script multiple times, each with a different value for the 'Application Name' input, so each application will be stored in a unique directory. This must be a valid directory name. Do not use symbols in the name. Example: myapp

Backup Cron Hour (1)

Defines the hour when the backup will be taken. Use a value of 1-24, or set to 'Ignore' to create a backup every hour. Example: 10

Backup Cron Hour (2)

Defines the hour when the backup will be taken. Use a value of 1-24, or set to 'Ignore' to create a backup every hour. Example: 10

Backup Cron Minute (1)

Defines the minute of the hour when the backup will be taken. Use a value of 1-59, or set to 'Ignore' and a random minute will be calculated. Example: 10

Backup Cron Minute (2)

Defines the minute of the hour when the backup will be taken. Use a value of 1-59, or set to 'Ignore' and a random minute will be calculated. Example: 10

Backup Lineage (1)

The name associated with your primary and secondary database backups. It's used to associate them with your database environment for maintenance, restore, and replication purposes. Backup snapshots will automatically be tagged with this value (e.g. rs_backup:lineage=mysqlbackup). Backups are identified by their lineage name. Note: For servers running on Rackspace, this value also indicates the Cloud Files container to use for storing primary backups. If a Cloud Files container with this name does not already exist, one will automatically be created. Example: prod_db_lineage

Backup Lineage (2)

The name associated with your primary and secondary database backups. It's used to associate them with your database environment for maintenance, restore, and replication purposes. Backup snapshots will automatically be tagged with this value (e.g. rs_backup:lineage=mysqlbackup). Backups are identified by their lineage name. Note: For servers running on Rackspace, this value also indicates the Cloud Files container to use for storing primary backups. If a Cloud Files container with this name does not already exist, one will automatically be created. Example: prod_db_lineage

Backup Lineage Override

If defined, this will override the input defined for 'Backup Lineage' (block_device/devices/device2/backup/lineage) so that you can restore the volume from another backup that has as a different lineage name. The most recently completed snapshots will be used unless a specific timestamp value is specified for 'Restore Timestamp Override' (block_device/devices/device2/backup/timestamp_override). Example: prod_db_lienage_2

Backup Max Snapshots (1)

The maximum number of primary backups to keep in addition to those being rotated. Example: 60

Backup Max Snapshots (2)

The maximum number of primary backups to keep in addition to those being rotated. Example: 60

Backup Restore Timestamp Override (1)

Another optional variable to restore from a specific timestamp. Specify a string matching the timestamp tags on the volume snapshot set. You will need to specify the timestamp that's defined by the snapshot's tag (not name). For example, if the snapshot's tag is 'rs_backup:timestamp=1303613371' you would specify '1303613371' for this input. Example: 1303613371

Backup Restore Timestamp Override (2)

Another optional variable to restore from a specific timestamp. Specify a string matching the timestamp tags on the volume snapshot set. You will need to specify the timestamp that's defined by the snapshot's tag (not name). For example, if the snapshot's tag is 'rs_backup:timestamp=1303613371' you would specify '1303613371' for this input. Example: 1303613371

Block Device Mount Directory (1)

The directory of where to mount the block device (e.g., /mnt/storage). Example: /mnt/storage

Block Device Mount Directory (2)

The directory of where to mount the block device (e.g., /mnt/storage). Example: /mnt/storage

Block Device(s) to Operate On

The block device(s) to operate on. Can be a comma-separated list of device names or '*' to indicate all devices. Example: device1

Container datasource name

This name is used to set up the database connection with the application server. You should set the attribute if your application is compiled to use a different datasource name. To set custom datasource you must override input value. Example: jdbc/MyConnDB

Database Admin Password

The password of the database user with 'admin' privileges. Example: cred:DBADMIN_PASSWORD.

Database Admin Username

The username of the database user with 'admin' privileges. Example: cred:DBADMIN_USER.

Database Application Password

The password of the database user that has 'user' privileges. Example: cred:DBAPPLICATION_PASSWORD.

Database Application Username

The username of the database user that has 'user' privileges. Example: cred:DBAPPLICATION_USER.

Database Backup Lineage

The prefix that will be used to name/locate the backup of a particular database.Note: For servers running on Rackspace, this value also indicates the Cloud Files container to use for storing primary backups.If a Cloud Files container with this name does not already exist,the setup process creates one. Example: text:prod_db_lineage

Database DNS TTL Limit

The upper limit for the TTL of the master DB DNS record in seconds. This value should be kept low in the event of Master DB failure so that the DNS record updates in a timely manner. When installing the DB server, this value is checked in the DNS records. Input should be set for 300 when using CloudDNS. Example: 60

Database Master DNS Record ID

The unique identifier that is associated with the DNS A record of the master database server.The unique identifier is assigned by the DNS provider when you create a dynamic DNS A record. This ID is used to update the associated A record with the private IP address of the master server when this recipe is run. If you are using DNS Made Easy as your DNS provider, a 7-digit number is used (e.g., 4403234).Example:4403234

Database Master FQDN

The fully qualified domain name for the master database server. Example: db-master.example.com

Database Provider type

Database provider type to use on client side. This must be a string containing the provider cookbook name and (optionally) the version of the database. Example: db_mydatabase_1.0, db_mysql_5.1, db_mysql_5.5, db_postgres_9.1

Database Replication Network Interface

The network interface used for replication. WARNING: when selecting 'public' we highly recommend enabling SSL encryption, otherwise data could travel over insecure connections. Make sure you understand what you are doing before changing this value. Default: private

Database Replication Password

The password of the database user that has 'replication' privileges. Example: cred:DBREPLICATION_PASSWORD.

Database Replication Username

The username of the database user that has 'replication' privileges. Example: cred:DBREPLICATION_USER.

Database Restore Lineage Override

If defined, this will override the input defined for 'Backup Lineage' (db/backup/lineage) so that you can restore the database from another backup that has as a different lineage name. The most recently completed snapshots will be used unless a specific timestamp value is specified for 'Restore Timestamp Override' (db/backup/timestamp_override). Although this input allows you to restore from a different set of snapshots, subsequent backups will use 'Backup Lineage' to name the snapshots. Be sure to remove the 'Backup Lineage Override' input after the new master is operational. Example: text:new_db_lineage

Database Restore Timestamp Override

An optional variable to restore a database backup with a specific timestamp rather than the most recent backup in the lineage. You must specify a string that matches the timestamp tag on the volume snapshot. You will need to specify the timestamp that is defined by the snapshot's tag (not the name). For example, if the snapshot's tag is 'rs_backup:timestamp=1303613371' you would specify '1303613371' for this input. Example: 1303613371

Database Schema Name

Enter the name of the database schema to which applications will connect to.The database schema should have been created when the initial database was first set up. This input will be used to set the application server's database configuration file so that applications can connect to the correct schema within the database. NOTE: LAMP servers use this input for database dump backups in order to determine which schema will be backed up. Example: mydbschema

Database Slave DNS Record ID

The unique identifier that is associated with the DNS A record of a slave server. The unique identifier is assigned by the DNS provider when you create a dynamic DNS A record. This ID is used to update the associated A record with the private IP address of a slave server when this recipe is run. If you are using DNS Made Easy as your DNS provider, a 7-digit number is used (e.g., 4403234). Example:4403234

Database Slave FQDN

The fully qualified domain name for a slave database server. Example: db-slave.example.com

Domain Name

The domain name that you would like this node to have. Example: example.com

Domain Search Suffix

The domain search suffix you would like this node to have. Example: example.com

Dump Container

The cloud storage location where the dump file will be saved to or restored from. For Amazon S3, use the bucket name. For Rackspace Cloud Files, use the container name. Example: db_dump_bucket

Dump Prefix

The prefix that will be used to name/locate the backup of a particular database dump. Defines the prefix of the dump file name that will be used to name the backup database dump file, along with a timestamp. Example: prod_db_backup

Dump Storage Account ID

In order to write the dump file to the specified cloud storage location, you need to provide cloud authentication credentials. For Amazon S3, use your Amazon access key ID (e.g., cred:AWS_ACCESS_KEY_ID). For Rackspace Cloud Files, use your Rackspace login username (e.g., cred:RACKSPACE_USERNAME). For OpenStack Swift the format is: 'tenantID:username'. Example: cred:AWS_ACCESS_KEY_ID

Dump Storage Account Provider

Location where the dump file will be saved. Used by dump recipes to back up to remote object storage (complete list of supported storage locations is in input dropdown). Example: s3

Dump Storage Account Secret

In order to write the dump file to the specified cloud storage location, you need to provide cloud authentication credentials. For Amazon S3, use your AWS secret access key (e.g., cred:AWS_SECRET_ACCESS_KEY). For Rackspace Cloud Files, use your Rackspace account API key (e.g., cred:RACKSPACE_AUTH_KEY). Example: cred:AWS_SECRET_ACCESS_KEY

Dump Storage Endpoint URL

The endpoint URL for the storage cloud. This is used to override the default endpoint or for generic storage clouds such as Swift. Example: http://endpoint_ip:5000/v2.0/tokens

Enable security updates

Unfreezes software repositories after booting and installing packages, allowing for security updates to be installed.

Ephemeral File System Type

The type of file system that will be installed on the ephemeral device. By default, this input will be set to 'xfs'. This input is ignored on Redhat and Google cloud since we do not support 'xfs' on them. The 'ext3' file system will be set up by default on Redhat and Google cloud. Example: xfs

Firewall

Enables an iptables firewall for this server which allows port 22, 80 and 443 open by default. Use the sys_firewall::setup_rule recipe to enable/disable extra ports. Example: enabled

Firewall Rule

Enables or disables a firewall rule. Example: enable

Firewall Rule IP Address

Address can either be a network name, a network IP address (with /mask), or a plain IP address. The mask can either be a network mask or a plain number specifying the number of 1's at the left side of the network mask. Thus, a mask of 24 is equivalent to 255.255.255.0. A '!' argument before the address specification inverts the sense of the address. A value of 'any' allows any IP address. Example: any

Firewall Rule Port

Comma-separated list of ports to Enable or Disable. Example: 8080,8000

Firewall Rule Protocol

Firewall protocol use. Example: tcp

Force Promote to Master

If true, when promoting a slave to master, ignores making checks and changes to any current master. WARNING: setting this will promote a slave to a master with no replication until a new slave is brought up. Make sure you understand what you are doing before changing this value. Default: false

Force Reset Safety

Prevents the accidental running of the db::do_force_reset recipe. This recipe will only run if the input variable is overridden and set to "off". Example: text:off

Health Check URI

The URI that the load balancer will use to check the health of a server. It is only used for HTTP (not HTTPS) requests. Example: /

I/O Operations per Second (1)

The input/output operations per second (IOPS) that the volume can support. IOPS is currently only supported on Amazon EC2. Example: 500

I/O Operations per Second (2)

The input/output operations per second (IOPS) that the volume can support. IOPS is currently only supported on Amazon EC2. Example: 500

Init Slave at Boot

Set to 'True' to have the instance initialize the database server as a slave on boot. Set to 'False' if there is no master database server running. Example: false

Interval in Minutes to Run Reconverge List

Defines the interval in minutes to run recipe(s) of reconverge list. Example: 15

Keep Daily Backups (1)

The number of daily primary backups to keep (i.e., rotation size). Example: 14

Keep Daily Backups (2)

The number of daily primary backups to keep (i.e., rotation size). Example: 14

Keep Monthly Backups (1)

The number of monthly primary backups to keep (i.e., rotation size). Example: 12

Keep Monthly Backups (2)

The number of monthly primary backups to keep (i.e., rotation size). Example: 12

Keep Weekly Backups (1)

The number of weekly primary backups to keep (i.e., rotation size). Example: 6

Keep Weekly Backups (2)

The number of weekly primary backups to keep (i.e., rotation size). Example: 6

Keep Yearly Backups (1)

The number of yearly primary backups to keep (i.e., rotation size). Example: 2

Keep Yearly Backups (2)

The number of yearly primary backups to keep (i.e., rotation size). Example: 2

Known hosts ssh key

A valid SSH key which will be appended to /root/.ssh/known_hosts file. This input will allow to verify the destination host, by comparing its IP,FQDN, SSH-RSA with the record in /root/.ssh/known_hosts file. Use this input if you want to improve security and for MiTM attacks prevention. Example: cred:SSH_KNOWN_HOST_KEY.

Load Balance Pools

Comma-separated list of URIs or FQDNs for which the load balancer will create server pools to answer website requests. The order of the items in the list will be preserved when answering to requests. Last entry will be the default backend and will answer for all URIs and FQDNs not listed here. A single entry of any name, e.g. 'default', 'www.mysite.com' or '/appserver', will mimic basic behavior of one load balancer with one pool of application servers. This will be used for naming server pool backends. Application servers can provide any numbers of URIs or FQDNs to join corresponding server pool backends.Example: www.mysite.com, api.mysite.com, /serverid, default

Load Balance Provider

Specify the load balance provider to use either: 'lb_client' for ServerTemplate based Load Balancer solutions (such as aiCache, HAProxy, etc.), 'lb_elb' for AWS Load Balancing, or 'lb_clb' for Rackspace Cloud Load Balancing. Example: lb_client

Load Balance Service ID

The account name that is required for access to specified cloud load balancer. For Rackspace's CLB service, use your Rackspace username. (e.g., cred: RACKSPACE_USERNAME). For Amazon ELB, use your Amazon key ID (e.g., cred:AWS_ACCESS_KEY_ID). Example: cred:CLOUD_ACCOUNT_USERNAME

Load Balance Service Name

Name of the Cloud Load Balancer or Elastic Load Balancer device. Example: mylb

Load Balance Service Region

For Rackspace's Cloud Load Balancing service region, specify the cloud region or data center being used for this service. Example: ORD (Chicago)

Load Balance Service Secret

The account secret that is required for access to specified cloud load balancer. For Rackspace's CLB service, use your Rackspace account API key (e.g., cred:RACKSPACE_AUTH_KEY). For Amazon ELB, use your Amazon secret key (e.g., cred:AWS_SECRET_ACCESS_KEY). Example: cred:CLOUD_ACCOUNT_KEY

Logging Protocol

Protocol used to send logging messages from client to server. Example: udp

Master Backup Cron Hour

Defines the hour of the day when the primary backup will be taken of the master database. Backups of the master are taken daily. By default, an hour will be randomly chosen at launch time. Otherwise, the time of the backup is defined by 'Master Backup Cron Hour' and 'Master Backup Cron Minute'. However, if you specify a value in this input (e.g., 23 for 11:00 PM), then backups will occur once per day at the specified hour, rather than hourly. Uses standard crontab format. Example: 23

Master Backup Cron Minute

Defines the minute of the hour when the backup of the master database will be taken. Backups of the master are taken daily. By default, a minute will be randomly chosen at launch time. Otherwise, the time of the backup is defined by 'Master Backup Cron Hour' and 'Master Backup Cron Minute'. Uses standard crontab format. Example: 30

Master Secondary Backup Cron Hour

Defines the hour of the day when the secondary backup will be taken of the master database. Backups of the master are taken daily. By default, an hour will be randomly chosen at launch time. Otherwise, the time of the backup is defined by 'Master Secondary Backup Cron Hour' and 'Master Secondary Backup Cron Minute'. Uses standard crontab format (e.g., 23 for 11:00 PM).

Master Secondary Backup Cron Minute

Defines the minute of the hour when the secondary backup will be taken of the master database. Backups of the master are taken daily. By default, a minute will be randomly chosen at launch time. Otherwise, the time of the backup is defined by 'Master Secondary Backup Cron Hour' and 'Master Secondary Backup Cron Minute'. Uses standard crontab format (e.g., 30 for minute 30 of the hour).

Multi-Processing Module

Defines the multi-processing module setting in httpd.conf. Use 'worker' for Rails/Tomcat/Standalone frontends and 'prefork' for PHP. Example: prefork

NTP Servers

A comma-separated list of fully qualified domain names for the array of servers that instances should talk to. Example: time1.example.com, time2.example.com, time3.example.com

Nickname (1)

The name displayed in the dashboard for volumes and to uniquely identify LVM volume groups. Example: data_storage1

Nickname (2)

The name displayed in the dashboard for volumes and to uniquely identify LVM volume groups. Example: data_storage1

Number of Volumes in the Stripe (1)

The total number of volumes in the volume stripe that will be used by the database. Volumes will be created and mounted to the instance. The default value is 1, which means that only a single volume will be used (no striping). This value is ignored on clouds that do not support volumes (e.g., Rackspace). Example: 1

Number of Volumes in the Stripe (2)

The total number of volumes in the volume stripe that will be used by the database. Volumes will be created and mounted to the instance. The default value is 1, which means that only a single volume will be used (no striping). This value is ignored on clouds that do not support volumes (e.g., Rackspace). Example: 1

Percentage of the LVM used for data (1)

The percentage of the total Volume Group extents (LVM) that is used for data. (e.g. 50 percent - 1/2 used for data and remainder used for overhead and snapshots, 100 percent - all space is allocated for data (therefore snapshots can not be taken). WARNING: If the space used for data storage is too large, LVM snapshots cannot be performed. Using a non-default value is not recommended. Make sure you understand what you are doing before changing this value.

Percentage of the LVM used for data (2)

The percentage of the total Volume Group extents (LVM) that is used for data. (e.g. 50 percent - 1/2 used for data and remainder used for overhead and snapshots, 100 percent - all space is allocated for data (therefore snapshots can not be taken). WARNING: If the space used for data storage is too large, LVM snapshots cannot be performed. Using a non-default value is not recommended. Make sure you understand what you are doing before changing this value.

Percentage of the ephemeral LVM used for data

The percentage of the total ephemeral Volume Group extents (LVM) that is used for data (e.g. 50 percent - 1/2 used for data, 100 percent - all space is allocated for data). WARNING: Using a non-default value is not recommended. Make sure you understand what you are doing before changing this value. Example: 100

Primary Backup Secret (default)

Primary cloud authentication credentials. For Rackspace Cloud Files, use your Rackspace account API key (e.g., cred:RACKSPACE_AUTH_KEY). For clouds that do not require primary credentials (e.g., Amazon), set to 'ignore'. Example: cred:CLOUD_ACCOUNT_KEY

Primary Backup Storage Cloud (default)

The primary backup storage cloud (complete list of supported storage locations is in input dropdown). This is only used if the server's cloud does not have volume support. Example: s3

Primary Backup Storage Cloud Endpoint URL (default)

The endpoint URL for the primary backup storage cloud. This is used to override the default endpoint or for generic storage clouds such as Swift. Example: http://endpoint_ip:5000/v2.0/tokens

Primary Backup User (default)

Primary cloud authentication credentials. For Rackspace Cloud Files, use your Rackspace login username (e.g., cred:RACKSPACE_USERNAME). For OpenStack Swift the format is: 'tenantID:username'. For clouds that do not require primary credentials (e.g., Amazon), set to 'ignore'. Example: cred:CLOUD_ACCOUNT_USERNAME

Private SSH Key

The private SSH key of another instance that gets installed on this instance. Select input type 'key' from the dropdown and then select an SSH key that is installed on the other instance. Example: key:my_key

Process List

A space-separated list of additional processes to monitor in the RightScale Dashboard. Example: sshd crond

Process Match List

A space-separated list of pairs used to match the name(s) of additional processes to monitor in the RightScale Dashboard. Paired arguments are passed in using the following syntax 'name/regex'. Example: ssh/ssh* cron/cron*

Project App root

The destination location where the application code will be placed on the local instance. If you want the application code to be placed in the root directory, use a forward slash (/) otherwise you will need to specify the full path (e.g. /path/to/code). Example: /home/webapps

ROS Prefix

The prefix that will be used to locate the correct tarball of the application. For example, if you're using 'myapp.tgz' specify 'myapp' as the ROS Prefix. Example: myapp

ROS Storage Account Provider

The Remote Object Storage (ROS) service where the tarball of the application code will be retrieved from. Example: s3

Rackspace API Key

The API Key for Rackspace cloud account. This is required for registering instances with Rackspace Managed Cloud.

Rackspace SNET Enabled for Backup

When 'true', Rackspace internal private networking preferred) (is used for communications between servers and Rackspace Cloud Files. Ignored for all other clouds. Example: true

Rackspace Tenant ID

The tenant ID for Rackspace cloud account. This is required for registering instances with Rackspace Managed Cloud.

Rackspace Username

The username for Rackspace cloud account. This is required for registering instances with Rackspace Managed Cloud.

Reconverge List

A space-separated list of recipes to run every 15 minutes, which is designed to enforce system consistency. Example: app::do_firewall_request_open lb_haproxy::do_attach_all

RedHat Network Password

The password associated with the username specified in the rightscale/redhat/username input. Example: cred:REDHAT_SUBSCRIBER_PASSWORD

RedHat Network Username

The username to register the system with under RHN Satellite or Red Hat Network Classic. Example: cred:REDHAT_SUBSCRIBER_USERNAME

Remote Server

Configures an instance to forward its log data to a remote server. Specify either the remote server's FQDN or IP address. Example: syslog.example.com or 192.168.0.1

Repository Branch/Tag/Commit

The specific branch, tag, or commit (SHA) of the specified Git/Subversion repository that the application code will be retrieved from. For Git repositories, use 'master' to retrieve the master branch from the repository. For SVN repositories, use 'HEAD' to retrieve the latest changes from the repository. Example: mybranch

Repository Provider

Specify where the application code should be checked out from. Example: repo_git

Repository URL/ROS Container

The URL that points to the location of the repository that contains the application code. Or the name of the ROS container where a tarball of the application code will be retrieved from if you use 'repo_ros' provider. For Amazon S3, use the bucket name. Example: mycontainer, http://mysvn.net/app/ or git://github.com/username/myapp.git

SSL Certificate

The name of your SSL Certificate. Example: cred:SSL_CERT

SSL Certificate Chain

Your SSL Certificate Chain. Example: cred:SSL_CERT_CHAIN

SSL Certificate Key

Your SSL Certificate Key. Example: cred:SSL_KEY

SSL Enable

Enables SSL ('https'). Example: true

SSL Passphrase

Your SSL passphrase. Example: cred:SSL_PASSPHRASE

Secondary Backup Secret (default)

Secondary cloud authentication credentials. For Rackspace Cloud Files, use your Rackspace account API key (e.g., cred:RACKSPACE_AUTH_KEY). For Amazon S3, use your Amazon secret key (e.g., cred:AWS_SECRET_ACCESS_KEY). Example: cred:CLOUD_ACCOUNT_KEY

Secondary Backup Storage Cloud (default)

The secondary backup storage cloud. (See complete list of supported storage locations in input dropdown). Example: s3

Secondary Backup Storage Cloud Endpoint URL (default)

The endpoint URL for the secondary backup storage cloud. This is used to override the default endpoint or for generic storage clouds such as Swift. Example: http://endpoint_ip:5000/v2.0/tokens

Secondary Backup Storage Container (1)

The secondary backup storage container where the backup will be saved to or restored from. For Amazon S3, use the bucket name. For Rackspace Cloud Files, use the container name. Example: db_backup_bucket

Secondary Backup Storage Container (2)

The secondary backup storage container where the backup will be saved to or restored from. For Amazon S3, use the bucket name. For Rackspace Cloud Files, use the container name. Example: db_backup_bucket

Secondary Backup User (default)

Secondary cloud authentication credentials. For Rackspace Cloud Files, use your Rackspace login username (e.g., cred:RACKSPACE_USERNAME). For OpenStack Swift the format is: 'tenantID:username'. For Amazon S3, use your Amazon key ID (e.g., cred:AWS_ACCESS_KEY_ID). Example: cred:CLOUD_ACCOUNT_USERNAME

Short Hostname

The short hostname that you would like this node to have. Example: myhost

Slave Backup Cron Hour

By default, primary backups of the slave database are taken hourly. However, if you specify a value in this input (e.g., 23 for 11:00 PM), then backups will occur once per day at the specified hour, rather than hourly. Example: 23.

Slave Backup Cron Minute

Defines the minute of the hour when the backup EBS snapshot will be taken of the slave database. Backups of the slave are taken hourly. By default, a minute will be randomly chosen at launch time. Uses standard crontab format (e.g., 30 for minute 30 of the hour). Example 30

Slave Secondary Backup Cron Hour

By default, secondary backups of the slave database are taken hourly. However, if you specify a value in this input (e.g., 23 for 11:00 PM), then backups will occur once per day at the specified hour, rather than hourly. Uses standard crontab format (e.g., 23 for 11:00 PM).

Slave Secondary Backup Cron Minute

Defines the minute of the hour when the secondary backup will be taken of the slave database. Backups of the slave are taken hourly. By default, a minute will be randomly chosen at launch time. Uses standard crontab format (e.g., 30 for minute 30 of the hour). Uses standard crontab format (e.g., 30 for minute 30 of the hour).

Status Page Password

The password that is required to access the load balancer statistics report page. Example: cred:STATS_PASSWORD

Status Page Username

The username that is required to access the load balancer statistics report page. Example: cred:STATS_USER

Status URI

The URI for the load balancer statistics report page. This page lists the current session, queued session, response error, health check error, server status, etc. for each load balancer group. Example: /haproxy-status

Storage Cloud Endpoint URL

The endpoint URL for the storage cloud. This is used to override the default endpoint or for generic storage clouds such as Swift. Example: http://endpoint_ip:5000/v2.0/tokens

Swap size in GB

Creates and activates a swap file based on the selected size (in GB). Note: The swap added by this file will be in addition to any swap defined in the image. Example: 1.0

Swapfile location

The location of the swap file. Example: /mnt/ephemeral/swapfile

Terminate Safety

Prevents the accidental running of the 'db::do_teminate_server' recipe. This recipe will only run if this input variable is overridden and set to "off". Example: text:off

Timezone

Sets the system time to the timezone of the specified input, which must be a valid zoneinfo/tz database entry. If the input is 'unset' the timezone will use the 'localtime' that's defined in your RightScale account under Settings -> User Settings -> Preferences tab. You can find a list of valid examples from the timezone pulldown bar in the Preferences tab. Example: US/Pacific

Tomcat Internal Port

Sets the internal port on which Tomcat listens. By default, Tomcat listens on localhost port 8080. WARNING: The value for this input should NOT be the same as the value in 'app/port' input as it would conflict with the Apache listen port and would cause a fatal error when the apache service is started.

Tomcat Java MaxNewSize

The java MaxNewSize argument. Example: 256m

Tomcat Java MaxPermSize

The java MaxPermSize argument. Example: 256m

Tomcat Java NewSize

The java NewSize argument. Example: 256m

Tomcat Java PermSize

The java PermSize argument. Example: 256m

Tomcat Java XMS

The java Xms argument. Example: 512m

Tomcat Java XMX

The java Xmx argument. Example: 512m

Total Volume Size (1)

Defines the total size of the LVM volume stripe set (in GB). For example, if the stripe_count is '3' and you specify '3' for this input, it will create an LVM volume stripe that contains 3 volumes that are each 1 GB in size. If an uneven ratio is defined, volume sizes will be rounded up to the nearest whole integer. Ignored on clouds that do not support volumes (e.g., Rackspace). Example: 10

Total Volume Size (2)

Defines the total size of the LVM volume stripe set (in GB). For example, if the stripe_count is '3' and you specify '3' for this input, it will create an LVM volume stripe that contains 3 volumes that are each 1 GB in size. If an uneven ratio is defined, volume sizes will be rounded up to the nearest whole integer. Ignored on clouds that do not support volumes (e.g., Rackspace). Example: 10

Use Session Stickiness

Determines session stickiness. Set to 'True' to use session stickiness, where the load balancer will reconnect a session to the last server it was connected to (via a cookie). Set to 'False' if you do not want to use sticky sessions; the load balancer will establish a connection with the next available server. Example: true

Volume Type

The type of the volume - SATA or SSD. This attribute is supported only on Rackspace Open Cloud. Example: SATA

War file for ROOT

The path to the war file relative to project repo root directory. Will be renamed to ROOT.war. Example: /dist/app_test.war

Revision History

Revision Date Published Description of Changes Known Issues
2 Aug 30, 2013 Initial release. See v13.5 LTS Release Notes. N/A

See also

You must to post a comment.
Last modified
14:17, 11 Sep 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.