Logged in: Logged in as: Log in
Register
call_us_today.gif

subscribe_rss.gif
Search:
Page last modified 02:12, 5 Dec 2008 by deano
RightScale Support Wiki > References > RightScale > RightScale Dashboard > General Topics > List of Inputs

List of Inputs

Table of contents
  1. 1. Apache
        1. 1.1.1.1. APACHE_MPM
        2. 1.1.1.2. OPT_MAINTENANCE_CONTENTS
        3. 1.1.1.3. OPT_MAINTENANCE_PAGE
        4. 1.1.1.4. OPT_SERVE_LOCAL_FILES
        5. 1.1.1.5. OPT_TARGET_BIND_ADDRESS
        6. 1.1.1.6. OPT_TARGET_BIND_PORT
        7. 1.1.1.7. OPT_TZINFO
        8. 1.1.1.8. OPT_VHOST_PORT
        9. 1.1.1.9. OPT_WWW_DOCUMENT_ROOT
        10. 1.1.1.10. OPT_WWW_LOG_DIR
        11. 1.1.1.11. WEBSITE_DNS
  2. 2. Application
        1. 2.1.1.1. APPLICATION
        2. 2.1.1.2. APPLICATION_CODE_BUCKET
        3. 2.1.1.3. APPLICATION_CODE_PACKAGE
        4. 2.1.1.4. OPT_SVN_PASSWORD
        5. 2.1.1.5. OPT_SVN_USERNAME
        6. 2.1.1.6. OPT_SVN_CHECKOUT_MODE
        7. 2.1.1.7. SVN_APP_REPOSITORY
  3. 3. AWS Credentials
        1. 3.1.1.1. AWS_ACCESS_KEY_ID
        2. 3.1.1.2. AWS_SECRET_ACCESS_KEY
  4. 4. Database
        1. 4.1.1.1. BACKUPFILE_PREFIX
        2. 4.1.1.2. BACKUP_S3_BUCKET
        3. 4.1.1.3. DBADMIN_PASSWORD
        4. 4.1.1.4. DBADMIN_USER
        5. 4.1.1.5. DBAPPLICATION_PASSWORD
        6. 4.1.1.6. DBAPPLICATION_USER
        7. 4.1.1.7. DBREPLICATION_PASSWORD
        8. 4.1.1.8. DBREPLICATION_USER
        9. 4.1.1.9. DB_HOST_NAME
        10. 4.1.1.10. DB_SCHEMA_NAME
        11. 4.1.1.11. DB_SERVER_FOOTPRINT (deprecated)
        12. 4.1.1.12. DB_SERVER_USAGE
        13. 4.1.1.13. INIT_SLAVE_AT_BOOT (deprecated)
        14. 4.1.1.14. MASTER_DB_DNSID
        15. 4.1.1.15. MASTER_DB_DNSNAME
        16. 4.1.1.16. OPT_BACKUP_SLAVE_ROTATION_SIZE
        17. 4.1.1.17. OPT_COMPRESS_SLAVE_BACKUPS
        18. 4.1.1.18. OPT_MYSQL_MAX_CONNECTIONS
        19. 4.1.1.19. OPT_VOLUME_SIZE_GB
        20. 4.1.1.20. SLAVE_DB_DNSID
  5. 5. DNS
        1. 5.1.1.1. ADDR_TYPE (deprecated)
        2. 5.1.1.2. DNS_ID (deprecated)
        3. 5.1.1.3. DNSMADEEASY_PASSWORD
        4. 5.1.1.4. DNSMADEEASY_USER
        5. 5.1.1.5. EXTERNAL_DNS_ID
  6. 6. EBS
        1. 6.1.1.1. DB_BACKUP_KEEP_LAST
        2. 6.1.1.2. DB_BACKUP_MASTER_FREQ
        3. 6.1.1.3. DB_BACKUP_SLAVE_FREQ
        4. 6.1.1.4. DB_EBS_PREFIX
        5. 6.1.1.5. DB_RESTORE_PREFIX_OVERRIDE
        6. 6.1.1.6. OPT_LVM_DRIVES
        7. 6.1.1.7. OPT_LVM_SIZE
  7. 7. HAProxy
        1. 7.1.1.1. LB_APPLISTENER_NAME
        2. 7.1.1.2. LB_BACKEND_NAME
        3. 7.1.1.3. LB_BIND_ADDRESS
        4. 7.1.1.4. LB_BIND_PORT
        5. 7.1.1.5. LB_HOSTNAME
        6. 7.1.1.6. LB_TEMPLATE_NAME
        7. 7.1.1.7. HEALTH_CHECK_URI
        8. 7.1.1.8. MAX_CONN_PER_SERVER
        9. 7.1.1.9. OPT_HEALTH_CHECK_URI (deprecated)
        10. 7.1.1.10. OPT_HAPROXY_COLLECTD_INTERVAL
        11. 7.1.1.11. OPT_LB_STATS_PASSWORD
        12. 7.1.1.12. OPT_LB_STATS_URI
        13. 7.1.1.13. OPT_LB_STATS_USER
        14. 7.1.1.14. OPT_LB_STATS_USER
        15. 7.1.1.15. OPT_SESSION_STICKINESS
  8. 8. Monitoring
        1. 8.1.1.1. MON_PROCESSES
        2. 8.1.1.2. OPT_GEMS_LIST
        3. 8.1.1.3. OPT_HAPROXY_COLLECTD_INTERVAL
  9. 9. PHP
        1. 9.1.1.1. OPT_PHP_ENABLE
        2. 9.1.1.2. PHP_MODULES_LIST
  10. 10. Rails
        1. 10.1.1.1. OPT_MONGREL_CONFIG_SCRIPT
        2. 10.1.1.2. OPT_MONGREL_LOG_DIR
        3. 10.1.1.3. RAILS_ENV
  11. 11. TomCat
        1. 11.1.1.1. ENABLE_TOMCAT_NATIVE_APR
        2. 11.1.1.2. OPT_MOD_JK_ENABLE
        3. 11.1.1.3. TOMCAT_MANAGER_PASSWORD
        4. 11.1.1.4. TOMCAT_MANAGER_USER
  12. 12. Web Server
        1. 12.1.1.1. APP_SERVER_PORT
        2. 12.1.1.2. APP_SERVER_PROCESSES
        3. 12.1.1.3. APP_SERVER_START_PORT
  13. 13. Misc.
        1. 13.1.1.1. PRIVATE_SSH_KEY
        2. 13.1.1.2. SYSLOG_SERVER

 

Where should I define my inputs?
Inputs that are defined at the deployment level will be used for all servers in the deployment and will override input parameters that are defined at the ServerTemplate level.  Inputs that are defined at the individual server level will override input parameters that are defined at the deployment and ServerTemplate level.

 

What's the difference between Inputs, Scripts, and Script Inputs?
The Inputs tab defines the input parameters that will be used when a new instance is launched.  The Scripts tab defines the boot and operational scripts of the running instance.  The Script Inputs tab defines the input parameters for a running instance.  If you change an input parameter under the Script Inputs tab, it will only change the input value on the running instance.  If you want the modified value to be used when new servers are launched, you need to make the same change under the Inputs tab.
     

Apache

The following parameters configure the Apache settings for the front-end machines.

ADMIN_EMAIL

Provide the email address that will receive apache notifications.
Text : admin@mysite.com

APACHE_MPM

This setting tells Apache whether to use the threaded "worker" or to prefork. 
Use worker for Rails/TomCat/Standalone front ends. 
Use prefork for PHP.
The full documentation can be found in Apache official site. 
Text :

OPT_MAINTENANCE_CONTENTS

Description
Text : 

OPT_MAINTENANCE_PAGE

The URI for the HAProxy maintenance page.  URI is based on the document root path.
Text : 

OPT_SERVE_LOCAL_FILES

This option tells Apache whether it should serve the (static) content itself.  Currently it will omit dynamic PHP and TomCat content (*.php, *.action, *.jsp, *do).
$ignore

OPT_TARGET_BIND_ADDRESS

Apache will redirect requests to this IP address.
$ignore

OPT_TARGET_BIND_PORT

Apache will redirect requests to the associated port of OPT_TARGET_BIND_ADDRESS.
$ignore

OPT_TZINFO

Set the timezone of the instance.  The format follows standard timezone naming conventions (UTC, PST, EST, GMT, US/Eastern, America/Los_Angeles, etc.)  See TZSET for more details.  Default: UTC
Text: UTC

OPT_VHOST_PORT

Define the optional, main virtual host port by using this input. This is often used by the application server template.
Text: 8088

OPT_WWW_DOCUMENT_ROOT

The location where you want your application to be installed. Default: /home/webapps/$application/current
$ignore

OPT_WWW_LOG_DIR

The optional document root where the Apache log will be stored.  Default: /var/log
$ignore

WEBSITE_DNS

The host (server) name of this virtual host.  This is the public address of your frontends.
Text : www.mysite.com


Application

The template will automatically deploy your application with these specified values.

APPLICATION

Define the name of your application.
Text : my_app

APPLICATION_CODE_BUCKET
The location where the application can be retrieved.  Provide the name of the S3 bucket where the application is stored. 
Text : my_app_bucket
APPLICATION_CODE_PACKAGE
The name of the application tarball (.war, .tar.gz, .zip, etc) that can be retrieved from the S3 bucket.
Text : my_app.war
OPT_SVN_PASSWORD

Your SVN password.
Text : 

OPT_SVN_USERNAME

Your SVN username.
Text : 

OPT_SVN_CHECKOUT_MODE

The SVN mode (export or checkout) that you would like to get your files in.  Export is more secure but Checkout allows you to make changes and update them.
Text : export

SVN_APP_REPOSITORY

The pointer to your SVN server.  ex: http://url.of.your.svn.server.com/path/to/branch
Text : 

 

AWS Credentials

Since we want to create backups of our database in S3, the templates require that you include your Amazon keys. 

AWS_ACCESS_KEY_ID

Your AWS access key ID.
Cred : Select your AWS Access Key ID

AWS_SECRET_ACCESS_KEY

Your AWS access key.
Cred : Select your Secret Access Key

 

Database

The template will automatically generate your database.yml file with these specified values.

BACKUPFILE_PREFIX

The prefix that will be used for creating the backup filename. These parameters tell the Master-DB where to place the backups in S3. When backups are taken, the files will be named with the prefix that you define followed by a timestamp of when they were created so that you can easily verify the most recent backup.  You can define whatever prefix that you want to use.  Remember, you cannot use spaces in an S3 bucket's filename.
Text : production

BACKUP_S3_BUCKET

The name of the S3 bucket where database backups will be stored.
Text : mysite_bucket

DBADMIN_PASSWORD

The Administrator's password that is used to access the database.
Cred : 

DBADMIN_USER

The Administrator's username that is used to access the database.
Cred : 

DBAPPLICATION_PASSWORD

The password that users of the database will use to access your database.  This value is used to set up the connection between the database and the application.  You must use the same value that was defined in the Create a Redundant MySQL Setup tutorial.
Cred : 

DBAPPLICATION_USER

The username that users of the database will use to access your database. This value is used to set up the connection between the database and the application.You must use the same value that was defined in the Create a Redundant MySQL Setup tutorial.
Cred : 

DBREPLICATION_PASSWORD

The password that will be used by a slave database in order to replicate data from the master database.
Cred :

DBREPLICATION_USER

The username that will be used by a slave database in order to replicate data from the master database.
Cred :

DB_HOST_NAME

The internal DNS name of your Master-DB.
Text : 

DB_SCHEMA_NAME

The name of the database that is used by the application, i.e. the schema of your database.
Text : app_schema_name

DB_SERVER_FOOTPRINT (deprecated)

This parameter defines which MySQL config that you want to use. Set the it to dedicated-small, dedicated-large, or dedicated-xlarge depending on whether you are running a small, large or extra large instance respectively. The default is small. If you are not sure, you can double-check under the Info tab of the server.
Text : dedicated-small

DB_SERVER_USAGE

Describes how the server will be used.   The server is either a dedicated MySQL server or a shared MySQL server with other processes on the operating system.  Make your selection from the pulldown menu.
Text : dedicated 

INIT_SLAVE_AT_BOOT (deprecated)

Defines whether this instance should automatically initialize a Slave-DB at boot time.  To make sure that the Slave-DB automatically initializes itself when it boots, set the INIT_SLAVE_AT_BOOT input parameter to True (default). Set to False if you do not want it to initialize at boot time.  The only case where you would want to do this is if you don't already have a Master-DB instance running and you want to launch a Slave-DB.
Text : true

MASTER_DB_DNSID

The DNS ID (Record ID) of the Master-DB.  This value is generated when you create a subdomain using DNSMadeEasy.  It's used to update the DNS record to point to the new Master IP address.  ex: db-master.mysite.com
Text :  

MASTER_DB_DNSNAME

The DNS name of the Master-DB.
Text : master1.mysite.com

OPT_BACKUP_SLAVE_ROTATION_SIZE

Defines the number of revolving backups for the Slave-DB to take. If you leave this parameter undefined, the default value (6) will be used. i.e. Only the last 6 backups will be saved to S3. The oldest backup is overwritten in order to write the new backup.  By default, snapshots (backups) of a slave database are taken every 10 minutes.  Default: 6
$ignore

OPT_COMPRESS_SLAVE_BACKUPS

Set this value to "no" or "false" will disable the compression of these backups which will take some of the CPU load off the slave. Setting it to any other value will enable compression which will decrease the storage size on S3.   NOTE: You will only have to go to S3 in the event that you have no database server running or all running databases are corrupted.
$ignore

OPT_MYSQL_MAX_CONNECTIONS

Defines the maximum number of MySQL connections that you want to allow to the master database at any given time. Once your deployment is operational, you might want to define a limit.  Default: 500.
$ignore

OPT_VOLUME_SIZE_GB

The maximum amount of space (GB) to be partitioned to XFS format by LVM.  The size in gigabytes that you want /mnt to be formatted. This is a tradeoff between disk capacity and boot time since larger sizes will take longer to format. Set to "max" to get the full capacity.  Default: 60GB (small), 300GB (large, xlarge)
Text :  Max

SLAVE_DB_DNSID

The DNS-ID (Record ID) of the Slave-DB.  This value is used to update the DNS record to point to the new Slave IP address.  ex: db-master.mysite.comEnter the Slave-DB DNS ID for the SLAVE_DB_DNSID.
Text : 

 

DNS

In order to handle the possibility of a failure, we will need to use a DNS record to refer to the Master-DB and Slave-DB instances. Therefore, the server will need to access your DNSMadeEasy username and password.

ADDR_TYPE (deprecated)

This parameter defines whether you want to register the public or private IP address.
Text : public

DNS_ID (deprecated)

Leave this value empty in the deployment.  Values that are defined at the deployment level overwrite any child components. Therefore we need to define separate DNS IDs for each frontend.
Cred : Your User ID

DNSMADEEASY_PASSWORD

The username for you DNS Made Easy account.
Cred : Select your password

DNSMADEEASY_USER

The username for you DNS Made Easy account.
Cred : Select your User ID

EXTERNAL_DNS_ID

The DNS ID (Record ID) of the server is used to update the DNS record to point to the new server IP address.
Ignore : Leave Blank

 

EBS

The following parameters are defined in the "MySQL EBS" ServerTemplate.  See Elastic Block Store (EBS) or

DB_BACKUP_KEEP_LAST

Defines the total number of snapshots to keep of each master/slave instance.  The oldest snapshots will be deleted when the limit is reached.  Default = 60.   If you want to archive snapshots for weekly, monthly, yearly records, we recommend changing the name (by adding 'archive' as a prefix) so that its prefix will not match the DB_EBS_PREFIX and will be effectively "taken out" of the snapshot rotation.  Ex: Change 'mydb-master-YYYYMMDDHHMM' to 'archive-mydb-master-YYYYMMDDHHMM' where mydb = DB_EBS_PREFIX.
Text : 60

DB_BACKUP_MASTER_FREQ

Defines the frequency of EBS snapshots of the Master-DB.  By default, snapshots of the Master-DB are taken once every 4 hours.  You must wait for a snapshot to be 100% complete before it can be used when launching a new DB server.  The Cron string format consists of 5 values separated by spaces.  The backup will be executed when these values match the current time.  Use * for wildcard. 
Cron Format: minute(0-59) hour(0-23) month_day(1-31) month(1-12) week_day(0-7)
Text : 0 */4 * * *

DB_BACKUP_SLAVE_FREQ

Defines the frequency of EBS snapshots of the Slave-DB.  By default, snapshots of the Slave-DB are taken on an hourly basis.  You must wait for a snapshot to be 100% complete before it can be used when launching a new DB server.  The Cron string format consists of 5 values separated by spaces.  The backup will be executed when these values match the current time.  Use * for wildcard. 
Cron Format: minute(0-59) hour(0-23) month_day(1-31) month(1-12) week_day(0-7)
Text : 0 * * * *

DB_EBS_PREFIX

Defines the prefix that will be used when saving a snapshot of a DB volume or when choosing a snapshot to build a new volume when a new DB instance is launched.  Snapshots will be saved in the following format 'mydb-master-YYYYMMDDHHMM' where mydb = DB_EBS_PREFIX.   When a server is launched, it will use this prefix to find the most recent snapshot to generate a volume from and attach to the new DB instance.
Text :  

DB_RESTORE_PREFIX_OVERRIDE

Define an appropriate prefix to be used as an override of the DB_EBS_PREFIX.  Use this input is when you want to restore from a particular snapshot.  You can define an appropriate prefix to specify a particular point in time or copy and paste a snapshot's name to specify a specific snapshot.
Text :  

OPT_LVM_DRIVES

A placeholder for new EBS drives.  Set to 'internal' for all internal disk drives.
Text : internal

OPT_LVM_SIZE

The remounted EBS volume will use this percent of all disk space.  Default = max, where max = 60%.  i.e. Up to 60% of the disk capacity will be used, which reserves 40% free for database backups.%
Text : max

 

HAProxy

The following parameters configure HAProxy.

LB_APPLISTENER_NAME

Define the group name or listener of a pool of application servers where you want HAProxy to place the new app server.  When an application server connects to HAProxy, the application server tells HAProxy in which pool it should be placed.
Text : www

LB_BACKEND_NAME

A unique name of the application server that is connected to HAProxy.  HAProxy will use this name to identify each connected application server.  The name must be unique.
Env: EC2 _INSTANCE_ID

LB_BIND_ADDRESS

The IP address that you want HAProxy to listen on.  Normally, it is set to localhost (127.0.0.1). Default: 127.0.0.1
Text : 127.0.0.1

LB_BIND_PORT

The port number that you want HAProxy to listen on.  Default: 85  Each group must have a different port (or it can be the IP address (85).
Text : 85

LB_HOSTNAME

The hostname where HAProxy is installed, so application servers will know where they should be connected.  This value should be the same as the WEB_SITE_DNS value.
Text : www.mysite.com

LB_TEMPLATE_NAME

The basic HAProxy configuration template that should be used to configure HAProxy.  RightScale offers predefined haproxy_http and haproxy_tcp templates.  Default: haproxy_http
Text : haproxy_http

HEALTH_CHECK_URI

The path to the health-check script/page.
Text : 

MAX_CONN_PER_SERVER

The maximum number of connections per server.  HAProxy cannot send more requests to a server if it has reached its maximum number of connections.
Text : 255

OPT_HEALTH_CHECK_URI (deprecated)

See HEALTH_CHECK_URI.

OPT_HAPROXY_COLLECTD_INTERVAL

Sets the interval between each data collection from the HAproxy stats page.
Text : 

OPT_LB_STATS_PASSWORD

The password to access the HAProxy status page.
Text : 

OPT_LB_STATS_URI

The URI for the HAProxy status page (current session, queued session, response error, health check error, server status, etc.   HAProxy will display a status page for each HAProxy group.
Text :  /haproxy-status

OPT_LB_STATS_USER

The username to access the HAProxy status page.
Text : 

OPT_LB_STATS_USER

The username to access the HAProxy status page.
Text : 

OPT_SESSION_STICKINESS

This option tells whether HAProxy should do session stickiness.
Text : true


Monitoring

MON_PROCESSES

Extra processes that a user would like to monitor.  To monitor a specific process, set this input parameter as Text and input the name of the process(es). (space-separated)
Ignore : Leave Blank

OPT_GEMS_LIST

List of optional gem(s). (space-separated)
Key : production

OPT_HAPROXY_COLLECTD_INTERVAL

Set this value to a number of seconds for the collectd process to collect the data in each time interval. The result can be found in the HAproxymonitoring graph. Default: 10
$ignore


PHP

OPT_PHP_ENABLE

Set to "true" to enable Apache PHP module.
Set to "false" to disable Apache PHP module.
Text : true

PHP_MODULES_LIST

List of modules that you want to install.  (space-separated)  ex: php-mysql php-memcache php-gd
Text : php-mysql


Rails

OPT_MONGREL_CONFIG_SCRIPT
The configuration script that you want to run in order to determine the health status of the mongrels. ex: lib/mongrel_health_check_handler.rb
Text : 
OPT_MONGREL_LOG_DIR

An optional input overrides the log dir of mongrels (default: "rails_home"/log)
Text :

RAILS_ENV
Set up the Rails environment in the current workspace.
Text :  production

TomCat

ENABLE_TOMCAT_NATIVE_APR

Set to "true" to enable the native library for Apache Portable Runtime (APR).
Text :  true

OPT_MOD_JK_ENABLE

Set to "true" to enable Apache mod_jk for TomCat communication.  (TomCat FrontEnd Server)
Set to "false" to disable Apache mod_jk for TomCat communication. (PHP FrontEnd Server)
Text:

TOMCAT_MANAGER_PASSWORD

The password of the TomCat manager that will deploy the .war file via the TomCat interface.
Ignore : 

TOMCAT_MANAGER_USER

The username of the TomCat manager that will deploy the .war file via the TomCat interface.
Ignore : 


Web Server

APP_SERVER_PORT

The port of the application server where HAProxy will forward the requests.
Text : 8000

APP_SERVER_PROCESSES

The number of processes in the cluster for load balancing.
Text : 8

APP_SERVER_START_PORT

The port number of the first process in the cluster.
Text : 8000


Misc.

PRIVATE_SSH_KEY

The Slave-DB will need access to the Master-DB in order to take backups, so it will need the Master-DB's SSH key.
Key : production

SYSLOG_SERVER

Syslog is used to aggregate all of your log files. Use the default value: syslog.rightscale.com.
Text : syslog.rightscale.com

 

Tag page
What links here

Files 0

Attach file or image
 

Images 0

 
Viewing 1 of 1 comments: view all
#1
rubix says:
For the LB_BACKEND_NAME variable, make sure to use "EC2_INSTANCE_ID" (no spaces) rather than "EC2 _INSTANCE_ID" (a space after "EC2", which is how it is in this guide). It breaks the load balancer config setup if there's a space.
Posted 22:20, 10 Dec 2008
Viewing 1 of 1 comments: view all
You must login to post a comment.
Powered by MindTouch Deki Open Source Edition v.8.08.2