Note: Please go to docs.rightscale.com to access the current RightScale documentation set. Also, feel free to Chat with us!
Home > ServerTemplates > Archive > 11H1 > References > Database Manager with MySQL 5.0 Toolbox - 11H1

Database Manager with MySQL 5.0 Toolbox - 11H1

Table of Contents

  1. Info
  2. Images
  3. Scripts
  4. Inputs
  5. Revision History
  6. See also

Info

Current Revision: 16
MultiCloud Marketplace: https://www.rightscale.com/library/server_templates/Database-Manager-with-MySQL-5-/18668

  • Description - Basic MySQL 5.0 server that can be used for testing and troubleshooting purposes. Use the template's operational RightScripts to perform various maintenance, test, and diagnostic tasks. The use of this template's scripts requires the matching dbtools version for this compatibility release, which supports the striping of EBS volumes. Be sure to include the _"DB Rightscale tools install"_ RightScript as boot script to properly install these required tools.
  • Supported Clouds - AWS US-East, AWS US-West, AWS EU, AWS AP-Singapore, AWS AP-Tokyo

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_5.4_x64_v5.6 - 11H1
    • AWS US-East, AWS US-West, AWS EU, AWS AP-Singapore, AWS AP-Tokyo
  • RightImage_CentOS_5.4_i386_v5.6 - 11H1
    • AWS US-East, AWS US-West, AWS EU, AWS AP-Singapore, AWS AP-Tokyo

Scripts

Inputs

AWS_ACCESS_KEY_ID

The Access Key ID is an Amazon Access Credential that's used to authenticate your requests to AWS services. It's unique to your AWS Account Number. The Access Key ID and Secret Access Key are used to retrieve objects from an S3 bucket that are 'private'. Log into your AWS account at aws.amazon.com to retrieve your access identifiers. It's strongly recommended that you use a RightScale Credential (Design > Credentials) to hide the actual key value from non-admin users while still allowing them to pass the appropriate value as an input. Ex: 1JHQQ4KVEVM02KVEVM02

AWS_SECRET_ACCESS_KEY

The Secret Access Key is an Amazon Access Credential that's used to authenticate your requests to AWS services. It's unique to your AWS Account Number. The Access Key ID and Secret Access Key are used to retrieve objects from an S3 bucket that are 'private'. Log into your AWS account at aws.amazon.com to retrieve your access identifiers. It's strongly recommended that you use a RightScale Credential (Design > Credentials) to hide the actual key value from non-admin users while still allowing them to pass the appropriate value as an input. Ex: XVdxPgOM4auGcMlPz61IZGotpr9LzzI07tT8s2Ws

DBADMIN_PASSWORD

The password of the database user (DBADMIN_USER) that has "admin" privileges.

DBADMIN_USER

The username of the database user that has "admin" privileges.

DBAPPLICATION_PASSWORD

If the MySQL administrator set up a restricted MySQL account for application servers to access the database, then specify the password of that account for this input. If there is not a restricted MySQL account then use the same value that's used for DBADMIN_PASSWORD. The application server will then have unrestricted access to the database.

DBAPPLICATION_USER

If the MySQL administrator set up a restricted MySQL account for application servers to access the database, then specify the username of that account for this input. If there is not a restricted MySQL account then use the same value that's used for DBADMIN_USER. The application server will then have unrestricted access to the database.

DBREPLICATION_PASSWORD

The password that's used for replication between master and slave MySQL databases.

DBREPLICATION_USER

The username that's used for replication between master and slave MySQL databases.

DB_BINLOG_PREFIX

The prefix defines the filename and location of your MySQL stored binlog files. The prefix sets the log-bin variable in MySQL config file. If you do not specify an absolute path, it will be relative to the data directory. Ex: /mnt/mysql-binlogs/mysql-bin

DB_EBS_PREFIX

Used by MySQL EBS v1 (non-EBS stripe) ServerTemplates to both name and find backup EBS snapshots of a particular MySQL database. It's also used during a migration from a non-stripe to a striped MySQL EBS setup. This input is used to locate the non-EBS stripe backup that will be used to create an equivalent EBS stripe. When the associated script is executed, a new MySQL-EBS stripe will be created, however it will be of your old v1 database. The most recently completed backup will be used.

DB_EBS_SIZE_MULTIPLIER

Specifies the multiplying factor to be used for growing the storage space for your MySQL database during a migration from EBS to Striped EBS in order to provide room for your database to grow. Unless otherwise specified, the current size of the MySQL EBS volume will be doubled. (Default: 2) For example, if you have a 10GB EBS volume and want to transition to using an EBS stripe of two (EBS_Stripe_Count =2), the created EBS Stripe will be total of 20GB in size where each attached EBS volume will be 10GB.

DB_LINEAGE_NAME

The prefix that will be used to name/locate the backup EBS snapshots of a particular MySQL database. For example, if prefix is 'mydb', the filename will be 'mydb-master-timestamp' for a snapshot of your master database and 'mydb-slave-timestamp' for a snapshot of the slave. When you launch a Slave-DB or perform a database restoration, the prefix will be used to find the most recent MySQL EBS snapshot (default) or one that you've explicitly specified using the optional override inputs. (OPT_DB_RESTORE_LINEAGE_OVERRIDE and OPT_DB_RESTORE_TIMESTAMP_OVERRIDE) Each database's prefix should be unique. Ex: mydbprefix

DB_MYSQLDUMP_BUCKET

The S3 bucket where the MySQL database dump files will be stored to or restored from. The S3 bucket is specific to MySQL-S3 setups that are not using binary backups. Typically used for free developer ServerTemplates where binary backups are not supported.

DB_MYSQLDUMP_FILENAME

The filename of an existing MySQL database dumpfile (located in the DB_MYSQLDUMP_BUCKET) that will be used to create an EBS stripe for the first time. You will need to specify a full filename including the file extension. Ex: mydb-200910302212.gz

DB_SCHEMA_NAME

Enter the name of the MySQL database schema to which applications will connect. The database schema was created when the initial database was first set up. This input will be used to set the application server's database config file so that applications can connect to the correct schema within the database. This input is also used for MySQL dump backups in order to determine which schema is getting backed up. Ex: mydbschema

DB_SERVER_USAGE

Set this input to "dedicated" if it's a standalone MySQL server. Set to "shared" if you're launching an all-in-one server where there are other applications such as Apache, PHP, Rails, etc. also running on the server.

DNS_PASSWORD

The password that's used to access and modify your DNS A Records. For DNSMadeEasy and DynDNS, enter your password. (Ex: myPassw0rd) For AwsDNS, enter your AWS Secret Access Key. (Ex: XVdxPgOM4auGcMlPz61XVdxPgOM4auGcMlPz6)

DNS_USER

The username that's used to access and modify your DNS A Records. For DNSMadeEasy and DynDNS, enter your username. (Ex: myUsername) For AwsDNS, enter your AWS Access Key ID. (Ex: 1JHQQ4KVEVM1JHQQ4KVE)

EBS_STRIPE_COUNT

The total number of EBS volumes in the EBS stripe that will be used by the database. EBS volumes will be created and mounted to the instance. By default, a value of '1' will be used, which means only a single volume will be used (no striping). Only the predefined options have been tested.

EBS_TOTAL_VOLUME_GROUP_SIZE

Defines the total size of the striped EBS volume set (in GB). For example, a stripe count of '3' will create an EBS stripe that contains 3 EBS volumes that are each 1GB in size. If an uneven ratio is defined, volume sizes will be rounded up to the nearest whole integer.

MASTER_DB_DNSID

The unique identifier that's associated with the DNS A Record of the Master-DB. 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-DB when defining which server is the "master" database. If you are using DNSMadeEasy as your DNS provider, a 7-digit number is used. (Ex: 4403234)

MASTER_DB_DNSNAME

The fully qualified hostname for the MySQL Master-DB server. There must be a corresponding DNS A Record for the Master-DB server with your DNS provider (e.g. DNSMadeEasy). Application servers and Slave-DB servers will connect to the Master-DB by looking up the IP address that's mapped to the Master-DB's hostname. RightScale's scripts are designed to update the A Record with the Master-DB's private IP address. Ex: master.mydomain.com

MON_PROCESSES

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

MON_PROCESSMATCH

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

OPT_DB_FORCE_RESTORE

Determines how a database will be restored. Set to "false" to have the restore script fail if the database already exists. Set to "true" to overwrite existing content of the database. Use with caution! The value should normally be set to "ignore" or "false" to prevent the accidental destruction of a production database.

OPT_DB_MYSQL_TIMEOUT

Optional period of time to wait for a MySQL server to startup. When starting MySQL with large databases or on databases that need to rebuild tables, you may need to increase this value to prevent a MySQL server from timing out during startup.

OPT_DB_RESTORE_LINEAGE_OVERRIDE

If defined, it will override the input defined for DB_LINEAGE_NAME so that you can restore the database from another backup that has as different DB_LINEAGE_NAME. The most recent completed snapshots will be used unless a specific timestamp value is specified for OPT_DB_RESTORE_TIMESTAMP_OVERRIDE. This input allows you to restore from a different set of snapshots however, the subsequent backups will use DB_LINEAGE_NAME to name the snapshots. Be sure to remove this input once the new master is operational. Ex: lineageoverride

OPT_DB_RESTORE_TIMESTAMP_OVERRIDE

If you are using OPT_DB_RESTORE_LINEAGE_OVERRIDE input in order to restore a specific snapshot, you can also specify the desired timestamp. If the timestamp override is undefined, the latest database backup in the lineage will be used. Ex: 200912141627

OPT_DB_RESTORE_VERSION_CHECKING

Determines if a snapshot version check is performed when performing a database restoration. Set to 'no' to disable version checking. Set to 'true' (default) to enable version checking.

OPT_MYSQL_MAX_CONNECTIONS

The maximum MySQL connection that can be established across the entire deployment. (Default: 500) You should adjust this carefully! Too many connections can consume large amounts of memory and crash your database.

PRIVATE_SSH_KEY

The private SSH Key of another instance that gets installed on this instance. It allows this instance to SSH into another instance to update the configuration files. Select input type "key" from the dropdown and then select an SSH key that is installed on the other instance. You must select an SSH Key where its private material is available.

SERVER_EIP

EC2 elastic IP address

SERVER_UUID

A value of 'env:RS_INSTANCE_UUID' is required for proper RightScale monitoring and logging.

SKETCHY

A value of 'env:RS_SKETCHY' is required to use RightScale monitoring servers.

SLAVE_DB_DNSID

The unique identifier that's associated with the DNS A Record of the Slave-DB. 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 Slave-DB. If you are using DNSMadeEasy as your DNS provider, a 7-digit number is used. (Ex: 4403234)

SYSLOG_SERVER

The hostname of the syslog server where log files will be sent. This input should be set to 'env:RS_SYSLOG' so that you can view your log files in the Dashboard.

SYS_TZINFO

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 -> Preferences tab. You can find a list of valid examples from the timezone pulldown bar in the Preferences tab. Ex: US/Pacific, US/Eastern

Revision History

Revision Date Published Description of Changes Known Issues
16 Apr 07, 2011 Fixed DB restore (w3779)  
14 Mar 22, 2011 Initial Release -- 11H1 (w3779) The "DB Create MySQL EBS stripe volume - 11H1" script failed when importing a dump file from an S3 bucket. A false error was being raised because the script checked for an incorrect return.

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

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.