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

Memcached Server (v13 Infinity) - Reference

Table of Contents
  1. Info
  2. Images
  3. Scripts
  4. Inputs
    1. Backup Cron Hour (1)
      1. Backup Cron Hour (2)
        1. Backup Cron Minute (1)
        2. Backup Cron Minute (2)
        3. Backup Lineage (1)
        4. Backup Lineage (2)
        5. Backup Lineage Override
        6. Backup Max Snapshots (1)
        7. Backup Max Snapshots (2)
        8. Backup Restore Timestamp Override (1)
        9. Backup Restore Timestamp Override (2)
        10. Block Device Mount Directory (1)
        11. Block Device Mount Directory (2)
        12. Block Device(s) to Operate On
        13. Domain Name
        14. Domain Search Suffix
        15. Enable security updates
        16. Ephemeral File System Type
        17. Firewall
        18. Firewall Rule
        19. Firewall Rule IP Address
        20. Firewall Rule Port
        21. Firewall Rule Protocol
        22. Force Reset Safety
        23. I/O Operations per Second (1)
        24. I/O Operations per Second (2)
        25. Keep Daily Backups (1)
        26. Keep Daily Backups (2)
        27. Keep Monthly Backups (1)
        28. Keep Monthly Backups (2)
        29. Keep Weekly Backups (1)
        30. Keep Weekly Backups (2)
        31. Keep Yearly Backups (1)
        32. Keep Yearly Backups (2)
        33. Logging Protocol
        34. Memcached Cache size percentage
        35. Memcached TCP Port
        36. Memcached UDP Port
        37. Memcached cluster_id
        38. Memcached connection limit
        39. Memcached listening interface
        40. Memcached logging output level
        41. Memcached used threads
        42. Memcached user
        43. NTP Servers
        44. Nickname (1)
        45. Nickname (2)
        46. Number of Volumes in the Stripe (1)
        47. Number of Volumes in the Stripe (2)
        48. Percentage of the LVM used for data (1)
        49. Percentage of the LVM used for data (2)
        50. Percentage of the ephemeral LVM used for data
        51. Primary Backup Secret (default)
        52. Primary Backup Storage Cloud (default)
        53. Primary Backup Storage Cloud Endpoint URL (default)
        54. Primary Backup User (default)
        55. Private SSH Key
        56. Process List
        57. Process Match List
        58. Rackspace API Key
        59. Rackspace SNET Enabled for Backup
        60. Rackspace Tenant ID
        61. Rackspace Username
        62. RedHat Network Password
        63. RedHat Network Username
        64. Remote Server
        65. SSL Certificate
        66. Secondary Backup Secret (default)
        67. Secondary Backup Storage Cloud (default)
        68. Secondary Backup Storage Cloud Endpoint URL (default)
        69. Secondary Backup Storage Container (1)
        70. Secondary Backup Storage Container (2)
        71. Secondary Backup User (default)
        72. Short Hostname
        73. Terminate Safety
        74. Timezone
        75. Total Volume Size (1)
        76. Total Volume Size (2)
        77. Volume Type
  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:44:55 +0000
MultiCloud Marketplace: http://www.rightscale.com/library/se.../lineage/17146

  • 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 installs Memcached, which can be used as a caching layer to improve the performance of your cloud-based multi-tier application.

Documentation:  
Release Notes
    Application versions: * Memcached 1.4 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, Google, 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_CentOS_6.4_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, Google, HP Cloud, Rackspace, Rackspace Managed, Rackspace Open Cloud - Chicago, Rackspace Open Cloud - Dallas, Rackspace Open Cloud - London, Rackspace Open Cloud - Sydney, Rackspace UK
  • RightImage_CentOS_6.4_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_CentOS_6.4_x64_v13.5_LTS_HVM_EBS
    • AWS AP-Tokyo, AWS EU, AWS US-East, AWS US-Oregon
  • RightImage_CentOS_6.4_x64_v13.5_LTS_KVM
    • CloudStack default, Datapipe Hong Kong, Datapipe London, Datapipe New York Metro, Datapipe Silicon Valley, OpenStack default
  • RightImage_CentOS_6.4_x64_v13.5_LTS_VMware
    • None
  • RightImage_CentOS_6.4_x64_v13.5_LTS_XenServer
    • None
  • RightImage_RHEL_6.4_x64_v13.5_LTS
    • Rackspace Open Cloud - Chicago, Rackspace Open Cloud - Dallas, Rackspace Open Cloud - London, Rackspace Open Cloud - Sydney
  • RightImage_RHEL_6.4_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
    • 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_CentOS_6.4_x64_v13.5_LTS
    • None
  • SoftLayerImage_Storage_CentOS_6.4_x64_v13.5_LTS
    • None
  • SoftLayerImage_Storage_Ubuntu_12.04_x64_v13.5_LTS
    • None
  • SoftLayerImage_Ubuntu_12.04_x64_v13.5_LTS
    • None

Scripts

Inputs

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

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

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 Reset Safety

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

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

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

Logging Protocol

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

Memcached Cache size percentage

Set the amount of memory allocated to memcached for object storage in percentage from total system memory. Example: 80

Memcached TCP Port

The TCP port to use for connections. Example: 11211

Memcached UDP Port

The UDP port to use for connections. Example: 11211

Memcached cluster_id

Used to associate server with a memcached cluster. Example: cache_cluster

Memcached connection limit

Option to either reduce the number of connections (to prevent overloading memcached service) or to increase the number making more effective use of the server running memcached. Example: 1024

Memcached listening interface

Interface used for memcached connections. Example: any

Memcached logging output level

Without the verbose options, memcached normally produces no output during normal operating. Example: off

Memcached used threads

The number of threads to use when processing incoming requests. Example: 4

Memcached user

The user for executing memcached. Example: nobody

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*

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.

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

SSL Certificate

Specify the SSL Certificate to enable authentication with stunnel. Should contain both certificate and key. Certificate should be provided for both the Clients and the Logging Server. Example: cred:LOGGING_SSL_CRED

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

Terminate Safety

Prevents the accidental running of the block_device::do_teminate_server recipe.The recipe will only run if the 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

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

Volume Type

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

Revision History

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

See also

    You must to post a comment.
    Last modified
    12:45, 24 Oct 2013

    Tags

    This page has no custom tags.

    Classifications

    This page has no classifications.

    Announcements

    None

    Powered by MindTouch ®

    © 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.