rs-application_php cookbook

Sets up a PHP application server by checking out code from a git repository and connecting to a mysql database.

This cookbook is based on the application and application_php cookbooks and more information is available from them.

Github Repository: https://github.com/rightscale-cookbooks/rs-application_php

Requirements

Chef 12
Requires RightLink 10
See cookbook version 1.2.4 for Chef11 support
See cookbook version 1.1.1 for RightLink 6 support
Cookbook requirements
- application
- application_php
- database
- php
- git
- rightscale_tag
- collectd
- mysql
Platform
- Ubuntu 14.04
- CentOS 6
- CentOS 7

Usage

To set up a stand-alone PHP application server

Add the rs-application_php::default recipe to your run list.
Set the node['rs-application_php']['application_name'] attribute to provide a friendly name for the application.
Application code can be checked out from a remote repository by setting the rs-application_php/scm/* attributes.

To connect the PHP application server to a database server

Follow the same steps to set up a stand-alone PHP application server.
Set the rs-application_php/database/* attributes to provide the hostname of the database server, and the database credentials.

To attach the PHP application server to a load balancer

Add rs-application_php::tags and rs-application_php::application_backend recipes to your run list.
Set the node['rs-application_php']['vhost_path'] attribute to provide the virtual host name served by the application server. The remote load balancer servers will use this virtual host name to configure the access control lists (ACLs).
Set the node['rs-application_php']['remote_attach_recipe'] attribute to the recipe name that needs to be executed on the remote load balancer servers to attach an application server.
To attach the application server to the remote load balancer servers in the deployment, the node['rs-application_php']['application_name'] attribute in the application server should match one of the pool names served by the remote load balancer servers.
Ensure that the remote load balancer server has the necessary machine tags set up. Refer to Load Balancer Servers section in the rightscale_tag cookbook for the machine tags set on a load balancer server.

To detach the application server from a load balancer

Add the rs-application_php::application_backend_detached recipe to your run list.
Set the node['rs-application_php']['remote_detach_recipe'] attribute to the recipe name that needs to be executed on the remote load balancer servers to detach an application server.
To detach the application server from the remote load balancer servers in the deployment, the node['rs-application_php']['application_name'] attribute in the application server should match one of the pool names served by the remote load balancer servers.
Ensure that the remote load balancer servers has the necessary machine tags set up. Refer to Load Balancer Servers section in the rightscale_tag cookbook for the machine tags set on a load balancer server.

Attributes

node['rs-application_php']['packages'] - List of packages to be installed before starting the deployment. Package versions can be specified in this format <package>=<version>. This can be used to upgrade php, by specifying the php packages. It will automatically populate node['php']['packages'] and node['php']['mysql']['package'].
node['rs-application_php']['listen_port'] - The port to use for the application to bind. Default: 8080.
node['rs-application_php']['bind_network_interface'] - The network interface for the application to bind. This attribute can be either 'public' or 'private' interface. Default: 'private'.
node['rs-application_php']['scm']['repository'] - The repository location to download application code.
node['rs-application_php']['scm']['revision'] - The revision of application code to download from the repository.
node['rs-application_php']['application_name'] - The name of the application. This name is used to generate the path of the application code and to determine the backend pool in a load balancer that the application server will be attached to. The application name can only have alphanumeric characters and underscores.
node['rs-application_php']['vhost_path'] - The virtual host served by the application server. The virtual host name can be a valid domain/path name supported by the access control lists (ACLs) in a load balancer. This attribute is used in setting the application:vhost_path_<application_name> tag on the application server. A load balancer server uses this attribute to set up access control lists (ACLs).When setting a 3-tier deployment, ensure that no two application servers have the same application name but different virtual host names.
node['rs-application_php]['app_root'] - The path of application root relative to /usr/local/www/sites/<application name> directory. Default: /.
node['rs-application_php']['migration_command'] - The command used to perform application migration.
node['rs-application_php']['write_settings_file'] - Create the local settings file on the application deployment. Default: false.
node['rs-application_php]['local_settings_file'] - The name of local settings file to be created. The name can also be path relative to the application code. Default: config/db.php. Example: LocalSettings.php, config/db.php.
node['rs-application_php']['settings_template'] - The name of template that will be rendered to create the local settings file. If this attribute is set to nil, then the name of the template that will be used to create the settings file is obtained from the local_settings_file attribute - <local_settings_file>.erb. For example, if the local_settings_file is config/db.php, the template used to generate the settings file will be db.php.erb. Default: nil
node['rs-application_php']['database']['host'] - The FQDN of the database server. Default: localhost.
node['rs-application_php']['database']['user'] - The username used to connect to the database.
node['rs-application_php']['database']['password'] - The password used to connect to the database.
node['rs-application_php']['database']['schema'] - The schema name used to connect to the database.
node['rs-application_php']['remote_attach_recipe'] - The recipe to run on remote load balancer servers to attach the application server to the load balancer servers. Default: rs-haproxy::frontend.
node['rs-application_php']['remote_detach_recipe'] - The recipe to run on remote load balancer servers to detach the application server from the load balancer servers. Default: rs-haproxy::frontend.

Recipes

`rs-application_php::default`

Based on the attributes provided, this recipe will deploy the given application using the application LWRP.

`rs-application_php::tags`

This recipe tags the application server with application server tags used in setting up a 3-tier architecture in a RightScale environment. Refer to Application Servers section in rightscale_tag cookbook for the list of tags set on the application server.

`rs-application_php::collectd`

This recipe sets up collectd monitoring for the application server by installing the collectd package for Apache.

`rs-application_php::application_backend`

This recipe attaches the application server to the load balancer servers serving the same application name as that of the application server and existing in the same deployment. This recipe schedules the execution of the recipe specified in node['rs-application_php']['remote_attach_recipe'] attribute on the load balancer servers matching the load_balancers:active_<application_name>=true tag. This remote recipe execution is achieved by the rs_run_recipe utility.

`rs-application_php::application_backend_detached`

This recipe detaches the application server from the load balancer servers serving the same application name as that of the application server and existing in the same deployment. This recipe schedules the execution of the recipe specified in node['rs-application_php']['remote_detach_recipe'] attribute on the load balancer servers matching the load_balancers:active_<application_name>=true tag. This remote recipe execution is achieved by the rs_run_recipe utility.

Author

Author:: RightScale, Inc. (cookbooks@rightscale.com)