PHP for OpenShift - Docker images

This repository contains sources of the images for building various versions of PHP applications as reproducible Docker images using source-to-image. User can choose between RHEL and CentOS based builder images. The resulting image can be run using Docker.

PHP versions currently supported are:

• php-5.5

RHEL versions currently supported are:

• RHEL7

CentOS versions currently supported are:

• CentOS7

To build a PHP image, choose between a CentOS or RHEL based image:

• RHEL based image

  To build a rhel-based php-5.5 image, you need to run the build on a properly subscribed RHEL machine.

  $ git clone https://github.com/openshift/sti-php.git
  $ cd sti-php
  $ make build TARGET=rhel7 VERSION=5.5
  

• CentOS based image

  $ git clone https://github.com/openshift/sti-php.git
  $ cd sti-php
  $ make build VERSION=5.5
  

Alternatively, you can pull the CentOS image from Docker Hub via:

$ docker pull openshift/php-55-centos7

Notice: By omitting the VERSION parameter, the build/test action will be performed on all the supported versions of PHP. Since we are currently only support version 5.5, you can omit this parameter.

To build simple php-test-app application, using standalone STI and then run the resulting image with Docker execute:

• For RHEL based image

  $ sti build https://github.com/openshift/sti-php.git --context-dir=5.5/test/test-app openshift/php-55-rhel7 php-test-app
  $ docker run -p 8080:8080 php-test-app
  

• For CentOS based image

  $ sti build https://github.com/openshift/sti-php.git --context-dir=5.5/test/test-app openshift/php-55-centos7 php-test-app
  $ docker run -p 8080:8080 php-test-app
  

Accessing the application:

$ curl 127.0.0.1:8080

This repository also provides STI test framework, which launches tests to check functionality of a simple php application built on top of sti-php image.

User can choose between testing php test application based on RHEL or CentOS image.

• RHEL based image

  This image is not available as trusted build in Docker Index.

  To test a rhel7-based php-5.5 image, you need to run the test on a properly subscribed RHEL machine.

  $ cd sti-php
  $ make test TARGET=rhel7 VERSION=5.5
  

• CentOS based image

  $ cd sti-php
  $ make test VERSION=5.5
  

Notice: By omitting the VERSION parameter, the build/test action will be performed on all the supported versions of PHP. Since we currently only support version 5.5 you can omit this parameter.

• <php-version>

  • Dockerfile

    CentOS based Dockerfile.

  • Dockerfile.rhel7

    RHEL based Dockerfile. In order to perform build or test actions on this Dockerfile you need to run the action on properly subscribed RHEL machine.

  • .sti/bin/

    This folder contains scripts that are run by STI:

    • assemble

      Is used to install the sources into location from where the application will be run and prepare the application for deployment (eg. installing modules using npm, etc..)

    • run

      This script is responsible for running the application, by using the application web server.

  • contrib/

    This folder contains file with commonly used modules.

  • test/

    This folder contains a simple STI test framework with a sample PHP app.

    • test-app/

      Simple PHP app for used for testing purposes in the STI test framework.

    • run

      Script that runs the STI test framework.

• hack/

  Folder contains scripts which are responsible for build and test actions performed by the Makefile.

1. Platform name - php
2. Platform version(without dots)
3. Base builder image - centos7/rhel7

Examples: openshift/php-55-centos7, openshift/php-55-rhel7

To set these environment variables, you can place them into .sti/environment file inside your source code repository.

The following environment variables set their equivalent property value in the php.ini file:

• ERROR_REPORTING
  • Informs PHP of which errors, warnings and notices you would like it to take action for
  • Default: E_ALL & ~E_NOTICE
• DISPLAY_ERRORS
  • Controls whether or not and where PHP will output errors, notices and warnings
  • Default: ON
• DISPLAY_STARTUP_ERRORS
  • Cause display errors which occur during PHP's startup sequence to be handled separately from display errors
  • Default: OFF
• TRACK_ERRORS
  • Store the last error/warning message in $php_errormsg (boolean)
  • Default: OFF
• HTML_ERRORS
  • Link errors to documentation related to the error
  • Default: ON
• INCLUDE_PATH
  • Path for PHP source files
  • Default: .:/opt/openshift/src:/opt/rh/php55/root/usr/share/pear
• SESSION_PATH
  • Location for session data files
  • Default: /tmp/sessions

The following environment variables set their equivalent property value in the opcache.ini file:

• OPCACHE_MEMORY_CONSUMPTION
  • The OPcache shared memory storage size
  • Default: 16M

You can also override the entire directory used to load the PHP configuration by setting:

• PHPRC
  • Sets the path to the php.ini file
• PHP_INI_SCAN_DIR
  • Path to scan for additional ini configuration files

In case the DocumentRoot of the application is nested in source directory /opt/openshift/src, user can provide own .htaccess file, to override Apache behavior and specify how application requests should be handled. The .htaccess file needs to be located at the root of the application source.