CloudFoundry PHP Build pack

A build pack for CloudFoundry to deploy PHP based applications.

This is the next generation build pack for running PHP applications on CloudFoundry and it supersedes the CF PHP & Apache Build Pack. The rationale behind creating this build pack is to use the experiences and feedback gained while writing and using the old build pack with CloudFoundry to make a better build pack. This includes improving the end user experience as well as the quality of the code, its stability, extensibility and readability.

30 Second Tutorial

Getting started with the build pack is easy. With the cf command line utility installed, open a shell, change directories to the root of your PHP files and push your application using the argument -b https://github.com/dmikusa-pivotal/cf-php-build-pack.git.

Example:

mkdir my-php-app
cd my-php-app
cat << EOF > index.php
<?php
  phpinfo();
?>
EOF
cf push -m 128M -b https://github.com/dmikusa-pivotal/cf-php-build-pack.git my-php-app

Please note that you should change my-php-app to some unique name, otherwise you'll get an error and the push will fail.

The example above will create and push a test application, "my-php-app", to CloudFoundry. The -b argument instructs CF to use this build pack. The remainder of the options and arguments are not specific to the build pack, for questions on those consult the output of cf push -h.

Here's a breakdown of what happens when you run the example above.

• On your PC...
  • It'll create a new directory and one PHP file, which calls phpinfo()
  • Run cf to push your application. This will create a new application with a memory limit of 128M (more than enough here) and upload our test file.
• On the Server...
  • The build pack is executed.
  • Application files are copied to the htdocs folder.
  • Apache HTTPD & PHP 5.4 are downloaded, configured with the build pack defaults and run.
  • Your application is accessible at the URL http://.cfapps.io (assuming your targeted towards Pivotal Web Services).

More Information

While the 30 Second Tutorial shows how quick and easy it is to get started using the build pack, it skips over quite a bit of what you can do to adjust, configure and extend the build pack. The following docs and links provide a more in-depth look at the build pack.

• Goals
• Features
• Example Applications
• Usage
• Configuration Options
• Composer
• Binaries
• Troubleshooting
• Getting Help
• Issues & Feature Requests
• Development
• Releases
• License

Goals

Here are the general goals of the build pack (in no particular order):

• Maintain clean and easily understandable detect, compile and release scripts.
• Execute quickly. Run detect, compile and release scripts with minimal effort, downloading as little as possible.
• Utilize a default configuration that "just works" for the majority of users.
• Allow application developers to override default build pack behavior and settings through configuration.
• Allow the build pack to be extended easily via extensions.
• Allow application developers to include custom extensions.
• Not be tied to one particular HTTP server. Support multiple and allow application developers to pick which they use.
• Provide better insight into the application environment. Allow application and servers to be easily monitored.
• Integrate all logs and output into loggregator.

Features

Here's a list of the major features of the build pack.

• supports the latest versions of Apache HTTPD 2.4 and Nginx 1.5, 1.6 & 1.7
• supports the latest versions of PHP 5.4 and 5.5
• supports a large set of PHP extensions, including amqp, apc, bz2, curl, dba, gd, gettext, gmp, igbinary, imap, intl, ldap, mcrypt, memcache, memcached, mongo, msgpack, opcache, openssl, pdo_pgsql, pgsql, phalcon, pspell, redis, snmp, xdebug and zlib
• allows installing PHP runtime of choice: php cli, php cgi or php-fpm
• versions of HTTPD, Nginx and PHP are automatically upgraded to the latest release just by re-staging an application
• allows for application developers to control which PHP extensions are installed
• allows for application developers to custom configure HTTPD, Nginx or PHP
• supports running stand alone PHP scripts
• supports running applications that use Composer
• download location is configurable, allowing users to host binaries on the same network (i.e. run without an Internet connection)
• supports running in "offline" mode where binaries are bundled with the build pack
• supports an extension mechanism that allows the build pack to provided additional functionality
• allows for application developers to provide custom extensions
• support NewRelic through an extension
• NewRelic support works for bound services or when manually specifying a license key
• easy troubleshooting with the BP_DEBUG environment variable
• all logging output is routed through stderr & stdout which is sent to loggregator

Examples

Here are some example applications that can be used with this build pack.

• php-info This app has a basic index page and shows the output of phpinfo()
• PHPMyAdmin A deployment of PHPMyAdmin that uses bound MySQL services
• Wordpress A deployment of Wordpress that uses bound MySQL service
• CodeIgniter CodeIgniter tutorial application running on CF
• Stand Alone An example which runs a stand alone PHP script
• pgbouncer An example which runs the pgbouncer process in the container to pool db connections.

Getting Help

If you have questions, comments or need further help with the build pack you can post to the vcap-dev mailing list. It's a good place for posting question on all of the open source CloudFoundry components, like this build pack. Alternatively, if you're using Pivotal Web Services with the build pack, you could post to the support forums. I keep an eye on both places.

Releases

When using a custom build pack with CloudFoundry, you need to specify the Git URL for the build pack. By default, this will pull down the master branch of the build pack. With the CF PHP Build pack, the master branch is where work and new development occurs. By using this branch it will get you all the latest and greatest developments from the build pack.

If you'd like something that is a little more stable, you can select one of the release branches of the build pack. You can specify a release branch by appending #<branch> to the end of the build pack's URL.

---
applications:
- name: my-php-app
  memory: 128M
  instances: 1
  host: my-php-app
  path: .
  buildpack: https://github.com/dmikusa-pivotal/cf-php-build-pack#v1.0

The benefit of using a release branche is that it is stable, at least in terms of features and changes. No new features or changes will be made to a release branch. The only modifications are for security updates. This means if your app pushes OK now, it should push OK six months from now as long as you're using the same release branch.

Because this build pack is a project that I maintain in my spare time and I do not have infinite resources, I will only commit to maintaining the most recent release branch. Older branches will continue to exist and can continue to be used, but will not receive security updates. When a branch is no longer being maintained, the compile script will output a message when it is run to let you know that it's time to upgrade.

Issues & Feature Requests

This project is managed through Github. If you encounter any issues, bug or problems with the build pack please open an issue. Feature requests can also be submitted this way too.

License

The CloudFoundry PHP Build Pack is released under version 2.0 of the Apache License.