Note: If you cannot find a topic, go to docs.rightscale.com where all RightScale documentation will soon be located. Also, feel free to Chat with us!
Home > Partners > Integral R&D > Documentation > Asset Runbook for Joomla

Asset Runbook for Joomla

Objective

To understand how to use all of the scripts, inputs, and operational procedures required to run the Integral R&D ServerTemplates.

Table of Contents

  1. Objective
  2. Overview
  3. Setup Guide
    1. Import the ServerTemplate
    2. Configure and Launch the Server
  4. Scripts and Inputs
    1. Boot Scripts
      1. RightScript:  SYS Timezone set
      2. RightScript:  SYS Syslog remote logging client
      3. RightScript:  MAIL Postfix local delivery
      4. RightScript:  SYS Monitoring install
      5. RightScript:  RB Install s3sync
      6. RightScript: DB MySQL 5.1 server install
      7. RightScript:  IRD SAFE DB MySQL s3 mysqldump import
      8. RightScript:  DB Application Privileges set
      9. RightScript:  WEB Apache base install
      10. RightScript:  WEB PHP install
      11. RightScript:  IRD WEB install php packages
      12. RightScript:  WEB Apache vhost non-rails configure
      13. RightScript:  IRD JOOMLA Install web application
      14. RightScript:  IRD JOOMLA Initial configuration
      15. RightScript:  SYS Monitoring MYSQL add
      16. RightScript:  SYS Monitoring Apache add
      17. RightScript:  DB MySQL s3 continuous mysqldump backups
      18. RightScript:  DB MySQL s3 continuous application backups
    2. Operational Scripts
      1. RightScript:  DB MySQL s3 mysqldump backup
      2. RightScript:  WEB Apache (re)start
      3. RightScript:  IRD JOOMLA backup to s3 (code and data)
    3. Decommission Scripts
  5. Common Runbook Operations
    1. Ensuring that your Joomla Server Started Correctly
    2. Ensure that server file and database backup and restore operate correctly
  6. See also

Overview

The Joomla ServerTemplate published by Integral R&D configures a basic Joomla 1.5 LAMP server (Linux, Apache, MySQL, PHP) with additional features. The server configures itself by automatically downloading and installing a (configurable) Joomla base application package on first boot. The server is configured to take continuous backups of both the files and database, saving them to your S3 bucket daily. Suitable for single server (non redundant) production purposes.

Setup Guide

Import the ServerTemplate

Go to Design -> MultiCloud Marketplace -> ServerTemplates. Use the search tool to find and import the most recent revision of the appropriate Joomla ServerTemplate published by "Integral R and D."  The ServerTemplates are available for use to all RightScale users.

  • Joomla 1.6 LAMP All-In-One 11H1 v1  (Free)
  • Joomla 1.5 LAMP All-In-One 11H1 v1  (Free)
  • Joomla FLEX LAMP All-In-One 11H1 v3  (Free)

A copy of the ServerTemplate will be saved in your RightScale account’s local collection. (Design -> ServerTemplates).

Configure and Launch the Server

Once you've imported the ServerTemplate you can use it to add a new Server to a Deployment.  Define any missing inputs at the Deployment level.  Launch the server.

Scripts and Inputs

Please note: The Joomla 1.5 and 1.6 ServerTemplates share the same set of RightScripts and Inputs. There is a RightScript within the 1.6 ServerTemplate called “IRD JOOMLA-16 initial configuration” which makes special server configurations specific to Joomla 1.6.

Boot Scripts

The following boot scripts are listed in order and are based off of the ServerTemplates. For more information, please see Integral R&D's technical documentation here: RightScale Premium All-In-One Joomla ServerTemplate

RightScript:  SYS Timezone set

Description:  Sets the Timezone information.

Required Inputs and Default Settings:

  • SYS_TZINFO - Sets the system timezone to the timezone of the specified input.
RightScript:  SYS Syslog remote logging client

Description:  Configures the server for remote logging.

Required Inputs and Default Settings:

  • SERVER_UUID - Required for RightScale monitoring and logging.
  • SYSLOG_SERVER - The hostname of the syslog server where log files will be sent to.
RightScript:  MAIL Postfix local delivery

Description:  Configures the server for MAIL Postfix local delivery.

Required Inputs and Default Settings:

  • -none-
RightScript:  SYS Monitoring install

Description:  Configures the server to enable monitoring with RightScale.

Required Inputs and Default Settings:

  • MON_PROCESSES - A space-separated list of additional processes to monitor in the RightScale dashboard.
  • MON_PROCESSMATCH - A space-separated list of pairs used to match the names of additional processes to monitor in the RightScale Dashboard.
  • SERVER_UUID - Required for proper RightScript monitoring and logging.
  • SKETCHY - Required to use RightScale monitoring services.
RightScript:  RB Install s3sync

Description:  Installs the Ruby s3sync packages.

Required Inputs and Default Settings:

  • -none-
RightScript: DB MySQL 5.1 server install

Description:  Installs MySQL 5.1

Required Inputs and Default Settings:

  • DB_BINLOG_PREFIX - The prefix defines the filename and location of your MySQL stored binlogs.
  • DB_SERVER_USAGE - Defines whether this is a shared or standalone MySQL server.
  • OPT_DB_MYSQL_TIMEOUT - Optional period of time to wait for MySQL to start up.
  • OPT_MYSQL_MAX_CONNECTIONS - The maximum number of MySQL connections that can be established across your deployment.
RightScript:  IRD SAFE DB MySQL s3 mysqldump import

Description:  Configures the server to allow for importing MySQL dumps.

Required Inputs and Default Settings:

  • AWS_ACCESS_KEY_ID - Your AWS Access Key ID. Used for writing and reading from S3.
  • AWS_SECRET_ACCESS_KEY - Your AWS Secret Access Key. Used for writing and reading from S3.
  • DB_MYSQLDUMP_BUCKET - The S3 bucket where your MySQL dumps will be stored to or restored from.
  • DB_MYSQLDUMP_PREFIX - Defines the prefix for the MySQL dump filename.
  • DB_SCHEMA_NAME - The name for the MySQL DB schema for which the application will connect.
RightScript:  DB Application Privileges set

Description: Configures the application privileges for MySQL.

Required Inputs and Default Settings:

  • DBAPPLICATION_PASSWORD - The password for the MySQL database.
  • DBAPPLICATION_USER - The username for the MySQL database.
RightScript:  WEB Apache base install

Description: Installs Apache Web Server.

Required Inputs and Default Settings:

  • ADMIN_EMAIL - The email address that Apache uses to send administrative mail.
  • APACHE_MPM - Defines the setting in http.conf
RightScript:  WEB PHP install

Description: Installs PHP onto the server.

Required Inputs and Default Settings:

  • OPT_PHP_MODULES_LIST - Optional PHP modules to install.
RightScript:  IRD WEB install php packages

Description: A custom script developed by Integral R&D for installing PHP packages.

Required Inputs and Default Settings:

  • -none-
RightScript:  WEB Apache vhost non-rails configure

Description: Configures Apache for non-rails configurations.

Required Inputs and Default Settings:

  • ADMIN_EMAIL - The email address that Apache uses to send administrative mail.
  • APPLICATION - Sets the directory for your application’s web files.
  • WEBSITE_DNS - The fully qualified domain name that the web server will accept traffic for.
RightScript:  IRD JOOMLA Install web application

Description: Installs Joomla.

Required Inputs and Default Settings:

  • APPLICATION - Sets the directory for your application’s web files.
  • APPLICATION_CODE_BUCKET - The name of the S3 bucket where the application tarball can be retrieved.
  • APPLICATION_CODE_PREFIX - S3 prefix for the Key of the code package.
  • APPLICATION_TARBALL_URL - Full URL to a tarbell for bootstrapping the application.
  • AWS_ACCESS_KEY_ID - Your AWS Access Key
  • AWS_SECRET_ACCESS_KEY - Your AWS Secret Access Key
RightScript:  IRD JOOMLA Initial configuration

Description: Configures Joomla.

Required Inputs and Default Settings:

  • ADMIN_EMAIL - The email address that Apache uses to send administrative mail.
  • APPLICATION - Sets the directory for your application’s web files.
  • APPLICATION_TARBALL_URL - Full URL to a tarbell for bootstrapping the application.
  • DBAPPLICATION_PASSWORD - The password for the MySQL database.
  • DBAPPLICATION_USER - The username for the MySQL database.
  • DB_SCHEMA_NAME - The name for the MySQL DB schema for which the application will connect.
  • JOOMLA_PASSWORD - Initial Joomla administration password.
  • MASTER_DB_DNSNAME - The fully qualified hostname for the MySQL Master-DB server.
RightScript:  SYS Monitoring MYSQL add

Description: Adds MySQL monitoring information to SYS Monitoring.

Required Inputs and Default Settings:

  • -none
RightScript:  SYS Monitoring Apache add

Description: Adds Apache monitoring information to SYS Monitoring.

Required Inputs and Default Settings:

  • APACHE_MPM - Defines the setting in http.conf
  • SERVER_UUID - Required for RightScale monitoring and logging.
RightScript:  DB MySQL s3 continuous mysqldump backups

Description:  Schedules and configures the continuous MySQL backups.

Required Inputs and Default Settings:

  • AWS_ACCESS_KEY_ID - Your AWS Access Key ID
  • AWS_SECRET_ACCESS_KEY - Your AWS Secret Access Key
  • DB_MYSQLDUMP_BUCKET - The S3 bucket where your MySQL dumps will be stored to or restored from.
  • DB_MYSQLDUMP_PREFIX - Defines the prefix for the MySQL dump filename.
  • DB_SCHEMA_NAME - The name for the MySQL DB schema for which the application will connect.
RightScript:  DB MySQL s3 continuous application backups

Description:  Schedules and configures the continuous application backups.

Required Inputs and Default Settings:

  • APPLICATION - Sets the directory for your application’s web files.
  • APPLICATION_CODE_BUCKET - The name of the S3 bucket where the application tarball can be retrieved.
  • APPLICATION_CODE_PREFIX - S3 prefix for the Key of the code package.
  • AWS_ACCESS_KEY_ID - Your AWS Access Key ID
  • AWS_SECRET_ACCESS_KEY - Your AWS Secret Access Key

Operational Scripts

The following operational scripts are listed in order.

RightScript:  DB MySQL s3 mysqldump backup

Description:  A script that can run at any time, this will backup you MySQL database to S3.

Required Inputs and Default Settings:

  • AWS_ACCESS_KEY_ID - Your AWS Access Key ID
  • AWS_SECRET_ACCESS_KEY - Your AWS Secret Access Key
  • DB_MYSQLDUMP_BUCKET - The S3 bucket where your MySQL dumps will be stored to or restored from.
  • DB_MYSQLDUMP_PREFIX - Defines the prefix for the MySQL dump filename.
  • DB_SCHEMA_NAME - The name for the MySQL DB schema for which the application will connect.
RightScript:  WEB Apache (re)start

Description:  This script will start (or restart) Apache.

Required Inputs and Default Settings:

  • -none-
RightScript:  IRD JOOMLA backup to s3 (code and data)

Description:  A script that can be run at any time, this will backup your Joomla application and configurations to S3.

Required Inputs and Default Settings:

  • APPLICATION - Sets the directory for your application’s web files.
  • APPLICATION_CODE_BUCKET - The name of the S3 bucket where the application tarball can be retrieved.
  • APPLICATION_CODE_PREFIX - S3 prefix for the Key of the code package.
  • AWS_ACCESS_KEY_ID - Your AWS Access Key ID
  • AWS_SECRET_ACCESS_KEY - Your AWS Secret Access Key
  • DB_MYSQLDUMP_BUCKET - The S3 bucket where your MySQL dumps will be stored to or restored from.
  • DB_MYSQLDUMP_PREFIX - Defines the prefix for the MySQL dump filename.
  • DB_SCHEMA_NAME - The name for the MySQL DB schema for which the application will connect.

Decommission Scripts

-none-

 

Common Runbook Operations

Ensuring that your Joomla Server Started Correctly

After your server launches, you are able to access the Joomla site directly from the main server ip / ec2 address ('www.example.com', for instance). You can log in to the administrator console at http://www.example.com/administrator/ (replace example.com with your own server IP address).

Your site - both database and code - will be backed up daily to your S3 account, and restored on
reboot. You can force a manual backup at any time using the appropriate runscript.

Ensure that server file and database backup and restore operate correctly

  1. Log into the Joomla admin console.
  2. From within the Joomla admin console, select the menu item “Extensions” and then “Templates Manager.”
  3. Select the “beez” Template and click the “Default” button. This just made a very easy change to your application so that we can verify the backup and restore process works correctly.
  4. Execute the backup operational script.
  5. Destroy your server.
  6. Start a new server from the Joomla ServerTemplate. When defining your inputs, make sure that you define the values based off of the paramaters of your previous deployment. There is a check that happens to control whether this is a brand new server or a continuation of a server that was backed up.
  7. Log back into the Joomla administrator console.
  8. From within the Joomla administrator console, select the menu item “Extensions” and then “Templates Manager.”
  9. Verify that the “beez” Template is the current configuration. This should verify that the backup and restore process works correctly.

See also

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

Tags

This page has no custom tags.

Classifications

This page has no classifications.

Announcements

None

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.